1a5eb4965SSatish Balay #ifdef PETSC_RCS_HEADER 2*15091d37SBarry Smith static char vcid[] = "$Id: posindep.c,v 1.31 1998/12/03 04:04:06 bsmith Exp bsmith $"; 32d3f70b5SBarry Smith #endif 42d3f70b5SBarry Smith /* 5fb4a63b6SLois Curfman McInnes Code for Timestepping with implicit backwards Euler. 62d3f70b5SBarry Smith */ 72d3f70b5SBarry Smith #include "src/ts/tsimpl.h" /*I "ts.h" I*/ 82d3f70b5SBarry Smith 92d3f70b5SBarry Smith typedef struct { 102d3f70b5SBarry Smith Vec update; /* work vector where new solution is formed */ 112d3f70b5SBarry Smith Vec func; /* work vector where F(t[i],u[i]) is stored */ 122d3f70b5SBarry Smith Vec rhs; /* work vector for RHS; vec_sol/dt */ 132d3f70b5SBarry Smith 142d3f70b5SBarry Smith /* information used for Pseudo-timestepping */ 152d3f70b5SBarry Smith 167bf11e45SBarry Smith int (*dt)(TS,double*,void*); /* compute next timestep, and related context */ 172d3f70b5SBarry Smith void *dtctx; 187bf11e45SBarry Smith int (*verify)(TS,Vec,void*,double*,int*); /* verify previous timestep and related context */ 197bf11e45SBarry Smith void *verifyctx; 202d3f70b5SBarry Smith 217bf11e45SBarry Smith double initial_fnorm,fnorm; /* original and current norm of F(u) */ 22ca4b7087SBarry Smith double fnorm_previous; 2328aa8177SBarry Smith 2428aa8177SBarry Smith double dt_increment; /* scaling that dt is incremented each time-step */ 25ca4b7087SBarry Smith int increment_dt_from_initial_dt; 267bf11e45SBarry Smith } TS_Pseudo; 272d3f70b5SBarry Smith 282d3f70b5SBarry Smith /* ------------------------------------------------------------------------------*/ 292d3f70b5SBarry Smith 3058562591SBarry Smith #undef __FUNC__ 3158562591SBarry Smith #define __FUNC__ "TSPseudoComputeTimeStep" 327bf11e45SBarry Smith /*@ 337bf11e45SBarry Smith TSPseudoComputeTimeStep - Computes the next timestep for a currently running 34564e8f4eSLois Curfman McInnes pseudo-timestepping process. 352d3f70b5SBarry Smith 36*15091d37SBarry Smith Collective on TS 37*15091d37SBarry Smith 387bf11e45SBarry Smith Input Parameter: 397bf11e45SBarry Smith . ts - timestep context 407bf11e45SBarry Smith 417bf11e45SBarry Smith Output Parameter: 42fb4a63b6SLois Curfman McInnes . dt - newly computed timestep 43fb4a63b6SLois Curfman McInnes 44*15091d37SBarry Smith Level: advanced 45564e8f4eSLois Curfman McInnes 46564e8f4eSLois Curfman McInnes Notes: 47564e8f4eSLois Curfman McInnes The routine to be called here to compute the timestep should be 48564e8f4eSLois Curfman McInnes set by calling TSPseudoSetTimeStep(). 49564e8f4eSLois Curfman McInnes 50fb4a63b6SLois Curfman McInnes .keywords: timestep, pseudo, compute 51564e8f4eSLois Curfman McInnes 52564e8f4eSLois Curfman McInnes .seealso: TSPseudoDefaultTimeStep(), TSPseudoSetTimeStep() 537bf11e45SBarry Smith @*/ 547bf11e45SBarry Smith int TSPseudoComputeTimeStep(TS ts,double *dt) 557bf11e45SBarry Smith { 567bf11e45SBarry Smith TS_Pseudo *pseudo = (TS_Pseudo*) ts->data; 577bf11e45SBarry Smith int ierr; 587bf11e45SBarry Smith 593a40ed3dSBarry Smith PetscFunctionBegin; 607bf11e45SBarry Smith PLogEventBegin(TS_PseudoComputeTimeStep,ts,0,0,0); 617bf11e45SBarry Smith ierr = (*pseudo->dt)(ts,dt,pseudo->dtctx); CHKERRQ(ierr); 627bf11e45SBarry Smith PLogEventEnd(TS_PseudoComputeTimeStep,ts,0,0,0); 633a40ed3dSBarry Smith PetscFunctionReturn(0); 647bf11e45SBarry Smith } 657bf11e45SBarry Smith 667bf11e45SBarry Smith 677bf11e45SBarry Smith /* ------------------------------------------------------------------------------*/ 6858562591SBarry Smith #undef __FUNC__ 6958562591SBarry Smith #define __FUNC__ "TSPseudoDefaultVerifyTimeStep" 707bf11e45SBarry Smith /*@C 71639f9d9dSBarry Smith TSPseudoDefaultVerifyTimeStep - Default code to verify the quality of the last timestep. 727bf11e45SBarry Smith 73*15091d37SBarry Smith Collective on TS 74*15091d37SBarry Smith 757bf11e45SBarry Smith Input Parameters: 76*15091d37SBarry Smith + ts - the timestep context 777bf11e45SBarry Smith . dtctx - unused timestep context 78*15091d37SBarry Smith - update - latest solution vector 797bf11e45SBarry Smith 80564e8f4eSLois Curfman McInnes Output Parameters: 81*15091d37SBarry Smith + newdt - the timestep to use for the next step 82*15091d37SBarry Smith - flag - flag indicating whether the last time step was acceptable 837bf11e45SBarry Smith 84*15091d37SBarry Smith Level: advanced 85fee21e36SBarry Smith 86564e8f4eSLois Curfman McInnes Note: 87564e8f4eSLois Curfman McInnes This routine always returns a flag of 1, indicating an acceptable 88564e8f4eSLois Curfman McInnes timestep. 89564e8f4eSLois Curfman McInnes 90564e8f4eSLois Curfman McInnes .keywords: timestep, pseudo, default, verify 91564e8f4eSLois Curfman McInnes 92564e8f4eSLois Curfman McInnes .seealso: TSPseudoSetVerifyTimeStep(), TSPseudoVerifyTimeStep() 937bf11e45SBarry Smith @*/ 947bf11e45SBarry Smith int TSPseudoDefaultVerifyTimeStep(TS ts,Vec update,void *dtctx,double *newdt,int *flag) 957bf11e45SBarry Smith { 963a40ed3dSBarry Smith PetscFunctionBegin; 977bf11e45SBarry Smith *flag = 1; 983a40ed3dSBarry Smith PetscFunctionReturn(0); 997bf11e45SBarry Smith } 1007bf11e45SBarry Smith 1017bf11e45SBarry Smith 10258562591SBarry Smith #undef __FUNC__ 10358562591SBarry Smith #define __FUNC__ "TSPseudoVerifyTimeStep" 1047bf11e45SBarry Smith /*@ 105564e8f4eSLois Curfman McInnes TSPseudoVerifyTimeStep - Verifies whether the last timestep was acceptable. 1067bf11e45SBarry Smith 107*15091d37SBarry Smith Collective on TS 108*15091d37SBarry Smith 109fb4a63b6SLois Curfman McInnes Input Parameters: 110*15091d37SBarry Smith + ts - timestep context 111*15091d37SBarry Smith - update - latest solution vector 1127bf11e45SBarry Smith 113fb4a63b6SLois Curfman McInnes Output Parameters: 114*15091d37SBarry Smith + dt - newly computed timestep (if it had to shrink) 115*15091d37SBarry Smith - flag - indicates if current timestep was ok 1167bf11e45SBarry Smith 117*15091d37SBarry Smith Level: advanced 118fee21e36SBarry Smith 119564e8f4eSLois Curfman McInnes Notes: 120564e8f4eSLois Curfman McInnes The routine to be called here to compute the timestep should be 121564e8f4eSLois Curfman McInnes set by calling TSPseudoSetVerifyTimeStep(). 122564e8f4eSLois Curfman McInnes 123564e8f4eSLois Curfman McInnes .keywords: timestep, pseudo, verify 124564e8f4eSLois Curfman McInnes 125564e8f4eSLois Curfman McInnes .seealso: TSPseudoSetVerifyTimeStep(), TSPseudoDefaultVerifyTimeStep() 1267bf11e45SBarry Smith @*/ 1277bf11e45SBarry Smith int TSPseudoVerifyTimeStep(TS ts,Vec update,double *dt,int *flag) 1287bf11e45SBarry Smith { 1297bf11e45SBarry Smith TS_Pseudo *pseudo = (TS_Pseudo*) ts->data; 1307bf11e45SBarry Smith int ierr; 1317bf11e45SBarry Smith 1323a40ed3dSBarry Smith PetscFunctionBegin; 1333a40ed3dSBarry Smith if (!pseudo->verify) {*flag = 1; PetscFunctionReturn(0);} 1347bf11e45SBarry Smith 1357bf11e45SBarry Smith ierr = (*pseudo->verify)(ts,update,pseudo->verifyctx,dt,flag ); CHKERRQ(ierr); 1367bf11e45SBarry Smith 1373a40ed3dSBarry Smith PetscFunctionReturn(0); 1387bf11e45SBarry Smith } 1397bf11e45SBarry Smith 1407bf11e45SBarry Smith /* --------------------------------------------------------------------------------*/ 1417bf11e45SBarry Smith 14258562591SBarry Smith #undef __FUNC__ 14358562591SBarry Smith #define __FUNC__ "TSStep_Pseudo" 1447bf11e45SBarry Smith static int TSStep_Pseudo(TS ts,int *steps,double *time) 1452d3f70b5SBarry Smith { 1462d3f70b5SBarry Smith Vec sol = ts->vec_sol; 147f2267985SLois Curfman McInnes int ierr,i,max_steps = ts->max_steps,its,ok,lits; 1487bf11e45SBarry Smith TS_Pseudo *pseudo = (TS_Pseudo*) ts->data; 1497bf11e45SBarry Smith double current_time_step; 1502d3f70b5SBarry Smith 1513a40ed3dSBarry Smith PetscFunctionBegin; 1522d3f70b5SBarry Smith *steps = -ts->steps; 1532d3f70b5SBarry Smith 1547bf11e45SBarry Smith ierr = VecCopy(sol,pseudo->update); CHKERRQ(ierr); 1552d3f70b5SBarry Smith for ( i=0; i<max_steps && ts->ptime < ts->max_time; i++ ) { 1567bf11e45SBarry Smith ierr = TSPseudoComputeTimeStep(ts,&ts->time_step); CHKERRQ(ierr); 1577bf11e45SBarry Smith current_time_step = ts->time_step; 1587bf11e45SBarry Smith while (1) { 1597bf11e45SBarry Smith ts->ptime += current_time_step; 1607bf11e45SBarry Smith ierr = SNESSolve(ts->snes,pseudo->update,&its); CHKERRQ(ierr); 161f2267985SLois Curfman McInnes ierr = SNESGetNumberLinearIterations(ts->snes,&lits); CHKERRQ(ierr); 162f2267985SLois Curfman McInnes ts->nonlinear_its += PetscAbsInt(its); ts->linear_its += lits; 1637bf11e45SBarry Smith ierr = TSPseudoVerifyTimeStep(ts,pseudo->update,&ts->time_step,&ok); CHKERRQ(ierr); 1647bf11e45SBarry Smith if (ok) break; 1657bf11e45SBarry Smith ts->ptime -= current_time_step; 1667bf11e45SBarry Smith current_time_step = ts->time_step; 1677bf11e45SBarry Smith } 1687bf11e45SBarry Smith ierr = VecCopy(pseudo->update,sol); CHKERRQ(ierr); 1692d3f70b5SBarry Smith ts->steps++; 1702d3f70b5SBarry Smith ierr = TSMonitor(ts,ts->steps,ts->ptime,sol);CHKERRQ(ierr); 1712d3f70b5SBarry Smith } 1722d3f70b5SBarry Smith 1732d3f70b5SBarry Smith *steps += ts->steps; 1742d3f70b5SBarry Smith *time = ts->ptime; 1753a40ed3dSBarry Smith PetscFunctionReturn(0); 1762d3f70b5SBarry Smith } 1772d3f70b5SBarry Smith 1782d3f70b5SBarry Smith /*------------------------------------------------------------*/ 17958562591SBarry Smith #undef __FUNC__ 180d4bb536fSBarry Smith #define __FUNC__ "TSDestroy_Pseudo" 181e1311b90SBarry Smith static int TSDestroy_Pseudo(TS ts ) 1822d3f70b5SBarry Smith { 1837bf11e45SBarry Smith TS_Pseudo *pseudo = (TS_Pseudo*) ts->data; 1842d3f70b5SBarry Smith int ierr; 1852d3f70b5SBarry Smith 1863a40ed3dSBarry Smith PetscFunctionBegin; 187e4ef1970SSatish Balay if (pseudo->update) {ierr = VecDestroy(pseudo->update); CHKERRQ(ierr);} 1887bf11e45SBarry Smith if (pseudo->func) {ierr = VecDestroy(pseudo->func);CHKERRQ(ierr);} 1897bf11e45SBarry Smith if (pseudo->rhs) {ierr = VecDestroy(pseudo->rhs);CHKERRQ(ierr);} 1902d3f70b5SBarry Smith if (ts->Ashell) {ierr = MatDestroy(ts->A); CHKERRQ(ierr);} 1917bf11e45SBarry Smith PetscFree(pseudo); 1923a40ed3dSBarry Smith PetscFunctionReturn(0); 1932d3f70b5SBarry Smith } 1942d3f70b5SBarry Smith 1952d3f70b5SBarry Smith 1962d3f70b5SBarry Smith /*------------------------------------------------------------*/ 1972d3f70b5SBarry Smith /* 1982d3f70b5SBarry Smith This matrix shell multiply where user provided Shell matrix 1992d3f70b5SBarry Smith */ 2002d3f70b5SBarry Smith 20158562591SBarry Smith #undef __FUNC__ 20258562591SBarry Smith #define __FUNC__ "TSPseudoMatMult" 2037bf11e45SBarry Smith int TSPseudoMatMult(Mat mat,Vec x,Vec y) 2042d3f70b5SBarry Smith { 2052d3f70b5SBarry Smith TS ts; 2062d3f70b5SBarry Smith Scalar mdt,mone = -1.0; 2072d3f70b5SBarry Smith int ierr; 2082d3f70b5SBarry Smith 2093a40ed3dSBarry Smith PetscFunctionBegin; 2103a40ed3dSBarry Smith ierr = MatShellGetContext(mat,(void **)&ts);CHKERRQ(ierr); 2112d3f70b5SBarry Smith mdt = 1.0/ts->time_step; 2122d3f70b5SBarry Smith 2132d3f70b5SBarry Smith /* apply user provided function */ 2142d3f70b5SBarry Smith ierr = MatMult(ts->Ashell,x,y); CHKERRQ(ierr); 2152d3f70b5SBarry Smith /* shift and scale by 1/dt - F */ 2162d3f70b5SBarry Smith ierr = VecAXPBY(&mdt,&mone,x,y); CHKERRQ(ierr); 2173a40ed3dSBarry Smith PetscFunctionReturn(0); 2182d3f70b5SBarry Smith } 2192d3f70b5SBarry Smith 2202d3f70b5SBarry Smith /* 2212d3f70b5SBarry Smith This defines the nonlinear equation that is to be solved with SNES 2222d3f70b5SBarry Smith 2232d3f70b5SBarry Smith (U^{n+1} - U^{n})/dt - F(U^{n+1}) 2242d3f70b5SBarry Smith */ 22558562591SBarry Smith #undef __FUNC__ 22658562591SBarry Smith #define __FUNC__ "TSPseudoFunction" 2277bf11e45SBarry Smith int TSPseudoFunction(SNES snes,Vec x,Vec y,void *ctx) 2282d3f70b5SBarry Smith { 2292d3f70b5SBarry Smith TS ts = (TS) ctx; 2302d3f70b5SBarry Smith Scalar mdt = 1.0/ts->time_step,*unp1,*un,*Funp1; 2312d3f70b5SBarry Smith int ierr,i,n; 2322d3f70b5SBarry Smith 2333a40ed3dSBarry Smith PetscFunctionBegin; 2342d3f70b5SBarry Smith /* apply user provided function */ 2352d3f70b5SBarry Smith ierr = TSComputeRHSFunction(ts,ts->ptime,x,y); CHKERRQ(ierr); 2367bf11e45SBarry Smith /* compute (u^{n+1) - u^{n})/dt - F(u^{n+1}) */ 2372d3f70b5SBarry Smith ierr = VecGetArray(ts->vec_sol,&un); CHKERRQ(ierr); 2382d3f70b5SBarry Smith ierr = VecGetArray(x,&unp1); CHKERRQ(ierr); 2392d3f70b5SBarry Smith ierr = VecGetArray(y,&Funp1); CHKERRQ(ierr); 2402d3f70b5SBarry Smith ierr = VecGetLocalSize(x,&n); CHKERRQ(ierr); 2412d3f70b5SBarry Smith for ( i=0; i<n; i++ ) { 2422d3f70b5SBarry Smith Funp1[i] = mdt*(unp1[i] - un[i]) - Funp1[i]; 2432d3f70b5SBarry Smith } 2442d3f70b5SBarry Smith ierr = VecRestoreArray(ts->vec_sol,&un); 2452d3f70b5SBarry Smith ierr = VecRestoreArray(x,&unp1); 2462d3f70b5SBarry Smith ierr = VecRestoreArray(y,&Funp1); 2472d3f70b5SBarry Smith 2483a40ed3dSBarry Smith PetscFunctionReturn(0); 2492d3f70b5SBarry Smith } 2502d3f70b5SBarry Smith 2512d3f70b5SBarry Smith /* 2522d3f70b5SBarry Smith This constructs the Jacobian needed for SNES 2532d3f70b5SBarry Smith 2542d3f70b5SBarry Smith J = I/dt - J_{F} where J_{F} is the given Jacobian of F. 2552d3f70b5SBarry Smith */ 25658562591SBarry Smith #undef __FUNC__ 25758562591SBarry Smith #define __FUNC__ "TSPseudoJacobian" 2587bf11e45SBarry Smith int TSPseudoJacobian(SNES snes,Vec x,Mat *AA,Mat *BB,MatStructure *str,void *ctx) 2592d3f70b5SBarry Smith { 2602d3f70b5SBarry Smith TS ts = (TS) ctx; 2612d3f70b5SBarry Smith int ierr; 2622d3f70b5SBarry Smith Scalar mone = -1.0, mdt = 1.0/ts->time_step; 2632d3f70b5SBarry Smith MatType mtype; 2642d3f70b5SBarry Smith 2653a40ed3dSBarry Smith PetscFunctionBegin; 2662d3f70b5SBarry Smith /* construct users Jacobian */ 2672d3f70b5SBarry Smith if (ts->rhsjacobian) { 2682d3f70b5SBarry Smith ierr = (*ts->rhsjacobian)(ts,ts->ptime,x,AA,BB,str,ts->jacP);CHKERRQ(ierr); 2692d3f70b5SBarry Smith } 2702d3f70b5SBarry Smith 2712d3f70b5SBarry Smith /* shift and scale Jacobian, if not a shell matrix */ 2722d3f70b5SBarry Smith ierr = MatGetType(*AA,&mtype,PETSC_NULL); 2732d3f70b5SBarry Smith if (mtype != MATSHELL) { 2742d3f70b5SBarry Smith ierr = MatScale(&mone,*AA); CHKERRQ(ierr); 2752d3f70b5SBarry Smith ierr = MatShift(&mdt,*AA); CHKERRQ(ierr); 2762d3f70b5SBarry Smith } 2772d3f70b5SBarry Smith ierr = MatGetType(*BB,&mtype,PETSC_NULL); 2782d3f70b5SBarry Smith if (*BB != *AA && *str != SAME_PRECONDITIONER && mtype != MATSHELL) { 2792d3f70b5SBarry Smith ierr = MatScale(&mone,*BB); CHKERRQ(ierr); 2802d3f70b5SBarry Smith ierr = MatShift(&mdt,*BB); CHKERRQ(ierr); 2812d3f70b5SBarry Smith } 2822d3f70b5SBarry Smith 2833a40ed3dSBarry Smith PetscFunctionReturn(0); 2842d3f70b5SBarry Smith } 2852d3f70b5SBarry Smith 2862d3f70b5SBarry Smith 28758562591SBarry Smith #undef __FUNC__ 28858562591SBarry Smith #define __FUNC__ "TSSetUp_Pseudo" 2897bf11e45SBarry Smith static int TSSetUp_Pseudo(TS ts) 2902d3f70b5SBarry Smith { 2917bf11e45SBarry Smith TS_Pseudo *pseudo = (TS_Pseudo*) ts->data; 2922d3f70b5SBarry Smith int ierr, M, m; 2932d3f70b5SBarry Smith 2943a40ed3dSBarry Smith PetscFunctionBegin; 2957bf11e45SBarry Smith ierr = VecDuplicate(ts->vec_sol,&pseudo->update); CHKERRQ(ierr); 2967bf11e45SBarry Smith ierr = VecDuplicate(ts->vec_sol,&pseudo->func); CHKERRQ(ierr); 2977bf11e45SBarry Smith ierr = SNESSetFunction(ts->snes,pseudo->func,TSPseudoFunction,ts);CHKERRQ(ierr); 2982d3f70b5SBarry Smith if (ts->Ashell) { /* construct new shell matrix */ 2992d3f70b5SBarry Smith ierr = VecGetSize(ts->vec_sol,&M); CHKERRQ(ierr); 3002d3f70b5SBarry Smith ierr = VecGetLocalSize(ts->vec_sol,&m); CHKERRQ(ierr); 3012d3f70b5SBarry Smith ierr = MatCreateShell(ts->comm,m,M,M,M,ts,&ts->A); CHKERRQ(ierr); 3027bf11e45SBarry Smith ierr = MatShellSetOperation(ts->A,MATOP_MULT,(void*)TSPseudoMatMult);CHKERRQ(ierr); 3032d3f70b5SBarry Smith } 3047bf11e45SBarry Smith ierr = SNESSetJacobian(ts->snes,ts->A,ts->B,TSPseudoJacobian,ts);CHKERRQ(ierr); 3053a40ed3dSBarry Smith PetscFunctionReturn(0); 3062d3f70b5SBarry Smith } 3072d3f70b5SBarry Smith /*------------------------------------------------------------*/ 3082d3f70b5SBarry Smith 30958562591SBarry Smith #undef __FUNC__ 310d4bb536fSBarry Smith #define __FUNC__ "TSPseudoDefaultMonitor" 3112d3f70b5SBarry Smith int TSPseudoDefaultMonitor(TS ts, int step, double time,Vec v, void *ctx) 3122d3f70b5SBarry Smith { 3137bf11e45SBarry Smith TS_Pseudo *pseudo = (TS_Pseudo*) ts->data; 3142d3f70b5SBarry Smith 3153a40ed3dSBarry Smith PetscFunctionBegin; 31676be9ce4SBarry Smith (*PetscHelpPrintf)(ts->comm,"TS %d dt %g time %g fnorm %g\n",step,ts->time_step,time,pseudo->fnorm); 3173a40ed3dSBarry Smith PetscFunctionReturn(0); 3182d3f70b5SBarry Smith } 3192d3f70b5SBarry Smith 32058562591SBarry Smith #undef __FUNC__ 32158562591SBarry Smith #define __FUNC__ "TSSetFromOptions_Pseudo" 3227bf11e45SBarry Smith static int TSSetFromOptions_Pseudo(TS ts) 3232d3f70b5SBarry Smith { 3242d3f70b5SBarry Smith int ierr,flg; 32528aa8177SBarry Smith double inc; 3262d3f70b5SBarry Smith 3273a40ed3dSBarry Smith PetscFunctionBegin; 3282d3f70b5SBarry Smith ierr = SNESSetFromOptions(ts->snes); CHKERRQ(ierr); 3292d3f70b5SBarry Smith 3302d3f70b5SBarry Smith ierr = OptionsHasName(ts->prefix,"-ts_monitor",&flg); CHKERRQ(ierr); 3312d3f70b5SBarry Smith if (flg) { 33228aa8177SBarry Smith ierr = TSSetMonitor(ts,TSPseudoDefaultMonitor,0); CHKERRQ(ierr); 33328aa8177SBarry Smith } 33428aa8177SBarry Smith ierr = OptionsGetDouble(ts->prefix,"-ts_pseudo_increment",&inc,&flg); CHKERRQ(ierr); 33528aa8177SBarry Smith if (flg) { 33628aa8177SBarry Smith ierr = TSPseudoSetTimeStepIncrement(ts,inc); CHKERRQ(ierr); 3372d3f70b5SBarry Smith } 338ca4b7087SBarry Smith ierr = OptionsHasName(ts->prefix,"-ts_pseudo_increment_dt_from_initial_dt",&flg);CHKERRQ(ierr); 339ca4b7087SBarry Smith if (flg) { 340ca4b7087SBarry Smith ierr = TSPseudoIncrementDtFromInitialDt(ts); CHKERRQ(ierr); 341ca4b7087SBarry Smith } 3423a40ed3dSBarry Smith PetscFunctionReturn(0); 3432d3f70b5SBarry Smith } 3442d3f70b5SBarry Smith 34558562591SBarry Smith #undef __FUNC__ 346d4bb536fSBarry Smith #define __FUNC__ "TSPrintHelp_Pseudo" 347ca4b7087SBarry Smith static int TSPrintHelp_Pseudo(TS ts,char *p) 3482d3f70b5SBarry Smith { 3493a40ed3dSBarry Smith PetscFunctionBegin; 35076be9ce4SBarry Smith (*PetscHelpPrintf)(ts->comm," Options for TS Pseudo timestepper:\n"); 35176be9ce4SBarry Smith (*PetscHelpPrintf)(ts->comm," %sts_pseudo_increment <value> : default 1.1\n",p); 35276be9ce4SBarry Smith (*PetscHelpPrintf)(ts->comm," %sts_pseudo_increment_dt_from_initial_dt : use initial_dt *\n",p); 35376be9ce4SBarry Smith (*PetscHelpPrintf)(ts->comm," initial fnorm/current fnorm to determine new timestep\n"); 35476be9ce4SBarry Smith (*PetscHelpPrintf)(ts->comm," default is current_dt * previous fnorm/current fnorm\n"); 3553a40ed3dSBarry Smith PetscFunctionReturn(0); 3562d3f70b5SBarry Smith } 3572d3f70b5SBarry Smith 35858562591SBarry Smith #undef __FUNC__ 359d4bb536fSBarry Smith #define __FUNC__ "TSView_Pseudo" 360e1311b90SBarry Smith static int TSView_Pseudo(TS ts,Viewer viewer) 3612d3f70b5SBarry Smith { 3623a40ed3dSBarry Smith PetscFunctionBegin; 3633a40ed3dSBarry Smith PetscFunctionReturn(0); 3642d3f70b5SBarry Smith } 3652d3f70b5SBarry Smith 36682bf6240SBarry Smith /* ----------------------------------------------------------------------------- */ 36782bf6240SBarry Smith #undef __FUNC__ 36882bf6240SBarry Smith #define __FUNC__ "TSPseudoSetVerifyTimeStep" 36982bf6240SBarry Smith /*@ 37082bf6240SBarry Smith TSPseudoSetVerifyTimeStep - Sets a user-defined routine to verify the quality of the 37182bf6240SBarry Smith last timestep. 37282bf6240SBarry Smith 373*15091d37SBarry Smith Collective on TS 374*15091d37SBarry Smith 37582bf6240SBarry Smith Input Parameters: 376*15091d37SBarry Smith + ts - timestep context 37782bf6240SBarry Smith . dt - user-defined function to verify timestep 378*15091d37SBarry Smith - ctx - [optional] user-defined context for private data 37982bf6240SBarry Smith for the timestep verification routine (may be PETSC_NULL) 38082bf6240SBarry Smith 381*15091d37SBarry Smith Level: advanced 382fee21e36SBarry Smith 38382bf6240SBarry Smith Calling sequence of func: 38482bf6240SBarry Smith . func (TS ts,Vec update,void *ctx,double *newdt,int *flag); 38582bf6240SBarry Smith 38682bf6240SBarry Smith . update - latest solution vector 38782bf6240SBarry Smith . ctx - [optional] timestep context 38882bf6240SBarry Smith . newdt - the timestep to use for the next step 38982bf6240SBarry Smith . flag - flag indicating whether the last time step was acceptable 39082bf6240SBarry Smith 39182bf6240SBarry Smith Notes: 39282bf6240SBarry Smith The routine set here will be called by TSPseudoVerifyTimeStep() 39382bf6240SBarry Smith during the timestepping process. 39482bf6240SBarry Smith 39582bf6240SBarry Smith .keywords: timestep, pseudo, set, verify 39682bf6240SBarry Smith 39782bf6240SBarry Smith .seealso: TSPseudoDefaultVerifyTimeStep(), TSPseudoVerifyTimeStep() 39882bf6240SBarry Smith @*/ 39982bf6240SBarry Smith int TSPseudoSetVerifyTimeStep(TS ts,int (*dt)(TS,Vec,void*,double*,int*),void* ctx) 40082bf6240SBarry Smith { 40182bf6240SBarry Smith int ierr, (*f)(TS,int (*)(TS,Vec,void*,double *,int *),void *); 40282bf6240SBarry Smith 40382bf6240SBarry Smith PetscFunctionBegin; 40482bf6240SBarry Smith PetscValidHeaderSpecific(ts,TS_COOKIE); 40582bf6240SBarry Smith 40694d884c6SBarry Smith ierr = PetscObjectQueryFunction((PetscObject)ts,"TSPseudoSetVerifyTimeStep_C",(void **)&f);CHKERRQ(ierr); 40782bf6240SBarry Smith if (f) { 40882bf6240SBarry Smith ierr = (*f)(ts,dt,ctx);CHKERRQ(ierr); 40982bf6240SBarry Smith } 41082bf6240SBarry Smith PetscFunctionReturn(0); 41182bf6240SBarry Smith } 41282bf6240SBarry Smith 41382bf6240SBarry Smith #undef __FUNC__ 41482bf6240SBarry Smith #define __FUNC__ "TSPseudoSetTimeStepIncrement" 41582bf6240SBarry Smith /*@ 41682bf6240SBarry Smith TSPseudoSetTimeStepIncrement - Sets the scaling increment applied to 41782bf6240SBarry Smith dt when using the TSPseudoDefaultTimeStep() routine. 41882bf6240SBarry Smith 419fee21e36SBarry Smith Collective on TS 420fee21e36SBarry Smith 421*15091d37SBarry Smith Input Parameters: 422*15091d37SBarry Smith + ts - the timestep context 423*15091d37SBarry Smith - inc - the scaling factor >= 1.0 424*15091d37SBarry Smith 42582bf6240SBarry Smith Options Database Key: 42682bf6240SBarry Smith $ -ts_pseudo_increment <increment> 42782bf6240SBarry Smith 428*15091d37SBarry Smith Level: advanced 429*15091d37SBarry Smith 43082bf6240SBarry Smith .keywords: timestep, pseudo, set, increment 43182bf6240SBarry Smith 43282bf6240SBarry Smith .seealso: TSPseudoSetTimeStep(), TSPseudoDefaultTimeStep() 43382bf6240SBarry Smith @*/ 43482bf6240SBarry Smith int TSPseudoSetTimeStepIncrement(TS ts,double inc) 43582bf6240SBarry Smith { 43682bf6240SBarry Smith int ierr, (*f)(TS,double); 43782bf6240SBarry Smith 43882bf6240SBarry Smith PetscFunctionBegin; 43982bf6240SBarry Smith PetscValidHeaderSpecific(ts,TS_COOKIE); 44082bf6240SBarry Smith 44194d884c6SBarry Smith ierr = PetscObjectQueryFunction((PetscObject)ts,"TSPseudoSetTimeStepIncrement_C",(void **)&f);CHKERRQ(ierr); 44282bf6240SBarry Smith if (f) { 44382bf6240SBarry Smith ierr = (*f)(ts,inc);CHKERRQ(ierr); 44482bf6240SBarry Smith } 44582bf6240SBarry Smith PetscFunctionReturn(0); 44682bf6240SBarry Smith } 44782bf6240SBarry Smith 44882bf6240SBarry Smith #undef __FUNC__ 44982bf6240SBarry Smith #define __FUNC__ "TSPseudoIncrementDtFromInitialDt" 45082bf6240SBarry Smith /*@ 45182bf6240SBarry Smith TSPseudoIncrementDtFromInitialDt - Indicates that a new timestep 45282bf6240SBarry Smith is computed via the formula 45382bf6240SBarry Smith $ dt = initial_dt*initial_fnorm/current_fnorm 45482bf6240SBarry Smith rather than the default update, 45582bf6240SBarry Smith $ dt = current_dt*previous_fnorm/current_fnorm. 45682bf6240SBarry Smith 457*15091d37SBarry Smith Collective on TS 458*15091d37SBarry Smith 45982bf6240SBarry Smith Input Parameter: 46082bf6240SBarry Smith . ts - the timestep context 46182bf6240SBarry Smith 46282bf6240SBarry Smith Options Database Key: 46382bf6240SBarry Smith $ -ts_pseudo_increment_dt_from_initial_dt 46482bf6240SBarry Smith 465*15091d37SBarry Smith Level: advanced 466*15091d37SBarry Smith 46782bf6240SBarry Smith .keywords: timestep, pseudo, set, increment 46882bf6240SBarry Smith 46982bf6240SBarry Smith .seealso: TSPseudoSetTimeStep(), TSPseudoDefaultTimeStep() 47082bf6240SBarry Smith @*/ 47182bf6240SBarry Smith int TSPseudoIncrementDtFromInitialDt(TS ts) 47282bf6240SBarry Smith { 47382bf6240SBarry Smith int ierr, (*f)(TS); 47482bf6240SBarry Smith 47582bf6240SBarry Smith PetscFunctionBegin; 47682bf6240SBarry Smith PetscValidHeaderSpecific(ts,TS_COOKIE); 47782bf6240SBarry Smith 47894d884c6SBarry Smith ierr = PetscObjectQueryFunction((PetscObject)ts,"TSPseudoIncrementDtFromInitialDt_C",(void **)&f);CHKERRQ(ierr); 47982bf6240SBarry Smith if (f) { 48082bf6240SBarry Smith ierr = (*f)(ts);CHKERRQ(ierr); 48182bf6240SBarry Smith } 48282bf6240SBarry Smith PetscFunctionReturn(0); 48382bf6240SBarry Smith } 48482bf6240SBarry Smith 48582bf6240SBarry Smith 48682bf6240SBarry Smith #undef __FUNC__ 48782bf6240SBarry Smith #define __FUNC__ "TSPseudoSetTimeStep" 48882bf6240SBarry Smith /*@ 48982bf6240SBarry Smith TSPseudoSetTimeStep - Sets the user-defined routine to be 49082bf6240SBarry Smith called at each pseudo-timestep to update the timestep. 49182bf6240SBarry Smith 492*15091d37SBarry Smith Collective on TS 493*15091d37SBarry Smith 49482bf6240SBarry Smith Input Parameters: 495*15091d37SBarry Smith + ts - timestep context 49682bf6240SBarry Smith . dt - function to compute timestep 497*15091d37SBarry Smith - ctx - [optional] user-defined context for private data 49882bf6240SBarry Smith required by the function (may be PETSC_NULL) 49982bf6240SBarry Smith 500*15091d37SBarry Smith Level: intermediate 501fee21e36SBarry Smith 50282bf6240SBarry Smith Calling sequence of func: 50382bf6240SBarry Smith . func (TS ts,double *newdt,void *ctx); 50482bf6240SBarry Smith 50582bf6240SBarry Smith . newdt - the newly computed timestep 50682bf6240SBarry Smith . ctx - [optional] timestep context 50782bf6240SBarry Smith 50882bf6240SBarry Smith Notes: 50982bf6240SBarry Smith The routine set here will be called by TSPseudoComputeTimeStep() 51082bf6240SBarry Smith during the timestepping process. 51182bf6240SBarry Smith 51282bf6240SBarry Smith .keywords: timestep, pseudo, set 51382bf6240SBarry Smith 51482bf6240SBarry Smith .seealso: TSPseudoDefaultTimeStep(), TSPseudoComputeTimeStep() 51582bf6240SBarry Smith @*/ 51682bf6240SBarry Smith int TSPseudoSetTimeStep(TS ts,int (*dt)(TS,double*,void*),void* ctx) 51782bf6240SBarry Smith { 51882bf6240SBarry Smith int ierr, (*f)(TS,int (*)(TS,double *,void *),void *); 51982bf6240SBarry Smith 52082bf6240SBarry Smith PetscFunctionBegin; 52182bf6240SBarry Smith PetscValidHeaderSpecific(ts,TS_COOKIE); 52282bf6240SBarry Smith 52394d884c6SBarry Smith ierr = PetscObjectQueryFunction((PetscObject)ts,"TSPseudoSetTimeStep_C",(void **)&f);CHKERRQ(ierr); 52482bf6240SBarry Smith if (f) { 52582bf6240SBarry Smith ierr = (*f)(ts,dt,ctx);CHKERRQ(ierr); 52682bf6240SBarry Smith } 52782bf6240SBarry Smith PetscFunctionReturn(0); 52882bf6240SBarry Smith } 52982bf6240SBarry Smith 53082bf6240SBarry Smith /* ----------------------------------------------------------------------------- */ 53182bf6240SBarry Smith 532fb2e594dSBarry Smith EXTERN_C_BEGIN 53382bf6240SBarry Smith #undef __FUNC__ 53482bf6240SBarry Smith #define __FUNC__ "TSPseudoSetVerifyTimeStep_Pseudo" 53582bf6240SBarry Smith int TSPseudoSetVerifyTimeStep_Pseudo(TS ts,int (*dt)(TS,Vec,void*,double*,int*),void* ctx) 53682bf6240SBarry Smith { 53782bf6240SBarry Smith TS_Pseudo *pseudo; 53882bf6240SBarry Smith 53982bf6240SBarry Smith PetscFunctionBegin; 54082bf6240SBarry Smith pseudo = (TS_Pseudo*) ts->data; 54182bf6240SBarry Smith pseudo->verify = dt; 54282bf6240SBarry Smith pseudo->verifyctx = ctx; 54382bf6240SBarry Smith PetscFunctionReturn(0); 54482bf6240SBarry Smith } 545fb2e594dSBarry Smith EXTERN_C_END 54682bf6240SBarry Smith 547fb2e594dSBarry Smith EXTERN_C_BEGIN 54882bf6240SBarry Smith #undef __FUNC__ 54982bf6240SBarry Smith #define __FUNC__ "TSPseudoSetTimeStepIncrement_Pseudo" 55082bf6240SBarry Smith int TSPseudoSetTimeStepIncrement_Pseudo(TS ts,double inc) 55182bf6240SBarry Smith { 55282bf6240SBarry Smith TS_Pseudo *pseudo; 55382bf6240SBarry Smith 55482bf6240SBarry Smith PetscFunctionBegin; 55582bf6240SBarry Smith pseudo = (TS_Pseudo*) ts->data; 55682bf6240SBarry Smith pseudo->dt_increment = inc; 55782bf6240SBarry Smith PetscFunctionReturn(0); 55882bf6240SBarry Smith } 559fb2e594dSBarry Smith EXTERN_C_END 56082bf6240SBarry Smith 561fb2e594dSBarry Smith EXTERN_C_BEGIN 56282bf6240SBarry Smith #undef __FUNC__ 56382bf6240SBarry Smith #define __FUNC__ "TSPseudoIncrementDtFromInitialDt_Pseudo" 56482bf6240SBarry Smith int TSPseudoIncrementDtFromInitialDt_Pseudo(TS ts) 56582bf6240SBarry Smith { 56682bf6240SBarry Smith TS_Pseudo *pseudo; 56782bf6240SBarry Smith 56882bf6240SBarry Smith PetscFunctionBegin; 56982bf6240SBarry Smith pseudo = (TS_Pseudo*) ts->data; 57082bf6240SBarry Smith pseudo->increment_dt_from_initial_dt = 1; 57182bf6240SBarry Smith PetscFunctionReturn(0); 57282bf6240SBarry Smith } 573fb2e594dSBarry Smith EXTERN_C_END 57482bf6240SBarry Smith 575fb2e594dSBarry Smith EXTERN_C_BEGIN 57682bf6240SBarry Smith #undef __FUNC__ 57782bf6240SBarry Smith #define __FUNC__ "TSPseudoSetTimeStep_Pseudo" 57882bf6240SBarry Smith int TSPseudoSetTimeStep_Pseudo(TS ts,int (*dt)(TS,double*,void*),void* ctx) 57982bf6240SBarry Smith { 58082bf6240SBarry Smith TS_Pseudo *pseudo; 58182bf6240SBarry Smith 58282bf6240SBarry Smith PetscFunctionBegin; 58382bf6240SBarry Smith pseudo = (TS_Pseudo*) ts->data; 58482bf6240SBarry Smith pseudo->dt = dt; 58582bf6240SBarry Smith pseudo->dtctx = ctx; 58682bf6240SBarry Smith PetscFunctionReturn(0); 58782bf6240SBarry Smith } 588fb2e594dSBarry Smith EXTERN_C_END 58982bf6240SBarry Smith 59082bf6240SBarry Smith /* ----------------------------------------------------------------------------- */ 59182bf6240SBarry Smith 592fb2e594dSBarry Smith EXTERN_C_BEGIN 59358562591SBarry Smith #undef __FUNC__ 59458562591SBarry Smith #define __FUNC__ "TSCreate_Pseudo" 5957bf11e45SBarry Smith int TSCreate_Pseudo(TS ts ) 5962d3f70b5SBarry Smith { 5977bf11e45SBarry Smith TS_Pseudo *pseudo; 5982d3f70b5SBarry Smith int ierr; 5992d3f70b5SBarry Smith MatType mtype; 6002d3f70b5SBarry Smith 6013a40ed3dSBarry Smith PetscFunctionBegin; 6027bf11e45SBarry Smith ts->destroy = TSDestroy_Pseudo; 6037bf11e45SBarry Smith ts->printhelp = TSPrintHelp_Pseudo; 6047bf11e45SBarry Smith ts->view = TSView_Pseudo; 6052d3f70b5SBarry Smith 6062d3f70b5SBarry Smith if (ts->problem_type == TS_LINEAR) { 607a8c6a408SBarry Smith SETERRQ(PETSC_ERR_ARG_WRONG,0,"Only for nonlinear problems"); 6082d3f70b5SBarry Smith } 6092d3f70b5SBarry Smith if (!ts->A) { 610a8c6a408SBarry Smith SETERRQ(PETSC_ERR_ARG_WRONGSTATE,0,"Must set Jacobian"); 6112d3f70b5SBarry Smith } 6122d3f70b5SBarry Smith ierr = MatGetType(ts->A,&mtype,PETSC_NULL); 6132d3f70b5SBarry Smith if (mtype == MATSHELL) { 6142d3f70b5SBarry Smith ts->Ashell = ts->A; 6152d3f70b5SBarry Smith } 6167bf11e45SBarry Smith ts->setup = TSSetUp_Pseudo; 6177bf11e45SBarry Smith ts->step = TSStep_Pseudo; 6187bf11e45SBarry Smith ts->setfromoptions = TSSetFromOptions_Pseudo; 6197bf11e45SBarry Smith 6207bf11e45SBarry Smith /* create the required nonlinear solver context */ 6212d3f70b5SBarry Smith ierr = SNESCreate(ts->comm,SNES_NONLINEAR_EQUATIONS,&ts->snes);CHKERRQ(ierr); 6222d3f70b5SBarry Smith 6237bf11e45SBarry Smith pseudo = PetscNew(TS_Pseudo); CHKPTRQ(pseudo); 624eed86810SBarry Smith PLogObjectMemory(ts,sizeof(TS_Pseudo)); 625eed86810SBarry Smith 6267bf11e45SBarry Smith PetscMemzero(pseudo,sizeof(TS_Pseudo)); 6277bf11e45SBarry Smith ts->data = (void *) pseudo; 6282d3f70b5SBarry Smith 62928aa8177SBarry Smith pseudo->dt_increment = 1.1; 630ca4b7087SBarry Smith pseudo->increment_dt_from_initial_dt = 0; 63128aa8177SBarry Smith pseudo->dt = TSPseudoDefaultTimeStep; 63282bf6240SBarry Smith 63394d884c6SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSPseudoSetVerifyTimeStep_C", 634e1311b90SBarry Smith "TSPseudoSetVerifyTimeStep_Pseudo", 635e1311b90SBarry Smith (void*)TSPseudoSetVerifyTimeStep_Pseudo);CHKERRQ(ierr); 63694d884c6SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSPseudoSetTimeStepIncrement_C", 637e1311b90SBarry Smith "TSPseudoSetTimeStepIncrement_Pseudo", 638e1311b90SBarry Smith (void*)TSPseudoSetTimeStepIncrement_Pseudo);CHKERRQ(ierr); 63994d884c6SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSPseudoIncrementDtFromInitialDt_C", 640e1311b90SBarry Smith "TSPseudoIncrementDtFromInitialDt_Pseudo", 641e1311b90SBarry Smith (void*)TSPseudoIncrementDtFromInitialDt_Pseudo);CHKERRQ(ierr); 64294d884c6SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSPseudoSetTimeStep_C","TSPseudoSetTimeStep_Pseudo", 643e1311b90SBarry Smith (void*)TSPseudoSetTimeStep_Pseudo);CHKERRQ(ierr); 6443a40ed3dSBarry Smith PetscFunctionReturn(0); 6452d3f70b5SBarry Smith } 646fb2e594dSBarry Smith EXTERN_C_END 6472d3f70b5SBarry Smith 64858562591SBarry Smith #undef __FUNC__ 64982bf6240SBarry Smith #define __FUNC__ "TSPseudoDefaultTimeStep" 65082bf6240SBarry Smith /*@C 65182bf6240SBarry Smith TSPseudoDefaultTimeStep - Default code to compute pseudo-timestepping. 65282bf6240SBarry Smith Use with TSPseudoSetTimeStep(). 65328aa8177SBarry Smith 654*15091d37SBarry Smith Collective on TS 655*15091d37SBarry Smith 65628aa8177SBarry Smith Input Parameters: 65728aa8177SBarry Smith . ts - the timestep context 65882bf6240SBarry Smith . dtctx - unused timestep context 65928aa8177SBarry Smith 66082bf6240SBarry Smith Output Parameter: 66182bf6240SBarry Smith . newdt - the timestep to use for the next step 66228aa8177SBarry Smith 663*15091d37SBarry Smith Level: advanced 664*15091d37SBarry Smith 66582bf6240SBarry Smith .keywords: timestep, pseudo, default 666564e8f4eSLois Curfman McInnes 66782bf6240SBarry Smith .seealso: TSPseudoSetTimeStep(), TSPseudoComputeTimeStep() 66828aa8177SBarry Smith @*/ 66982bf6240SBarry Smith int TSPseudoDefaultTimeStep(TS ts,double* newdt,void* dtctx) 67028aa8177SBarry Smith { 67182bf6240SBarry Smith TS_Pseudo *pseudo = (TS_Pseudo*) ts->data; 67282bf6240SBarry Smith double inc = pseudo->dt_increment,fnorm_previous = pseudo->fnorm_previous; 67382bf6240SBarry Smith int ierr; 67428aa8177SBarry Smith 6753a40ed3dSBarry Smith PetscFunctionBegin; 67682bf6240SBarry Smith ierr = TSComputeRHSFunction(ts,ts->ptime,ts->vec_sol,pseudo->func);CHKERRQ(ierr); 67782bf6240SBarry Smith ierr = VecNorm(pseudo->func,NORM_2,&pseudo->fnorm); CHKERRQ(ierr); 67882bf6240SBarry Smith if (pseudo->initial_fnorm == 0.0) { 67982bf6240SBarry Smith /* first time through so compute initial function norm */ 68082bf6240SBarry Smith pseudo->initial_fnorm = pseudo->fnorm; 68182bf6240SBarry Smith fnorm_previous = pseudo->fnorm; 68282bf6240SBarry Smith } 68382bf6240SBarry Smith if (pseudo->fnorm == 0.0) { 68482bf6240SBarry Smith *newdt = 1.e12*inc*ts->time_step; 68582bf6240SBarry Smith } 68682bf6240SBarry Smith else if (pseudo->increment_dt_from_initial_dt) { 68782bf6240SBarry Smith *newdt = inc*ts->initial_time_step*pseudo->initial_fnorm/pseudo->fnorm; 68882bf6240SBarry Smith } else { 68982bf6240SBarry Smith *newdt = inc*ts->time_step*fnorm_previous/pseudo->fnorm; 69082bf6240SBarry Smith } 69182bf6240SBarry Smith pseudo->fnorm_previous = pseudo->fnorm; 6923a40ed3dSBarry Smith PetscFunctionReturn(0); 69328aa8177SBarry Smith } 6942d3f70b5SBarry Smith 695