1af0996ceSBarry Smith #include <petsc/private/tsimpl.h> /*I "petscts.h" I*/ 2496e6a7aSJed Brown #include <petscdmshell.h> 31e25c274SJed Brown #include <petscdmda.h> 42d5ee99bSBarry Smith #include <petscviewer.h> 52d5ee99bSBarry Smith #include <petscdraw.h> 6900f6b5bSMatthew G. Knepley #include <petscconvest.h> 7d763cef2SBarry Smith 81c167fc2SEmil Constantinescu #define SkipSmallValue(a,b,tol) if (PetscAbsScalar(a)< tol || PetscAbsScalar(b)< tol) continue; 91c167fc2SEmil Constantinescu 10d5ba7fb7SMatthew Knepley /* Logging support */ 11d74926cbSBarry Smith PetscClassId TS_CLASSID, DMTS_CLASSID; 12a05bf03eSHong Zhang PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 13d405a339SMatthew Knepley 14c793f718SLisandro Dalcin const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",NULL}; 1549354f04SShri Abhyankar 162ffb9264SLisandro Dalcin static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt,TSAdaptType default_type) 172ffb9264SLisandro Dalcin { 182ffb9264SLisandro Dalcin PetscErrorCode ierr; 192ffb9264SLisandro Dalcin 202ffb9264SLisandro Dalcin PetscFunctionBegin; 21b92453a8SLisandro Dalcin PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1); 22b92453a8SLisandro Dalcin PetscValidCharPointer(default_type,2); 232ffb9264SLisandro Dalcin if (!((PetscObject)adapt)->type_name) { 242ffb9264SLisandro Dalcin ierr = TSAdaptSetType(adapt,default_type);CHKERRQ(ierr); 252ffb9264SLisandro Dalcin } 262ffb9264SLisandro Dalcin PetscFunctionReturn(0); 272ffb9264SLisandro Dalcin } 282ffb9264SLisandro Dalcin 29bdad233fSMatthew Knepley /*@ 30bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 31bdad233fSMatthew Knepley 32bdad233fSMatthew Knepley Collective on TS 33bdad233fSMatthew Knepley 34bdad233fSMatthew Knepley Input Parameter: 35bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 36bdad233fSMatthew Knepley 37bdad233fSMatthew Knepley Options Database Keys: 38e49d4f37SHong Zhang + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE, TSBSYMP 39ef222394SBarry Smith . -ts_save_trajectory - checkpoint the solution at each time-step 40ef85077eSLisandro Dalcin . -ts_max_time <time> - maximum time to compute to 41ef85077eSLisandro Dalcin . -ts_max_steps <steps> - maximum number of time-steps to take 42ef85077eSLisandro Dalcin . -ts_init_time <time> - initial time to start computation 434dc72f7fSBarry Smith . -ts_final_time <time> - final time to compute to (deprecated: use -ts_max_time) 443e4cdcaaSBarry Smith . -ts_dt <dt> - initial time step 451628793fSSatish Balay . -ts_exact_final_time <stepover,interpolate,matchstep> - whether to stop at the exact given final time and how to compute the solution at that time 46a3cdaa26SBarry Smith . -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed 47a3cdaa26SBarry Smith . -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails 48a3cdaa26SBarry Smith . -ts_error_if_step_fails <true,false> - Error if no step succeeds 49a3cdaa26SBarry Smith . -ts_rtol <rtol> - relative tolerance for local truncation error 50a3cdaa26SBarry Smith . -ts_atol <atol> Absolute tolerance for local truncation error 51f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - test the Jacobian at each iteration against finite difference with RHS function 52f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - test the Jacobian at each iteration against finite difference with RHS function 53ef222394SBarry Smith . -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory) 54847ff0e1SMatthew G. Knepley . -ts_fd_color - Use finite differences with coloring to compute IJacobian 55bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 56aee7a9fbSMatthew G. Knepley . -ts_monitor_cancel - Cancel all monitors 57de06c3feSJed Brown . -ts_monitor_lg_solution - Monitor solution graphically 58de06c3feSJed Brown . -ts_monitor_lg_error - Monitor error graphically 597cf37e64SBarry Smith . -ts_monitor_error - Monitors norm of error 606934998bSLisandro Dalcin . -ts_monitor_lg_timestep - Monitor timestep size graphically 618b668821SLisandro Dalcin . -ts_monitor_lg_timestep_log - Monitor log timestep size graphically 62de06c3feSJed Brown . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 63de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 64de06c3feSJed Brown . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 65de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 663e4cdcaaSBarry Smith . -ts_monitor_draw_solution_phase <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom 673e4cdcaaSBarry Smith . -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction() 68fde5950dSBarry Smith . -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep 69e4160dc7SJulian Andrej . -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu) 709e336e28SPatrick Sanan - -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time 7153ea634cSHong Zhang 723d5a8a6aSBarry Smith Notes: 733d5a8a6aSBarry Smith See SNESSetFromOptions() and KSPSetFromOptions() for how to control the nonlinear and linear solves used by the time-stepper. 743d5a8a6aSBarry Smith 753d5a8a6aSBarry Smith Certain SNES options get reset for each new nonlinear solver, for example -snes_lag_jacobian <its> and -snes_lag_preconditioner <its>, in order 763d5a8a6aSBarry Smith to retain them over the multiple nonlinear solves that TS uses you mush also provide -snes_lag_jacobian_persists true and 773d5a8a6aSBarry Smith -snes_lag_preconditioner_persists true 783d5a8a6aSBarry Smith 799e336e28SPatrick Sanan Developer Note: 809e336e28SPatrick Sanan We should unify all the -ts_monitor options in the way that -xxx_view has been unified 81bdad233fSMatthew Knepley 82bdad233fSMatthew Knepley Level: beginner 83bdad233fSMatthew Knepley 84a313700dSBarry Smith .seealso: TSGetType() 85bdad233fSMatthew Knepley @*/ 867087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 87bdad233fSMatthew Knepley { 88bc952696SBarry Smith PetscBool opt,flg,tflg; 89dfbe8321SBarry Smith PetscErrorCode ierr; 90eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 9131748224SBarry Smith PetscReal time_step; 9249354f04SShri Abhyankar TSExactFinalTimeOption eftopt; 93d1212d36SBarry Smith char dir[16]; 94cd11d68dSLisandro Dalcin TSIFunction ifun; 956991f827SBarry Smith const char *defaultType; 966991f827SBarry Smith char typeName[256]; 97bdad233fSMatthew Knepley 98bdad233fSMatthew Knepley PetscFunctionBegin; 990700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1006991f827SBarry Smith 1016991f827SBarry Smith ierr = TSRegisterAll();CHKERRQ(ierr); 102cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 103cd11d68dSLisandro Dalcin 104cd11d68dSLisandro Dalcin ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 1051ef27442SStefano Zampini if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name; 1061ef27442SStefano Zampini else defaultType = ifun ? TSBEULER : TSEULER; 1076991f827SBarry Smith ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr); 1086991f827SBarry Smith if (opt) { 1096991f827SBarry Smith ierr = TSSetType(ts,typeName);CHKERRQ(ierr); 1106991f827SBarry Smith } else { 1116991f827SBarry Smith ierr = TSSetType(ts,defaultType);CHKERRQ(ierr); 1126991f827SBarry Smith } 113bdad233fSMatthew Knepley 114bdad233fSMatthew Knepley /* Handle generic TS options */ 1154dc72f7fSBarry Smith ierr = PetscOptionsDeprecated("-ts_final_time","-ts_max_time","3.10",NULL);CHKERRQ(ierr); 116ef85077eSLisandro Dalcin ierr = PetscOptionsReal("-ts_max_time","Maximum time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 11719eac22cSLisandro Dalcin ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetMaxSteps",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 1180298fd71SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 11931748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 120cd11d68dSLisandro Dalcin if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);} 12149354f04SShri Abhyankar ierr = PetscOptionsEnum("-ts_exact_final_time","Option for handling of final time step","TSSetExactFinalTime",TSExactFinalTimeOptions,(PetscEnum)ts->exact_final_time,(PetscEnum*)&eftopt,&flg);CHKERRQ(ierr); 12249354f04SShri Abhyankar if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 1230298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL);CHKERRQ(ierr); 1240298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 1250298fd71SBarry Smith ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 1260298fd71SBarry Smith ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 1270298fd71SBarry Smith ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 128bdad233fSMatthew Knepley 129f3b1f45cSBarry Smith ierr = PetscOptionsBool("-ts_rhs_jacobian_test_mult","Test the RHS Jacobian for consistency with RHS at each solve ","None",ts->testjacobian,&ts->testjacobian,NULL);CHKERRQ(ierr); 130f3b1f45cSBarry Smith ierr = PetscOptionsBool("-ts_rhs_jacobian_test_mult_transpose","Test the RHS Jacobian transpose for consistency with RHS at each solve ","None",ts->testjacobiantranspose,&ts->testjacobiantranspose,NULL);CHKERRQ(ierr); 1310fe4d17eSHong Zhang ierr = PetscOptionsBool("-ts_use_splitrhsfunction","Use the split RHS function for multirate solvers ","TSSetUseSplitRHSFunction",ts->use_splitrhsfunction,&ts->use_splitrhsfunction,NULL);CHKERRQ(ierr); 13256f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS) 13356f85f32SBarry Smith { 13456f85f32SBarry Smith PetscBool set; 13556f85f32SBarry Smith flg = PETSC_FALSE; 13656f85f32SBarry Smith ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 13756f85f32SBarry Smith if (set) { 13856f85f32SBarry Smith ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 13956f85f32SBarry Smith } 14056f85f32SBarry Smith } 14156f85f32SBarry Smith #endif 14256f85f32SBarry Smith 143bdad233fSMatthew Knepley /* Monitor options */ 144*d0c080abSJoseph Pusztay ierr = PetscOptionsInt("-ts_monitor_frequency", "Number of time steps between monitor output", "TSMonitorSetFrequency", ts->monitorFrequency, &ts->monitorFrequency, NULL);CHKERRQ(ierr); 145cd11d68dSLisandro Dalcin ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr); 146cc9c3a59SBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_extreme","Monitor extreme values of the solution","TSMonitorExtreme",TSMonitorExtreme,NULL);CHKERRQ(ierr); 147fde5950dSBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr); 148*d0c080abSJoseph Pusztay ierr = TSMonitorSetFromOptions(ts,"-ts_dmswarm_monitor_moments","Monitor moments of particle distribution","TSDMSwarmMonitorMoments",TSDMSwarmMonitorMoments,NULL);CHKERRQ(ierr); 149fde5950dSBarry Smith 150589a23caSBarry Smith ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",NULL,monfilename,sizeof(monfilename),&flg);CHKERRQ(ierr); 1515180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1525180491cSLisandro Dalcin 1534f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 154b3603a34SBarry Smith if (opt) { 1553923b477SBarry Smith PetscInt howoften = 1; 156e669de00SBarry Smith DM dm; 157e669de00SBarry Smith PetscBool net; 158b3603a34SBarry Smith 1590298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 160e669de00SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 161e669de00SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)dm,DMNETWORK,&net);CHKERRQ(ierr); 162e669de00SBarry Smith if (net) { 163e669de00SBarry Smith TSMonitorLGCtxNetwork ctx; 164e669de00SBarry Smith ierr = TSMonitorLGCtxNetworkCreate(ts,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 165e669de00SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGCtxNetworkSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxNetworkDestroy);CHKERRQ(ierr); 166e669de00SBarry Smith ierr = PetscOptionsBool("-ts_monitor_lg_solution_semilogy","Plot the solution with a semi-log axis","",ctx->semilogy,&ctx->semilogy,NULL);CHKERRQ(ierr); 167e669de00SBarry Smith } else { 168e669de00SBarry Smith TSMonitorLGCtx ctx; 169c793f718SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 1704f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 171bdad233fSMatthew Knepley } 172e669de00SBarry Smith } 1736ba87a44SLisandro Dalcin 1744f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 175ef20d060SBarry Smith if (opt) { 1760b039ecaSBarry Smith TSMonitorLGCtx ctx; 1773923b477SBarry Smith PetscInt howoften = 1; 178ef20d060SBarry Smith 1790298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 180c793f718SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 1814f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 182ef20d060SBarry Smith } 183edbaebb3SBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_error","View the error at each timestep","TSMonitorError",TSMonitorError,NULL);CHKERRQ(ierr); 1847cf37e64SBarry Smith 1856934998bSLisandro Dalcin ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 1866934998bSLisandro Dalcin if (opt) { 1876934998bSLisandro Dalcin TSMonitorLGCtx ctx; 1886934998bSLisandro Dalcin PetscInt howoften = 1; 1896934998bSLisandro Dalcin 1906934998bSLisandro Dalcin ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 1916ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 1926934998bSLisandro Dalcin ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 1936934998bSLisandro Dalcin } 1948b668821SLisandro Dalcin ierr = PetscOptionsName("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 1958b668821SLisandro Dalcin if (opt) { 1968b668821SLisandro Dalcin TSMonitorLGCtx ctx; 1978b668821SLisandro Dalcin PetscInt howoften = 1; 1988b668821SLisandro Dalcin 1998b668821SLisandro Dalcin ierr = PetscOptionsInt("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 2008b668821SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2018b668821SLisandro Dalcin ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 2028b668821SLisandro Dalcin ctx->semilogy = PETSC_TRUE; 2038b668821SLisandro Dalcin } 2048b668821SLisandro Dalcin 205201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 206201da799SBarry Smith if (opt) { 207201da799SBarry Smith TSMonitorLGCtx ctx; 208201da799SBarry Smith PetscInt howoften = 1; 209201da799SBarry Smith 2100298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2116ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 212201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 213201da799SBarry Smith } 214201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 215201da799SBarry Smith if (opt) { 216201da799SBarry Smith TSMonitorLGCtx ctx; 217201da799SBarry Smith PetscInt howoften = 1; 218201da799SBarry Smith 2190298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2206ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 221201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 222201da799SBarry Smith } 2238189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 2248189c53fSBarry Smith if (opt) { 2258189c53fSBarry Smith TSMonitorSPEigCtx ctx; 2268189c53fSBarry Smith PetscInt howoften = 1; 2278189c53fSBarry Smith 2280298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 229c793f718SLisandro Dalcin ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 2308189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 2318189c53fSBarry Smith } 2320ec8ee2bSJoseph Pusztay ierr = PetscOptionsName("-ts_monitor_sp_swarm","Display particle phase from the DMSwarm","TSMonitorSPSwarm",&opt);CHKERRQ(ierr); 2331b575b74SJoseph Pusztay if (opt) { 2341b575b74SJoseph Pusztay TSMonitorSPCtx ctx; 2351b575b74SJoseph Pusztay PetscInt howoften = 1; 2360ec8ee2bSJoseph Pusztay ierr = PetscOptionsInt("-ts_monitor_sp_swarm","Display particles phase from the DMSwarm","TSMonitorSPSwarm",howoften,&howoften,NULL);CHKERRQ(ierr); 2371b575b74SJoseph Pusztay ierr = TSMonitorSPCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx);CHKERRQ(ierr); 2380ec8ee2bSJoseph Pusztay ierr = TSMonitorSet(ts, TSMonitorSPSwarmSolution, ctx, (PetscErrorCode (*)(void**))TSMonitorSPCtxDestroy);CHKERRQ(ierr); 2391b575b74SJoseph Pusztay } 240ef20d060SBarry Smith opt = PETSC_FALSE; 2410dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 242a7cc72afSBarry Smith if (opt) { 24383a4ac43SBarry Smith TSMonitorDrawCtx ctx; 24483a4ac43SBarry Smith PetscInt howoften = 1; 245a80ad3e0SBarry Smith 2460298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 247c793f718SLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 24883a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 249bdad233fSMatthew Knepley } 250fb1732b5SBarry Smith opt = PETSC_FALSE; 2512d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 2522d5ee99bSBarry Smith if (opt) { 2532d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 2542d5ee99bSBarry Smith PetscReal bounds[4]; 2552d5ee99bSBarry Smith PetscInt n = 4; 2562d5ee99bSBarry Smith PetscDraw draw; 2576934998bSLisandro Dalcin PetscDrawAxis axis; 2582d5ee99bSBarry Smith 2592d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 2602d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 261c793f718SLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr); 2622d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 2636934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr); 2646934998bSLisandro Dalcin ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 2656934998bSLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 2662d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2672d5ee99bSBarry Smith } 2682d5ee99bSBarry Smith opt = PETSC_FALSE; 2690dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 2703a471f94SBarry Smith if (opt) { 27183a4ac43SBarry Smith TSMonitorDrawCtx ctx; 27283a4ac43SBarry Smith PetscInt howoften = 1; 2733a471f94SBarry Smith 2740298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 275c793f718SLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 27683a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2773a471f94SBarry Smith } 2780ed3bfb6SBarry Smith opt = PETSC_FALSE; 2790ed3bfb6SBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt);CHKERRQ(ierr); 2800ed3bfb6SBarry Smith if (opt) { 2810ed3bfb6SBarry Smith TSMonitorDrawCtx ctx; 2820ed3bfb6SBarry Smith PetscInt howoften = 1; 2830ed3bfb6SBarry Smith 2840ed3bfb6SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL);CHKERRQ(ierr); 285c793f718SLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 2860ed3bfb6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2870ed3bfb6SBarry Smith } 288fde5950dSBarry Smith 289ed81e22dSJed Brown opt = PETSC_FALSE; 290589a23caSBarry Smith ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",NULL,monfilename,sizeof(monfilename),&flg);CHKERRQ(ierr); 291ed81e22dSJed Brown if (flg) { 292ed81e22dSJed Brown const char *ptr,*ptr2; 293ed81e22dSJed Brown char *filetemplate; 294ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 295ed81e22dSJed Brown /* Do some cursory validation of the input. */ 296ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 297ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 298ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 299ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 300ce94432eSBarry Smith if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03D.vts"); 301ed81e22dSJed Brown if (ptr2) break; 302ed81e22dSJed Brown } 303ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 304ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 305ed81e22dSJed Brown } 306bdad233fSMatthew Knepley 307589a23caSBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,sizeof(dir),&flg);CHKERRQ(ierr); 308d1212d36SBarry Smith if (flg) { 309d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 310d1212d36SBarry Smith int ray = 0; 3113ee9839eSMatthew G. Knepley DMDirection ddir; 312d1212d36SBarry Smith DM da; 313d1212d36SBarry Smith PetscMPIInt rank; 314d1212d36SBarry Smith 315ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 3163ee9839eSMatthew G. Knepley if (dir[0] == 'x') ddir = DM_X; 3173ee9839eSMatthew G. Knepley else if (dir[0] == 'y') ddir = DM_Y; 318ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 319d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 320d1212d36SBarry Smith 3215bd1e576SStefano Zampini ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %d\n",dir[0],ray);CHKERRQ(ierr); 322b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 323d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 324d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 325ffc4695bSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRMPI(ierr); 326d1212d36SBarry Smith if (!rank) { 327c793f718SLisandro Dalcin ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,NULL,NULL,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 328d1212d36SBarry Smith } 32951b4a12fSMatthew G. Knepley rayctx->lgctx = NULL; 330d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 331d1212d36SBarry Smith } 332589a23caSBarry Smith ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,sizeof(dir),&flg);CHKERRQ(ierr); 33351b4a12fSMatthew G. Knepley if (flg) { 33451b4a12fSMatthew G. Knepley TSMonitorDMDARayCtx *rayctx; 33551b4a12fSMatthew G. Knepley int ray = 0; 3363ee9839eSMatthew G. Knepley DMDirection ddir; 33751b4a12fSMatthew G. Knepley DM da; 33851b4a12fSMatthew G. Knepley PetscInt howoften = 1; 339d1212d36SBarry Smith 34051b4a12fSMatthew G. Knepley if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 3413ee9839eSMatthew G. Knepley if (dir[0] == 'x') ddir = DM_X; 3423ee9839eSMatthew G. Knepley else if (dir[0] == 'y') ddir = DM_Y; 34351b4a12fSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 34451b4a12fSMatthew G. Knepley sscanf(dir+2, "%d", &ray); 3451c3436cfSJed Brown 3465bd1e576SStefano Zampini ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %d\n", dir[0], ray);CHKERRQ(ierr); 347b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 34851b4a12fSMatthew G. Knepley ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 34951b4a12fSMatthew G. Knepley ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 350c793f718SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 35151b4a12fSMatthew G. Knepley ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 35251b4a12fSMatthew G. Knepley } 353a7a1495cSBarry Smith 354b3d3934dSBarry Smith ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr); 355b3d3934dSBarry Smith if (opt) { 356b3d3934dSBarry Smith TSMonitorEnvelopeCtx ctx; 357b3d3934dSBarry Smith 358b3d3934dSBarry Smith ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr); 359b3d3934dSBarry Smith ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr); 360b3d3934dSBarry Smith } 361aee7a9fbSMatthew G. Knepley flg = PETSC_FALSE; 362aee7a9fbSMatthew G. Knepley ierr = PetscOptionsBool("-ts_monitor_cancel","Remove all monitors","TSMonitorCancel",flg,&flg,&opt);CHKERRQ(ierr); 363aee7a9fbSMatthew G. Knepley if (opt && flg) {ierr = TSMonitorCancel(ts);CHKERRQ(ierr);} 364b3d3934dSBarry Smith 365847ff0e1SMatthew G. Knepley flg = PETSC_FALSE; 366847ff0e1SMatthew G. Knepley ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr); 367847ff0e1SMatthew G. Knepley if (flg) { 368847ff0e1SMatthew G. Knepley DM dm; 369847ff0e1SMatthew G. Knepley DMTS tdm; 370847ff0e1SMatthew G. Knepley 371847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 372847ff0e1SMatthew G. Knepley ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr); 373847ff0e1SMatthew G. Knepley tdm->ijacobianctx = NULL; 374c793f718SLisandro Dalcin ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, NULL);CHKERRQ(ierr); 375847ff0e1SMatthew G. Knepley ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 376847ff0e1SMatthew G. Knepley } 377847ff0e1SMatthew G. Knepley 378d763cef2SBarry Smith /* Handle specific TS options */ 379d763cef2SBarry Smith if (ts->ops->setfromoptions) { 3806991f827SBarry Smith ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr); 381d763cef2SBarry Smith } 382fbc52257SHong Zhang 383a7bdc993SLisandro Dalcin /* Handle TSAdapt options */ 384a7bdc993SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 385a7bdc993SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 386a7bdc993SLisandro Dalcin ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr); 387a7bdc993SLisandro Dalcin 38868bece0bSHong Zhang /* TS trajectory must be set after TS, since it may use some TS options above */ 3894f122a70SLisandro Dalcin tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE; 39068bece0bSHong Zhang ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr); 39168bece0bSHong Zhang if (tflg) { 39268bece0bSHong Zhang ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 39368bece0bSHong Zhang } 394a05bf03eSHong Zhang 395a05bf03eSHong Zhang ierr = TSAdjointSetFromOptions(PetscOptionsObject,ts);CHKERRQ(ierr); 396d763cef2SBarry Smith 397d763cef2SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 3980633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr); 399fbc52257SHong Zhang ierr = PetscOptionsEnd();CHKERRQ(ierr); 400d763cef2SBarry Smith 4014f122a70SLisandro Dalcin if (ts->trajectory) { 4024f122a70SLisandro Dalcin ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 403d763cef2SBarry Smith } 40468bece0bSHong Zhang 4051ef27442SStefano Zampini /* why do we have to do this here and not during TSSetUp? */ 4064f122a70SLisandro Dalcin ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr); 4071ef27442SStefano Zampini if (ts->problem_type == TS_LINEAR) { 4081ef27442SStefano Zampini ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&flg,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr); 4091ef27442SStefano Zampini if (!flg) { ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); } 4101ef27442SStefano Zampini } 4114f122a70SLisandro Dalcin ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr); 412d763cef2SBarry Smith PetscFunctionReturn(0); 413d763cef2SBarry Smith } 414d763cef2SBarry Smith 415d2daff3dSHong Zhang /*@ 41678fbdcc8SBarry Smith TSGetTrajectory - Gets the trajectory from a TS if it exists 41778fbdcc8SBarry Smith 41878fbdcc8SBarry Smith Collective on TS 41978fbdcc8SBarry Smith 42078fbdcc8SBarry Smith Input Parameters: 42178fbdcc8SBarry Smith . ts - the TS context obtained from TSCreate() 42278fbdcc8SBarry Smith 4237a7aea1fSJed Brown Output Parameters: 42478fbdcc8SBarry Smith . tr - the TSTrajectory object, if it exists 42578fbdcc8SBarry Smith 42678fbdcc8SBarry Smith Note: This routine should be called after all TS options have been set 42778fbdcc8SBarry Smith 42878fbdcc8SBarry Smith Level: advanced 42978fbdcc8SBarry Smith 43078fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate() 43178fbdcc8SBarry Smith 43278fbdcc8SBarry Smith @*/ 43378fbdcc8SBarry Smith PetscErrorCode TSGetTrajectory(TS ts,TSTrajectory *tr) 43478fbdcc8SBarry Smith { 43578fbdcc8SBarry Smith PetscFunctionBegin; 43678fbdcc8SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 43778fbdcc8SBarry Smith *tr = ts->trajectory; 43878fbdcc8SBarry Smith PetscFunctionReturn(0); 43978fbdcc8SBarry Smith } 44078fbdcc8SBarry Smith 44178fbdcc8SBarry Smith /*@ 442bc952696SBarry Smith TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object 443d2daff3dSHong Zhang 444d2daff3dSHong Zhang Collective on TS 445d2daff3dSHong Zhang 446d2daff3dSHong Zhang Input Parameters: 447bc952696SBarry Smith . ts - the TS context obtained from TSCreate() 448bc952696SBarry Smith 44978fbdcc8SBarry Smith Options Database: 45078fbdcc8SBarry Smith + -ts_save_trajectory - saves the trajectory to a file 45178fbdcc8SBarry Smith - -ts_trajectory_type type 45278fbdcc8SBarry Smith 45368bece0bSHong Zhang Note: This routine should be called after all TS options have been set 454d2daff3dSHong Zhang 455c3a89c15SBarry Smith The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/lib/petsc/bin/PetscBinaryIOTrajectory.py and 45678fbdcc8SBarry Smith MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m 45778fbdcc8SBarry Smith 458d2daff3dSHong Zhang Level: intermediate 459d2daff3dSHong Zhang 4602d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve() 461d2daff3dSHong Zhang 462d2daff3dSHong Zhang @*/ 463bc952696SBarry Smith PetscErrorCode TSSetSaveTrajectory(TS ts) 464d2daff3dSHong Zhang { 465bc952696SBarry Smith PetscErrorCode ierr; 466bc952696SBarry Smith 467d2daff3dSHong Zhang PetscFunctionBegin; 468d2daff3dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 469bc952696SBarry Smith if (!ts->trajectory) { 470bc952696SBarry Smith ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 471bc952696SBarry Smith } 472d2daff3dSHong Zhang PetscFunctionReturn(0); 473d2daff3dSHong Zhang } 474d2daff3dSHong Zhang 475a7a1495cSBarry Smith /*@ 4762d29f1f2SStefano Zampini TSResetTrajectory - Destroys and recreates the internal TSTrajectory object 4772d29f1f2SStefano Zampini 4782d29f1f2SStefano Zampini Collective on TS 4792d29f1f2SStefano Zampini 4802d29f1f2SStefano Zampini Input Parameters: 4812d29f1f2SStefano Zampini . ts - the TS context obtained from TSCreate() 4822d29f1f2SStefano Zampini 4832d29f1f2SStefano Zampini Level: intermediate 4842d29f1f2SStefano Zampini 4852d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve() 4862d29f1f2SStefano Zampini 4872d29f1f2SStefano Zampini @*/ 4882d29f1f2SStefano Zampini PetscErrorCode TSResetTrajectory(TS ts) 4892d29f1f2SStefano Zampini { 4902d29f1f2SStefano Zampini PetscErrorCode ierr; 4912d29f1f2SStefano Zampini 4922d29f1f2SStefano Zampini PetscFunctionBegin; 4932d29f1f2SStefano Zampini PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4942d29f1f2SStefano Zampini if (ts->trajectory) { 4952d29f1f2SStefano Zampini ierr = TSTrajectoryDestroy(&ts->trajectory);CHKERRQ(ierr); 4962d29f1f2SStefano Zampini ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 4972d29f1f2SStefano Zampini } 4982d29f1f2SStefano Zampini PetscFunctionReturn(0); 4992d29f1f2SStefano Zampini } 5002d29f1f2SStefano Zampini 5012d29f1f2SStefano Zampini /*@ 502a7a1495cSBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 503a7a1495cSBarry Smith set with TSSetRHSJacobian(). 504a7a1495cSBarry Smith 505d083f849SBarry Smith Collective on TS 506a7a1495cSBarry Smith 507a7a1495cSBarry Smith Input Parameters: 508316643e7SJed Brown + ts - the TS context 509a7a1495cSBarry Smith . t - current timestep 5100910c330SBarry Smith - U - input vector 511a7a1495cSBarry Smith 512a7a1495cSBarry Smith Output Parameters: 513a7a1495cSBarry Smith + A - Jacobian matrix 514a7a1495cSBarry Smith . B - optional preconditioning matrix 515a7a1495cSBarry Smith - flag - flag indicating matrix structure 516a7a1495cSBarry Smith 517a7a1495cSBarry Smith Notes: 518a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 519a7a1495cSBarry Smith is used internally within the nonlinear solvers. 520a7a1495cSBarry Smith 52194b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 522a7a1495cSBarry Smith flag parameter. 523a7a1495cSBarry Smith 524a7a1495cSBarry Smith Level: developer 525a7a1495cSBarry Smith 52694b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 527a7a1495cSBarry Smith @*/ 528d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B) 529a7a1495cSBarry Smith { 530dfbe8321SBarry Smith PetscErrorCode ierr; 531270bf2e7SJed Brown PetscObjectState Ustate; 5326c1e1eecSBarry Smith PetscObjectId Uid; 53324989b8cSPeter Brune DM dm; 534942e3340SBarry Smith DMTS tsdm; 53524989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 53624989b8cSPeter Brune void *ctx; 537b2df71adSDebojyoti Ghosh TSRHSFunction rhsfunction; 538a7a1495cSBarry Smith 539a7a1495cSBarry Smith PetscFunctionBegin; 5400700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5410910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5420910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 54324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 544942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 5456374d434SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 5462663174eSHong Zhang ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 54759e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 5486c1e1eecSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr); 549971015bcSStefano Zampini 5502663174eSHong Zhang if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) PetscFunctionReturn(0); 551d90be118SSean Farley 552ae692cf2SHong Zhang if (ts->rhsjacobian.shift && ts->rhsjacobian.reuse) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Should not call TSComputeRHSJacobian() on a shifted matrix (shift=%lf) when RHSJacobian is reusable.",ts->rhsjacobian.shift); 55324989b8cSPeter Brune if (rhsjacobianfunc) { 55494ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 555a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 556d1e9a80fSBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr); 557a7a1495cSBarry Smith PetscStackPop; 558a6ab3590SBarry Smith ts->rhsjacs++; 55994ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 560ef66eb69SBarry Smith } else { 56194ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 562971015bcSStefano Zampini if (B && A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);} 563ef66eb69SBarry Smith } 5640e4ef248SJed Brown ts->rhsjacobian.time = t; 565971015bcSStefano Zampini ts->rhsjacobian.shift = 0; 566971015bcSStefano Zampini ts->rhsjacobian.scale = 1.; 5677f79407eSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr); 56859e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 569a7a1495cSBarry Smith PetscFunctionReturn(0); 570a7a1495cSBarry Smith } 571a7a1495cSBarry Smith 572316643e7SJed Brown /*@ 573d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 574d763cef2SBarry Smith 575d083f849SBarry Smith Collective on TS 576316643e7SJed Brown 577316643e7SJed Brown Input Parameters: 578316643e7SJed Brown + ts - the TS context 579316643e7SJed Brown . t - current time 5800910c330SBarry Smith - U - state vector 581316643e7SJed Brown 582316643e7SJed Brown Output Parameter: 583316643e7SJed Brown . y - right hand side 584316643e7SJed Brown 585316643e7SJed Brown Note: 586316643e7SJed Brown Most users should not need to explicitly call this routine, as it 587316643e7SJed Brown is used internally within the nonlinear solvers. 588316643e7SJed Brown 589316643e7SJed Brown Level: developer 590316643e7SJed Brown 591316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 592316643e7SJed Brown @*/ 5930910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 594d763cef2SBarry Smith { 595dfbe8321SBarry Smith PetscErrorCode ierr; 59624989b8cSPeter Brune TSRHSFunction rhsfunction; 59724989b8cSPeter Brune TSIFunction ifunction; 59824989b8cSPeter Brune void *ctx; 59924989b8cSPeter Brune DM dm; 60024989b8cSPeter Brune 601d763cef2SBarry Smith PetscFunctionBegin; 6020700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6030910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6040700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 60524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 60624989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 6070298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 608d763cef2SBarry Smith 609ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 610d763cef2SBarry Smith 61124989b8cSPeter Brune if (rhsfunction) { 612a6ab3590SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 6131be370b1SHong Zhang ierr = VecLockReadPush(U);CHKERRQ(ierr); 614d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 6150910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 616d763cef2SBarry Smith PetscStackPop; 6171be370b1SHong Zhang ierr = VecLockReadPop(U);CHKERRQ(ierr); 618a6ab3590SBarry Smith ts->rhsfuncs++; 619a6ab3590SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 620214bc6a2SJed Brown } else { 621214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 622b2cd27e8SJed Brown } 623d763cef2SBarry Smith PetscFunctionReturn(0); 624d763cef2SBarry Smith } 625d763cef2SBarry Smith 626ef20d060SBarry Smith /*@ 627ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 628ef20d060SBarry Smith 629d083f849SBarry Smith Collective on TS 630ef20d060SBarry Smith 631ef20d060SBarry Smith Input Parameters: 632ef20d060SBarry Smith + ts - the TS context 633ef20d060SBarry Smith - t - current time 634ef20d060SBarry Smith 635ef20d060SBarry Smith Output Parameter: 6360910c330SBarry Smith . U - the solution 637ef20d060SBarry Smith 638ef20d060SBarry Smith Note: 639ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 640ef20d060SBarry Smith is used internally within the nonlinear solvers. 641ef20d060SBarry Smith 642ef20d060SBarry Smith Level: developer 643ef20d060SBarry Smith 644abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 645ef20d060SBarry Smith @*/ 6460910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 647ef20d060SBarry Smith { 648ef20d060SBarry Smith PetscErrorCode ierr; 649ef20d060SBarry Smith TSSolutionFunction solutionfunction; 650ef20d060SBarry Smith void *ctx; 651ef20d060SBarry Smith DM dm; 652ef20d060SBarry Smith 653ef20d060SBarry Smith PetscFunctionBegin; 654ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6550910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 656ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 657ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 658ef20d060SBarry Smith 659ef20d060SBarry Smith if (solutionfunction) { 6609b7cd975SBarry Smith PetscStackPush("TS user solution function"); 6610910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 662ef20d060SBarry Smith PetscStackPop; 663ef20d060SBarry Smith } 664ef20d060SBarry Smith PetscFunctionReturn(0); 665ef20d060SBarry Smith } 6669b7cd975SBarry Smith /*@ 6679b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 6689b7cd975SBarry Smith 669d083f849SBarry Smith Collective on TS 6709b7cd975SBarry Smith 6719b7cd975SBarry Smith Input Parameters: 6729b7cd975SBarry Smith + ts - the TS context 6739b7cd975SBarry Smith - t - current time 6749b7cd975SBarry Smith 6759b7cd975SBarry Smith Output Parameter: 6769b7cd975SBarry Smith . U - the function value 6779b7cd975SBarry Smith 6789b7cd975SBarry Smith Note: 6799b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 6809b7cd975SBarry Smith is used internally within the nonlinear solvers. 6819b7cd975SBarry Smith 6829b7cd975SBarry Smith Level: developer 6839b7cd975SBarry Smith 6849b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 6859b7cd975SBarry Smith @*/ 6869b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 6879b7cd975SBarry Smith { 6889b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 6899b7cd975SBarry Smith void *ctx; 6909b7cd975SBarry Smith DM dm; 6919b7cd975SBarry Smith 6929b7cd975SBarry Smith PetscFunctionBegin; 6939b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6949b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6959b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 6969b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 6979b7cd975SBarry Smith 6989b7cd975SBarry Smith if (forcing) { 6999b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 7009b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 7019b7cd975SBarry Smith PetscStackPop; 7029b7cd975SBarry Smith } 7039b7cd975SBarry Smith PetscFunctionReturn(0); 7049b7cd975SBarry Smith } 705ef20d060SBarry Smith 706214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 707214bc6a2SJed Brown { 7082dd45cf8SJed Brown Vec F; 709214bc6a2SJed Brown PetscErrorCode ierr; 710214bc6a2SJed Brown 711214bc6a2SJed Brown PetscFunctionBegin; 7120298fd71SBarry Smith *Frhs = NULL; 7130298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 714214bc6a2SJed Brown if (!ts->Frhs) { 7152dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 716214bc6a2SJed Brown } 717214bc6a2SJed Brown *Frhs = ts->Frhs; 718214bc6a2SJed Brown PetscFunctionReturn(0); 719214bc6a2SJed Brown } 720214bc6a2SJed Brown 721971015bcSStefano Zampini PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 722214bc6a2SJed Brown { 723214bc6a2SJed Brown Mat A,B; 7242dd45cf8SJed Brown PetscErrorCode ierr; 72541a1d4d2SBarry Smith TSIJacobian ijacobian; 726214bc6a2SJed Brown 727214bc6a2SJed Brown PetscFunctionBegin; 728c0cd0301SJed Brown if (Arhs) *Arhs = NULL; 729c0cd0301SJed Brown if (Brhs) *Brhs = NULL; 73041a1d4d2SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr); 731214bc6a2SJed Brown if (Arhs) { 732214bc6a2SJed Brown if (!ts->Arhs) { 73341a1d4d2SBarry Smith if (ijacobian) { 734214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 735d60b7d5cSBarry Smith ierr = TSSetMatStructure(ts,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 73641a1d4d2SBarry Smith } else { 73741a1d4d2SBarry Smith ts->Arhs = A; 73841a1d4d2SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 73941a1d4d2SBarry Smith } 7403565c898SBarry Smith } else { 7413565c898SBarry Smith PetscBool flg; 7423565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 7433565c898SBarry Smith /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */ 7443565c898SBarry Smith if (flg && !ijacobian && ts->Arhs == ts->Brhs){ 7453565c898SBarry Smith ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr); 7463565c898SBarry Smith ts->Arhs = A; 7473565c898SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 7483565c898SBarry Smith } 749214bc6a2SJed Brown } 750214bc6a2SJed Brown *Arhs = ts->Arhs; 751214bc6a2SJed Brown } 752214bc6a2SJed Brown if (Brhs) { 753214bc6a2SJed Brown if (!ts->Brhs) { 754bdb70873SJed Brown if (A != B) { 75541a1d4d2SBarry Smith if (ijacobian) { 756214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 757bdb70873SJed Brown } else { 75841a1d4d2SBarry Smith ts->Brhs = B; 75941a1d4d2SBarry Smith ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 76041a1d4d2SBarry Smith } 76141a1d4d2SBarry Smith } else { 762bdb70873SJed Brown ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 76351699248SLisandro Dalcin ts->Brhs = ts->Arhs; 764bdb70873SJed Brown } 765214bc6a2SJed Brown } 766214bc6a2SJed Brown *Brhs = ts->Brhs; 767214bc6a2SJed Brown } 768214bc6a2SJed Brown PetscFunctionReturn(0); 769214bc6a2SJed Brown } 770214bc6a2SJed Brown 771316643e7SJed Brown /*@ 7720910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 773316643e7SJed Brown 774d083f849SBarry Smith Collective on TS 775316643e7SJed Brown 776316643e7SJed Brown Input Parameters: 777316643e7SJed Brown + ts - the TS context 778316643e7SJed Brown . t - current time 7790910c330SBarry Smith . U - state vector 7800910c330SBarry Smith . Udot - time derivative of state vector 781214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 782316643e7SJed Brown 783316643e7SJed Brown Output Parameter: 784316643e7SJed Brown . Y - right hand side 785316643e7SJed Brown 786316643e7SJed Brown Note: 787316643e7SJed Brown Most users should not need to explicitly call this routine, as it 788316643e7SJed Brown is used internally within the nonlinear solvers. 789316643e7SJed Brown 790316643e7SJed Brown If the user did did not write their equations in implicit form, this 791316643e7SJed Brown function recasts them in implicit form. 792316643e7SJed Brown 793316643e7SJed Brown Level: developer 794316643e7SJed Brown 795316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 796316643e7SJed Brown @*/ 7970910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 798316643e7SJed Brown { 799316643e7SJed Brown PetscErrorCode ierr; 80024989b8cSPeter Brune TSIFunction ifunction; 80124989b8cSPeter Brune TSRHSFunction rhsfunction; 80224989b8cSPeter Brune void *ctx; 80324989b8cSPeter Brune DM dm; 804316643e7SJed Brown 805316643e7SJed Brown PetscFunctionBegin; 8060700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8070910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 8080910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 8090700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 810316643e7SJed Brown 81124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 81224989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 8130298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 81424989b8cSPeter Brune 815ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 816d90be118SSean Farley 8170910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 81824989b8cSPeter Brune if (ifunction) { 819316643e7SJed Brown PetscStackPush("TS user implicit function"); 8200910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 821316643e7SJed Brown PetscStackPop; 822a6ab3590SBarry Smith ts->ifuncs++; 823214bc6a2SJed Brown } 824214bc6a2SJed Brown if (imex) { 82524989b8cSPeter Brune if (!ifunction) { 8260910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 8272dd45cf8SJed Brown } 82824989b8cSPeter Brune } else if (rhsfunction) { 82924989b8cSPeter Brune if (ifunction) { 830214bc6a2SJed Brown Vec Frhs; 831214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 8320910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 833214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 8342dd45cf8SJed Brown } else { 8350910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 8360910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 837316643e7SJed Brown } 8384a6899ffSJed Brown } 8390910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 840316643e7SJed Brown PetscFunctionReturn(0); 841316643e7SJed Brown } 842316643e7SJed Brown 843cfa8a9a2SHong Zhang /* 844cfa8a9a2SHong Zhang TSRecoverRHSJacobian - Recover the Jacobian matrix so that one can call TSComputeRHSJacobian() on it. 845cfa8a9a2SHong Zhang 846cfa8a9a2SHong Zhang Note: 847cfa8a9a2SHong Zhang This routine is needed when one switches from TSComputeIJacobian() to TSComputeRHSJacobian() because the Jacobian matrix may be shifted or scaled in TSComputeIJacobian(). 848cfa8a9a2SHong Zhang 849cfa8a9a2SHong Zhang */ 850cfa8a9a2SHong Zhang static PetscErrorCode TSRecoverRHSJacobian(TS ts,Mat A,Mat B) 851cfa8a9a2SHong Zhang { 852cfa8a9a2SHong Zhang PetscErrorCode ierr; 853cfa8a9a2SHong Zhang 854cfa8a9a2SHong Zhang PetscFunctionBegin; 855cfa8a9a2SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 85603c97d52SHong Zhang if (A != ts->Arhs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Invalid Amat"); 85703c97d52SHong Zhang if (B != ts->Brhs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Invalid Bmat"); 858cfa8a9a2SHong Zhang 859cfa8a9a2SHong Zhang if (ts->rhsjacobian.shift) { 860cfa8a9a2SHong Zhang ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 861cfa8a9a2SHong Zhang } 862cfa8a9a2SHong Zhang if (ts->rhsjacobian.scale == -1.) { 863cfa8a9a2SHong Zhang ierr = MatScale(A,-1);CHKERRQ(ierr); 864cfa8a9a2SHong Zhang } 865cfa8a9a2SHong Zhang if (B && B == ts->Brhs && A != B) { 866cfa8a9a2SHong Zhang if (ts->rhsjacobian.shift) { 867cfa8a9a2SHong Zhang ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 868cfa8a9a2SHong Zhang } 869cfa8a9a2SHong Zhang if (ts->rhsjacobian.scale == -1.) { 870cfa8a9a2SHong Zhang ierr = MatScale(B,-1);CHKERRQ(ierr); 871cfa8a9a2SHong Zhang } 872cfa8a9a2SHong Zhang } 873cfa8a9a2SHong Zhang ts->rhsjacobian.shift = 0; 874cfa8a9a2SHong Zhang ts->rhsjacobian.scale = 1.; 875cfa8a9a2SHong Zhang PetscFunctionReturn(0); 876cfa8a9a2SHong Zhang } 877cfa8a9a2SHong Zhang 878316643e7SJed Brown /*@ 879316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 880316643e7SJed Brown 881d083f849SBarry Smith Collective on TS 882316643e7SJed Brown 883316643e7SJed Brown Input 884316643e7SJed Brown Input Parameters: 885316643e7SJed Brown + ts - the TS context 886316643e7SJed Brown . t - current timestep 8870910c330SBarry Smith . U - state vector 8880910c330SBarry Smith . Udot - time derivative of state vector 889214bc6a2SJed Brown . shift - shift to apply, see note below 890214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 891316643e7SJed Brown 892316643e7SJed Brown Output Parameters: 893316643e7SJed Brown + A - Jacobian matrix 8943565c898SBarry Smith - B - matrix from which the preconditioner is constructed; often the same as A 895316643e7SJed Brown 896316643e7SJed Brown Notes: 8970910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 898316643e7SJed Brown 8990910c330SBarry Smith dF/dU + shift*dF/dUdot 900316643e7SJed Brown 901316643e7SJed Brown Most users should not need to explicitly call this routine, as it 902316643e7SJed Brown is used internally within the nonlinear solvers. 903316643e7SJed Brown 904316643e7SJed Brown Level: developer 905316643e7SJed Brown 906316643e7SJed Brown .seealso: TSSetIJacobian() 90763495f91SJed Brown @*/ 908d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 909316643e7SJed Brown { 910316643e7SJed Brown PetscErrorCode ierr; 91124989b8cSPeter Brune TSIJacobian ijacobian; 91224989b8cSPeter Brune TSRHSJacobian rhsjacobian; 91324989b8cSPeter Brune DM dm; 91424989b8cSPeter Brune void *ctx; 915316643e7SJed Brown 916316643e7SJed Brown PetscFunctionBegin; 9170700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9180910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 9190910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 920316643e7SJed Brown PetscValidPointer(A,6); 92194ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,6); 922316643e7SJed Brown PetscValidPointer(B,7); 92394ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,7); 92424989b8cSPeter Brune 92524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 92624989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 9270298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 92824989b8cSPeter Brune 929ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 930316643e7SJed Brown 93194ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 93224989b8cSPeter Brune if (ijacobian) { 933316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 934d1e9a80fSBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 935a6ab3590SBarry Smith ts->ijacs++; 936316643e7SJed Brown PetscStackPop; 9374a6899ffSJed Brown } 938214bc6a2SJed Brown if (imex) { 939b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 9404c26be97Sstefano_zampini PetscBool assembled; 941971015bcSStefano Zampini if (rhsjacobian) { 942971015bcSStefano Zampini Mat Arhs = NULL; 943971015bcSStefano Zampini ierr = TSGetRHSMats_Private(ts,&Arhs,NULL);CHKERRQ(ierr); 944971015bcSStefano Zampini if (A == Arhs) { 945e8b1e424SHong Zhang if (rhsjacobian == TSComputeRHSJacobianConstant) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Unsupported operation! cannot use TSComputeRHSJacobianConstant"); /* there is no way to reconstruct shift*M-J since J cannot be reevaluated */ 946971015bcSStefano Zampini ts->rhsjacobian.time = PETSC_MIN_REAL; 947971015bcSStefano Zampini } 948971015bcSStefano Zampini } 94994ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 9504c26be97Sstefano_zampini ierr = MatAssembled(A,&assembled);CHKERRQ(ierr); 9514c26be97Sstefano_zampini if (!assembled) { 9524c26be97Sstefano_zampini ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9534c26be97Sstefano_zampini ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9544c26be97Sstefano_zampini } 95594ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 95694ab13aaSBarry Smith if (A != B) { 95794ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 9584c26be97Sstefano_zampini ierr = MatAssembled(B,&assembled);CHKERRQ(ierr); 9594c26be97Sstefano_zampini if (!assembled) { 9604c26be97Sstefano_zampini ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9614c26be97Sstefano_zampini ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9624c26be97Sstefano_zampini } 96394ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 964214bc6a2SJed Brown } 965214bc6a2SJed Brown } 966214bc6a2SJed Brown } else { 967e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 968e8b1e424SHong Zhang if (rhsjacobian) { /* RHSJacobian needs to be converted to part of IJacobian if exists */ 969214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 970e1244c69SJed Brown } 971e8b1e424SHong Zhang if (Arhs == A) { /* No IJacobian matrix, so we only have the RHS matrix */ 972e8b1e424SHong Zhang PetscObjectState Ustate; 973e8b1e424SHong Zhang PetscObjectId Uid; 974e8b1e424SHong Zhang TSRHSFunction rhsfunction; 975e8b1e424SHong Zhang 976e8b1e424SHong Zhang ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 977e8b1e424SHong Zhang ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 978e8b1e424SHong Zhang ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr); 979097a96a2SHong Zhang if ((rhsjacobian == TSComputeRHSJacobianConstant || (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && rhsfunction != TSComputeRHSFunctionLinear)) && ts->rhsjacobian.scale == -1.) { /* No need to recompute RHSJacobian */ 980e8b1e424SHong Zhang ierr = MatShift(A,shift-ts->rhsjacobian.shift);CHKERRQ(ierr); /* revert the old shift and add the new shift with a single call to MatShift */ 98134d322a1SHong Zhang if (A != B) { 98234d322a1SHong Zhang ierr = MatShift(B,shift-ts->rhsjacobian.shift);CHKERRQ(ierr); 98334d322a1SHong Zhang } 984e8b1e424SHong Zhang } else { 9853565c898SBarry Smith PetscBool flg; 986e8b1e424SHong Zhang 987e8b1e424SHong Zhang if (ts->rhsjacobian.reuse) { /* Undo the damage */ 988e8b1e424SHong Zhang /* MatScale has a short path for this case. 989e8b1e424SHong Zhang However, this code path is taken the first time TSComputeRHSJacobian is called 990e8b1e424SHong Zhang and the matrices have not been assembled yet */ 991cfa8a9a2SHong Zhang ierr = TSRecoverRHSJacobian(ts,A,B);CHKERRQ(ierr); 992e8b1e424SHong Zhang } 993e8b1e424SHong Zhang ierr = TSComputeRHSJacobian(ts,t,U,A,B);CHKERRQ(ierr); 9943565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 9953565c898SBarry Smith /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */ 9963565c898SBarry Smith if (!flg) { 99794ab13aaSBarry Smith ierr = MatScale(A,-1);CHKERRQ(ierr); 99894ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 9993565c898SBarry Smith } 100094ab13aaSBarry Smith if (A != B) { 100194ab13aaSBarry Smith ierr = MatScale(B,-1);CHKERRQ(ierr); 100294ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 1003316643e7SJed Brown } 1004e8b1e424SHong Zhang } 1005e8b1e424SHong Zhang ts->rhsjacobian.scale = -1; 1006e8b1e424SHong Zhang ts->rhsjacobian.shift = shift; 1007d60b7d5cSBarry Smith } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 1008e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 100994ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 101094ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 101194ab13aaSBarry Smith if (A != B) { 101294ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 101394ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 1014214bc6a2SJed Brown } 1015316643e7SJed Brown } 1016e8b1e424SHong Zhang ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 1017d60b7d5cSBarry Smith ierr = MatAXPY(A,-1,Arhs,ts->axpy_pattern);CHKERRQ(ierr); 101894ab13aaSBarry Smith if (A != B) { 1019d60b7d5cSBarry Smith ierr = MatAXPY(B,-1,Brhs,ts->axpy_pattern);CHKERRQ(ierr); 1020316643e7SJed Brown } 1021316643e7SJed Brown } 1022316643e7SJed Brown } 102394ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 1024316643e7SJed Brown PetscFunctionReturn(0); 1025316643e7SJed Brown } 1026316643e7SJed Brown 1027d763cef2SBarry Smith /*@C 1028d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 1029b5abc632SBarry Smith where U_t = G(t,u). 1030d763cef2SBarry Smith 10313f9fe445SBarry Smith Logically Collective on TS 1032d763cef2SBarry Smith 1033d763cef2SBarry Smith Input Parameters: 1034d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 10350298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 1036d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 1037d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 10380298fd71SBarry Smith function evaluation routine (may be NULL) 1039d763cef2SBarry Smith 1040a96d6ef6SBarry Smith Calling sequence of f: 1041a96d6ef6SBarry Smith $ PetscErrorCode f(TS ts,PetscReal t,Vec u,Vec F,void *ctx); 1042d763cef2SBarry Smith 1043a96d6ef6SBarry Smith + ts - timestep context 1044a96d6ef6SBarry Smith . t - current timestep 1045d763cef2SBarry Smith . u - input vector 1046d763cef2SBarry Smith . F - function vector 1047d763cef2SBarry Smith - ctx - [optional] user-defined function context 1048d763cef2SBarry Smith 1049d763cef2SBarry Smith Level: beginner 1050d763cef2SBarry Smith 105195452b02SPatrick Sanan Notes: 105295452b02SPatrick Sanan You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE. 10532bbac0d3SBarry Smith 1054ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 1055d763cef2SBarry Smith @*/ 1056089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 1057d763cef2SBarry Smith { 1058089b2837SJed Brown PetscErrorCode ierr; 1059089b2837SJed Brown SNES snes; 10600298fd71SBarry Smith Vec ralloc = NULL; 106124989b8cSPeter Brune DM dm; 1062d763cef2SBarry Smith 1063089b2837SJed Brown PetscFunctionBegin; 10640700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1065ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 106624989b8cSPeter Brune 106724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 106824989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 1069089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1070e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 1071e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 1072e856ceecSJed Brown r = ralloc; 1073e856ceecSJed Brown } 1074089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 1075e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1076d763cef2SBarry Smith PetscFunctionReturn(0); 1077d763cef2SBarry Smith } 1078d763cef2SBarry Smith 1079ef20d060SBarry Smith /*@C 1080abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 1081ef20d060SBarry Smith 1082ef20d060SBarry Smith Logically Collective on TS 1083ef20d060SBarry Smith 1084ef20d060SBarry Smith Input Parameters: 1085ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 1086ef20d060SBarry Smith . f - routine for evaluating the solution 1087ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 10880298fd71SBarry Smith function evaluation routine (may be NULL) 1089ef20d060SBarry Smith 1090a96d6ef6SBarry Smith Calling sequence of f: 1091a96d6ef6SBarry Smith $ PetscErrorCode f(TS ts,PetscReal t,Vec u,void *ctx); 1092ef20d060SBarry Smith 1093ef20d060SBarry Smith + t - current timestep 1094ef20d060SBarry Smith . u - output vector 1095ef20d060SBarry Smith - ctx - [optional] user-defined function context 1096ef20d060SBarry Smith 10970ed3bfb6SBarry Smith Options Database: 10980ed3bfb6SBarry Smith + -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction() 10990ed3bfb6SBarry Smith - -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction() 11000ed3bfb6SBarry Smith 1101abd5a294SJed Brown Notes: 1102abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 1103abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 1104abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 1105abd5a294SJed Brown 11064f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 1107abd5a294SJed Brown 1108ef20d060SBarry Smith Level: beginner 1109ef20d060SBarry Smith 11100ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError() 1111ef20d060SBarry Smith @*/ 1112ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 1113ef20d060SBarry Smith { 1114ef20d060SBarry Smith PetscErrorCode ierr; 1115ef20d060SBarry Smith DM dm; 1116ef20d060SBarry Smith 1117ef20d060SBarry Smith PetscFunctionBegin; 1118ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1119ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1120ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 1121ef20d060SBarry Smith PetscFunctionReturn(0); 1122ef20d060SBarry Smith } 1123ef20d060SBarry Smith 11249b7cd975SBarry Smith /*@C 11259b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 11269b7cd975SBarry Smith 11279b7cd975SBarry Smith Logically Collective on TS 11289b7cd975SBarry Smith 11299b7cd975SBarry Smith Input Parameters: 11309b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 1131e162b725SBarry Smith . func - routine for evaluating the forcing function 11329b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 11330298fd71SBarry Smith function evaluation routine (may be NULL) 11349b7cd975SBarry Smith 11359b7cd975SBarry Smith Calling sequence of func: 11366bc98fa9SBarry Smith $ PetscErrorCode func (TS ts,PetscReal t,Vec f,void *ctx); 11379b7cd975SBarry Smith 11389b7cd975SBarry Smith + t - current timestep 1139e162b725SBarry Smith . f - output vector 11409b7cd975SBarry Smith - ctx - [optional] user-defined function context 11419b7cd975SBarry Smith 11429b7cd975SBarry Smith Notes: 11439b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 1144e162b725SBarry Smith create closed-form solutions with a non-physical forcing term. It allows you to use the Method of Manufactored Solution without directly editing the 1145e162b725SBarry Smith definition of the problem you are solving and hence possibly introducing bugs. 1146e162b725SBarry Smith 1147e162b725SBarry Smith This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0 1148e162b725SBarry Smith 1149e162b725SBarry Smith This forcing function does not depend on the solution to the equations, it can only depend on spatial location, time, and possibly parameters, the 1150e162b725SBarry Smith parameters can be passed in the ctx variable. 11519b7cd975SBarry Smith 11529b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 11539b7cd975SBarry Smith 11549b7cd975SBarry Smith Level: beginner 11559b7cd975SBarry Smith 11569b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 11579b7cd975SBarry Smith @*/ 1158e162b725SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx) 11599b7cd975SBarry Smith { 11609b7cd975SBarry Smith PetscErrorCode ierr; 11619b7cd975SBarry Smith DM dm; 11629b7cd975SBarry Smith 11639b7cd975SBarry Smith PetscFunctionBegin; 11649b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 11659b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1166e162b725SBarry Smith ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr); 11679b7cd975SBarry Smith PetscFunctionReturn(0); 11689b7cd975SBarry Smith } 11699b7cd975SBarry Smith 1170d763cef2SBarry Smith /*@C 1171f7ab8db6SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 1172b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 1173d763cef2SBarry Smith 11743f9fe445SBarry Smith Logically Collective on TS 1175d763cef2SBarry Smith 1176d763cef2SBarry Smith Input Parameters: 1177d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1178e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1179e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1180d763cef2SBarry Smith . f - the Jacobian evaluation routine 1181d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 11820298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 1183d763cef2SBarry Smith 1184f7ab8db6SBarry Smith Calling sequence of f: 1185a96d6ef6SBarry Smith $ PetscErrorCode f(TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 1186d763cef2SBarry Smith 1187d763cef2SBarry Smith + t - current timestep 1188d763cef2SBarry Smith . u - input vector 1189e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1190e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1191d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 1192d763cef2SBarry Smith 11936cd88445SBarry Smith Notes: 11946cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 11956cd88445SBarry Smith 11966cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1197ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1198d763cef2SBarry Smith 1199d763cef2SBarry Smith Level: beginner 1200d763cef2SBarry Smith 1201ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1202d763cef2SBarry Smith 1203d763cef2SBarry Smith @*/ 1204e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1205d763cef2SBarry Smith { 1206277b19d0SLisandro Dalcin PetscErrorCode ierr; 1207089b2837SJed Brown SNES snes; 120824989b8cSPeter Brune DM dm; 120924989b8cSPeter Brune TSIJacobian ijacobian; 1210277b19d0SLisandro Dalcin 1211d763cef2SBarry Smith PetscFunctionBegin; 12120700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1213e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1214e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1215e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1216e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1217d763cef2SBarry Smith 121824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 121924989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 12200298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1221089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 12225f659677SPeter Brune if (!ijacobian) { 1223e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 12240e4ef248SJed Brown } 1225e5d3d808SBarry Smith if (Amat) { 1226e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 12270e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1228e5d3d808SBarry Smith ts->Arhs = Amat; 12290e4ef248SJed Brown } 1230e5d3d808SBarry Smith if (Pmat) { 1231e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 12320e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1233e5d3d808SBarry Smith ts->Brhs = Pmat; 12340e4ef248SJed Brown } 1235d763cef2SBarry Smith PetscFunctionReturn(0); 1236d763cef2SBarry Smith } 1237d763cef2SBarry Smith 1238316643e7SJed Brown /*@C 1239b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1240316643e7SJed Brown 12413f9fe445SBarry Smith Logically Collective on TS 1242316643e7SJed Brown 1243316643e7SJed Brown Input Parameters: 1244316643e7SJed Brown + ts - the TS context obtained from TSCreate() 12450298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1246316643e7SJed Brown . f - the function evaluation routine 12470298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1248316643e7SJed Brown 1249316643e7SJed Brown Calling sequence of f: 12506bc98fa9SBarry Smith $ PetscErrorCode f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1251316643e7SJed Brown 1252316643e7SJed Brown + t - time at step/stage being solved 1253316643e7SJed Brown . u - state vector 1254316643e7SJed Brown . u_t - time derivative of state vector 1255316643e7SJed Brown . F - function vector 1256316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1257316643e7SJed Brown 1258316643e7SJed Brown Important: 12592bbac0d3SBarry Smith The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function. 1260316643e7SJed Brown 1261316643e7SJed Brown Level: beginner 1262316643e7SJed Brown 1263d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1264316643e7SJed Brown @*/ 126551699248SLisandro Dalcin PetscErrorCode TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx) 1266316643e7SJed Brown { 1267089b2837SJed Brown PetscErrorCode ierr; 1268089b2837SJed Brown SNES snes; 126951699248SLisandro Dalcin Vec ralloc = NULL; 127024989b8cSPeter Brune DM dm; 1271316643e7SJed Brown 1272316643e7SJed Brown PetscFunctionBegin; 12730700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 127451699248SLisandro Dalcin if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 127524989b8cSPeter Brune 127624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 127724989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 127824989b8cSPeter Brune 1279089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 128051699248SLisandro Dalcin if (!r && !ts->dm && ts->vec_sol) { 128151699248SLisandro Dalcin ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 128251699248SLisandro Dalcin r = ralloc; 1283e856ceecSJed Brown } 128451699248SLisandro Dalcin ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 128551699248SLisandro Dalcin ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1286089b2837SJed Brown PetscFunctionReturn(0); 1287089b2837SJed Brown } 1288089b2837SJed Brown 1289089b2837SJed Brown /*@C 1290089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1291089b2837SJed Brown 1292089b2837SJed Brown Not Collective 1293089b2837SJed Brown 1294089b2837SJed Brown Input Parameter: 1295089b2837SJed Brown . ts - the TS context 1296089b2837SJed Brown 1297089b2837SJed Brown Output Parameter: 12980298fd71SBarry Smith + r - vector to hold residual (or NULL) 12990298fd71SBarry Smith . func - the function to compute residual (or NULL) 13000298fd71SBarry Smith - ctx - the function context (or NULL) 1301089b2837SJed Brown 1302089b2837SJed Brown Level: advanced 1303089b2837SJed Brown 1304089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1305089b2837SJed Brown @*/ 1306089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1307089b2837SJed Brown { 1308089b2837SJed Brown PetscErrorCode ierr; 1309089b2837SJed Brown SNES snes; 131024989b8cSPeter Brune DM dm; 1311089b2837SJed Brown 1312089b2837SJed Brown PetscFunctionBegin; 1313089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1314089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13150298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 131624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 131724989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1318089b2837SJed Brown PetscFunctionReturn(0); 1319089b2837SJed Brown } 1320089b2837SJed Brown 1321089b2837SJed Brown /*@C 1322089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1323089b2837SJed Brown 1324089b2837SJed Brown Not Collective 1325089b2837SJed Brown 1326089b2837SJed Brown Input Parameter: 1327089b2837SJed Brown . ts - the TS context 1328089b2837SJed Brown 1329089b2837SJed Brown Output Parameter: 13300298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 13310298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 13320298fd71SBarry Smith - ctx - the function context (or NULL) 1333089b2837SJed Brown 1334089b2837SJed Brown Level: advanced 1335089b2837SJed Brown 13362bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction() 1337089b2837SJed Brown @*/ 1338089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1339089b2837SJed Brown { 1340089b2837SJed Brown PetscErrorCode ierr; 1341089b2837SJed Brown SNES snes; 134224989b8cSPeter Brune DM dm; 1343089b2837SJed Brown 1344089b2837SJed Brown PetscFunctionBegin; 1345089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1346089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13470298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 134824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 134924989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1350316643e7SJed Brown PetscFunctionReturn(0); 1351316643e7SJed Brown } 1352316643e7SJed Brown 1353316643e7SJed Brown /*@C 1354a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1355ae8867d6SBarry Smith provided with TSSetIFunction(). 1356316643e7SJed Brown 13573f9fe445SBarry Smith Logically Collective on TS 1358316643e7SJed Brown 1359316643e7SJed Brown Input Parameters: 1360316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1361e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1362e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1363316643e7SJed Brown . f - the Jacobian evaluation routine 13640298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1365316643e7SJed Brown 1366316643e7SJed Brown Calling sequence of f: 13676bc98fa9SBarry Smith $ PetscErrorCode f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1368316643e7SJed Brown 1369316643e7SJed Brown + t - time at step/stage being solved 13701b4a444bSJed Brown . U - state vector 13711b4a444bSJed Brown . U_t - time derivative of state vector 1372316643e7SJed Brown . a - shift 1373e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1374e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1375316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1376316643e7SJed Brown 1377316643e7SJed Brown Notes: 1378e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1379316643e7SJed Brown 1380895c21f2SBarry Smith If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null 1381895c21f2SBarry Smith space to Amat and the KSP solvers will automatically use that null space as needed during the solution process. 1382895c21f2SBarry Smith 1383a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1384b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1385a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1386a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1387a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1388a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1389a4f0a591SBarry Smith 13906cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 13916cd88445SBarry Smith 13926cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1393ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1394ca5f011dSBarry Smith 1395316643e7SJed Brown Level: beginner 1396316643e7SJed Brown 1397ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1398316643e7SJed Brown 1399316643e7SJed Brown @*/ 1400e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1401316643e7SJed Brown { 1402316643e7SJed Brown PetscErrorCode ierr; 1403089b2837SJed Brown SNES snes; 140424989b8cSPeter Brune DM dm; 1405316643e7SJed Brown 1406316643e7SJed Brown PetscFunctionBegin; 14070700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1408e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1409e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1410e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1411e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 141224989b8cSPeter Brune 141324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 141424989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 141524989b8cSPeter Brune 1416089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1417e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1418316643e7SJed Brown PetscFunctionReturn(0); 1419316643e7SJed Brown } 1420316643e7SJed Brown 1421e1244c69SJed Brown /*@ 1422e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1423e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1424e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1425e1244c69SJed Brown not been changed by the TS. 1426e1244c69SJed Brown 1427e1244c69SJed Brown Logically Collective 1428e1244c69SJed Brown 1429e1244c69SJed Brown Input Arguments: 1430e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1431e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1432e1244c69SJed Brown 1433e1244c69SJed Brown Level: intermediate 1434e1244c69SJed Brown 1435e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1436e1244c69SJed Brown @*/ 1437e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1438e1244c69SJed Brown { 1439e1244c69SJed Brown PetscFunctionBegin; 1440e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1441e1244c69SJed Brown PetscFunctionReturn(0); 1442e1244c69SJed Brown } 1443e1244c69SJed Brown 1444efe9872eSLisandro Dalcin /*@C 1445efe9872eSLisandro Dalcin TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved. 1446efe9872eSLisandro Dalcin 1447efe9872eSLisandro Dalcin Logically Collective on TS 1448efe9872eSLisandro Dalcin 1449efe9872eSLisandro Dalcin Input Parameters: 1450efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1451efe9872eSLisandro Dalcin . F - vector to hold the residual (or NULL to have it created internally) 1452efe9872eSLisandro Dalcin . fun - the function evaluation routine 1453efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1454efe9872eSLisandro Dalcin 1455efe9872eSLisandro Dalcin Calling sequence of fun: 14566bc98fa9SBarry Smith $ PetscErrorCode fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx); 1457efe9872eSLisandro Dalcin 1458efe9872eSLisandro Dalcin + t - time at step/stage being solved 1459efe9872eSLisandro Dalcin . U - state vector 1460efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1461efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1462efe9872eSLisandro Dalcin . F - function vector 1463efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine (may be NULL) 1464efe9872eSLisandro Dalcin 1465efe9872eSLisandro Dalcin Level: beginner 1466efe9872eSLisandro Dalcin 1467a96d6ef6SBarry Smith .seealso: TSSetI2Jacobian(), TSSetIFunction(), TSCreate(), TSSetRHSFunction() 1468efe9872eSLisandro Dalcin @*/ 1469efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx) 1470efe9872eSLisandro Dalcin { 1471efe9872eSLisandro Dalcin DM dm; 1472efe9872eSLisandro Dalcin PetscErrorCode ierr; 1473efe9872eSLisandro Dalcin 1474efe9872eSLisandro Dalcin PetscFunctionBegin; 1475efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1476efe9872eSLisandro Dalcin if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2); 1477efe9872eSLisandro Dalcin ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr); 1478efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1479efe9872eSLisandro Dalcin ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1480efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1481efe9872eSLisandro Dalcin } 1482efe9872eSLisandro Dalcin 1483efe9872eSLisandro Dalcin /*@C 1484efe9872eSLisandro Dalcin TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1485efe9872eSLisandro Dalcin 1486efe9872eSLisandro Dalcin Not Collective 1487efe9872eSLisandro Dalcin 1488efe9872eSLisandro Dalcin Input Parameter: 1489efe9872eSLisandro Dalcin . ts - the TS context 1490efe9872eSLisandro Dalcin 1491efe9872eSLisandro Dalcin Output Parameter: 1492efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL) 1493efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL) 1494efe9872eSLisandro Dalcin - ctx - the function context (or NULL) 1495efe9872eSLisandro Dalcin 1496efe9872eSLisandro Dalcin Level: advanced 1497efe9872eSLisandro Dalcin 1498a96d6ef6SBarry Smith .seealso: TSSetIFunction(), SNESGetFunction(), TSCreate() 1499efe9872eSLisandro Dalcin @*/ 1500efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx) 1501efe9872eSLisandro Dalcin { 1502efe9872eSLisandro Dalcin PetscErrorCode ierr; 1503efe9872eSLisandro Dalcin SNES snes; 1504efe9872eSLisandro Dalcin DM dm; 1505efe9872eSLisandro Dalcin 1506efe9872eSLisandro Dalcin PetscFunctionBegin; 1507efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1508efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1509efe9872eSLisandro Dalcin ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1510efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1511efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1512efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1513efe9872eSLisandro Dalcin } 1514efe9872eSLisandro Dalcin 1515efe9872eSLisandro Dalcin /*@C 1516bc77d74cSLisandro Dalcin TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t + a*dF/dU_tt 1517efe9872eSLisandro Dalcin where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function(). 1518efe9872eSLisandro Dalcin 1519efe9872eSLisandro Dalcin Logically Collective on TS 1520efe9872eSLisandro Dalcin 1521efe9872eSLisandro Dalcin Input Parameters: 1522efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1523efe9872eSLisandro Dalcin . J - Jacobian matrix 1524efe9872eSLisandro Dalcin . P - preconditioning matrix for J (may be same as J) 1525efe9872eSLisandro Dalcin . jac - the Jacobian evaluation routine 1526efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1527efe9872eSLisandro Dalcin 1528efe9872eSLisandro Dalcin Calling sequence of jac: 15296bc98fa9SBarry Smith $ PetscErrorCode jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx); 1530efe9872eSLisandro Dalcin 1531efe9872eSLisandro Dalcin + t - time at step/stage being solved 1532efe9872eSLisandro Dalcin . U - state vector 1533efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1534efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1535efe9872eSLisandro Dalcin . v - shift for U_t 1536efe9872eSLisandro Dalcin . a - shift for U_tt 1537efe9872eSLisandro Dalcin . J - Jacobian of G(U) = F(t,U,W+v*U,W'+a*U), equivalent to dF/dU + v*dF/dU_t + a*dF/dU_tt 1538efe9872eSLisandro Dalcin . P - preconditioning matrix for J, may be same as J 1539efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine 1540efe9872eSLisandro Dalcin 1541efe9872eSLisandro Dalcin Notes: 1542efe9872eSLisandro Dalcin The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve. 1543efe9872eSLisandro Dalcin 1544efe9872eSLisandro Dalcin The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be 1545efe9872eSLisandro Dalcin the Jacobian of G(U) = F(t,U,W+v*U,W'+a*U) where F(t,U,U_t,U_tt) = 0 is the DAE to be solved. 1546efe9872eSLisandro Dalcin The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U where the positive "shift" 1547bc77d74cSLisandro Dalcin parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states. 1548efe9872eSLisandro Dalcin 1549efe9872eSLisandro Dalcin Level: beginner 1550efe9872eSLisandro Dalcin 1551a96d6ef6SBarry Smith .seealso: TSSetI2Function(), TSGetI2Jacobian() 1552efe9872eSLisandro Dalcin @*/ 1553efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx) 1554efe9872eSLisandro Dalcin { 1555efe9872eSLisandro Dalcin DM dm; 1556efe9872eSLisandro Dalcin PetscErrorCode ierr; 1557efe9872eSLisandro Dalcin 1558efe9872eSLisandro Dalcin PetscFunctionBegin; 1559efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1560efe9872eSLisandro Dalcin if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2); 1561efe9872eSLisandro Dalcin if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3); 1562efe9872eSLisandro Dalcin ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr); 1563efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1564efe9872eSLisandro Dalcin ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1565efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1566efe9872eSLisandro Dalcin } 1567efe9872eSLisandro Dalcin 1568efe9872eSLisandro Dalcin /*@C 1569efe9872eSLisandro Dalcin TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep. 1570efe9872eSLisandro Dalcin 1571efe9872eSLisandro Dalcin Not Collective, but parallel objects are returned if TS is parallel 1572efe9872eSLisandro Dalcin 1573efe9872eSLisandro Dalcin Input Parameter: 1574efe9872eSLisandro Dalcin . ts - The TS context obtained from TSCreate() 1575efe9872eSLisandro Dalcin 1576efe9872eSLisandro Dalcin Output Parameters: 1577efe9872eSLisandro Dalcin + J - The (approximate) Jacobian of F(t,U,U_t,U_tt) 1578efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J 1579efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices 1580efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine 1581efe9872eSLisandro Dalcin 158295452b02SPatrick Sanan Notes: 158395452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 1584efe9872eSLisandro Dalcin 1585efe9872eSLisandro Dalcin Level: advanced 1586efe9872eSLisandro Dalcin 1587a96d6ef6SBarry Smith .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber(), TSSetI2Jacobian(), TSGetI2Function(), TSCreate() 1588efe9872eSLisandro Dalcin 1589efe9872eSLisandro Dalcin @*/ 1590efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx) 1591efe9872eSLisandro Dalcin { 1592efe9872eSLisandro Dalcin PetscErrorCode ierr; 1593efe9872eSLisandro Dalcin SNES snes; 1594efe9872eSLisandro Dalcin DM dm; 1595efe9872eSLisandro Dalcin 1596efe9872eSLisandro Dalcin PetscFunctionBegin; 1597efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1598efe9872eSLisandro Dalcin ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 1599efe9872eSLisandro Dalcin ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr); 1600efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1601efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1602efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1603efe9872eSLisandro Dalcin } 1604efe9872eSLisandro Dalcin 1605efe9872eSLisandro Dalcin /*@ 1606efe9872eSLisandro Dalcin TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0 1607efe9872eSLisandro Dalcin 1608d083f849SBarry Smith Collective on TS 1609efe9872eSLisandro Dalcin 1610efe9872eSLisandro Dalcin Input Parameters: 1611efe9872eSLisandro Dalcin + ts - the TS context 1612efe9872eSLisandro Dalcin . t - current time 1613efe9872eSLisandro Dalcin . U - state vector 1614efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t) 1615efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt) 1616efe9872eSLisandro Dalcin 1617efe9872eSLisandro Dalcin Output Parameter: 1618efe9872eSLisandro Dalcin . F - the residual vector 1619efe9872eSLisandro Dalcin 1620efe9872eSLisandro Dalcin Note: 1621efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1622efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1623efe9872eSLisandro Dalcin 1624efe9872eSLisandro Dalcin Level: developer 1625efe9872eSLisandro Dalcin 1626a96d6ef6SBarry Smith .seealso: TSSetI2Function(), TSGetI2Function() 1627efe9872eSLisandro Dalcin @*/ 1628efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F) 1629efe9872eSLisandro Dalcin { 1630efe9872eSLisandro Dalcin DM dm; 1631efe9872eSLisandro Dalcin TSI2Function I2Function; 1632efe9872eSLisandro Dalcin void *ctx; 1633efe9872eSLisandro Dalcin TSRHSFunction rhsfunction; 1634efe9872eSLisandro Dalcin PetscErrorCode ierr; 1635efe9872eSLisandro Dalcin 1636efe9872eSLisandro Dalcin PetscFunctionBegin; 1637efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1638efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1639efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1640efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1641efe9872eSLisandro Dalcin PetscValidHeaderSpecific(F,VEC_CLASSID,6); 1642efe9872eSLisandro Dalcin 1643efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1644efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr); 1645efe9872eSLisandro Dalcin ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 1646efe9872eSLisandro Dalcin 1647efe9872eSLisandro Dalcin if (!I2Function) { 1648efe9872eSLisandro Dalcin ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr); 1649efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1650efe9872eSLisandro Dalcin } 1651efe9872eSLisandro Dalcin 1652efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1653efe9872eSLisandro Dalcin 1654efe9872eSLisandro Dalcin PetscStackPush("TS user implicit function"); 1655efe9872eSLisandro Dalcin ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr); 1656efe9872eSLisandro Dalcin PetscStackPop; 1657efe9872eSLisandro Dalcin 1658efe9872eSLisandro Dalcin if (rhsfunction) { 1659efe9872eSLisandro Dalcin Vec Frhs; 1660efe9872eSLisandro Dalcin ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 1661efe9872eSLisandro Dalcin ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 1662efe9872eSLisandro Dalcin ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr); 1663efe9872eSLisandro Dalcin } 1664efe9872eSLisandro Dalcin 1665efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1666efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1667efe9872eSLisandro Dalcin } 1668efe9872eSLisandro Dalcin 1669efe9872eSLisandro Dalcin /*@ 1670efe9872eSLisandro Dalcin TSComputeI2Jacobian - Evaluates the Jacobian of the DAE 1671efe9872eSLisandro Dalcin 1672d083f849SBarry Smith Collective on TS 1673efe9872eSLisandro Dalcin 1674efe9872eSLisandro Dalcin Input Parameters: 1675efe9872eSLisandro Dalcin + ts - the TS context 1676efe9872eSLisandro Dalcin . t - current timestep 1677efe9872eSLisandro Dalcin . U - state vector 1678efe9872eSLisandro Dalcin . V - time derivative of state vector 1679efe9872eSLisandro Dalcin . A - second time derivative of state vector 1680efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below 1681efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below 1682efe9872eSLisandro Dalcin 1683efe9872eSLisandro Dalcin Output Parameters: 1684efe9872eSLisandro Dalcin + J - Jacobian matrix 1685efe9872eSLisandro Dalcin - P - optional preconditioning matrix 1686efe9872eSLisandro Dalcin 1687efe9872eSLisandro Dalcin Notes: 1688efe9872eSLisandro Dalcin If F(t,U,V,A)=0 is the DAE, the required Jacobian is 1689efe9872eSLisandro Dalcin 1690efe9872eSLisandro Dalcin dF/dU + shiftV*dF/dV + shiftA*dF/dA 1691efe9872eSLisandro Dalcin 1692efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1693efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1694efe9872eSLisandro Dalcin 1695efe9872eSLisandro Dalcin Level: developer 1696efe9872eSLisandro Dalcin 1697efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1698efe9872eSLisandro Dalcin @*/ 1699efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P) 1700efe9872eSLisandro Dalcin { 1701efe9872eSLisandro Dalcin DM dm; 1702efe9872eSLisandro Dalcin TSI2Jacobian I2Jacobian; 1703efe9872eSLisandro Dalcin void *ctx; 1704efe9872eSLisandro Dalcin TSRHSJacobian rhsjacobian; 1705efe9872eSLisandro Dalcin PetscErrorCode ierr; 1706efe9872eSLisandro Dalcin 1707efe9872eSLisandro Dalcin PetscFunctionBegin; 1708efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1709efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1710efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1711efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1712efe9872eSLisandro Dalcin PetscValidHeaderSpecific(J,MAT_CLASSID,8); 1713efe9872eSLisandro Dalcin PetscValidHeaderSpecific(P,MAT_CLASSID,9); 1714efe9872eSLisandro Dalcin 1715efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1716efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr); 1717efe9872eSLisandro Dalcin ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 1718efe9872eSLisandro Dalcin 1719efe9872eSLisandro Dalcin if (!I2Jacobian) { 1720efe9872eSLisandro Dalcin ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr); 1721efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1722efe9872eSLisandro Dalcin } 1723efe9872eSLisandro Dalcin 1724efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1725efe9872eSLisandro Dalcin 1726efe9872eSLisandro Dalcin PetscStackPush("TS user implicit Jacobian"); 1727efe9872eSLisandro Dalcin ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr); 1728efe9872eSLisandro Dalcin PetscStackPop; 1729efe9872eSLisandro Dalcin 1730efe9872eSLisandro Dalcin if (rhsjacobian) { 1731d60b7d5cSBarry Smith Mat Jrhs,Prhs; 1732efe9872eSLisandro Dalcin ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr); 1733efe9872eSLisandro Dalcin ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr); 1734d60b7d5cSBarry Smith ierr = MatAXPY(J,-1,Jrhs,ts->axpy_pattern);CHKERRQ(ierr); 1735d60b7d5cSBarry Smith if (P != J) {ierr = MatAXPY(P,-1,Prhs,ts->axpy_pattern);CHKERRQ(ierr);} 1736efe9872eSLisandro Dalcin } 1737efe9872eSLisandro Dalcin 1738efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1739efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1740efe9872eSLisandro Dalcin } 1741efe9872eSLisandro Dalcin 1742438f35afSJed Brown /*@C 1743438f35afSJed Brown TSSetTransientVariable - sets function to transform from state to transient variables 1744438f35afSJed Brown 1745438f35afSJed Brown Logically Collective 1746438f35afSJed Brown 1747438f35afSJed Brown Input Arguments: 1748438f35afSJed Brown + ts - time stepping context on which to change the transient variable 1749a96d6ef6SBarry Smith . tvar - a function that transforms to transient variables 1750438f35afSJed Brown - ctx - a context for tvar 1751438f35afSJed Brown 1752a96d6ef6SBarry Smith Calling sequence of tvar: 1753a96d6ef6SBarry Smith $ PetscErrorCode tvar(TS ts,Vec p,Vec c,void *ctx); 1754a96d6ef6SBarry Smith 1755a96d6ef6SBarry Smith + ts - timestep context 1756a96d6ef6SBarry Smith . p - input vector (primative form) 1757a96d6ef6SBarry Smith . c - output vector, transient variables (conservative form) 1758a96d6ef6SBarry Smith - ctx - [optional] user-defined function context 1759a96d6ef6SBarry Smith 1760438f35afSJed Brown Level: advanced 1761438f35afSJed Brown 1762438f35afSJed Brown Notes: 1763438f35afSJed Brown This is typically used to transform from primitive to conservative variables so that a time integrator (e.g., TSBDF) 1764438f35afSJed Brown can be conservative. In this context, primitive variables P are used to model the state (e.g., because they lead to 1765438f35afSJed Brown well-conditioned formulations even in limiting cases such as low-Mach or zero porosity). The transient variable is 1766438f35afSJed Brown C(P), specified by calling this function. An IFunction thus receives arguments (P, Cdot) and the IJacobian must be 1767438f35afSJed Brown evaluated via the chain rule, as in 1768438f35afSJed Brown 1769438f35afSJed Brown dF/dP + shift * dF/dCdot dC/dP. 1770438f35afSJed Brown 1771438f35afSJed Brown .seealso: DMTSSetTransientVariable(), DMTSGetTransientVariable(), TSSetIFunction(), TSSetIJacobian() 1772438f35afSJed Brown @*/ 1773438f35afSJed Brown PetscErrorCode TSSetTransientVariable(TS ts,TSTransientVariable tvar,void *ctx) 1774438f35afSJed Brown { 1775438f35afSJed Brown PetscErrorCode ierr; 1776438f35afSJed Brown DM dm; 1777438f35afSJed Brown 1778438f35afSJed Brown PetscFunctionBegin; 1779438f35afSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1780438f35afSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1781438f35afSJed Brown ierr = DMTSSetTransientVariable(dm,tvar,ctx);CHKERRQ(ierr); 1782438f35afSJed Brown PetscFunctionReturn(0); 1783438f35afSJed Brown } 1784438f35afSJed Brown 1785efe9872eSLisandro Dalcin /*@ 1786e3c11fc1SJed Brown TSComputeTransientVariable - transforms state (primitive) variables to transient (conservative) variables 1787e3c11fc1SJed Brown 1788e3c11fc1SJed Brown Logically Collective 1789e3c11fc1SJed Brown 1790e3c11fc1SJed Brown Input Parameters: 1791e3c11fc1SJed Brown + ts - TS on which to compute 1792e3c11fc1SJed Brown - U - state vector to be transformed to transient variables 1793e3c11fc1SJed Brown 1794e3c11fc1SJed Brown Output Parameters: 1795e3c11fc1SJed Brown . C - transient (conservative) variable 1796e3c11fc1SJed Brown 1797e3c11fc1SJed Brown Developer Notes: 1798e3c11fc1SJed Brown If DMTSSetTransientVariable() has not been called, then C is not modified in this routine and C=NULL is allowed. 1799e3c11fc1SJed Brown This makes it safe to call without a guard. One can use TSHasTransientVariable() to check if transient variables are 1800e3c11fc1SJed Brown being used. 1801e3c11fc1SJed Brown 1802e3c11fc1SJed Brown Level: developer 1803e3c11fc1SJed Brown 1804e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeIFunction(), TSComputeIJacobian() 1805e3c11fc1SJed Brown @*/ 1806e3c11fc1SJed Brown PetscErrorCode TSComputeTransientVariable(TS ts,Vec U,Vec C) 1807e3c11fc1SJed Brown { 1808e3c11fc1SJed Brown PetscErrorCode ierr; 1809e3c11fc1SJed Brown DM dm; 1810e3c11fc1SJed Brown DMTS dmts; 1811e3c11fc1SJed Brown 1812e3c11fc1SJed Brown PetscFunctionBegin; 1813e3c11fc1SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1814e3c11fc1SJed Brown PetscValidHeaderSpecific(U,VEC_CLASSID,2); 1815e3c11fc1SJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1816e3c11fc1SJed Brown ierr = DMGetDMTS(dm,&dmts);CHKERRQ(ierr); 1817e3c11fc1SJed Brown if (dmts->ops->transientvar) { 1818e3c11fc1SJed Brown PetscValidHeaderSpecific(C,VEC_CLASSID,3); 1819e3c11fc1SJed Brown ierr = (*dmts->ops->transientvar)(ts,U,C,dmts->transientvarctx);CHKERRQ(ierr); 1820e3c11fc1SJed Brown } 1821e3c11fc1SJed Brown PetscFunctionReturn(0); 1822e3c11fc1SJed Brown } 1823e3c11fc1SJed Brown 1824e3c11fc1SJed Brown /*@ 1825e3c11fc1SJed Brown TSHasTransientVariable - determine whether transient variables have been set 1826e3c11fc1SJed Brown 1827e3c11fc1SJed Brown Logically Collective 1828e3c11fc1SJed Brown 1829e3c11fc1SJed Brown Input Parameters: 1830e3c11fc1SJed Brown . ts - TS on which to compute 1831e3c11fc1SJed Brown 1832e3c11fc1SJed Brown Output Parameters: 1833e3c11fc1SJed Brown . has - PETSC_TRUE if transient variables have been set 1834e3c11fc1SJed Brown 1835e3c11fc1SJed Brown Level: developer 1836e3c11fc1SJed Brown 1837e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeTransientVariable() 1838e3c11fc1SJed Brown @*/ 1839e3c11fc1SJed Brown PetscErrorCode TSHasTransientVariable(TS ts,PetscBool *has) 1840e3c11fc1SJed Brown { 1841e3c11fc1SJed Brown PetscErrorCode ierr; 1842e3c11fc1SJed Brown DM dm; 1843e3c11fc1SJed Brown DMTS dmts; 1844e3c11fc1SJed Brown 1845e3c11fc1SJed Brown PetscFunctionBegin; 1846e3c11fc1SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1847e3c11fc1SJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1848e3c11fc1SJed Brown ierr = DMGetDMTS(dm,&dmts);CHKERRQ(ierr); 1849e3c11fc1SJed Brown *has = dmts->ops->transientvar ? PETSC_TRUE : PETSC_FALSE; 1850e3c11fc1SJed Brown PetscFunctionReturn(0); 1851e3c11fc1SJed Brown } 1852e3c11fc1SJed Brown 1853e3c11fc1SJed Brown /*@ 1854efe9872eSLisandro Dalcin TS2SetSolution - Sets the initial solution and time derivative vectors 1855efe9872eSLisandro Dalcin for use by the TS routines handling second order equations. 1856efe9872eSLisandro Dalcin 1857d083f849SBarry Smith Logically Collective on TS 1858efe9872eSLisandro Dalcin 1859efe9872eSLisandro Dalcin Input Parameters: 1860efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1861efe9872eSLisandro Dalcin . u - the solution vector 1862efe9872eSLisandro Dalcin - v - the time derivative vector 1863efe9872eSLisandro Dalcin 1864efe9872eSLisandro Dalcin Level: beginner 1865efe9872eSLisandro Dalcin 1866efe9872eSLisandro Dalcin @*/ 1867efe9872eSLisandro Dalcin PetscErrorCode TS2SetSolution(TS ts,Vec u,Vec v) 1868efe9872eSLisandro Dalcin { 1869efe9872eSLisandro Dalcin PetscErrorCode ierr; 1870efe9872eSLisandro Dalcin 1871efe9872eSLisandro Dalcin PetscFunctionBegin; 1872efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1873efe9872eSLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 1874efe9872eSLisandro Dalcin PetscValidHeaderSpecific(v,VEC_CLASSID,3); 1875efe9872eSLisandro Dalcin ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 1876efe9872eSLisandro Dalcin ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr); 1877efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 1878efe9872eSLisandro Dalcin ts->vec_dot = v; 1879efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1880efe9872eSLisandro Dalcin } 1881efe9872eSLisandro Dalcin 1882efe9872eSLisandro Dalcin /*@ 1883efe9872eSLisandro Dalcin TS2GetSolution - Returns the solution and time derivative at the present timestep 1884efe9872eSLisandro Dalcin for second order equations. It is valid to call this routine inside the function 1885efe9872eSLisandro Dalcin that you are evaluating in order to move to the new timestep. This vector not 1886efe9872eSLisandro Dalcin changed until the solution at the next timestep has been calculated. 1887efe9872eSLisandro Dalcin 1888efe9872eSLisandro Dalcin Not Collective, but Vec returned is parallel if TS is parallel 1889efe9872eSLisandro Dalcin 1890efe9872eSLisandro Dalcin Input Parameter: 1891efe9872eSLisandro Dalcin . ts - the TS context obtained from TSCreate() 1892efe9872eSLisandro Dalcin 1893efe9872eSLisandro Dalcin Output Parameter: 1894efe9872eSLisandro Dalcin + u - the vector containing the solution 1895efe9872eSLisandro Dalcin - v - the vector containing the time derivative 1896efe9872eSLisandro Dalcin 1897efe9872eSLisandro Dalcin Level: intermediate 1898efe9872eSLisandro Dalcin 1899efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime() 1900efe9872eSLisandro Dalcin 1901efe9872eSLisandro Dalcin @*/ 1902efe9872eSLisandro Dalcin PetscErrorCode TS2GetSolution(TS ts,Vec *u,Vec *v) 1903efe9872eSLisandro Dalcin { 1904efe9872eSLisandro Dalcin PetscFunctionBegin; 1905efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1906efe9872eSLisandro Dalcin if (u) PetscValidPointer(u,2); 1907efe9872eSLisandro Dalcin if (v) PetscValidPointer(v,3); 1908efe9872eSLisandro Dalcin if (u) *u = ts->vec_sol; 1909efe9872eSLisandro Dalcin if (v) *v = ts->vec_dot; 1910efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1911efe9872eSLisandro Dalcin } 1912efe9872eSLisandro Dalcin 191355849f57SBarry Smith /*@C 191455849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 191555849f57SBarry Smith 191655849f57SBarry Smith Collective on PetscViewer 191755849f57SBarry Smith 191855849f57SBarry Smith Input Parameters: 191955849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 192055849f57SBarry Smith some related function before a call to TSLoad(). 192155849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 192255849f57SBarry Smith 192355849f57SBarry Smith Level: intermediate 192455849f57SBarry Smith 192555849f57SBarry Smith Notes: 192655849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 192755849f57SBarry Smith 192855849f57SBarry Smith Notes for advanced users: 192955849f57SBarry Smith Most users should not need to know the details of the binary storage 193055849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 193155849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 193255849f57SBarry Smith format is 193355849f57SBarry Smith .vb 193455849f57SBarry Smith has not yet been determined 193555849f57SBarry Smith .ve 193655849f57SBarry Smith 193755849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 193855849f57SBarry Smith @*/ 1939f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 194055849f57SBarry Smith { 194155849f57SBarry Smith PetscErrorCode ierr; 194255849f57SBarry Smith PetscBool isbinary; 194355849f57SBarry Smith PetscInt classid; 194455849f57SBarry Smith char type[256]; 19452d53ad75SBarry Smith DMTS sdm; 1946ad6bc421SBarry Smith DM dm; 194755849f57SBarry Smith 194855849f57SBarry Smith PetscFunctionBegin; 1949f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 195055849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 195155849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 195255849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 195355849f57SBarry Smith 1954060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 1955ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 1956060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 1957f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1958f2c2a1b9SBarry Smith if (ts->ops->load) { 1959f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1960f2c2a1b9SBarry Smith } 1961ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1962ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1963ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1964f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1965f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 19662d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19672d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 196855849f57SBarry Smith PetscFunctionReturn(0); 196955849f57SBarry Smith } 197055849f57SBarry Smith 19719804daf3SBarry Smith #include <petscdraw.h> 1972e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1973e04113cfSBarry Smith #include <petscviewersaws.h> 1974f05ece33SBarry Smith #endif 1975fe2efc57SMark 1976fe2efc57SMark /*@C 1977fe2efc57SMark TSViewFromOptions - View from Options 1978fe2efc57SMark 1979fe2efc57SMark Collective on TS 1980fe2efc57SMark 1981fe2efc57SMark Input Parameters: 1982fe2efc57SMark + A - the application ordering context 1983736c3998SJose E. Roman . obj - Optional object 1984736c3998SJose E. Roman - name - command line option 1985fe2efc57SMark 1986fe2efc57SMark Level: intermediate 1987fe2efc57SMark .seealso: TS, TSView, PetscObjectViewFromOptions(), TSCreate() 1988fe2efc57SMark @*/ 1989fe2efc57SMark PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) 1990fe2efc57SMark { 1991fe2efc57SMark PetscErrorCode ierr; 1992fe2efc57SMark 1993fe2efc57SMark PetscFunctionBegin; 1994fe2efc57SMark PetscValidHeaderSpecific(A,TS_CLASSID,1); 1995fe2efc57SMark ierr = PetscObjectViewFromOptions((PetscObject)A,obj,name);CHKERRQ(ierr); 1996fe2efc57SMark PetscFunctionReturn(0); 1997fe2efc57SMark } 1998fe2efc57SMark 19997e2c5f70SBarry Smith /*@C 2000d763cef2SBarry Smith TSView - Prints the TS data structure. 2001d763cef2SBarry Smith 20024c49b128SBarry Smith Collective on TS 2003d763cef2SBarry Smith 2004d763cef2SBarry Smith Input Parameters: 2005d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2006d763cef2SBarry Smith - viewer - visualization context 2007d763cef2SBarry Smith 2008d763cef2SBarry Smith Options Database Key: 2009d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 2010d763cef2SBarry Smith 2011d763cef2SBarry Smith Notes: 2012d763cef2SBarry Smith The available visualization contexts include 2013b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 2014b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 2015d763cef2SBarry Smith output where only the first processor opens 2016d763cef2SBarry Smith the file. All other processors send their 2017d763cef2SBarry Smith data to the first processor to print. 2018d763cef2SBarry Smith 2019d763cef2SBarry Smith The user can open an alternative visualization context with 2020b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 2021d763cef2SBarry Smith 2022595c91d4SBarry Smith In the debugger you can do "call TSView(ts,0)" to display the TS solver. (The same holds for any PETSc object viewer). 2023595c91d4SBarry Smith 2024d763cef2SBarry Smith Level: beginner 2025d763cef2SBarry Smith 2026b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 2027d763cef2SBarry Smith @*/ 20287087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 2029d763cef2SBarry Smith { 2030dfbe8321SBarry Smith PetscErrorCode ierr; 203119fd82e9SBarry Smith TSType type; 20322b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 20332d53ad75SBarry Smith DMTS sdm; 2034e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 2035536b137fSBarry Smith PetscBool issaws; 2036f05ece33SBarry Smith #endif 2037d763cef2SBarry Smith 2038d763cef2SBarry Smith PetscFunctionBegin; 20390700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 20403050cee2SBarry Smith if (!viewer) { 2041ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 20423050cee2SBarry Smith } 20430700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 2044c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 2045fd16b177SBarry Smith 2046251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 2047251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 204855849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 20492b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 2050e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 2051536b137fSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 2052f05ece33SBarry Smith #endif 205332077d6dSBarry Smith if (iascii) { 2054dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 2055efd4aadfSBarry Smith if (ts->ops->view) { 2056efd4aadfSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2057efd4aadfSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 2058efd4aadfSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2059efd4aadfSBarry Smith } 2060ef85077eSLisandro Dalcin if (ts->max_steps < PETSC_MAX_INT) { 206177431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 2062ef85077eSLisandro Dalcin } 2063ef85077eSLisandro Dalcin if (ts->max_time < PETSC_MAX_REAL) { 20647c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 2065ef85077eSLisandro Dalcin } 2066a6ab3590SBarry Smith if (ts->ifuncs) { 2067a6ab3590SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of I function evaluations=%D\n",ts->ifuncs);CHKERRQ(ierr); 2068a6ab3590SBarry Smith } 2069a6ab3590SBarry Smith if (ts->ijacs) { 2070a6ab3590SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of I Jacobian evaluations=%D\n",ts->ijacs);CHKERRQ(ierr); 2071a6ab3590SBarry Smith } 2072a6ab3590SBarry Smith if (ts->rhsfuncs) { 2073a6ab3590SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of RHS function evaluations=%D\n",ts->rhsfuncs);CHKERRQ(ierr); 2074a6ab3590SBarry Smith } 2075a6ab3590SBarry Smith if (ts->rhsjacs) { 2076a6ab3590SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of RHS Jacobian evaluations=%D\n",ts->rhsjacs);CHKERRQ(ierr); 2077a6ab3590SBarry Smith } 2078efd4aadfSBarry Smith if (ts->usessnes) { 2079efd4aadfSBarry Smith PetscBool lin; 2080d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 20815ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 2082d763cef2SBarry Smith } 20835ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 20841ef27442SStefano Zampini ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&lin,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr); 2085efd4aadfSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr); 2086efd4aadfSBarry Smith } 2087193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 2088a0af407cSBarry Smith if (ts->vrtol) { 2089a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of relative error tolerances, ");CHKERRQ(ierr); 2090a0af407cSBarry Smith } else { 2091a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr); 2092a0af407cSBarry Smith } 2093a0af407cSBarry Smith if (ts->vatol) { 2094a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of absolute error tolerances\n");CHKERRQ(ierr); 2095a0af407cSBarry Smith } else { 2096a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr); 2097a0af407cSBarry Smith } 2098825ab935SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2099efd4aadfSBarry Smith ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr); 2100825ab935SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 21010f5bd95cSBarry Smith } else if (isstring) { 2102a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 210336a9e3b9SBarry Smith ierr = PetscViewerStringSPrintf(viewer," TSType: %-7.7s",type);CHKERRQ(ierr); 210436a9e3b9SBarry Smith if (ts->ops->view) {ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);} 210555849f57SBarry Smith } else if (isbinary) { 210655849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 210755849f57SBarry Smith MPI_Comm comm; 210855849f57SBarry Smith PetscMPIInt rank; 210955849f57SBarry Smith char type[256]; 211055849f57SBarry Smith 211155849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 2112ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr); 211355849f57SBarry Smith if (!rank) { 2114f253e43cSLisandro Dalcin ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr); 211555849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 2116f253e43cSLisandro Dalcin ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr); 211755849f57SBarry Smith } 211855849f57SBarry Smith if (ts->ops->view) { 211955849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 212055849f57SBarry Smith } 2121efd4aadfSBarry Smith if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);} 2122f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 2123f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 21242d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 21252d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 21262b0a91c0SBarry Smith } else if (isdraw) { 21272b0a91c0SBarry Smith PetscDraw draw; 21282b0a91c0SBarry Smith char str[36]; 212989fd9fafSBarry Smith PetscReal x,y,bottom,h; 21302b0a91c0SBarry Smith 21312b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 21322b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 21332b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 21342b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 213551fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 213689fd9fafSBarry Smith bottom = y - h; 21372b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 21382b0a91c0SBarry Smith if (ts->ops->view) { 21392b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 21402b0a91c0SBarry Smith } 2141efd4aadfSBarry Smith if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);} 2142efd4aadfSBarry Smith if (ts->snes) {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);} 21432b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2144e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 2145536b137fSBarry Smith } else if (issaws) { 2146d45a07a7SBarry Smith PetscMPIInt rank; 21472657e9d9SBarry Smith const char *name; 21482657e9d9SBarry Smith 21492657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 2150ffc4695bSBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRMPI(ierr); 2151d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 2152d45a07a7SBarry Smith char dir[1024]; 2153d45a07a7SBarry Smith 2154e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 2155a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 21562657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 21572657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 21582657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 2159d763cef2SBarry Smith } 21600acecf5bSBarry Smith if (ts->ops->view) { 21610acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 21620acecf5bSBarry Smith } 2163f05ece33SBarry Smith #endif 2164f05ece33SBarry Smith } 216536a9e3b9SBarry Smith if (ts->snes && ts->usessnes) { 216636a9e3b9SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 216736a9e3b9SBarry Smith ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr); 216836a9e3b9SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 216936a9e3b9SBarry Smith } 217036a9e3b9SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 217136a9e3b9SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 2172f05ece33SBarry Smith 2173b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2174251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 2175b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2176d763cef2SBarry Smith PetscFunctionReturn(0); 2177d763cef2SBarry Smith } 2178d763cef2SBarry Smith 2179b07ff414SBarry Smith /*@ 2180d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 2181d763cef2SBarry Smith the timesteppers. 2182d763cef2SBarry Smith 21833f9fe445SBarry Smith Logically Collective on TS 2184d763cef2SBarry Smith 2185d763cef2SBarry Smith Input Parameters: 2186d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2187d763cef2SBarry Smith - usrP - optional user context 2188d763cef2SBarry Smith 218995452b02SPatrick Sanan Fortran Notes: 219095452b02SPatrick Sanan To use this from Fortran you must write a Fortran interface definition for this 2191daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2192daf670e6SBarry Smith 2193d763cef2SBarry Smith Level: intermediate 2194d763cef2SBarry Smith 2195d763cef2SBarry Smith .seealso: TSGetApplicationContext() 2196d763cef2SBarry Smith @*/ 21977087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 2198d763cef2SBarry Smith { 2199d763cef2SBarry Smith PetscFunctionBegin; 22000700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2201d763cef2SBarry Smith ts->user = usrP; 2202d763cef2SBarry Smith PetscFunctionReturn(0); 2203d763cef2SBarry Smith } 2204d763cef2SBarry Smith 2205b07ff414SBarry Smith /*@ 2206d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 2207d763cef2SBarry Smith timestepper. 2208d763cef2SBarry Smith 2209d763cef2SBarry Smith Not Collective 2210d763cef2SBarry Smith 2211d763cef2SBarry Smith Input Parameter: 2212d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2213d763cef2SBarry Smith 2214d763cef2SBarry Smith Output Parameter: 2215d763cef2SBarry Smith . usrP - user context 2216d763cef2SBarry Smith 221795452b02SPatrick Sanan Fortran Notes: 221895452b02SPatrick Sanan To use this from Fortran you must write a Fortran interface definition for this 2219daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2220daf670e6SBarry Smith 2221d763cef2SBarry Smith Level: intermediate 2222d763cef2SBarry Smith 2223d763cef2SBarry Smith .seealso: TSSetApplicationContext() 2224d763cef2SBarry Smith @*/ 2225e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 2226d763cef2SBarry Smith { 2227d763cef2SBarry Smith PetscFunctionBegin; 22280700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2229e71120c6SJed Brown *(void**)usrP = ts->user; 2230d763cef2SBarry Smith PetscFunctionReturn(0); 2231d763cef2SBarry Smith } 2232d763cef2SBarry Smith 2233d763cef2SBarry Smith /*@ 223480275a0aSLisandro Dalcin TSGetStepNumber - Gets the number of steps completed. 2235d763cef2SBarry Smith 2236d763cef2SBarry Smith Not Collective 2237d763cef2SBarry Smith 2238d763cef2SBarry Smith Input Parameter: 2239d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2240d763cef2SBarry Smith 2241d763cef2SBarry Smith Output Parameter: 224280275a0aSLisandro Dalcin . steps - number of steps completed so far 2243d763cef2SBarry Smith 2244d763cef2SBarry Smith Level: intermediate 2245d763cef2SBarry Smith 22469be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 2247d763cef2SBarry Smith @*/ 224880275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps) 2249d763cef2SBarry Smith { 2250d763cef2SBarry Smith PetscFunctionBegin; 22510700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 225280275a0aSLisandro Dalcin PetscValidIntPointer(steps,2); 225380275a0aSLisandro Dalcin *steps = ts->steps; 225480275a0aSLisandro Dalcin PetscFunctionReturn(0); 225580275a0aSLisandro Dalcin } 225680275a0aSLisandro Dalcin 225780275a0aSLisandro Dalcin /*@ 225880275a0aSLisandro Dalcin TSSetStepNumber - Sets the number of steps completed. 225980275a0aSLisandro Dalcin 226080275a0aSLisandro Dalcin Logically Collective on TS 226180275a0aSLisandro Dalcin 226280275a0aSLisandro Dalcin Input Parameters: 226380275a0aSLisandro Dalcin + ts - the TS context 226480275a0aSLisandro Dalcin - steps - number of steps completed so far 226580275a0aSLisandro Dalcin 226680275a0aSLisandro Dalcin Notes: 226780275a0aSLisandro Dalcin For most uses of the TS solvers the user need not explicitly call 226880275a0aSLisandro Dalcin TSSetStepNumber(), as the step counter is appropriately updated in 226980275a0aSLisandro Dalcin TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to 227080275a0aSLisandro Dalcin reinitialize timestepping by setting the step counter to zero (and time 227180275a0aSLisandro Dalcin to the initial time) to solve a similar problem with different initial 227280275a0aSLisandro Dalcin conditions or parameters. Other possible use case is to continue 227380275a0aSLisandro Dalcin timestepping from a previously interrupted run in such a way that TS 227480275a0aSLisandro Dalcin monitors will be called with a initial nonzero step counter. 227580275a0aSLisandro Dalcin 227680275a0aSLisandro Dalcin Level: advanced 227780275a0aSLisandro Dalcin 227880275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution() 227980275a0aSLisandro Dalcin @*/ 228080275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps) 228180275a0aSLisandro Dalcin { 228280275a0aSLisandro Dalcin PetscFunctionBegin; 228380275a0aSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 228480275a0aSLisandro Dalcin PetscValidLogicalCollectiveInt(ts,steps,2); 228580275a0aSLisandro Dalcin if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative"); 228680275a0aSLisandro Dalcin ts->steps = steps; 2287d763cef2SBarry Smith PetscFunctionReturn(0); 2288d763cef2SBarry Smith } 2289d763cef2SBarry Smith 2290d763cef2SBarry Smith /*@ 2291d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 2292d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 2293d763cef2SBarry Smith 22943f9fe445SBarry Smith Logically Collective on TS 2295d763cef2SBarry Smith 2296d763cef2SBarry Smith Input Parameters: 2297d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2298d763cef2SBarry Smith - time_step - the size of the timestep 2299d763cef2SBarry Smith 2300d763cef2SBarry Smith Level: intermediate 2301d763cef2SBarry Smith 2302aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime() 2303d763cef2SBarry Smith 2304d763cef2SBarry Smith @*/ 23057087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 2306d763cef2SBarry Smith { 2307d763cef2SBarry Smith PetscFunctionBegin; 23080700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2309c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 2310d763cef2SBarry Smith ts->time_step = time_step; 2311d763cef2SBarry Smith PetscFunctionReturn(0); 2312d763cef2SBarry Smith } 2313d763cef2SBarry Smith 2314a43b19c4SJed Brown /*@ 231549354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 231649354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 231749354f04SShri Abhyankar or just return at the final time TS computed. 2318a43b19c4SJed Brown 2319a43b19c4SJed Brown Logically Collective on TS 2320a43b19c4SJed Brown 2321a43b19c4SJed Brown Input Parameter: 2322a43b19c4SJed Brown + ts - the time-step context 232349354f04SShri Abhyankar - eftopt - exact final time option 2324a43b19c4SJed Brown 2325feed9e9dSBarry Smith $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 2326feed9e9dSBarry Smith $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 2327feed9e9dSBarry Smith $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 2328feed9e9dSBarry Smith 2329feed9e9dSBarry Smith Options Database: 2330feed9e9dSBarry Smith . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime 2331feed9e9dSBarry Smith 2332ee346746SBarry Smith Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time 2333ee346746SBarry Smith then the final time you selected. 2334ee346746SBarry Smith 2335a43b19c4SJed Brown Level: beginner 2336a43b19c4SJed Brown 2337f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime() 2338a43b19c4SJed Brown @*/ 233949354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 2340a43b19c4SJed Brown { 2341a43b19c4SJed Brown PetscFunctionBegin; 2342a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 234349354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 234449354f04SShri Abhyankar ts->exact_final_time = eftopt; 2345a43b19c4SJed Brown PetscFunctionReturn(0); 2346a43b19c4SJed Brown } 2347a43b19c4SJed Brown 2348d763cef2SBarry Smith /*@ 2349f6953c82SLisandro Dalcin TSGetExactFinalTime - Gets the exact final time option. 2350f6953c82SLisandro Dalcin 2351f6953c82SLisandro Dalcin Not Collective 2352f6953c82SLisandro Dalcin 2353f6953c82SLisandro Dalcin Input Parameter: 2354f6953c82SLisandro Dalcin . ts - the TS context 2355f6953c82SLisandro Dalcin 2356f6953c82SLisandro Dalcin Output Parameter: 2357f6953c82SLisandro Dalcin . eftopt - exact final time option 2358f6953c82SLisandro Dalcin 2359f6953c82SLisandro Dalcin Level: beginner 2360f6953c82SLisandro Dalcin 2361f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime() 2362f6953c82SLisandro Dalcin @*/ 2363f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt) 2364f6953c82SLisandro Dalcin { 2365f6953c82SLisandro Dalcin PetscFunctionBegin; 2366f6953c82SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2367f6953c82SLisandro Dalcin PetscValidPointer(eftopt,2); 2368f6953c82SLisandro Dalcin *eftopt = ts->exact_final_time; 2369f6953c82SLisandro Dalcin PetscFunctionReturn(0); 2370f6953c82SLisandro Dalcin } 2371f6953c82SLisandro Dalcin 2372f6953c82SLisandro Dalcin /*@ 2373d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 2374d763cef2SBarry Smith 2375d763cef2SBarry Smith Not Collective 2376d763cef2SBarry Smith 2377d763cef2SBarry Smith Input Parameter: 2378d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2379d763cef2SBarry Smith 2380d763cef2SBarry Smith Output Parameter: 2381d763cef2SBarry Smith . dt - the current timestep size 2382d763cef2SBarry Smith 2383d763cef2SBarry Smith Level: intermediate 2384d763cef2SBarry Smith 2385aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime() 2386d763cef2SBarry Smith 2387d763cef2SBarry Smith @*/ 23887087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 2389d763cef2SBarry Smith { 2390d763cef2SBarry Smith PetscFunctionBegin; 23910700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2392f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 2393d763cef2SBarry Smith *dt = ts->time_step; 2394d763cef2SBarry Smith PetscFunctionReturn(0); 2395d763cef2SBarry Smith } 2396d763cef2SBarry Smith 2397d8e5e3e6SSatish Balay /*@ 2398d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 2399d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 2400d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 2401d763cef2SBarry Smith the solution at the next timestep has been calculated. 2402d763cef2SBarry Smith 2403d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 2404d763cef2SBarry Smith 2405d763cef2SBarry Smith Input Parameter: 2406d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2407d763cef2SBarry Smith 2408d763cef2SBarry Smith Output Parameter: 2409d763cef2SBarry Smith . v - the vector containing the solution 2410d763cef2SBarry Smith 241163e21af5SBarry Smith Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested 241263e21af5SBarry Smith final time. It returns the solution at the next timestep. 241363e21af5SBarry Smith 2414d763cef2SBarry Smith Level: intermediate 2415d763cef2SBarry Smith 24160ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction() 2417d763cef2SBarry Smith 2418d763cef2SBarry Smith @*/ 24197087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 2420d763cef2SBarry Smith { 2421d763cef2SBarry Smith PetscFunctionBegin; 24220700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 24234482741eSBarry Smith PetscValidPointer(v,2); 24248737fe31SLisandro Dalcin *v = ts->vec_sol; 2425d763cef2SBarry Smith PetscFunctionReturn(0); 2426d763cef2SBarry Smith } 2427d763cef2SBarry Smith 242803fe5f5eSDebojyoti Ghosh /*@ 2429b2bf4f3aSDebojyoti Ghosh TSGetSolutionComponents - Returns any solution components at the present 243003fe5f5eSDebojyoti Ghosh timestep, if available for the time integration method being used. 2431b2bf4f3aSDebojyoti Ghosh Solution components are quantities that share the same size and 243203fe5f5eSDebojyoti Ghosh structure as the solution vector. 243303fe5f5eSDebojyoti Ghosh 243403fe5f5eSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 243503fe5f5eSDebojyoti Ghosh 243603fe5f5eSDebojyoti Ghosh Parameters : 2437a2b725a8SWilliam Gropp + ts - the TS context obtained from TSCreate() (input parameter). 2438b2bf4f3aSDebojyoti Ghosh . n - If v is PETSC_NULL, then the number of solution components is 2439b2bf4f3aSDebojyoti Ghosh returned through n, else the n-th solution component is 244003fe5f5eSDebojyoti Ghosh returned in v. 2441a2b725a8SWilliam Gropp - v - the vector containing the n-th solution component 244203fe5f5eSDebojyoti Ghosh (may be PETSC_NULL to use this function to find out 2443b2bf4f3aSDebojyoti Ghosh the number of solutions components). 244403fe5f5eSDebojyoti Ghosh 24454cdd57e5SDebojyoti Ghosh Level: advanced 244603fe5f5eSDebojyoti Ghosh 244703fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution() 244803fe5f5eSDebojyoti Ghosh 244903fe5f5eSDebojyoti Ghosh @*/ 2450b2bf4f3aSDebojyoti Ghosh PetscErrorCode TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v) 245103fe5f5eSDebojyoti Ghosh { 245203fe5f5eSDebojyoti Ghosh PetscErrorCode ierr; 245303fe5f5eSDebojyoti Ghosh 245403fe5f5eSDebojyoti Ghosh PetscFunctionBegin; 245503fe5f5eSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2456b2bf4f3aSDebojyoti Ghosh if (!ts->ops->getsolutioncomponents) *n = 0; 245703fe5f5eSDebojyoti Ghosh else { 2458b2bf4f3aSDebojyoti Ghosh ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr); 245903fe5f5eSDebojyoti Ghosh } 246003fe5f5eSDebojyoti Ghosh PetscFunctionReturn(0); 246103fe5f5eSDebojyoti Ghosh } 246203fe5f5eSDebojyoti Ghosh 24634cdd57e5SDebojyoti Ghosh /*@ 24644cdd57e5SDebojyoti Ghosh TSGetAuxSolution - Returns an auxiliary solution at the present 24654cdd57e5SDebojyoti Ghosh timestep, if available for the time integration method being used. 24664cdd57e5SDebojyoti Ghosh 24674cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 24684cdd57e5SDebojyoti Ghosh 24694cdd57e5SDebojyoti Ghosh Parameters : 2470a2b725a8SWilliam Gropp + ts - the TS context obtained from TSCreate() (input parameter). 2471a2b725a8SWilliam Gropp - v - the vector containing the auxiliary solution 24724cdd57e5SDebojyoti Ghosh 24734cdd57e5SDebojyoti Ghosh Level: intermediate 24744cdd57e5SDebojyoti Ghosh 24754cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution() 24764cdd57e5SDebojyoti Ghosh 24774cdd57e5SDebojyoti Ghosh @*/ 24784cdd57e5SDebojyoti Ghosh PetscErrorCode TSGetAuxSolution(TS ts,Vec *v) 24794cdd57e5SDebojyoti Ghosh { 24804cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 24814cdd57e5SDebojyoti Ghosh 24824cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 24834cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2484f6356ec7SDebojyoti Ghosh if (ts->ops->getauxsolution) { 24854cdd57e5SDebojyoti Ghosh ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr); 2486f6356ec7SDebojyoti Ghosh } else { 2487f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v);CHKERRQ(ierr); 2488f6356ec7SDebojyoti Ghosh } 24894cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 24904cdd57e5SDebojyoti Ghosh } 24914cdd57e5SDebojyoti Ghosh 24924cdd57e5SDebojyoti Ghosh /*@ 24934cdd57e5SDebojyoti Ghosh TSGetTimeError - Returns the estimated error vector, if the chosen 24944cdd57e5SDebojyoti Ghosh TSType has an error estimation functionality. 24954cdd57e5SDebojyoti Ghosh 24964cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 24974cdd57e5SDebojyoti Ghosh 24989657682dSDebojyoti Ghosh Note: MUST call after TSSetUp() 24999657682dSDebojyoti Ghosh 25004cdd57e5SDebojyoti Ghosh Parameters : 2501a2b725a8SWilliam Gropp + ts - the TS context obtained from TSCreate() (input parameter). 2502657c1e31SEmil Constantinescu . n - current estimate (n=0) or previous one (n=-1) 2503a2b725a8SWilliam Gropp - v - the vector containing the error (same size as the solution). 25044cdd57e5SDebojyoti Ghosh 25054cdd57e5SDebojyoti Ghosh Level: intermediate 25064cdd57e5SDebojyoti Ghosh 250757df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError() 25084cdd57e5SDebojyoti Ghosh 25094cdd57e5SDebojyoti Ghosh @*/ 25100a01e1b2SEmil Constantinescu PetscErrorCode TSGetTimeError(TS ts,PetscInt n,Vec *v) 25114cdd57e5SDebojyoti Ghosh { 25124cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 25134cdd57e5SDebojyoti Ghosh 25144cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 25154cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2516f6356ec7SDebojyoti Ghosh if (ts->ops->gettimeerror) { 25170a01e1b2SEmil Constantinescu ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr); 2518f6356ec7SDebojyoti Ghosh } else { 2519f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v);CHKERRQ(ierr); 2520f6356ec7SDebojyoti Ghosh } 25214cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 25224cdd57e5SDebojyoti Ghosh } 25234cdd57e5SDebojyoti Ghosh 252457df6a1bSDebojyoti Ghosh /*@ 252557df6a1bSDebojyoti Ghosh TSSetTimeError - Sets the estimated error vector, if the chosen 252657df6a1bSDebojyoti Ghosh TSType has an error estimation functionality. This can be used 252757df6a1bSDebojyoti Ghosh to restart such a time integrator with a given error vector. 252857df6a1bSDebojyoti Ghosh 252957df6a1bSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 253057df6a1bSDebojyoti Ghosh 253157df6a1bSDebojyoti Ghosh Parameters : 2532a2b725a8SWilliam Gropp + ts - the TS context obtained from TSCreate() (input parameter). 2533a2b725a8SWilliam Gropp - v - the vector containing the error (same size as the solution). 253457df6a1bSDebojyoti Ghosh 253557df6a1bSDebojyoti Ghosh Level: intermediate 253657df6a1bSDebojyoti Ghosh 253757df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError) 253857df6a1bSDebojyoti Ghosh 253957df6a1bSDebojyoti Ghosh @*/ 254057df6a1bSDebojyoti Ghosh PetscErrorCode TSSetTimeError(TS ts,Vec v) 254157df6a1bSDebojyoti Ghosh { 254257df6a1bSDebojyoti Ghosh PetscErrorCode ierr; 254357df6a1bSDebojyoti Ghosh 254457df6a1bSDebojyoti Ghosh PetscFunctionBegin; 254557df6a1bSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 25469657682dSDebojyoti Ghosh if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first"); 254757df6a1bSDebojyoti Ghosh if (ts->ops->settimeerror) { 254857df6a1bSDebojyoti Ghosh ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr); 254957df6a1bSDebojyoti Ghosh } 255057df6a1bSDebojyoti Ghosh PetscFunctionReturn(0); 255157df6a1bSDebojyoti Ghosh } 255257df6a1bSDebojyoti Ghosh 2553bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 2554d8e5e3e6SSatish Balay /*@ 2555bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 2556d763cef2SBarry Smith 2557bdad233fSMatthew Knepley Not collective 2558d763cef2SBarry Smith 2559bdad233fSMatthew Knepley Input Parameters: 2560bdad233fSMatthew Knepley + ts - The TS 2561bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2562d763cef2SBarry Smith .vb 25630910c330SBarry Smith U_t - A U = 0 (linear) 25640910c330SBarry Smith U_t - A(t) U = 0 (linear) 25650910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 2566d763cef2SBarry Smith .ve 2567d763cef2SBarry Smith 2568d763cef2SBarry Smith Level: beginner 2569d763cef2SBarry Smith 2570bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2571d763cef2SBarry Smith @*/ 25727087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 2573a7cc72afSBarry Smith { 25749e2a6581SJed Brown PetscErrorCode ierr; 25759e2a6581SJed Brown 2576d763cef2SBarry Smith PetscFunctionBegin; 25770700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2578bdad233fSMatthew Knepley ts->problem_type = type; 25799e2a6581SJed Brown if (type == TS_LINEAR) { 25809e2a6581SJed Brown SNES snes; 25819e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 25829e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 25839e2a6581SJed Brown } 2584d763cef2SBarry Smith PetscFunctionReturn(0); 2585d763cef2SBarry Smith } 2586d763cef2SBarry Smith 2587bdad233fSMatthew Knepley /*@C 2588bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 2589bdad233fSMatthew Knepley 2590bdad233fSMatthew Knepley Not collective 2591bdad233fSMatthew Knepley 2592bdad233fSMatthew Knepley Input Parameter: 2593bdad233fSMatthew Knepley . ts - The TS 2594bdad233fSMatthew Knepley 2595bdad233fSMatthew Knepley Output Parameter: 2596bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2597bdad233fSMatthew Knepley .vb 2598089b2837SJed Brown M U_t = A U 2599089b2837SJed Brown M(t) U_t = A(t) U 2600b5abc632SBarry Smith F(t,U,U_t) 2601bdad233fSMatthew Knepley .ve 2602bdad233fSMatthew Knepley 2603bdad233fSMatthew Knepley Level: beginner 2604bdad233fSMatthew Knepley 2605bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2606bdad233fSMatthew Knepley @*/ 26077087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 2608a7cc72afSBarry Smith { 2609bdad233fSMatthew Knepley PetscFunctionBegin; 26100700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 26114482741eSBarry Smith PetscValidIntPointer(type,2); 2612bdad233fSMatthew Knepley *type = ts->problem_type; 2613bdad233fSMatthew Knepley PetscFunctionReturn(0); 2614bdad233fSMatthew Knepley } 2615d763cef2SBarry Smith 2616303a5415SBarry Smith /* 2617303a5415SBarry Smith Attempt to check/preset a default value for the exact final time option. This is needed at the beginning of TSSolve() and in TSSetUp() 2618303a5415SBarry Smith */ 2619303a5415SBarry Smith static PetscErrorCode TSSetExactFinalTimeDefault(TS ts) 2620303a5415SBarry Smith { 2621303a5415SBarry Smith PetscErrorCode ierr; 2622303a5415SBarry Smith PetscBool isnone; 2623303a5415SBarry Smith 2624303a5415SBarry Smith PetscFunctionBegin; 2625303a5415SBarry Smith ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 2626303a5415SBarry Smith ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 2627303a5415SBarry Smith 2628303a5415SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr); 2629303a5415SBarry Smith if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) { 2630303a5415SBarry Smith ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP; 2631303a5415SBarry Smith } else if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) { 2632303a5415SBarry Smith ts->exact_final_time = TS_EXACTFINALTIME_INTERPOLATE; 2633303a5415SBarry Smith } 2634303a5415SBarry Smith PetscFunctionReturn(0); 2635303a5415SBarry Smith } 2636303a5415SBarry Smith 2637303a5415SBarry Smith 2638d763cef2SBarry Smith /*@ 2639303a5415SBarry Smith TSSetUp - Sets up the internal data structures for the later use of a timestepper. 2640d763cef2SBarry Smith 2641d763cef2SBarry Smith Collective on TS 2642d763cef2SBarry Smith 2643d763cef2SBarry Smith Input Parameter: 2644d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2645d763cef2SBarry Smith 2646d763cef2SBarry Smith Notes: 2647d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 2648d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 2649141bd67dSStefano Zampini the call to TSStep() or TSSolve(). However, if one wishes to control this 2650d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 2651141bd67dSStefano Zampini and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve(). 2652d763cef2SBarry Smith 2653d763cef2SBarry Smith Level: advanced 2654d763cef2SBarry Smith 2655141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve() 2656d763cef2SBarry Smith @*/ 26577087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 2658d763cef2SBarry Smith { 2659dfbe8321SBarry Smith PetscErrorCode ierr; 26606c6b9e74SPeter Brune DM dm; 26616c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 2662d1e9a80fSBarry Smith PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 2663cd11d68dSLisandro Dalcin TSIFunction ifun; 26646c6b9e74SPeter Brune TSIJacobian ijac; 2665efe9872eSLisandro Dalcin TSI2Jacobian i2jac; 26666c6b9e74SPeter Brune TSRHSJacobian rhsjac; 2667d763cef2SBarry Smith 2668d763cef2SBarry Smith PetscFunctionBegin; 26690700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2670277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 2671277b19d0SLisandro Dalcin 26727adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 2673cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 2674cd11d68dSLisandro Dalcin ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr); 2675d763cef2SBarry Smith } 2676277b19d0SLisandro Dalcin 26771a638600SStefano Zampini if (!ts->vec_sol) { 26781a638600SStefano Zampini if (ts->dm) { 26791a638600SStefano Zampini ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 26801a638600SStefano Zampini } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 26811a638600SStefano Zampini } 2682277b19d0SLisandro Dalcin 2683298bade4SHong Zhang if (!ts->Jacp && ts->Jacprhs) { /* IJacobianP shares the same matrix with RHSJacobianP if only RHSJacobianP is provided */ 2684298bade4SHong Zhang ierr = PetscObjectReference((PetscObject)ts->Jacprhs);CHKERRQ(ierr); 2685298bade4SHong Zhang ts->Jacp = ts->Jacprhs; 2686298bade4SHong Zhang } 2687298bade4SHong Zhang 2688cd4cee2dSHong Zhang if (ts->quadraturets) { 2689cd4cee2dSHong Zhang ierr = TSSetUp(ts->quadraturets);CHKERRQ(ierr); 2690ecf68647SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2691cd4cee2dSHong Zhang ierr = VecDuplicate(ts->quadraturets->vec_sol,&ts->vec_costintegrand);CHKERRQ(ierr); 2692cd4cee2dSHong Zhang } 2693cd4cee2dSHong Zhang 2694971015bcSStefano Zampini ierr = TSGetRHSJacobian(ts,NULL,NULL,&rhsjac,NULL);CHKERRQ(ierr); 2695f23ba4b3SHong Zhang if (rhsjac == TSComputeRHSJacobianConstant) { 2696e1244c69SJed Brown Mat Amat,Pmat; 2697e1244c69SJed Brown SNES snes; 2698e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2699e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 2700e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 2701e1244c69SJed Brown * have displaced the RHS matrix */ 2702971015bcSStefano Zampini if (Amat && Amat == ts->Arhs) { 2703abc0d4abSBarry Smith /* we need to copy the values of the matrix because for the constant Jacobian case the user will never set the numerical values in this new location */ 2704abc0d4abSBarry Smith ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr); 2705e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 2706e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 2707e1244c69SJed Brown } 2708971015bcSStefano Zampini if (Pmat && Pmat == ts->Brhs) { 2709abc0d4abSBarry Smith ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 2710e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 2711e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 2712e1244c69SJed Brown } 2713e1244c69SJed Brown } 27142ffb9264SLisandro Dalcin 27152ffb9264SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 27162ffb9264SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 27172ffb9264SLisandro Dalcin 2718277b19d0SLisandro Dalcin if (ts->ops->setup) { 2719000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 2720277b19d0SLisandro Dalcin } 2721277b19d0SLisandro Dalcin 2722303a5415SBarry Smith ierr = TSSetExactFinalTimeDefault(ts);CHKERRQ(ierr); 27232ffb9264SLisandro Dalcin 2724a6772fa2SLisandro Dalcin /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 27256c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 27266c6b9e74SPeter Brune */ 27276c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 27280298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 27296c6b9e74SPeter Brune if (!func) { 27306c6b9e74SPeter Brune ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 27316c6b9e74SPeter Brune } 2732a6772fa2SLisandro Dalcin /* If the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it. 27336c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 27346c6b9e74SPeter Brune */ 27350298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 27360298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 2737efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr); 27380298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 2739efe9872eSLisandro Dalcin if (!jac && (ijac || i2jac || rhsjac)) { 27406c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 27416c6b9e74SPeter Brune } 2742c0517034SDebojyoti Ghosh 2743c0517034SDebojyoti Ghosh /* if time integration scheme has a starting method, call it */ 2744c0517034SDebojyoti Ghosh if (ts->ops->startingmethod) { 2745c0517034SDebojyoti Ghosh ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr); 2746c0517034SDebojyoti Ghosh } 2747c0517034SDebojyoti Ghosh 2748277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 2749277b19d0SLisandro Dalcin PetscFunctionReturn(0); 2750277b19d0SLisandro Dalcin } 2751277b19d0SLisandro Dalcin 2752f6a906c0SBarry Smith /*@ 2753277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 2754277b19d0SLisandro Dalcin 2755277b19d0SLisandro Dalcin Collective on TS 2756277b19d0SLisandro Dalcin 2757277b19d0SLisandro Dalcin Input Parameter: 2758277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 2759277b19d0SLisandro Dalcin 2760277b19d0SLisandro Dalcin Level: beginner 2761277b19d0SLisandro Dalcin 2762277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 2763277b19d0SLisandro Dalcin @*/ 2764277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 2765277b19d0SLisandro Dalcin { 27661d06f6b3SHong Zhang TS_RHSSplitLink ilink = ts->tsrhssplit,next; 2767277b19d0SLisandro Dalcin PetscErrorCode ierr; 2768277b19d0SLisandro Dalcin 2769277b19d0SLisandro Dalcin PetscFunctionBegin; 2770277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2771b18ea86cSHong Zhang 2772277b19d0SLisandro Dalcin if (ts->ops->reset) { 2773277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 2774277b19d0SLisandro Dalcin } 2775277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 2776e27a82bcSLisandro Dalcin if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);} 2777bbd56ea5SKarl Rupp 27784e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 27794e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 2780214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 27816bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2782efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 2783e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 2784e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 278538637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 2786bbd56ea5SKarl Rupp 2787cd4cee2dSHong Zhang ierr = MatDestroy(&ts->Jacprhs);CHKERRQ(ierr); 2788ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 2789ecf68647SHong Zhang if (ts->forward_solve) { 2790ecf68647SHong Zhang ierr = TSForwardReset(ts);CHKERRQ(ierr); 2791ecf68647SHong Zhang } 2792cd4cee2dSHong Zhang if (ts->quadraturets) { 2793cd4cee2dSHong Zhang ierr = TSReset(ts->quadraturets);CHKERRQ(ierr); 279436eaed60SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2795cd4cee2dSHong Zhang } 27961d06f6b3SHong Zhang while (ilink) { 27971d06f6b3SHong Zhang next = ilink->next; 27981d06f6b3SHong Zhang ierr = TSDestroy(&ilink->ts);CHKERRQ(ierr); 27991d06f6b3SHong Zhang ierr = PetscFree(ilink->splitname);CHKERRQ(ierr); 28001d06f6b3SHong Zhang ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 28011d06f6b3SHong Zhang ierr = PetscFree(ilink);CHKERRQ(ierr); 28021d06f6b3SHong Zhang ilink = next; 280387f4e208SHong Zhang } 2804545aaa6fSHong Zhang ts->num_rhs_splits = 0; 2805277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 2806d763cef2SBarry Smith PetscFunctionReturn(0); 2807d763cef2SBarry Smith } 2808d763cef2SBarry Smith 28091fb7b255SJunchao Zhang /*@C 2810d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 2811d763cef2SBarry Smith with TSCreate(). 2812d763cef2SBarry Smith 2813d763cef2SBarry Smith Collective on TS 2814d763cef2SBarry Smith 2815d763cef2SBarry Smith Input Parameter: 2816d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2817d763cef2SBarry Smith 2818d763cef2SBarry Smith Level: beginner 2819d763cef2SBarry Smith 2820d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 2821d763cef2SBarry Smith @*/ 28226bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 2823d763cef2SBarry Smith { 28246849ba73SBarry Smith PetscErrorCode ierr; 2825d763cef2SBarry Smith 2826d763cef2SBarry Smith PetscFunctionBegin; 28276bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 2828ecf68647SHong Zhang PetscValidHeaderSpecific(*ts,TS_CLASSID,1); 2829c793f718SLisandro Dalcin if (--((PetscObject)(*ts))->refct > 0) {*ts = NULL; PetscFunctionReturn(0);} 2830d763cef2SBarry Smith 2831ecf68647SHong Zhang ierr = TSReset(*ts);CHKERRQ(ierr); 2832ecf68647SHong Zhang ierr = TSAdjointReset(*ts);CHKERRQ(ierr); 2833ecf68647SHong Zhang if ((*ts)->forward_solve) { 2834ecf68647SHong Zhang ierr = TSForwardReset(*ts);CHKERRQ(ierr); 2835ecf68647SHong Zhang } 2836e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 2837e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 28386bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 28396d4c513bSLisandro Dalcin 2840bc952696SBarry Smith ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2841bc952696SBarry Smith 284284df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 28436427ac75SLisandro Dalcin ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr); 28446427ac75SLisandro Dalcin 28456bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 28466bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 28476bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 28480dd9f2efSHong Zhang ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr); 28496d4c513bSLisandro Dalcin 2850cd4cee2dSHong Zhang ierr = TSDestroy(&(*ts)->quadraturets);CHKERRQ(ierr); 2851a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2852d763cef2SBarry Smith PetscFunctionReturn(0); 2853d763cef2SBarry Smith } 2854d763cef2SBarry Smith 2855d8e5e3e6SSatish Balay /*@ 2856d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 2857d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 2858d763cef2SBarry Smith 2859d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 2860d763cef2SBarry Smith 2861d763cef2SBarry Smith Input Parameter: 2862d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2863d763cef2SBarry Smith 2864d763cef2SBarry Smith Output Parameter: 2865d763cef2SBarry Smith . snes - the nonlinear solver context 2866d763cef2SBarry Smith 2867d763cef2SBarry Smith Notes: 2868d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 2869d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 287094b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 2871d763cef2SBarry Smith 2872d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 28730298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 2874d763cef2SBarry Smith 2875d763cef2SBarry Smith Level: beginner 2876d763cef2SBarry Smith 2877d763cef2SBarry Smith @*/ 28787087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2879d763cef2SBarry Smith { 2880d372ba47SLisandro Dalcin PetscErrorCode ierr; 2881d372ba47SLisandro Dalcin 2882d763cef2SBarry Smith PetscFunctionBegin; 28830700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28844482741eSBarry Smith PetscValidPointer(snes,2); 2885d372ba47SLisandro Dalcin if (!ts->snes) { 2886ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 288716413a6aSBarry Smith ierr = PetscObjectSetOptions((PetscObject)ts->snes,((PetscObject)ts)->options);CHKERRQ(ierr); 28880298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 28893bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2890d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2891496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 28929e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 28939e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 28949e2a6581SJed Brown } 2895d372ba47SLisandro Dalcin } 2896d763cef2SBarry Smith *snes = ts->snes; 2897d763cef2SBarry Smith PetscFunctionReturn(0); 2898d763cef2SBarry Smith } 2899d763cef2SBarry Smith 2900deb2cd25SJed Brown /*@ 2901deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2902deb2cd25SJed Brown 2903deb2cd25SJed Brown Collective 2904deb2cd25SJed Brown 2905deb2cd25SJed Brown Input Parameter: 2906deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 2907deb2cd25SJed Brown - snes - the nonlinear solver context 2908deb2cd25SJed Brown 2909deb2cd25SJed Brown Notes: 2910deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 2911deb2cd25SJed Brown 2912deb2cd25SJed Brown Level: developer 2913deb2cd25SJed Brown 2914deb2cd25SJed Brown @*/ 2915deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 2916deb2cd25SJed Brown { 2917deb2cd25SJed Brown PetscErrorCode ierr; 2918d1e9a80fSBarry Smith PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2919deb2cd25SJed Brown 2920deb2cd25SJed Brown PetscFunctionBegin; 2921deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2922deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2923deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2924deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2925bbd56ea5SKarl Rupp 2926deb2cd25SJed Brown ts->snes = snes; 2927bbd56ea5SKarl Rupp 29280298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 29290298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2930740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 29310298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2932740132f1SEmil Constantinescu } 2933deb2cd25SJed Brown PetscFunctionReturn(0); 2934deb2cd25SJed Brown } 2935deb2cd25SJed Brown 2936d8e5e3e6SSatish Balay /*@ 293794b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 2938d763cef2SBarry Smith a TS (timestepper) context. 2939d763cef2SBarry Smith 294094b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 2941d763cef2SBarry Smith 2942d763cef2SBarry Smith Input Parameter: 2943d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2944d763cef2SBarry Smith 2945d763cef2SBarry Smith Output Parameter: 294694b7f48cSBarry Smith . ksp - the nonlinear solver context 2947d763cef2SBarry Smith 2948d763cef2SBarry Smith Notes: 294994b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 2950d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 2951d763cef2SBarry Smith KSP and PC contexts as well. 2952d763cef2SBarry Smith 295394b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 29540298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2955d763cef2SBarry Smith 2956d763cef2SBarry Smith Level: beginner 2957d763cef2SBarry Smith 2958d763cef2SBarry Smith @*/ 29597087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2960d763cef2SBarry Smith { 2961d372ba47SLisandro Dalcin PetscErrorCode ierr; 2962089b2837SJed Brown SNES snes; 2963d372ba47SLisandro Dalcin 2964d763cef2SBarry Smith PetscFunctionBegin; 29650700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 29664482741eSBarry Smith PetscValidPointer(ksp,2); 296717186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2968e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2969089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2970089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2971d763cef2SBarry Smith PetscFunctionReturn(0); 2972d763cef2SBarry Smith } 2973d763cef2SBarry Smith 2974d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2975d763cef2SBarry Smith 2976adb62b0dSMatthew Knepley /*@ 2977618ce8baSLisandro Dalcin TSSetMaxSteps - Sets the maximum number of steps to use. 2978618ce8baSLisandro Dalcin 2979618ce8baSLisandro Dalcin Logically Collective on TS 2980618ce8baSLisandro Dalcin 2981618ce8baSLisandro Dalcin Input Parameters: 2982618ce8baSLisandro Dalcin + ts - the TS context obtained from TSCreate() 2983618ce8baSLisandro Dalcin - maxsteps - maximum number of steps to use 2984618ce8baSLisandro Dalcin 2985618ce8baSLisandro Dalcin Options Database Keys: 2986618ce8baSLisandro Dalcin . -ts_max_steps <maxsteps> - Sets maxsteps 2987618ce8baSLisandro Dalcin 2988618ce8baSLisandro Dalcin Notes: 2989618ce8baSLisandro Dalcin The default maximum number of steps is 5000 2990618ce8baSLisandro Dalcin 2991618ce8baSLisandro Dalcin Level: intermediate 2992618ce8baSLisandro Dalcin 2993618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime() 2994618ce8baSLisandro Dalcin @*/ 2995618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps) 2996618ce8baSLisandro Dalcin { 2997618ce8baSLisandro Dalcin PetscFunctionBegin; 2998618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2999618ce8baSLisandro Dalcin PetscValidLogicalCollectiveInt(ts,maxsteps,2); 3000618ce8baSLisandro Dalcin if (maxsteps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative"); 3001618ce8baSLisandro Dalcin ts->max_steps = maxsteps; 3002618ce8baSLisandro Dalcin PetscFunctionReturn(0); 3003618ce8baSLisandro Dalcin } 3004618ce8baSLisandro Dalcin 3005618ce8baSLisandro Dalcin /*@ 3006618ce8baSLisandro Dalcin TSGetMaxSteps - Gets the maximum number of steps to use. 3007618ce8baSLisandro Dalcin 3008618ce8baSLisandro Dalcin Not Collective 3009618ce8baSLisandro Dalcin 3010618ce8baSLisandro Dalcin Input Parameters: 3011618ce8baSLisandro Dalcin . ts - the TS context obtained from TSCreate() 3012618ce8baSLisandro Dalcin 3013618ce8baSLisandro Dalcin Output Parameter: 3014618ce8baSLisandro Dalcin . maxsteps - maximum number of steps to use 3015618ce8baSLisandro Dalcin 3016618ce8baSLisandro Dalcin Level: advanced 3017618ce8baSLisandro Dalcin 3018618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime() 3019618ce8baSLisandro Dalcin @*/ 3020618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps) 3021618ce8baSLisandro Dalcin { 3022618ce8baSLisandro Dalcin PetscFunctionBegin; 3023618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3024618ce8baSLisandro Dalcin PetscValidIntPointer(maxsteps,2); 3025618ce8baSLisandro Dalcin *maxsteps = ts->max_steps; 3026618ce8baSLisandro Dalcin PetscFunctionReturn(0); 3027618ce8baSLisandro Dalcin } 3028618ce8baSLisandro Dalcin 3029618ce8baSLisandro Dalcin /*@ 3030618ce8baSLisandro Dalcin TSSetMaxTime - Sets the maximum (or final) time for timestepping. 3031618ce8baSLisandro Dalcin 3032618ce8baSLisandro Dalcin Logically Collective on TS 3033618ce8baSLisandro Dalcin 3034618ce8baSLisandro Dalcin Input Parameters: 3035618ce8baSLisandro Dalcin + ts - the TS context obtained from TSCreate() 3036618ce8baSLisandro Dalcin - maxtime - final time to step to 3037618ce8baSLisandro Dalcin 3038618ce8baSLisandro Dalcin Options Database Keys: 3039ef85077eSLisandro Dalcin . -ts_max_time <maxtime> - Sets maxtime 3040618ce8baSLisandro Dalcin 3041618ce8baSLisandro Dalcin Notes: 3042618ce8baSLisandro Dalcin The default maximum time is 5.0 3043618ce8baSLisandro Dalcin 3044618ce8baSLisandro Dalcin Level: intermediate 3045618ce8baSLisandro Dalcin 3046618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime() 3047618ce8baSLisandro Dalcin @*/ 3048618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime) 3049618ce8baSLisandro Dalcin { 3050618ce8baSLisandro Dalcin PetscFunctionBegin; 3051618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3052618ce8baSLisandro Dalcin PetscValidLogicalCollectiveReal(ts,maxtime,2); 3053618ce8baSLisandro Dalcin ts->max_time = maxtime; 3054618ce8baSLisandro Dalcin PetscFunctionReturn(0); 3055618ce8baSLisandro Dalcin } 3056618ce8baSLisandro Dalcin 3057618ce8baSLisandro Dalcin /*@ 3058618ce8baSLisandro Dalcin TSGetMaxTime - Gets the maximum (or final) time for timestepping. 3059618ce8baSLisandro Dalcin 3060618ce8baSLisandro Dalcin Not Collective 3061618ce8baSLisandro Dalcin 3062618ce8baSLisandro Dalcin Input Parameters: 3063618ce8baSLisandro Dalcin . ts - the TS context obtained from TSCreate() 3064618ce8baSLisandro Dalcin 3065618ce8baSLisandro Dalcin Output Parameter: 3066618ce8baSLisandro Dalcin . maxtime - final time to step to 3067618ce8baSLisandro Dalcin 3068618ce8baSLisandro Dalcin Level: advanced 3069618ce8baSLisandro Dalcin 3070618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps() 3071618ce8baSLisandro Dalcin @*/ 3072618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime) 3073618ce8baSLisandro Dalcin { 3074618ce8baSLisandro Dalcin PetscFunctionBegin; 3075618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3076618ce8baSLisandro Dalcin PetscValidRealPointer(maxtime,2); 3077618ce8baSLisandro Dalcin *maxtime = ts->max_time; 3078618ce8baSLisandro Dalcin PetscFunctionReturn(0); 3079618ce8baSLisandro Dalcin } 3080618ce8baSLisandro Dalcin 3081618ce8baSLisandro Dalcin /*@ 3082aaa6c58dSLisandro Dalcin TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep(). 3083edc382c3SSatish Balay 3084edc382c3SSatish Balay Level: deprecated 3085edc382c3SSatish Balay 3086aaa6c58dSLisandro Dalcin @*/ 3087aaa6c58dSLisandro Dalcin PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 3088aaa6c58dSLisandro Dalcin { 3089aaa6c58dSLisandro Dalcin PetscErrorCode ierr; 3090aaa6c58dSLisandro Dalcin PetscFunctionBegin; 3091aaa6c58dSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3092aaa6c58dSLisandro Dalcin ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 3093aaa6c58dSLisandro Dalcin ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 3094aaa6c58dSLisandro Dalcin PetscFunctionReturn(0); 3095aaa6c58dSLisandro Dalcin } 3096aaa6c58dSLisandro Dalcin 3097aaa6c58dSLisandro Dalcin /*@ 309819eac22cSLisandro Dalcin TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime(). 3099edc382c3SSatish Balay 3100edc382c3SSatish Balay Level: deprecated 3101edc382c3SSatish Balay 3102adb62b0dSMatthew Knepley @*/ 31037087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 3104adb62b0dSMatthew Knepley { 3105adb62b0dSMatthew Knepley PetscFunctionBegin; 31060700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3107abc0a331SBarry Smith if (maxsteps) { 31084482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 3109adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 3110adb62b0dSMatthew Knepley } 3111abc0a331SBarry Smith if (maxtime) { 31124482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 3113adb62b0dSMatthew Knepley *maxtime = ts->max_time; 3114adb62b0dSMatthew Knepley } 3115adb62b0dSMatthew Knepley PetscFunctionReturn(0); 3116adb62b0dSMatthew Knepley } 3117adb62b0dSMatthew Knepley 3118d763cef2SBarry Smith /*@ 311919eac22cSLisandro Dalcin TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime(). 3120edc382c3SSatish Balay 3121edc382c3SSatish Balay Level: deprecated 3122edc382c3SSatish Balay 3123d763cef2SBarry Smith @*/ 31247087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 3125d763cef2SBarry Smith { 3126d763cef2SBarry Smith PetscFunctionBegin; 31270700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3128c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 3129c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 313039b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 313139b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 3132d763cef2SBarry Smith PetscFunctionReturn(0); 3133d763cef2SBarry Smith } 3134d763cef2SBarry Smith 3135d763cef2SBarry Smith /*@ 31365c5f5948SLisandro Dalcin TSGetTimeStepNumber - Deprecated, use TSGetStepNumber(). 3137edc382c3SSatish Balay 3138edc382c3SSatish Balay Level: deprecated 3139edc382c3SSatish Balay 31405c5f5948SLisandro Dalcin @*/ 3141e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); } 31425c5f5948SLisandro Dalcin 314319eac22cSLisandro Dalcin /*@ 31444f4e0956SLisandro Dalcin TSGetTotalSteps - Deprecated, use TSGetStepNumber(). 3145edc382c3SSatish Balay 3146edc382c3SSatish Balay Level: deprecated 3147edc382c3SSatish Balay 31484f4e0956SLisandro Dalcin @*/ 31494f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); } 31504f4e0956SLisandro Dalcin 31514f4e0956SLisandro Dalcin /*@ 3152d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 3153d763cef2SBarry Smith for use by the TS routines. 3154d763cef2SBarry Smith 3155d083f849SBarry Smith Logically Collective on TS 3156d763cef2SBarry Smith 3157d763cef2SBarry Smith Input Parameters: 3158d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 31590910c330SBarry Smith - u - the solution vector 3160d763cef2SBarry Smith 3161d763cef2SBarry Smith Level: beginner 3162d763cef2SBarry Smith 31630ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate() 3164d763cef2SBarry Smith @*/ 31650910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 3166d763cef2SBarry Smith { 31678737fe31SLisandro Dalcin PetscErrorCode ierr; 3168496e6a7aSJed Brown DM dm; 31698737fe31SLisandro Dalcin 3170d763cef2SBarry Smith PetscFunctionBegin; 31710700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 31720910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 31730910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 31746bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 31750910c330SBarry Smith ts->vec_sol = u; 3176bbd56ea5SKarl Rupp 3177496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 31780910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 3179d763cef2SBarry Smith PetscFunctionReturn(0); 3180d763cef2SBarry Smith } 3181d763cef2SBarry Smith 3182ac226902SBarry Smith /*@C 3183000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 31843f2090d5SJed Brown called once at the beginning of each time step. 3185000e7ae3SMatthew Knepley 31863f9fe445SBarry Smith Logically Collective on TS 3187000e7ae3SMatthew Knepley 3188000e7ae3SMatthew Knepley Input Parameters: 3189000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3190000e7ae3SMatthew Knepley - func - The function 3191000e7ae3SMatthew Knepley 3192000e7ae3SMatthew Knepley Calling sequence of func: 31936bc98fa9SBarry Smith . PetscErrorCode func (TS ts); 3194000e7ae3SMatthew Knepley 3195000e7ae3SMatthew Knepley Level: intermediate 3196000e7ae3SMatthew Knepley 3197dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep() 3198000e7ae3SMatthew Knepley @*/ 31997087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 3200000e7ae3SMatthew Knepley { 3201000e7ae3SMatthew Knepley PetscFunctionBegin; 32020700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3203ae60f76fSBarry Smith ts->prestep = func; 3204000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3205000e7ae3SMatthew Knepley } 3206000e7ae3SMatthew Knepley 320709ee8438SJed Brown /*@ 32083f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 32093f2090d5SJed Brown 32103f2090d5SJed Brown Collective on TS 32113f2090d5SJed Brown 32123f2090d5SJed Brown Input Parameters: 32133f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 32143f2090d5SJed Brown 32153f2090d5SJed Brown Notes: 32163f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 32173f2090d5SJed Brown so most users would not generally call this routine themselves. 32183f2090d5SJed Brown 32193f2090d5SJed Brown Level: developer 32203f2090d5SJed Brown 32219be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 32223f2090d5SJed Brown @*/ 32237087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 32243f2090d5SJed Brown { 32253f2090d5SJed Brown PetscErrorCode ierr; 32263f2090d5SJed Brown 32273f2090d5SJed Brown PetscFunctionBegin; 32280700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3229ae60f76fSBarry Smith if (ts->prestep) { 32305efd42a4SStefano Zampini Vec U; 32315efd42a4SStefano Zampini PetscObjectState sprev,spost; 32325efd42a4SStefano Zampini 32335efd42a4SStefano Zampini ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 32345efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3235ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 32365efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3237dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 3238312ce896SJed Brown } 32393f2090d5SJed Brown PetscFunctionReturn(0); 32403f2090d5SJed Brown } 32413f2090d5SJed Brown 3242b8123daeSJed Brown /*@C 3243b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 3244b8123daeSJed Brown called once at the beginning of each stage. 3245b8123daeSJed Brown 3246b8123daeSJed Brown Logically Collective on TS 3247b8123daeSJed Brown 3248b8123daeSJed Brown Input Parameters: 3249b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 3250b8123daeSJed Brown - func - The function 3251b8123daeSJed Brown 3252b8123daeSJed Brown Calling sequence of func: 3253b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 3254b8123daeSJed Brown 3255b8123daeSJed Brown Level: intermediate 3256b8123daeSJed Brown 3257b8123daeSJed Brown Note: 3258b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 325980275a0aSLisandro Dalcin The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being 3260b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3261b8123daeSJed Brown 32629be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3263b8123daeSJed Brown @*/ 3264b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 3265b8123daeSJed Brown { 3266b8123daeSJed Brown PetscFunctionBegin; 3267b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3268ae60f76fSBarry Smith ts->prestage = func; 3269b8123daeSJed Brown PetscFunctionReturn(0); 3270b8123daeSJed Brown } 3271b8123daeSJed Brown 32729be3e283SDebojyoti Ghosh /*@C 32739be3e283SDebojyoti Ghosh TSSetPostStage - Sets the general-purpose function 32749be3e283SDebojyoti Ghosh called once at the end of each stage. 32759be3e283SDebojyoti Ghosh 32769be3e283SDebojyoti Ghosh Logically Collective on TS 32779be3e283SDebojyoti Ghosh 32789be3e283SDebojyoti Ghosh Input Parameters: 32799be3e283SDebojyoti Ghosh + ts - The TS context obtained from TSCreate() 32809be3e283SDebojyoti Ghosh - func - The function 32819be3e283SDebojyoti Ghosh 32829be3e283SDebojyoti Ghosh Calling sequence of func: 32839be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 32849be3e283SDebojyoti Ghosh 32859be3e283SDebojyoti Ghosh Level: intermediate 32869be3e283SDebojyoti Ghosh 32879be3e283SDebojyoti Ghosh Note: 32889be3e283SDebojyoti Ghosh There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 328980275a0aSLisandro Dalcin The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being 32909be3e283SDebojyoti Ghosh attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 32919be3e283SDebojyoti Ghosh 32929be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 32939be3e283SDebojyoti Ghosh @*/ 32949be3e283SDebojyoti Ghosh PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 32959be3e283SDebojyoti Ghosh { 32969be3e283SDebojyoti Ghosh PetscFunctionBegin; 32979be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts, TS_CLASSID,1); 32989be3e283SDebojyoti Ghosh ts->poststage = func; 32999be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 33009be3e283SDebojyoti Ghosh } 33019be3e283SDebojyoti Ghosh 3302c688d042SShri Abhyankar /*@C 3303c688d042SShri Abhyankar TSSetPostEvaluate - Sets the general-purpose function 3304c688d042SShri Abhyankar called once at the end of each step evaluation. 3305c688d042SShri Abhyankar 3306c688d042SShri Abhyankar Logically Collective on TS 3307c688d042SShri Abhyankar 3308c688d042SShri Abhyankar Input Parameters: 3309c688d042SShri Abhyankar + ts - The TS context obtained from TSCreate() 3310c688d042SShri Abhyankar - func - The function 3311c688d042SShri Abhyankar 3312c688d042SShri Abhyankar Calling sequence of func: 3313c688d042SShri Abhyankar . PetscErrorCode func(TS ts); 3314c688d042SShri Abhyankar 3315c688d042SShri Abhyankar Level: intermediate 3316c688d042SShri Abhyankar 3317c688d042SShri Abhyankar Note: 33181785ff2aSShri Abhyankar Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling 33191785ff2aSShri Abhyankar thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep() 3320e7e94ed4SShri Abhyankar may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step 3321e7e94ed4SShri Abhyankar solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step 3322e7e94ed4SShri Abhyankar with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime() 3323c688d042SShri Abhyankar 3324c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3325c688d042SShri Abhyankar @*/ 3326c688d042SShri Abhyankar PetscErrorCode TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS)) 3327c688d042SShri Abhyankar { 3328c688d042SShri Abhyankar PetscFunctionBegin; 3329c688d042SShri Abhyankar PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3330c688d042SShri Abhyankar ts->postevaluate = func; 3331c688d042SShri Abhyankar PetscFunctionReturn(0); 3332c688d042SShri Abhyankar } 3333c688d042SShri Abhyankar 3334b8123daeSJed Brown /*@ 3335b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 3336b8123daeSJed Brown 3337b8123daeSJed Brown Collective on TS 3338b8123daeSJed Brown 3339b8123daeSJed Brown Input Parameters: 3340b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 33419be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 3342b8123daeSJed Brown 3343b8123daeSJed Brown Notes: 3344b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 3345b8123daeSJed Brown most users would not generally call this routine themselves. 3346b8123daeSJed Brown 3347b8123daeSJed Brown Level: developer 3348b8123daeSJed Brown 33499be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3350b8123daeSJed Brown @*/ 3351b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 3352b8123daeSJed Brown { 3353b8123daeSJed Brown PetscFunctionBegin; 3354b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3355ae60f76fSBarry Smith if (ts->prestage) { 3356ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 3357b8123daeSJed Brown } 3358b8123daeSJed Brown PetscFunctionReturn(0); 3359b8123daeSJed Brown } 3360b8123daeSJed Brown 33619be3e283SDebojyoti Ghosh /*@ 33629be3e283SDebojyoti Ghosh TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 33639be3e283SDebojyoti Ghosh 33649be3e283SDebojyoti Ghosh Collective on TS 33659be3e283SDebojyoti Ghosh 33669be3e283SDebojyoti Ghosh Input Parameters: 33679be3e283SDebojyoti Ghosh . ts - The TS context obtained from TSCreate() 33689be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 33699be3e283SDebojyoti Ghosh stageindex - Stage number 33709be3e283SDebojyoti Ghosh Y - Array of vectors (of size = total number 33719be3e283SDebojyoti Ghosh of stages) with the stage solutions 33729be3e283SDebojyoti Ghosh 33739be3e283SDebojyoti Ghosh Notes: 33749be3e283SDebojyoti Ghosh TSPostStage() is typically used within time stepping implementations, 33759be3e283SDebojyoti Ghosh most users would not generally call this routine themselves. 33769be3e283SDebojyoti Ghosh 33779be3e283SDebojyoti Ghosh Level: developer 33789be3e283SDebojyoti Ghosh 33799be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 33809be3e283SDebojyoti Ghosh @*/ 33819be3e283SDebojyoti Ghosh PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 33829be3e283SDebojyoti Ghosh { 33839be3e283SDebojyoti Ghosh PetscFunctionBegin; 33849be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 33854beae5d8SLisandro Dalcin if (ts->poststage) { 33869be3e283SDebojyoti Ghosh PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 33879be3e283SDebojyoti Ghosh } 33889be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 33899be3e283SDebojyoti Ghosh } 33909be3e283SDebojyoti Ghosh 3391c688d042SShri Abhyankar /*@ 3392c688d042SShri Abhyankar TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate() 3393c688d042SShri Abhyankar 3394c688d042SShri Abhyankar Collective on TS 3395c688d042SShri Abhyankar 3396c688d042SShri Abhyankar Input Parameters: 3397c688d042SShri Abhyankar . ts - The TS context obtained from TSCreate() 3398c688d042SShri Abhyankar 3399c688d042SShri Abhyankar Notes: 3400c688d042SShri Abhyankar TSPostEvaluate() is typically used within time stepping implementations, 3401c688d042SShri Abhyankar most users would not generally call this routine themselves. 3402c688d042SShri Abhyankar 3403c688d042SShri Abhyankar Level: developer 3404c688d042SShri Abhyankar 3405c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep() 3406c688d042SShri Abhyankar @*/ 3407c688d042SShri Abhyankar PetscErrorCode TSPostEvaluate(TS ts) 3408c688d042SShri Abhyankar { 3409c688d042SShri Abhyankar PetscErrorCode ierr; 3410c688d042SShri Abhyankar 3411c688d042SShri Abhyankar PetscFunctionBegin; 3412c688d042SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3413c688d042SShri Abhyankar if (ts->postevaluate) { 3414dcb233daSLisandro Dalcin Vec U; 3415dcb233daSLisandro Dalcin PetscObjectState sprev,spost; 3416dcb233daSLisandro Dalcin 3417dcb233daSLisandro Dalcin ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 3418dcb233daSLisandro Dalcin ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3419c688d042SShri Abhyankar PetscStackCallStandard((*ts->postevaluate),(ts)); 3420dcb233daSLisandro Dalcin ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3421dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 3422c688d042SShri Abhyankar } 3423c688d042SShri Abhyankar PetscFunctionReturn(0); 3424c688d042SShri Abhyankar } 3425c688d042SShri Abhyankar 3426ac226902SBarry Smith /*@C 3427000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 34283f2090d5SJed Brown called once at the end of each time step. 3429000e7ae3SMatthew Knepley 34303f9fe445SBarry Smith Logically Collective on TS 3431000e7ae3SMatthew Knepley 3432000e7ae3SMatthew Knepley Input Parameters: 3433000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3434000e7ae3SMatthew Knepley - func - The function 3435000e7ae3SMatthew Knepley 3436000e7ae3SMatthew Knepley Calling sequence of func: 3437b8123daeSJed Brown $ func (TS ts); 3438000e7ae3SMatthew Knepley 34391785ff2aSShri Abhyankar Notes: 34401785ff2aSShri Abhyankar The function set by TSSetPostStep() is called after each successful step. The solution vector X 34411785ff2aSShri Abhyankar obtained by TSGetSolution() may be different than that computed at the step end if the event handler 34421785ff2aSShri Abhyankar locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead. 34431785ff2aSShri Abhyankar 3444000e7ae3SMatthew Knepley Level: intermediate 3445000e7ae3SMatthew Knepley 3446dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep() 3447000e7ae3SMatthew Knepley @*/ 34487087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 3449000e7ae3SMatthew Knepley { 3450000e7ae3SMatthew Knepley PetscFunctionBegin; 34510700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3452ae60f76fSBarry Smith ts->poststep = func; 3453000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3454000e7ae3SMatthew Knepley } 3455000e7ae3SMatthew Knepley 345609ee8438SJed Brown /*@ 34573f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 34583f2090d5SJed Brown 34593f2090d5SJed Brown Collective on TS 34603f2090d5SJed Brown 34613f2090d5SJed Brown Input Parameters: 34623f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 34633f2090d5SJed Brown 34643f2090d5SJed Brown Notes: 34653f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 34663f2090d5SJed Brown so most users would not generally call this routine themselves. 34673f2090d5SJed Brown 34683f2090d5SJed Brown Level: developer 34693f2090d5SJed Brown 34703f2090d5SJed Brown @*/ 34717087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 34723f2090d5SJed Brown { 34733f2090d5SJed Brown PetscErrorCode ierr; 34743f2090d5SJed Brown 34753f2090d5SJed Brown PetscFunctionBegin; 34760700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3477ae60f76fSBarry Smith if (ts->poststep) { 34785efd42a4SStefano Zampini Vec U; 34795efd42a4SStefano Zampini PetscObjectState sprev,spost; 34805efd42a4SStefano Zampini 34815efd42a4SStefano Zampini ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 34825efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3483ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 34845efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3485dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 348672ac3e02SJed Brown } 34873f2090d5SJed Brown PetscFunctionReturn(0); 34883f2090d5SJed Brown } 34893f2090d5SJed Brown 3490cd652676SJed Brown /*@ 3491cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3492cd652676SJed Brown 3493cd652676SJed Brown Collective on TS 3494cd652676SJed Brown 3495cd652676SJed Brown Input Argument: 3496cd652676SJed Brown + ts - time stepping context 3497cd652676SJed Brown - t - time to interpolate to 3498cd652676SJed Brown 3499cd652676SJed Brown Output Argument: 35000910c330SBarry Smith . U - state at given time 3501cd652676SJed Brown 3502cd652676SJed Brown Level: intermediate 3503cd652676SJed Brown 3504cd652676SJed Brown Developer Notes: 3505cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 3506cd652676SJed Brown 3507874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve() 3508cd652676SJed Brown @*/ 35090910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 3510cd652676SJed Brown { 3511cd652676SJed Brown PetscErrorCode ierr; 3512cd652676SJed Brown 3513cd652676SJed Brown PetscFunctionBegin; 3514cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3515b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3516be5899b3SLisandro Dalcin if (t < ts->ptime_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)ts->ptime_prev,(double)ts->ptime); 3517ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 35180910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 3519cd652676SJed Brown PetscFunctionReturn(0); 3520cd652676SJed Brown } 3521cd652676SJed Brown 3522d763cef2SBarry Smith /*@ 35236d9e5789SSean Farley TSStep - Steps one time step 3524d763cef2SBarry Smith 3525d763cef2SBarry Smith Collective on TS 3526d763cef2SBarry Smith 3527d763cef2SBarry Smith Input Parameter: 3528d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3529d763cef2SBarry Smith 353027829d71SBarry Smith Level: developer 3531d763cef2SBarry Smith 3532b8123daeSJed Brown Notes: 353327829d71SBarry Smith The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 353427829d71SBarry Smith 3535b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 3536b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3537b8123daeSJed Brown 353819eac22cSLisandro Dalcin This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the 353919eac22cSLisandro Dalcin time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 354025cb2221SBarry Smith 35419be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 3542d763cef2SBarry Smith @*/ 3543193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 3544d763cef2SBarry Smith { 3545dfbe8321SBarry Smith PetscErrorCode ierr; 3546fffbeea8SBarry Smith static PetscBool cite = PETSC_FALSE; 3547be5899b3SLisandro Dalcin PetscReal ptime; 3548d763cef2SBarry Smith 3549d763cef2SBarry Smith PetscFunctionBegin; 35500700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3551f1d62c27SHong Zhang ierr = PetscCitationsRegister("@article{tspaper,\n" 3552fffbeea8SBarry Smith " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3553f1d62c27SHong Zhang " author = {Abhyankar, Shrirang and Brown, Jed and Constantinescu, Emil and Ghosh, Debojyoti and Smith, Barry F. and Zhang, Hong},\n" 3554f1d62c27SHong Zhang " journal = {arXiv e-preprints},\n" 3555f1d62c27SHong Zhang " eprint = {1806.01437},\n" 3556f1d62c27SHong Zhang " archivePrefix = {arXiv},\n" 3557f1d62c27SHong Zhang " year = {2018}\n}\n",&cite);CHKERRQ(ierr); 3558fffbeea8SBarry Smith 3559d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 356068bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3561d405a339SMatthew Knepley 3562fc8dbba5SLisandro Dalcin if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3563ef85077eSLisandro Dalcin if (ts->max_time >= PETSC_MAX_REAL && ts->max_steps == PETSC_MAX_INT) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>"); 3564a6772fa2SLisandro Dalcin if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSStep()"); 3565be5899b3SLisandro Dalcin if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE"); 3566a6772fa2SLisandro Dalcin 3567be5899b3SLisandro Dalcin if (!ts->steps) ts->ptime_prev = ts->ptime; 3568be5899b3SLisandro Dalcin ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev; 35692808aa04SLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 3570fc8dbba5SLisandro Dalcin 3571d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3572193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 3573d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3574fc8dbba5SLisandro Dalcin 3575fc8dbba5SLisandro Dalcin if (ts->reason >= 0) { 3576be5899b3SLisandro Dalcin ts->ptime_prev = ptime; 35772808aa04SLisandro Dalcin ts->steps++; 3578be5899b3SLisandro Dalcin ts->steprollback = PETSC_FALSE; 357928d5b5d6SLisandro Dalcin ts->steprestart = PETSC_FALSE; 3580d2daff3dSHong Zhang } 3581fc8dbba5SLisandro Dalcin 3582fc8dbba5SLisandro Dalcin if (!ts->reason) { 358308c7845fSBarry Smith if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 358408c7845fSBarry Smith else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 358508c7845fSBarry Smith } 3586fc8dbba5SLisandro Dalcin 3587fc8dbba5SLisandro Dalcin if (ts->reason < 0 && ts->errorifstepfailed && ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 3588fc8dbba5SLisandro Dalcin if (ts->reason < 0 && ts->errorifstepfailed) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 358908c7845fSBarry Smith PetscFunctionReturn(0); 359008c7845fSBarry Smith } 359108c7845fSBarry Smith 359208c7845fSBarry Smith /*@ 35937cbde773SLisandro Dalcin TSEvaluateWLTE - Evaluate the weighted local truncation error norm 35947cbde773SLisandro Dalcin at the end of a time step with a given order of accuracy. 35957cbde773SLisandro Dalcin 35967cbde773SLisandro Dalcin Collective on TS 35977cbde773SLisandro Dalcin 35987cbde773SLisandro Dalcin Input Arguments: 35997cbde773SLisandro Dalcin + ts - time stepping context 36007cbde773SLisandro Dalcin . wnormtype - norm type, either NORM_2 or NORM_INFINITY 36017cbde773SLisandro Dalcin - order - optional, desired order for the error evaluation or PETSC_DECIDE 36027cbde773SLisandro Dalcin 36037cbde773SLisandro Dalcin Output Arguments: 36047cbde773SLisandro Dalcin + order - optional, the actual order of the error evaluation 36057cbde773SLisandro Dalcin - wlte - the weighted local truncation error norm 36067cbde773SLisandro Dalcin 36077cbde773SLisandro Dalcin Level: advanced 36087cbde773SLisandro Dalcin 36097cbde773SLisandro Dalcin Notes: 36107cbde773SLisandro Dalcin If the timestepper cannot evaluate the error in a particular step 36117cbde773SLisandro Dalcin (eg. in the first step or restart steps after event handling), 36127cbde773SLisandro Dalcin this routine returns wlte=-1.0 . 36137cbde773SLisandro Dalcin 36147cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm() 36157cbde773SLisandro Dalcin @*/ 36167cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte) 36177cbde773SLisandro Dalcin { 36187cbde773SLisandro Dalcin PetscErrorCode ierr; 36197cbde773SLisandro Dalcin 36207cbde773SLisandro Dalcin PetscFunctionBegin; 36217cbde773SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 36227cbde773SLisandro Dalcin PetscValidType(ts,1); 36237cbde773SLisandro Dalcin PetscValidLogicalCollectiveEnum(ts,wnormtype,4); 36247cbde773SLisandro Dalcin if (order) PetscValidIntPointer(order,3); 36257cbde773SLisandro Dalcin if (order) PetscValidLogicalCollectiveInt(ts,*order,3); 36267cbde773SLisandro Dalcin PetscValidRealPointer(wlte,4); 36277cbde773SLisandro Dalcin if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 36287cbde773SLisandro Dalcin if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name); 36297cbde773SLisandro Dalcin ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr); 36307cbde773SLisandro Dalcin PetscFunctionReturn(0); 36317cbde773SLisandro Dalcin } 36327cbde773SLisandro Dalcin 363305175c85SJed Brown /*@ 363405175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 363505175c85SJed Brown 36361c3436cfSJed Brown Collective on TS 363705175c85SJed Brown 363805175c85SJed Brown Input Arguments: 36391c3436cfSJed Brown + ts - time stepping context 36401c3436cfSJed Brown . order - desired order of accuracy 36410298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 364205175c85SJed Brown 364305175c85SJed Brown Output Arguments: 36440910c330SBarry Smith . U - state at the end of the current step 364505175c85SJed Brown 364605175c85SJed Brown Level: advanced 364705175c85SJed Brown 3648108c343cSJed Brown Notes: 3649108c343cSJed Brown This function cannot be called until all stages have been evaluated. 3650108c343cSJed Brown It is normally called by adaptive controllers before a step has been accepted and may also be called by the user after TSStep() has returned. 3651108c343cSJed Brown 36521c3436cfSJed Brown .seealso: TSStep(), TSAdapt 365305175c85SJed Brown @*/ 36540910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 365505175c85SJed Brown { 365605175c85SJed Brown PetscErrorCode ierr; 365705175c85SJed Brown 365805175c85SJed Brown PetscFunctionBegin; 365905175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 366005175c85SJed Brown PetscValidType(ts,1); 36610910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3662ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 36630910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 366405175c85SJed Brown PetscFunctionReturn(0); 366505175c85SJed Brown } 366605175c85SJed Brown 3667aad739acSMatthew G. Knepley /*@C 36682e61be88SMatthew G. Knepley TSGetComputeInitialCondition - Get the function used to automatically compute an initial condition for the timestepping. 3669aad739acSMatthew G. Knepley 3670aad739acSMatthew G. Knepley Not collective 3671aad739acSMatthew G. Knepley 3672aad739acSMatthew G. Knepley Input Argument: 3673aad739acSMatthew G. Knepley . ts - time stepping context 3674aad739acSMatthew G. Knepley 3675aad739acSMatthew G. Knepley Output Argument: 36762e61be88SMatthew G. Knepley . initConditions - The function which computes an initial condition 3677aad739acSMatthew G. Knepley 3678aad739acSMatthew G. Knepley Level: advanced 3679aad739acSMatthew G. Knepley 3680aad739acSMatthew G. Knepley Notes: 3681aad739acSMatthew G. Knepley The calling sequence for the function is 36822e61be88SMatthew G. Knepley $ initCondition(TS ts, Vec u) 3683aad739acSMatthew G. Knepley $ ts - The timestepping context 36842e61be88SMatthew G. Knepley $ u - The input vector in which the initial condition is stored 3685aad739acSMatthew G. Knepley 36862e61be88SMatthew G. Knepley .seealso: TSSetComputeInitialCondition(), TSComputeInitialCondition() 3687aad739acSMatthew G. Knepley @*/ 36882e61be88SMatthew G. Knepley PetscErrorCode TSGetComputeInitialCondition(TS ts, PetscErrorCode (**initCondition)(TS, Vec)) 3689aad739acSMatthew G. Knepley { 3690aad739acSMatthew G. Knepley PetscFunctionBegin; 3691aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 36922e61be88SMatthew G. Knepley PetscValidPointer(initCondition, 2); 36932e61be88SMatthew G. Knepley *initCondition = ts->ops->initcondition; 3694aad739acSMatthew G. Knepley PetscFunctionReturn(0); 3695aad739acSMatthew G. Knepley } 3696aad739acSMatthew G. Knepley 3697aad739acSMatthew G. Knepley /*@C 36982e61be88SMatthew G. Knepley TSSetComputeInitialCondition - Set the function used to automatically compute an initial condition for the timestepping. 3699aad739acSMatthew G. Knepley 3700aad739acSMatthew G. Knepley Logically collective on ts 3701aad739acSMatthew G. Knepley 3702aad739acSMatthew G. Knepley Input Arguments: 3703aad739acSMatthew G. Knepley + ts - time stepping context 37042e61be88SMatthew G. Knepley - initCondition - The function which computes an initial condition 3705aad739acSMatthew G. Knepley 3706aad739acSMatthew G. Knepley Level: advanced 3707aad739acSMatthew G. Knepley 3708a96d6ef6SBarry Smith Calling sequence for initCondition: 3709a96d6ef6SBarry Smith $ PetscErrorCode initCondition(TS ts, Vec u) 3710a96d6ef6SBarry Smith 3711a96d6ef6SBarry Smith + ts - The timestepping context 3712a96d6ef6SBarry Smith - u - The input vector in which the initial condition is to be stored 3713aad739acSMatthew G. Knepley 37142e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSComputeInitialCondition() 3715aad739acSMatthew G. Knepley @*/ 37162e61be88SMatthew G. Knepley PetscErrorCode TSSetComputeInitialCondition(TS ts, PetscErrorCode (*initCondition)(TS, Vec)) 3717aad739acSMatthew G. Knepley { 3718aad739acSMatthew G. Knepley PetscFunctionBegin; 3719aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 37202e61be88SMatthew G. Knepley PetscValidFunction(initCondition, 2); 37212e61be88SMatthew G. Knepley ts->ops->initcondition = initCondition; 3722aad739acSMatthew G. Knepley PetscFunctionReturn(0); 3723aad739acSMatthew G. Knepley } 3724aad739acSMatthew G. Knepley 3725aad739acSMatthew G. Knepley /*@ 37262e61be88SMatthew G. Knepley TSComputeInitialCondition - Compute an initial condition for the timestepping using the function previously set. 3727aad739acSMatthew G. Knepley 3728aad739acSMatthew G. Knepley Collective on ts 3729aad739acSMatthew G. Knepley 3730aad739acSMatthew G. Knepley Input Arguments: 3731aad739acSMatthew G. Knepley + ts - time stepping context 37322e61be88SMatthew G. Knepley - u - The Vec to store the condition in which will be used in TSSolve() 3733aad739acSMatthew G. Knepley 3734aad739acSMatthew G. Knepley Level: advanced 3735aad739acSMatthew G. Knepley 37362e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve() 3737aad739acSMatthew G. Knepley @*/ 37382e61be88SMatthew G. Knepley PetscErrorCode TSComputeInitialCondition(TS ts, Vec u) 3739aad739acSMatthew G. Knepley { 3740aad739acSMatthew G. Knepley PetscErrorCode ierr; 3741aad739acSMatthew G. Knepley 3742aad739acSMatthew G. Knepley PetscFunctionBegin; 3743aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3744aad739acSMatthew G. Knepley PetscValidHeaderSpecific(u, VEC_CLASSID, 2); 37452e61be88SMatthew G. Knepley if (ts->ops->initcondition) {ierr = (*ts->ops->initcondition)(ts, u);CHKERRQ(ierr);} 3746aad739acSMatthew G. Knepley PetscFunctionReturn(0); 3747aad739acSMatthew G. Knepley } 3748aad739acSMatthew G. Knepley 3749aad739acSMatthew G. Knepley /*@C 3750aad739acSMatthew G. Knepley TSGetComputeExactError - Get the function used to automatically compute the exact error for the timestepping. 3751aad739acSMatthew G. Knepley 3752aad739acSMatthew G. Knepley Not collective 3753aad739acSMatthew G. Knepley 3754aad739acSMatthew G. Knepley Input Argument: 3755aad739acSMatthew G. Knepley . ts - time stepping context 3756aad739acSMatthew G. Knepley 3757aad739acSMatthew G. Knepley Output Argument: 3758aad739acSMatthew G. Knepley . exactError - The function which computes the solution error 3759aad739acSMatthew G. Knepley 3760aad739acSMatthew G. Knepley Level: advanced 3761aad739acSMatthew G. Knepley 3762a96d6ef6SBarry Smith Calling sequence for exactError: 3763a96d6ef6SBarry Smith $ PetscErrorCode exactError(TS ts, Vec u) 3764a96d6ef6SBarry Smith 3765a96d6ef6SBarry Smith + ts - The timestepping context 3766a96d6ef6SBarry Smith . u - The approximate solution vector 3767a96d6ef6SBarry Smith - e - The input vector in which the error is stored 3768aad739acSMatthew G. Knepley 3769aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError() 3770aad739acSMatthew G. Knepley @*/ 3771aad739acSMatthew G. Knepley PetscErrorCode TSGetComputeExactError(TS ts, PetscErrorCode (**exactError)(TS, Vec, Vec)) 3772aad739acSMatthew G. Knepley { 3773aad739acSMatthew G. Knepley PetscFunctionBegin; 3774aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3775aad739acSMatthew G. Knepley PetscValidPointer(exactError, 2); 3776aad739acSMatthew G. Knepley *exactError = ts->ops->exacterror; 3777aad739acSMatthew G. Knepley PetscFunctionReturn(0); 3778aad739acSMatthew G. Knepley } 3779aad739acSMatthew G. Knepley 3780aad739acSMatthew G. Knepley /*@C 3781aad739acSMatthew G. Knepley TSSetComputeExactError - Set the function used to automatically compute the exact error for the timestepping. 3782aad739acSMatthew G. Knepley 3783aad739acSMatthew G. Knepley Logically collective on ts 3784aad739acSMatthew G. Knepley 3785aad739acSMatthew G. Knepley Input Arguments: 3786aad739acSMatthew G. Knepley + ts - time stepping context 3787aad739acSMatthew G. Knepley - exactError - The function which computes the solution error 3788aad739acSMatthew G. Knepley 3789aad739acSMatthew G. Knepley Level: advanced 3790aad739acSMatthew G. Knepley 3791a96d6ef6SBarry Smith Calling sequence for exactError: 3792a96d6ef6SBarry Smith $ PetscErrorCode exactError(TS ts, Vec u) 3793a96d6ef6SBarry Smith 3794a96d6ef6SBarry Smith + ts - The timestepping context 3795a96d6ef6SBarry Smith . u - The approximate solution vector 3796a96d6ef6SBarry Smith - e - The input vector in which the error is stored 3797aad739acSMatthew G. Knepley 3798aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError() 3799aad739acSMatthew G. Knepley @*/ 3800aad739acSMatthew G. Knepley PetscErrorCode TSSetComputeExactError(TS ts, PetscErrorCode (*exactError)(TS, Vec, Vec)) 3801aad739acSMatthew G. Knepley { 3802aad739acSMatthew G. Knepley PetscFunctionBegin; 3803aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3804f907fdbfSMatthew G. Knepley PetscValidFunction(exactError, 2); 3805aad739acSMatthew G. Knepley ts->ops->exacterror = exactError; 3806aad739acSMatthew G. Knepley PetscFunctionReturn(0); 3807aad739acSMatthew G. Knepley } 3808aad739acSMatthew G. Knepley 3809aad739acSMatthew G. Knepley /*@ 3810aad739acSMatthew G. Knepley TSComputeExactError - Compute the solution error for the timestepping using the function previously set. 3811aad739acSMatthew G. Knepley 3812aad739acSMatthew G. Knepley Collective on ts 3813aad739acSMatthew G. Knepley 3814aad739acSMatthew G. Knepley Input Arguments: 3815aad739acSMatthew G. Knepley + ts - time stepping context 3816aad739acSMatthew G. Knepley . u - The approximate solution 3817aad739acSMatthew G. Knepley - e - The Vec used to store the error 3818aad739acSMatthew G. Knepley 3819aad739acSMatthew G. Knepley Level: advanced 3820aad739acSMatthew G. Knepley 38212e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve() 3822aad739acSMatthew G. Knepley @*/ 3823aad739acSMatthew G. Knepley PetscErrorCode TSComputeExactError(TS ts, Vec u, Vec e) 3824aad739acSMatthew G. Knepley { 3825aad739acSMatthew G. Knepley PetscErrorCode ierr; 3826aad739acSMatthew G. Knepley 3827aad739acSMatthew G. Knepley PetscFunctionBegin; 3828aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3829aad739acSMatthew G. Knepley PetscValidHeaderSpecific(u, VEC_CLASSID, 2); 3830aad739acSMatthew G. Knepley PetscValidHeaderSpecific(e, VEC_CLASSID, 3); 3831aad739acSMatthew G. Knepley if (ts->ops->exacterror) {ierr = (*ts->ops->exacterror)(ts, u, e);CHKERRQ(ierr);} 3832aad739acSMatthew G. Knepley PetscFunctionReturn(0); 3833aad739acSMatthew G. Knepley } 3834aad739acSMatthew G. Knepley 3835b1cb36f3SHong Zhang /*@ 38366a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 38376a4d4014SLisandro Dalcin 38386a4d4014SLisandro Dalcin Collective on TS 38396a4d4014SLisandro Dalcin 38406a4d4014SLisandro Dalcin Input Parameter: 38416a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 384263e21af5SBarry Smith - u - the solution vector (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used, 384363e21af5SBarry Smith otherwise must contain the initial conditions and will contain the solution at the final requested time 38445a3a76d0SJed Brown 38456a4d4014SLisandro Dalcin Level: beginner 38466a4d4014SLisandro Dalcin 38475a3a76d0SJed Brown Notes: 38485a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 38495a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 38505a3a76d0SJed Brown stepped over the final time. 38515a3a76d0SJed Brown 385263e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime() 38536a4d4014SLisandro Dalcin @*/ 3854cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 38556a4d4014SLisandro Dalcin { 3856b06615a5SLisandro Dalcin Vec solution; 38576a4d4014SLisandro Dalcin PetscErrorCode ierr; 3858f22f69f0SBarry Smith 38596a4d4014SLisandro Dalcin PetscFunctionBegin; 38600700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3861f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 3862303a5415SBarry Smith 3863303a5415SBarry Smith ierr = TSSetExactFinalTimeDefault(ts);CHKERRQ(ierr); 3864ee41a567SStefano Zampini if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && u) { /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */ 38650910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 3866b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 3867b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 3868b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 38695a3a76d0SJed Brown } 38700910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 3871715f1b00SHong Zhang if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE"); 3872bbd56ea5SKarl Rupp } else if (u) { 38730910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 38745a3a76d0SJed Brown } 3875b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 387668bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3877a6772fa2SLisandro Dalcin 3878ef85077eSLisandro Dalcin if (ts->max_time >= PETSC_MAX_REAL && ts->max_steps == PETSC_MAX_INT) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>"); 3879a6772fa2SLisandro Dalcin if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSSolve()"); 3880a6772fa2SLisandro Dalcin if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE"); 3881a6772fa2SLisandro Dalcin 3882715f1b00SHong Zhang if (ts->forward_solve) { 3883715f1b00SHong Zhang ierr = TSForwardSetUp(ts);CHKERRQ(ierr); 3884715f1b00SHong Zhang } 3885715f1b00SHong Zhang 3886e7069c78SShri /* reset number of steps only when the step is not restarted. ARKIMEX 3887715f1b00SHong Zhang restarts the step after an event. Resetting these counters in such case causes 3888e7069c78SShri TSTrajectory to incorrectly save the output files 3889e7069c78SShri */ 3890715f1b00SHong Zhang /* reset time step and iteration counters */ 38912808aa04SLisandro Dalcin if (!ts->steps) { 38925ef26d82SJed Brown ts->ksp_its = 0; 38935ef26d82SJed Brown ts->snes_its = 0; 3894c610991cSLisandro Dalcin ts->num_snes_failures = 0; 3895c610991cSLisandro Dalcin ts->reject = 0; 38962808aa04SLisandro Dalcin ts->steprestart = PETSC_TRUE; 38972808aa04SLisandro Dalcin ts->steprollback = PETSC_FALSE; 38987d51462cSStefano Zampini ts->rhsjacobian.time = PETSC_MIN_REAL; 38992808aa04SLisandro Dalcin } 3900e97c63d7SStefano Zampini 3901e97c63d7SStefano Zampini /* make sure initial time step does not overshoot final time */ 3902e97c63d7SStefano Zampini if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP) { 3903e97c63d7SStefano Zampini PetscReal maxdt = ts->max_time-ts->ptime; 3904e97c63d7SStefano Zampini PetscReal dt = ts->time_step; 3905e97c63d7SStefano Zampini 3906e97c63d7SStefano Zampini ts->time_step = dt >= maxdt ? maxdt : (PetscIsCloseAtTol(dt,maxdt,10*PETSC_MACHINE_EPSILON,0) ? maxdt : dt); 3907e97c63d7SStefano Zampini } 3908193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 3909193ac0bcSJed Brown 3910900f6b5bSMatthew G. Knepley { 3911900f6b5bSMatthew G. Knepley PetscViewer viewer; 3912900f6b5bSMatthew G. Knepley PetscViewerFormat format; 3913900f6b5bSMatthew G. Knepley PetscBool flg; 3914900f6b5bSMatthew G. Knepley static PetscBool incall = PETSC_FALSE; 3915900f6b5bSMatthew G. Knepley 3916900f6b5bSMatthew G. Knepley if (!incall) { 3917900f6b5bSMatthew G. Knepley /* Estimate the convergence rate of the time discretization */ 3918900f6b5bSMatthew G. Knepley ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) ts),((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_estimate", &viewer, &format, &flg);CHKERRQ(ierr); 3919900f6b5bSMatthew G. Knepley if (flg) { 3920900f6b5bSMatthew G. Knepley PetscConvEst conv; 3921900f6b5bSMatthew G. Knepley DM dm; 3922900f6b5bSMatthew G. Knepley PetscReal *alpha; /* Convergence rate of the solution error for each field in the L_2 norm */ 3923900f6b5bSMatthew G. Knepley PetscInt Nf; 3924f2ed2dc7SMatthew G. Knepley PetscBool checkTemporal = PETSC_TRUE; 3925900f6b5bSMatthew G. Knepley 3926900f6b5bSMatthew G. Knepley incall = PETSC_TRUE; 3927f2ed2dc7SMatthew G. Knepley ierr = PetscOptionsGetBool(((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_temporal", &checkTemporal, &flg);CHKERRQ(ierr); 3928900f6b5bSMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 3929900f6b5bSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 3930900f6b5bSMatthew G. Knepley ierr = PetscCalloc1(PetscMax(Nf, 1), &alpha);CHKERRQ(ierr); 3931900f6b5bSMatthew G. Knepley ierr = PetscConvEstCreate(PetscObjectComm((PetscObject) ts), &conv);CHKERRQ(ierr); 3932f2ed2dc7SMatthew G. Knepley ierr = PetscConvEstUseTS(conv, checkTemporal);CHKERRQ(ierr); 3933900f6b5bSMatthew G. Knepley ierr = PetscConvEstSetSolver(conv, (PetscObject) ts);CHKERRQ(ierr); 3934900f6b5bSMatthew G. Knepley ierr = PetscConvEstSetFromOptions(conv);CHKERRQ(ierr); 3935900f6b5bSMatthew G. Knepley ierr = PetscConvEstSetUp(conv);CHKERRQ(ierr); 3936900f6b5bSMatthew G. Knepley ierr = PetscConvEstGetConvRate(conv, alpha);CHKERRQ(ierr); 3937900f6b5bSMatthew G. Knepley ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr); 3938900f6b5bSMatthew G. Knepley ierr = PetscConvEstRateView(conv, alpha, viewer);CHKERRQ(ierr); 3939900f6b5bSMatthew G. Knepley ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3940900f6b5bSMatthew G. Knepley ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 3941900f6b5bSMatthew G. Knepley ierr = PetscConvEstDestroy(&conv);CHKERRQ(ierr); 3942900f6b5bSMatthew G. Knepley ierr = PetscFree(alpha);CHKERRQ(ierr); 3943900f6b5bSMatthew G. Knepley incall = PETSC_FALSE; 3944900f6b5bSMatthew G. Knepley } 3945900f6b5bSMatthew G. Knepley } 3946900f6b5bSMatthew G. Knepley } 3947900f6b5bSMatthew G. Knepley 3948ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 3949f05ece33SBarry Smith 3950193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 3951193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 3952a6772fa2SLisandro Dalcin if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 3953cc708dedSBarry Smith ts->solvetime = ts->ptime; 3954a6772fa2SLisandro Dalcin solution = ts->vec_sol; 3955be5899b3SLisandro Dalcin } else { /* Step the requested number of timesteps. */ 3956db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 3957db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3958e7069c78SShri 39592808aa04SLisandro Dalcin if (!ts->steps) { 39602808aa04SLisandro Dalcin ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 39616427ac75SLisandro Dalcin ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 39622808aa04SLisandro Dalcin } 39636427ac75SLisandro Dalcin 3964e1a7a14fSJed Brown while (!ts->reason) { 39652808aa04SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 39669687d888SLisandro Dalcin if (!ts->steprollback) { 39679687d888SLisandro Dalcin ierr = TSPreStep(ts);CHKERRQ(ierr); 39689687d888SLisandro Dalcin } 3969193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 3970f3b1f45cSBarry Smith if (ts->testjacobian) { 3971f3b1f45cSBarry Smith ierr = TSRHSJacobianTest(ts,NULL);CHKERRQ(ierr); 3972f3b1f45cSBarry Smith } 3973f3b1f45cSBarry Smith if (ts->testjacobiantranspose) { 3974f3b1f45cSBarry Smith ierr = TSRHSJacobianTestTranspose(ts,NULL);CHKERRQ(ierr); 3975f3b1f45cSBarry Smith } 3976cd4cee2dSHong Zhang if (ts->quadraturets && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */ 39777b0e2f17SHong Zhang if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */ 3978b1cb36f3SHong Zhang ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr); 39797b0e2f17SHong Zhang if (ts->reason >= 0) ts->steps++; 3980b1cb36f3SHong Zhang } 398158818c2dSLisandro Dalcin if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */ 39827b0e2f17SHong Zhang if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */ 3983715f1b00SHong Zhang ierr = TSForwardStep(ts);CHKERRQ(ierr); 39847b0e2f17SHong Zhang if (ts->reason >= 0) ts->steps++; 3985715f1b00SHong Zhang } 398610b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 3987e783b05fSHong Zhang ierr = TSEventHandler(ts);CHKERRQ(ierr); /* The right-hand side may be changed due to event. Be careful with Any computation using the RHS information after this point. */ 398858818c2dSLisandro Dalcin if (ts->steprollback) { 398958818c2dSLisandro Dalcin ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 399058818c2dSLisandro Dalcin } 3991e783b05fSHong Zhang if (!ts->steprollback) { 39922808aa04SLisandro Dalcin ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 39931eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 3994aeb4809dSShri Abhyankar } 3995193ac0bcSJed Brown } 39962808aa04SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 39976427ac75SLisandro Dalcin 399849354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 39990910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 4000cc708dedSBarry Smith ts->solvetime = ts->max_time; 4001b06615a5SLisandro Dalcin solution = u; 400263e21af5SBarry Smith ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr); 40030574a7fbSJed Brown } else { 4004ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4005cc708dedSBarry Smith ts->solvetime = ts->ptime; 4006b06615a5SLisandro Dalcin solution = ts->vec_sol; 40070574a7fbSJed Brown } 4008193ac0bcSJed Brown } 4009d2daff3dSHong Zhang 4010ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 4011aee7a9fbSMatthew G. Knepley ierr = VecViewFromOptions(solution,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr); 401256f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 4013ef222394SBarry Smith if (ts->adjoint_solve) { 4014ef222394SBarry Smith ierr = TSAdjointSolve(ts);CHKERRQ(ierr); 40152b0a91c0SBarry Smith } 40166a4d4014SLisandro Dalcin PetscFunctionReturn(0); 40176a4d4014SLisandro Dalcin } 40186a4d4014SLisandro Dalcin 4019d763cef2SBarry Smith /*@ 4020b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 4021d763cef2SBarry Smith 4022d763cef2SBarry Smith Not Collective 4023d763cef2SBarry Smith 4024d763cef2SBarry Smith Input Parameter: 4025d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 4026d763cef2SBarry Smith 4027d763cef2SBarry Smith Output Parameter: 402819eac22cSLisandro Dalcin . t - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime(). 4029d763cef2SBarry Smith 4030d763cef2SBarry Smith Level: beginner 4031d763cef2SBarry Smith 4032b8123daeSJed Brown Note: 4033b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 40349be3e283SDebojyoti Ghosh TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 4035b8123daeSJed Brown 40368f199f4dSPatrick Sanan .seealso: TSGetSolveTime(), TSSetTime(), TSGetTimeStep(), TSGetStepNumber() 4037d763cef2SBarry Smith 4038d763cef2SBarry Smith @*/ 40397087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 4040d763cef2SBarry Smith { 4041d763cef2SBarry Smith PetscFunctionBegin; 40420700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4043f7cf8827SBarry Smith PetscValidRealPointer(t,2); 4044d763cef2SBarry Smith *t = ts->ptime; 4045d763cef2SBarry Smith PetscFunctionReturn(0); 4046d763cef2SBarry Smith } 4047d763cef2SBarry Smith 4048e5e524a1SHong Zhang /*@ 4049e5e524a1SHong Zhang TSGetPrevTime - Gets the starting time of the previously completed step. 4050e5e524a1SHong Zhang 4051e5e524a1SHong Zhang Not Collective 4052e5e524a1SHong Zhang 4053e5e524a1SHong Zhang Input Parameter: 4054e5e524a1SHong Zhang . ts - the TS context obtained from TSCreate() 4055e5e524a1SHong Zhang 4056e5e524a1SHong Zhang Output Parameter: 4057e5e524a1SHong Zhang . t - the previous time 4058e5e524a1SHong Zhang 4059e5e524a1SHong Zhang Level: beginner 4060e5e524a1SHong Zhang 4061aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep() 4062e5e524a1SHong Zhang 4063e5e524a1SHong Zhang @*/ 4064e5e524a1SHong Zhang PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 4065e5e524a1SHong Zhang { 4066e5e524a1SHong Zhang PetscFunctionBegin; 4067e5e524a1SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4068e5e524a1SHong Zhang PetscValidRealPointer(t,2); 4069e5e524a1SHong Zhang *t = ts->ptime_prev; 4070e5e524a1SHong Zhang PetscFunctionReturn(0); 4071e5e524a1SHong Zhang } 4072e5e524a1SHong Zhang 40736a4d4014SLisandro Dalcin /*@ 40746a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 40756a4d4014SLisandro Dalcin 40763f9fe445SBarry Smith Logically Collective on TS 40776a4d4014SLisandro Dalcin 40786a4d4014SLisandro Dalcin Input Parameters: 40796a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 40806a4d4014SLisandro Dalcin - time - the time 40816a4d4014SLisandro Dalcin 40826a4d4014SLisandro Dalcin Level: intermediate 40836a4d4014SLisandro Dalcin 408419eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps() 40856a4d4014SLisandro Dalcin 40866a4d4014SLisandro Dalcin @*/ 40877087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 40886a4d4014SLisandro Dalcin { 40896a4d4014SLisandro Dalcin PetscFunctionBegin; 40900700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4091c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 40926a4d4014SLisandro Dalcin ts->ptime = t; 40936a4d4014SLisandro Dalcin PetscFunctionReturn(0); 40946a4d4014SLisandro Dalcin } 40956a4d4014SLisandro Dalcin 4096d763cef2SBarry Smith /*@C 4097d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 4098d763cef2SBarry Smith TS options in the database. 4099d763cef2SBarry Smith 41003f9fe445SBarry Smith Logically Collective on TS 4101d763cef2SBarry Smith 4102d763cef2SBarry Smith Input Parameter: 4103d763cef2SBarry Smith + ts - The TS context 4104d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4105d763cef2SBarry Smith 4106d763cef2SBarry Smith Notes: 4107d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4108d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4109d763cef2SBarry Smith hyphen. 4110d763cef2SBarry Smith 4111d763cef2SBarry Smith Level: advanced 4112d763cef2SBarry Smith 4113d763cef2SBarry Smith .seealso: TSSetFromOptions() 4114d763cef2SBarry Smith 4115d763cef2SBarry Smith @*/ 41167087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 4117d763cef2SBarry Smith { 4118dfbe8321SBarry Smith PetscErrorCode ierr; 4119089b2837SJed Brown SNES snes; 4120d763cef2SBarry Smith 4121d763cef2SBarry Smith PetscFunctionBegin; 41220700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4123d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4124089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4125089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4126d763cef2SBarry Smith PetscFunctionReturn(0); 4127d763cef2SBarry Smith } 4128d763cef2SBarry Smith 4129d763cef2SBarry Smith /*@C 4130d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 4131d763cef2SBarry Smith TS options in the database. 4132d763cef2SBarry Smith 41333f9fe445SBarry Smith Logically Collective on TS 4134d763cef2SBarry Smith 4135d763cef2SBarry Smith Input Parameter: 4136d763cef2SBarry Smith + ts - The TS context 4137d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4138d763cef2SBarry Smith 4139d763cef2SBarry Smith Notes: 4140d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4141d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4142d763cef2SBarry Smith hyphen. 4143d763cef2SBarry Smith 4144d763cef2SBarry Smith Level: advanced 4145d763cef2SBarry Smith 4146d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 4147d763cef2SBarry Smith 4148d763cef2SBarry Smith @*/ 41497087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 4150d763cef2SBarry Smith { 4151dfbe8321SBarry Smith PetscErrorCode ierr; 4152089b2837SJed Brown SNES snes; 4153d763cef2SBarry Smith 4154d763cef2SBarry Smith PetscFunctionBegin; 41550700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4156d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4157089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4158089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4159d763cef2SBarry Smith PetscFunctionReturn(0); 4160d763cef2SBarry Smith } 4161d763cef2SBarry Smith 4162d763cef2SBarry Smith /*@C 4163d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 4164d763cef2SBarry Smith TS options in the database. 4165d763cef2SBarry Smith 4166d763cef2SBarry Smith Not Collective 4167d763cef2SBarry Smith 4168d763cef2SBarry Smith Input Parameter: 4169d763cef2SBarry Smith . ts - The TS context 4170d763cef2SBarry Smith 4171d763cef2SBarry Smith Output Parameter: 4172d763cef2SBarry Smith . prefix - A pointer to the prefix string used 4173d763cef2SBarry Smith 417495452b02SPatrick Sanan Notes: 417595452b02SPatrick Sanan On the fortran side, the user should pass in a string 'prifix' of 4176d763cef2SBarry Smith sufficient length to hold the prefix. 4177d763cef2SBarry Smith 4178d763cef2SBarry Smith Level: intermediate 4179d763cef2SBarry Smith 4180d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 4181d763cef2SBarry Smith @*/ 41827087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 4183d763cef2SBarry Smith { 4184dfbe8321SBarry Smith PetscErrorCode ierr; 4185d763cef2SBarry Smith 4186d763cef2SBarry Smith PetscFunctionBegin; 41870700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 41884482741eSBarry Smith PetscValidPointer(prefix,2); 4189d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4190d763cef2SBarry Smith PetscFunctionReturn(0); 4191d763cef2SBarry Smith } 4192d763cef2SBarry Smith 4193d763cef2SBarry Smith /*@C 4194d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 4195d763cef2SBarry Smith 4196d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 4197d763cef2SBarry Smith 4198d763cef2SBarry Smith Input Parameter: 4199d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 4200d763cef2SBarry Smith 4201d763cef2SBarry Smith Output Parameters: 4202e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 4203e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 4204e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 4205e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 4206d763cef2SBarry Smith 420795452b02SPatrick Sanan Notes: 420895452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 4209d763cef2SBarry Smith 4210d763cef2SBarry Smith Level: intermediate 4211d763cef2SBarry Smith 421280275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 4213d763cef2SBarry Smith 4214d763cef2SBarry Smith @*/ 4215e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 4216d763cef2SBarry Smith { 4217089b2837SJed Brown PetscErrorCode ierr; 421824989b8cSPeter Brune DM dm; 4219089b2837SJed Brown 4220d763cef2SBarry Smith PetscFunctionBegin; 422123a57915SBarry Smith if (Amat || Pmat) { 422223a57915SBarry Smith SNES snes; 4223089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 422423a57915SBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4225e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 422623a57915SBarry Smith } 422724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 422824989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 4229d763cef2SBarry Smith PetscFunctionReturn(0); 4230d763cef2SBarry Smith } 4231d763cef2SBarry Smith 42322eca1d9cSJed Brown /*@C 42332eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 42342eca1d9cSJed Brown 42352eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 42362eca1d9cSJed Brown 42372eca1d9cSJed Brown Input Parameter: 42382eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 42392eca1d9cSJed Brown 42402eca1d9cSJed Brown Output Parameters: 4241e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 4242e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 42432eca1d9cSJed Brown . f - The function to compute the matrices 42442eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 42452eca1d9cSJed Brown 424695452b02SPatrick Sanan Notes: 424795452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 42482eca1d9cSJed Brown 42492eca1d9cSJed Brown Level: advanced 42502eca1d9cSJed Brown 425180275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 42522eca1d9cSJed Brown 42532eca1d9cSJed Brown @*/ 4254e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 42552eca1d9cSJed Brown { 4256089b2837SJed Brown PetscErrorCode ierr; 425724989b8cSPeter Brune DM dm; 42580910c330SBarry Smith 42592eca1d9cSJed Brown PetscFunctionBegin; 4260c0aab802Sstefano_zampini if (Amat || Pmat) { 4261c0aab802Sstefano_zampini SNES snes; 4262089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4263f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4264e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4265c0aab802Sstefano_zampini } 426624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 426724989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 42682eca1d9cSJed Brown PetscFunctionReturn(0); 42692eca1d9cSJed Brown } 42702eca1d9cSJed Brown 4271af0996ceSBarry Smith #include <petsc/private/dmimpl.h> 42726c699258SBarry Smith /*@ 42732a808120SBarry Smith TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS 42746c699258SBarry Smith 4275d083f849SBarry Smith Logically Collective on ts 42766c699258SBarry Smith 42776c699258SBarry Smith Input Parameters: 42782a808120SBarry Smith + ts - the ODE integrator object 42792a808120SBarry Smith - dm - the dm, cannot be NULL 42806c699258SBarry Smith 4281e03a659cSJed Brown Notes: 4282e03a659cSJed Brown A DM can only be used for solving one problem at a time because information about the problem is stored on the DM, 4283e03a659cSJed Brown even when not using interfaces like DMTSSetIFunction(). Use DMClone() to get a distinct DM when solving 4284e03a659cSJed Brown different problems using the same function space. 4285e03a659cSJed Brown 42866c699258SBarry Smith Level: intermediate 42876c699258SBarry Smith 42886c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 42896c699258SBarry Smith @*/ 42907087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 42916c699258SBarry Smith { 42926c699258SBarry Smith PetscErrorCode ierr; 4293089b2837SJed Brown SNES snes; 4294942e3340SBarry Smith DMTS tsdm; 42956c699258SBarry Smith 42966c699258SBarry Smith PetscFunctionBegin; 42970700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 42982a808120SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,2); 429970663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 4300942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 43012a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 4302942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 4303942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 430424989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 430524989b8cSPeter Brune tsdm->originaldm = dm; 430624989b8cSPeter Brune } 430724989b8cSPeter Brune } 43086bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 430924989b8cSPeter Brune } 43106c699258SBarry Smith ts->dm = dm; 4311bbd56ea5SKarl Rupp 4312089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4313089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 43146c699258SBarry Smith PetscFunctionReturn(0); 43156c699258SBarry Smith } 43166c699258SBarry Smith 43176c699258SBarry Smith /*@ 43186c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 43196c699258SBarry Smith 43203f9fe445SBarry Smith Not Collective 43216c699258SBarry Smith 43226c699258SBarry Smith Input Parameter: 43236c699258SBarry Smith . ts - the preconditioner context 43246c699258SBarry Smith 43256c699258SBarry Smith Output Parameter: 43266c699258SBarry Smith . dm - the dm 43276c699258SBarry Smith 43286c699258SBarry Smith Level: intermediate 43296c699258SBarry Smith 43306c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 43316c699258SBarry Smith @*/ 43327087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 43336c699258SBarry Smith { 4334496e6a7aSJed Brown PetscErrorCode ierr; 4335496e6a7aSJed Brown 43366c699258SBarry Smith PetscFunctionBegin; 43370700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4338496e6a7aSJed Brown if (!ts->dm) { 4339ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 4340496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 4341496e6a7aSJed Brown } 43426c699258SBarry Smith *dm = ts->dm; 43436c699258SBarry Smith PetscFunctionReturn(0); 43446c699258SBarry Smith } 43451713a123SBarry Smith 43460f5c6efeSJed Brown /*@ 43470f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 43480f5c6efeSJed Brown 43493f9fe445SBarry Smith Logically Collective on SNES 43500f5c6efeSJed Brown 43510f5c6efeSJed Brown Input Parameter: 4352d42a1c89SJed Brown + snes - nonlinear solver 43530910c330SBarry Smith . U - the current state at which to evaluate the residual 4354d42a1c89SJed Brown - ctx - user context, must be a TS 43550f5c6efeSJed Brown 43560f5c6efeSJed Brown Output Parameter: 43570f5c6efeSJed Brown . F - the nonlinear residual 43580f5c6efeSJed Brown 43590f5c6efeSJed Brown Notes: 43600f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 43610f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 43620f5c6efeSJed Brown 43630f5c6efeSJed Brown Level: advanced 43640f5c6efeSJed Brown 43650f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 43660f5c6efeSJed Brown @*/ 43670910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 43680f5c6efeSJed Brown { 43690f5c6efeSJed Brown TS ts = (TS)ctx; 43700f5c6efeSJed Brown PetscErrorCode ierr; 43710f5c6efeSJed Brown 43720f5c6efeSJed Brown PetscFunctionBegin; 43730f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 43740910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 43750f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 43760f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 43770910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 43780f5c6efeSJed Brown PetscFunctionReturn(0); 43790f5c6efeSJed Brown } 43800f5c6efeSJed Brown 43810f5c6efeSJed Brown /*@ 43820f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 43830f5c6efeSJed Brown 43840f5c6efeSJed Brown Collective on SNES 43850f5c6efeSJed Brown 43860f5c6efeSJed Brown Input Parameter: 43870f5c6efeSJed Brown + snes - nonlinear solver 43880910c330SBarry Smith . U - the current state at which to evaluate the residual 43890f5c6efeSJed Brown - ctx - user context, must be a TS 43900f5c6efeSJed Brown 43910f5c6efeSJed Brown Output Parameter: 43920f5c6efeSJed Brown + A - the Jacobian 43930f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 43940f5c6efeSJed Brown - flag - indicates any structure change in the matrix 43950f5c6efeSJed Brown 43960f5c6efeSJed Brown Notes: 43970f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 43980f5c6efeSJed Brown 43990f5c6efeSJed Brown Level: developer 44000f5c6efeSJed Brown 44010f5c6efeSJed Brown .seealso: SNESSetJacobian() 44020f5c6efeSJed Brown @*/ 4403d1e9a80fSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 44040f5c6efeSJed Brown { 44050f5c6efeSJed Brown TS ts = (TS)ctx; 44060f5c6efeSJed Brown PetscErrorCode ierr; 44070f5c6efeSJed Brown 44080f5c6efeSJed Brown PetscFunctionBegin; 44090f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 44100910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 44110f5c6efeSJed Brown PetscValidPointer(A,3); 441294ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,3); 44130f5c6efeSJed Brown PetscValidPointer(B,4); 441494ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,4); 44150f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 4416d1e9a80fSBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 44170f5c6efeSJed Brown PetscFunctionReturn(0); 44180f5c6efeSJed Brown } 4419325fc9f4SBarry Smith 44200e4ef248SJed Brown /*@C 44219ae8fd06SBarry Smith TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only 44220e4ef248SJed Brown 44230e4ef248SJed Brown Collective on TS 44240e4ef248SJed Brown 44250e4ef248SJed Brown Input Arguments: 44260e4ef248SJed Brown + ts - time stepping context 44270e4ef248SJed Brown . t - time at which to evaluate 44280910c330SBarry Smith . U - state at which to evaluate 44290e4ef248SJed Brown - ctx - context 44300e4ef248SJed Brown 44310e4ef248SJed Brown Output Arguments: 44320e4ef248SJed Brown . F - right hand side 44330e4ef248SJed Brown 44340e4ef248SJed Brown Level: intermediate 44350e4ef248SJed Brown 44360e4ef248SJed Brown Notes: 44370e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 44380e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 44390e4ef248SJed Brown 44400e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 44410e4ef248SJed Brown @*/ 44420910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 44430e4ef248SJed Brown { 44440e4ef248SJed Brown PetscErrorCode ierr; 44450e4ef248SJed Brown Mat Arhs,Brhs; 44460e4ef248SJed Brown 44470e4ef248SJed Brown PetscFunctionBegin; 44480e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 44492663174eSHong Zhang /* undo the damage caused by shifting */ 4450cfa8a9a2SHong Zhang ierr = TSRecoverRHSJacobian(ts,Arhs,Brhs);CHKERRQ(ierr); 4451d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 44520910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 44530e4ef248SJed Brown PetscFunctionReturn(0); 44540e4ef248SJed Brown } 44550e4ef248SJed Brown 44560e4ef248SJed Brown /*@C 44570e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 44580e4ef248SJed Brown 44590e4ef248SJed Brown Collective on TS 44600e4ef248SJed Brown 44610e4ef248SJed Brown Input Arguments: 44620e4ef248SJed Brown + ts - time stepping context 44630e4ef248SJed Brown . t - time at which to evaluate 44640910c330SBarry Smith . U - state at which to evaluate 44650e4ef248SJed Brown - ctx - context 44660e4ef248SJed Brown 44670e4ef248SJed Brown Output Arguments: 44680e4ef248SJed Brown + A - pointer to operator 44690e4ef248SJed Brown . B - pointer to preconditioning matrix 44700e4ef248SJed Brown - flg - matrix structure flag 44710e4ef248SJed Brown 44720e4ef248SJed Brown Level: intermediate 44730e4ef248SJed Brown 44740e4ef248SJed Brown Notes: 44750e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 44760e4ef248SJed Brown 44770e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 44780e4ef248SJed Brown @*/ 4479d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 44800e4ef248SJed Brown { 44810e4ef248SJed Brown PetscFunctionBegin; 44820e4ef248SJed Brown PetscFunctionReturn(0); 44830e4ef248SJed Brown } 44840e4ef248SJed Brown 44850026cea9SSean Farley /*@C 44860026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 44870026cea9SSean Farley 44880026cea9SSean Farley Collective on TS 44890026cea9SSean Farley 44900026cea9SSean Farley Input Arguments: 44910026cea9SSean Farley + ts - time stepping context 44920026cea9SSean Farley . t - time at which to evaluate 44930910c330SBarry Smith . U - state at which to evaluate 44940910c330SBarry Smith . Udot - time derivative of state vector 44950026cea9SSean Farley - ctx - context 44960026cea9SSean Farley 44970026cea9SSean Farley Output Arguments: 44980026cea9SSean Farley . F - left hand side 44990026cea9SSean Farley 45000026cea9SSean Farley Level: intermediate 45010026cea9SSean Farley 45020026cea9SSean Farley Notes: 45030910c330SBarry Smith The assumption here is that the left hand side is of the form A*Udot (and not A*Udot + B*U). For other cases, the 45040026cea9SSean Farley user is required to write their own TSComputeIFunction. 45050026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 45060026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 45070026cea9SSean Farley 45089ae8fd06SBarry Smith Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U 45099ae8fd06SBarry Smith 45109ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear() 45110026cea9SSean Farley @*/ 45120910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 45130026cea9SSean Farley { 45140026cea9SSean Farley PetscErrorCode ierr; 45150026cea9SSean Farley Mat A,B; 45160026cea9SSean Farley 45170026cea9SSean Farley PetscFunctionBegin; 45180298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 4519d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 45200910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 45210026cea9SSean Farley PetscFunctionReturn(0); 45220026cea9SSean Farley } 45230026cea9SSean Farley 45240026cea9SSean Farley /*@C 4525b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 45260026cea9SSean Farley 45270026cea9SSean Farley Collective on TS 45280026cea9SSean Farley 45290026cea9SSean Farley Input Arguments: 45300026cea9SSean Farley + ts - time stepping context 45310026cea9SSean Farley . t - time at which to evaluate 45320910c330SBarry Smith . U - state at which to evaluate 45330910c330SBarry Smith . Udot - time derivative of state vector 45340026cea9SSean Farley . shift - shift to apply 45350026cea9SSean Farley - ctx - context 45360026cea9SSean Farley 45370026cea9SSean Farley Output Arguments: 45380026cea9SSean Farley + A - pointer to operator 45390026cea9SSean Farley . B - pointer to preconditioning matrix 45400026cea9SSean Farley - flg - matrix structure flag 45410026cea9SSean Farley 4542b41af12eSJed Brown Level: advanced 45430026cea9SSean Farley 45440026cea9SSean Farley Notes: 45450026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 45460026cea9SSean Farley 4547b41af12eSJed Brown It is only appropriate for problems of the form 4548b41af12eSJed Brown 4549b41af12eSJed Brown $ M Udot = F(U,t) 4550b41af12eSJed Brown 4551b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 4552b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 4553b41af12eSJed Brown an implicit operator of the form 4554b41af12eSJed Brown 4555b41af12eSJed Brown $ shift*M + J 4556b41af12eSJed Brown 4557b41af12eSJed Brown where J is the Jacobian of -F(U). Support may be added in a future version of PETSc, but for now, the user must store 4558b41af12eSJed Brown a copy of M or reassemble it when requested. 4559b41af12eSJed Brown 45600026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 45610026cea9SSean Farley @*/ 4562d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 45630026cea9SSean Farley { 4564b41af12eSJed Brown PetscErrorCode ierr; 4565b41af12eSJed Brown 45660026cea9SSean Farley PetscFunctionBegin; 456794ab13aaSBarry Smith ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 4568b41af12eSJed Brown ts->ijacobian.shift = shift; 45690026cea9SSean Farley PetscFunctionReturn(0); 45700026cea9SSean Farley } 4571b41af12eSJed Brown 4572e817cc15SEmil Constantinescu /*@ 4573e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 4574e817cc15SEmil Constantinescu 4575e817cc15SEmil Constantinescu Not Collective 4576e817cc15SEmil Constantinescu 4577e817cc15SEmil Constantinescu Input Parameter: 4578e817cc15SEmil Constantinescu . ts - the TS context 4579e817cc15SEmil Constantinescu 4580e817cc15SEmil Constantinescu Output Parameter: 45814e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 4582e817cc15SEmil Constantinescu 4583e817cc15SEmil Constantinescu Level: beginner 4584e817cc15SEmil Constantinescu 4585e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 4586e817cc15SEmil Constantinescu @*/ 4587e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 4588e817cc15SEmil Constantinescu { 4589e817cc15SEmil Constantinescu PetscFunctionBegin; 4590e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4591e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 4592e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 4593e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4594e817cc15SEmil Constantinescu } 4595e817cc15SEmil Constantinescu 4596e817cc15SEmil Constantinescu /*@ 4597e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 4598e817cc15SEmil Constantinescu 4599e817cc15SEmil Constantinescu Not Collective 4600e817cc15SEmil Constantinescu 4601e817cc15SEmil Constantinescu Input Parameter: 4602e817cc15SEmil Constantinescu + ts - the TS context 46031297b224SEmil Constantinescu - equation_type - see TSEquationType 4604e817cc15SEmil Constantinescu 4605e817cc15SEmil Constantinescu Level: advanced 4606e817cc15SEmil Constantinescu 4607e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 4608e817cc15SEmil Constantinescu @*/ 4609e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 4610e817cc15SEmil Constantinescu { 4611e817cc15SEmil Constantinescu PetscFunctionBegin; 4612e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4613e817cc15SEmil Constantinescu ts->equation_type = equation_type; 4614e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4615e817cc15SEmil Constantinescu } 46160026cea9SSean Farley 46174af1b03aSJed Brown /*@ 46184af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 46194af1b03aSJed Brown 46204af1b03aSJed Brown Not Collective 46214af1b03aSJed Brown 46224af1b03aSJed Brown Input Parameter: 46234af1b03aSJed Brown . ts - the TS context 46244af1b03aSJed Brown 46254af1b03aSJed Brown Output Parameter: 46264af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 46274af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 46284af1b03aSJed Brown 4629487e0bb9SJed Brown Level: beginner 46304af1b03aSJed Brown 4631cd652676SJed Brown Notes: 4632cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 46334af1b03aSJed Brown 46344af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 46354af1b03aSJed Brown @*/ 46364af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 46374af1b03aSJed Brown { 46384af1b03aSJed Brown PetscFunctionBegin; 46394af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 46404af1b03aSJed Brown PetscValidPointer(reason,2); 46414af1b03aSJed Brown *reason = ts->reason; 46424af1b03aSJed Brown PetscFunctionReturn(0); 46434af1b03aSJed Brown } 46444af1b03aSJed Brown 4645d6ad946cSShri Abhyankar /*@ 4646d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 4647d6ad946cSShri Abhyankar 46486b221cbeSPatrick Sanan Logically Collective; reason must contain common value 4649d6ad946cSShri Abhyankar 46506b221cbeSPatrick Sanan Input Parameters: 4651d6ad946cSShri Abhyankar + ts - the TS context 46526b221cbeSPatrick Sanan - reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 4653d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 4654d6ad946cSShri Abhyankar 4655f5abba47SShri Abhyankar Level: advanced 4656d6ad946cSShri Abhyankar 4657d6ad946cSShri Abhyankar Notes: 46586b221cbeSPatrick Sanan Can only be called while TSSolve() is active. 4659d6ad946cSShri Abhyankar 4660d6ad946cSShri Abhyankar .seealso: TSConvergedReason 4661d6ad946cSShri Abhyankar @*/ 4662d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 4663d6ad946cSShri Abhyankar { 4664d6ad946cSShri Abhyankar PetscFunctionBegin; 4665d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4666d6ad946cSShri Abhyankar ts->reason = reason; 4667d6ad946cSShri Abhyankar PetscFunctionReturn(0); 4668d6ad946cSShri Abhyankar } 4669d6ad946cSShri Abhyankar 4670cc708dedSBarry Smith /*@ 4671cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 4672cc708dedSBarry Smith 4673cc708dedSBarry Smith Not Collective 4674cc708dedSBarry Smith 4675cc708dedSBarry Smith Input Parameter: 4676cc708dedSBarry Smith . ts - the TS context 4677cc708dedSBarry Smith 4678cc708dedSBarry Smith Output Parameter: 467919eac22cSLisandro Dalcin . ftime - the final time. This time corresponds to the final time set with TSSetMaxTime() 4680cc708dedSBarry Smith 4681487e0bb9SJed Brown Level: beginner 4682cc708dedSBarry Smith 4683cc708dedSBarry Smith Notes: 4684cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 4685cc708dedSBarry Smith 4686cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 4687cc708dedSBarry Smith @*/ 4688cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 4689cc708dedSBarry Smith { 4690cc708dedSBarry Smith PetscFunctionBegin; 4691cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4692cc708dedSBarry Smith PetscValidPointer(ftime,2); 4693cc708dedSBarry Smith *ftime = ts->solvetime; 4694cc708dedSBarry Smith PetscFunctionReturn(0); 4695cc708dedSBarry Smith } 4696cc708dedSBarry Smith 46972c18e0fdSBarry Smith /*@ 46985ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 46999f67acb7SJed Brown used by the time integrator. 47009f67acb7SJed Brown 47019f67acb7SJed Brown Not Collective 47029f67acb7SJed Brown 47039f67acb7SJed Brown Input Parameter: 47049f67acb7SJed Brown . ts - TS context 47059f67acb7SJed Brown 47069f67acb7SJed Brown Output Parameter: 47079f67acb7SJed Brown . nits - number of nonlinear iterations 47089f67acb7SJed Brown 47099f67acb7SJed Brown Notes: 47109f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 47119f67acb7SJed Brown 47129f67acb7SJed Brown Level: intermediate 47139f67acb7SJed Brown 47145ef26d82SJed Brown .seealso: TSGetKSPIterations() 47159f67acb7SJed Brown @*/ 47165ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 47179f67acb7SJed Brown { 47189f67acb7SJed Brown PetscFunctionBegin; 47199f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 47209f67acb7SJed Brown PetscValidIntPointer(nits,2); 47215ef26d82SJed Brown *nits = ts->snes_its; 47229f67acb7SJed Brown PetscFunctionReturn(0); 47239f67acb7SJed Brown } 47249f67acb7SJed Brown 47259f67acb7SJed Brown /*@ 47265ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 47279f67acb7SJed Brown used by the time integrator. 47289f67acb7SJed Brown 47299f67acb7SJed Brown Not Collective 47309f67acb7SJed Brown 47319f67acb7SJed Brown Input Parameter: 47329f67acb7SJed Brown . ts - TS context 47339f67acb7SJed Brown 47349f67acb7SJed Brown Output Parameter: 47359f67acb7SJed Brown . lits - number of linear iterations 47369f67acb7SJed Brown 47379f67acb7SJed Brown Notes: 47389f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 47399f67acb7SJed Brown 47409f67acb7SJed Brown Level: intermediate 47419f67acb7SJed Brown 47425ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 47439f67acb7SJed Brown @*/ 47445ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 47459f67acb7SJed Brown { 47469f67acb7SJed Brown PetscFunctionBegin; 47479f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 47489f67acb7SJed Brown PetscValidIntPointer(lits,2); 47495ef26d82SJed Brown *lits = ts->ksp_its; 47509f67acb7SJed Brown PetscFunctionReturn(0); 47519f67acb7SJed Brown } 47529f67acb7SJed Brown 4753cef5090cSJed Brown /*@ 4754cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 4755cef5090cSJed Brown 4756cef5090cSJed Brown Not Collective 4757cef5090cSJed Brown 4758cef5090cSJed Brown Input Parameter: 4759cef5090cSJed Brown . ts - TS context 4760cef5090cSJed Brown 4761cef5090cSJed Brown Output Parameter: 4762cef5090cSJed Brown . rejects - number of steps rejected 4763cef5090cSJed Brown 4764cef5090cSJed Brown Notes: 4765cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 4766cef5090cSJed Brown 4767cef5090cSJed Brown Level: intermediate 4768cef5090cSJed Brown 47695ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 4770cef5090cSJed Brown @*/ 4771cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 4772cef5090cSJed Brown { 4773cef5090cSJed Brown PetscFunctionBegin; 4774cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4775cef5090cSJed Brown PetscValidIntPointer(rejects,2); 4776cef5090cSJed Brown *rejects = ts->reject; 4777cef5090cSJed Brown PetscFunctionReturn(0); 4778cef5090cSJed Brown } 4779cef5090cSJed Brown 4780cef5090cSJed Brown /*@ 4781cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 4782cef5090cSJed Brown 4783cef5090cSJed Brown Not Collective 4784cef5090cSJed Brown 4785cef5090cSJed Brown Input Parameter: 4786cef5090cSJed Brown . ts - TS context 4787cef5090cSJed Brown 4788cef5090cSJed Brown Output Parameter: 4789cef5090cSJed Brown . fails - number of failed nonlinear solves 4790cef5090cSJed Brown 4791cef5090cSJed Brown Notes: 4792cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 4793cef5090cSJed Brown 4794cef5090cSJed Brown Level: intermediate 4795cef5090cSJed Brown 47965ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 4797cef5090cSJed Brown @*/ 4798cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 4799cef5090cSJed Brown { 4800cef5090cSJed Brown PetscFunctionBegin; 4801cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4802cef5090cSJed Brown PetscValidIntPointer(fails,2); 4803cef5090cSJed Brown *fails = ts->num_snes_failures; 4804cef5090cSJed Brown PetscFunctionReturn(0); 4805cef5090cSJed Brown } 4806cef5090cSJed Brown 4807cef5090cSJed Brown /*@ 4808cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 4809cef5090cSJed Brown 4810cef5090cSJed Brown Not Collective 4811cef5090cSJed Brown 4812cef5090cSJed Brown Input Parameter: 4813cef5090cSJed Brown + ts - TS context 4814cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 4815cef5090cSJed Brown 4816cef5090cSJed Brown Notes: 4817cef5090cSJed Brown The counter is reset to zero for each step 4818cef5090cSJed Brown 4819cef5090cSJed Brown Options Database Key: 4820cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 4821cef5090cSJed Brown 4822cef5090cSJed Brown Level: intermediate 4823cef5090cSJed Brown 48245ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 4825cef5090cSJed Brown @*/ 4826cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 4827cef5090cSJed Brown { 4828cef5090cSJed Brown PetscFunctionBegin; 4829cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4830cef5090cSJed Brown ts->max_reject = rejects; 4831cef5090cSJed Brown PetscFunctionReturn(0); 4832cef5090cSJed Brown } 4833cef5090cSJed Brown 4834cef5090cSJed Brown /*@ 4835cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 4836cef5090cSJed Brown 4837cef5090cSJed Brown Not Collective 4838cef5090cSJed Brown 4839cef5090cSJed Brown Input Parameter: 4840cef5090cSJed Brown + ts - TS context 4841cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 4842cef5090cSJed Brown 4843cef5090cSJed Brown Notes: 4844cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 4845cef5090cSJed Brown 4846cef5090cSJed Brown Options Database Key: 4847cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 4848cef5090cSJed Brown 4849cef5090cSJed Brown Level: intermediate 4850cef5090cSJed Brown 48515ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 4852cef5090cSJed Brown @*/ 4853cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 4854cef5090cSJed Brown { 4855cef5090cSJed Brown PetscFunctionBegin; 4856cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4857cef5090cSJed Brown ts->max_snes_failures = fails; 4858cef5090cSJed Brown PetscFunctionReturn(0); 4859cef5090cSJed Brown } 4860cef5090cSJed Brown 4861cef5090cSJed Brown /*@ 4862cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 4863cef5090cSJed Brown 4864cef5090cSJed Brown Not Collective 4865cef5090cSJed Brown 4866cef5090cSJed Brown Input Parameter: 4867cef5090cSJed Brown + ts - TS context 4868cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 4869cef5090cSJed Brown 4870cef5090cSJed Brown Options Database Key: 4871cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 4872cef5090cSJed Brown 4873cef5090cSJed Brown Level: intermediate 4874cef5090cSJed Brown 48755ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 4876cef5090cSJed Brown @*/ 4877cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 4878cef5090cSJed Brown { 4879cef5090cSJed Brown PetscFunctionBegin; 4880cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4881cef5090cSJed Brown ts->errorifstepfailed = err; 4882cef5090cSJed Brown PetscFunctionReturn(0); 4883cef5090cSJed Brown } 4884cef5090cSJed Brown 488584df9cb4SJed Brown /*@ 4886552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 488784df9cb4SJed Brown 4888ed81e22dSJed Brown Collective on TS if controller has not been created yet 488984df9cb4SJed Brown 489084df9cb4SJed Brown Input Arguments: 4891ed81e22dSJed Brown . ts - time stepping context 489284df9cb4SJed Brown 489384df9cb4SJed Brown Output Arguments: 4894ed81e22dSJed Brown . adapt - adaptive controller 489584df9cb4SJed Brown 489684df9cb4SJed Brown Level: intermediate 489784df9cb4SJed Brown 4898ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 489984df9cb4SJed Brown @*/ 4900552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 490184df9cb4SJed Brown { 490284df9cb4SJed Brown PetscErrorCode ierr; 490384df9cb4SJed Brown 490484df9cb4SJed Brown PetscFunctionBegin; 490584df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4906bec58848SLisandro Dalcin PetscValidPointer(adapt,2); 490784df9cb4SJed Brown if (!ts->adapt) { 4908ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 49093bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 49101c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 491184df9cb4SJed Brown } 4912bec58848SLisandro Dalcin *adapt = ts->adapt; 491384df9cb4SJed Brown PetscFunctionReturn(0); 491484df9cb4SJed Brown } 4915d6ebe24aSShri Abhyankar 49161c3436cfSJed Brown /*@ 49171c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 49181c3436cfSJed Brown 49191c3436cfSJed Brown Logically Collective 49201c3436cfSJed Brown 49211c3436cfSJed Brown Input Arguments: 49221c3436cfSJed Brown + ts - time integration context 49231c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 49240298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 49251c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 49260298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 49271c3436cfSJed Brown 4928a3cdaa26SBarry Smith Options Database keys: 4929a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error 4930a3cdaa26SBarry Smith - -ts_atol <atol> Absolute tolerance for local truncation error 4931a3cdaa26SBarry Smith 49323ff766beSShri Abhyankar Notes: 49333ff766beSShri Abhyankar With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 49343ff766beSShri Abhyankar (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 49353ff766beSShri Abhyankar computed only for the differential or the algebraic part then this can be done using the vector of 49363ff766beSShri Abhyankar tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 49373ff766beSShri Abhyankar differential part and infinity for the algebraic part, the LTE calculation will include only the 49383ff766beSShri Abhyankar differential variables. 49393ff766beSShri Abhyankar 49401c3436cfSJed Brown Level: beginner 49411c3436cfSJed Brown 49425c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSGetTolerances() 49431c3436cfSJed Brown @*/ 49441c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 49451c3436cfSJed Brown { 49461c3436cfSJed Brown PetscErrorCode ierr; 49471c3436cfSJed Brown 49481c3436cfSJed Brown PetscFunctionBegin; 4949c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 49501c3436cfSJed Brown if (vatol) { 49511c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 49521c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 49531c3436cfSJed Brown ts->vatol = vatol; 49541c3436cfSJed Brown } 4955c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 49561c3436cfSJed Brown if (vrtol) { 49571c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 49581c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 49591c3436cfSJed Brown ts->vrtol = vrtol; 49601c3436cfSJed Brown } 49611c3436cfSJed Brown PetscFunctionReturn(0); 49621c3436cfSJed Brown } 49631c3436cfSJed Brown 4964c5033834SJed Brown /*@ 4965c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 4966c5033834SJed Brown 4967c5033834SJed Brown Logically Collective 4968c5033834SJed Brown 4969c5033834SJed Brown Input Arguments: 4970c5033834SJed Brown . ts - time integration context 4971c5033834SJed Brown 4972c5033834SJed Brown Output Arguments: 49730298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 49740298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 49750298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 49760298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 4977c5033834SJed Brown 4978c5033834SJed Brown Level: beginner 4979c5033834SJed Brown 49805c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSSetTolerances() 4981c5033834SJed Brown @*/ 4982c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 4983c5033834SJed Brown { 4984c5033834SJed Brown PetscFunctionBegin; 4985c5033834SJed Brown if (atol) *atol = ts->atol; 4986c5033834SJed Brown if (vatol) *vatol = ts->vatol; 4987c5033834SJed Brown if (rtol) *rtol = ts->rtol; 4988c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 4989c5033834SJed Brown PetscFunctionReturn(0); 4990c5033834SJed Brown } 4991c5033834SJed Brown 49929c6b16b5SShri Abhyankar /*@ 4993a4868fbcSLisandro Dalcin TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors 49949c6b16b5SShri Abhyankar 49959c6b16b5SShri Abhyankar Collective on TS 49969c6b16b5SShri Abhyankar 49979c6b16b5SShri Abhyankar Input Arguments: 49989c6b16b5SShri Abhyankar + ts - time stepping context 4999a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5000a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 50019c6b16b5SShri Abhyankar 50029c6b16b5SShri Abhyankar Output Arguments: 5003a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 means that the error matches the tolerances 50047453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 5005a2b725a8SWilliam Gropp - normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 50069c6b16b5SShri Abhyankar 50079c6b16b5SShri Abhyankar Level: developer 50089c6b16b5SShri Abhyankar 5009deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity() 50109c6b16b5SShri Abhyankar @*/ 50117453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 50129c6b16b5SShri Abhyankar { 50139c6b16b5SShri Abhyankar PetscErrorCode ierr; 50149c6b16b5SShri Abhyankar PetscInt i,n,N,rstart; 50157453f775SEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 50167453f775SEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 50179c6b16b5SShri Abhyankar const PetscScalar *u,*y; 50187453f775SEmil Constantinescu PetscReal sum,suma,sumr,gsum,gsuma,gsumr,diff; 50197453f775SEmil Constantinescu PetscReal tol,tola,tolr; 50207453f775SEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 50219c6b16b5SShri Abhyankar 50229c6b16b5SShri Abhyankar PetscFunctionBegin; 50239c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5024a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5025a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5026a4868fbcSLisandro Dalcin PetscValidType(U,2); 5027a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5028a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5029a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 50308a175baeSEmil Constantinescu PetscValidPointer(norma,5); 50318a175baeSEmil Constantinescu PetscValidPointer(normr,6); 5032a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 50339c6b16b5SShri Abhyankar 50349c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 50359c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 50369c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 50379c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 50389c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 50397453f775SEmil Constantinescu sum = 0.; n_loc = 0; 50407453f775SEmil Constantinescu suma = 0.; na_loc = 0; 50417453f775SEmil Constantinescu sumr = 0.; nr_loc = 0; 50429c6b16b5SShri Abhyankar if (ts->vatol && ts->vrtol) { 50439c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 50449c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 50459c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 50469c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 504776cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 50487453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 50497453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 50507453f775SEmil Constantinescu if (tola>0.){ 50517453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 50527453f775SEmil Constantinescu na_loc++; 50537453f775SEmil Constantinescu } 50547453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 50557453f775SEmil Constantinescu if (tolr>0.){ 50567453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 50577453f775SEmil Constantinescu nr_loc++; 50587453f775SEmil Constantinescu } 50597453f775SEmil Constantinescu tol=tola+tolr; 50607453f775SEmil Constantinescu if (tol>0.){ 50617453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 50627453f775SEmil Constantinescu n_loc++; 50637453f775SEmil Constantinescu } 50649c6b16b5SShri Abhyankar } 50659c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 50669c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 50679c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 50689c6b16b5SShri Abhyankar const PetscScalar *atol; 50699c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 50709c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 507176cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 50727453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 50737453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 50747453f775SEmil Constantinescu if (tola>0.){ 50757453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 50767453f775SEmil Constantinescu na_loc++; 50777453f775SEmil Constantinescu } 50787453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 50797453f775SEmil Constantinescu if (tolr>0.){ 50807453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 50817453f775SEmil Constantinescu nr_loc++; 50827453f775SEmil Constantinescu } 50837453f775SEmil Constantinescu tol=tola+tolr; 50847453f775SEmil Constantinescu if (tol>0.){ 50857453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 50867453f775SEmil Constantinescu n_loc++; 50877453f775SEmil Constantinescu } 50889c6b16b5SShri Abhyankar } 50899c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 50909c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 50919c6b16b5SShri Abhyankar const PetscScalar *rtol; 50929c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 50939c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 509476cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 50957453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 50967453f775SEmil Constantinescu tola = ts->atol; 50977453f775SEmil Constantinescu if (tola>0.){ 50987453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 50997453f775SEmil Constantinescu na_loc++; 51007453f775SEmil Constantinescu } 51017453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 51027453f775SEmil Constantinescu if (tolr>0.){ 51037453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 51047453f775SEmil Constantinescu nr_loc++; 51057453f775SEmil Constantinescu } 51067453f775SEmil Constantinescu tol=tola+tolr; 51077453f775SEmil Constantinescu if (tol>0.){ 51087453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 51097453f775SEmil Constantinescu n_loc++; 51107453f775SEmil Constantinescu } 51119c6b16b5SShri Abhyankar } 51129c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 51139c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 51149c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 511576cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 51167453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 51177453f775SEmil Constantinescu tola = ts->atol; 51187453f775SEmil Constantinescu if (tola>0.){ 51197453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 51207453f775SEmil Constantinescu na_loc++; 51217453f775SEmil Constantinescu } 51227453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 51237453f775SEmil Constantinescu if (tolr>0.){ 51247453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 51257453f775SEmil Constantinescu nr_loc++; 51267453f775SEmil Constantinescu } 51277453f775SEmil Constantinescu tol=tola+tolr; 51287453f775SEmil Constantinescu if (tol>0.){ 51297453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 51307453f775SEmil Constantinescu n_loc++; 51317453f775SEmil Constantinescu } 51329c6b16b5SShri Abhyankar } 51339c6b16b5SShri Abhyankar } 51349c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 51359c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 51369c6b16b5SShri Abhyankar 51377453f775SEmil Constantinescu err_loc[0] = sum; 51387453f775SEmil Constantinescu err_loc[1] = suma; 51397453f775SEmil Constantinescu err_loc[2] = sumr; 51407453f775SEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 51417453f775SEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 51427453f775SEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 51437453f775SEmil Constantinescu 5144a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 51457453f775SEmil Constantinescu 51467453f775SEmil Constantinescu gsum = err_glb[0]; 51477453f775SEmil Constantinescu gsuma = err_glb[1]; 51487453f775SEmil Constantinescu gsumr = err_glb[2]; 51497453f775SEmil Constantinescu n_glb = err_glb[3]; 51507453f775SEmil Constantinescu na_glb = err_glb[4]; 51517453f775SEmil Constantinescu nr_glb = err_glb[5]; 51527453f775SEmil Constantinescu 5153b1316ef9SEmil Constantinescu *norm = 0.; 5154b1316ef9SEmil Constantinescu if (n_glb>0.){*norm = PetscSqrtReal(gsum / n_glb);} 5155b1316ef9SEmil Constantinescu *norma = 0.; 5156b1316ef9SEmil Constantinescu if (na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 5157b1316ef9SEmil Constantinescu *normr = 0.; 5158b1316ef9SEmil Constantinescu if (nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 51599c6b16b5SShri Abhyankar 51609c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 51617453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 51627453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 51639c6b16b5SShri Abhyankar PetscFunctionReturn(0); 51649c6b16b5SShri Abhyankar } 51659c6b16b5SShri Abhyankar 51669c6b16b5SShri Abhyankar /*@ 5167a4868fbcSLisandro Dalcin TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors 51689c6b16b5SShri Abhyankar 51699c6b16b5SShri Abhyankar Collective on TS 51709c6b16b5SShri Abhyankar 51719c6b16b5SShri Abhyankar Input Arguments: 51729c6b16b5SShri Abhyankar + ts - time stepping context 5173a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5174a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 51759c6b16b5SShri Abhyankar 51769c6b16b5SShri Abhyankar Output Arguments: 5177a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 means that the error matches the tolerances 51787453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 5179a2b725a8SWilliam Gropp - normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 51809c6b16b5SShri Abhyankar 51819c6b16b5SShri Abhyankar Level: developer 51829c6b16b5SShri Abhyankar 5183deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2() 51849c6b16b5SShri Abhyankar @*/ 51857453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 51869c6b16b5SShri Abhyankar { 51879c6b16b5SShri Abhyankar PetscErrorCode ierr; 51887453f775SEmil Constantinescu PetscInt i,n,N,rstart; 51899c6b16b5SShri Abhyankar const PetscScalar *u,*y; 51907453f775SEmil Constantinescu PetscReal max,gmax,maxa,gmaxa,maxr,gmaxr; 51917453f775SEmil Constantinescu PetscReal tol,tola,tolr,diff; 51927453f775SEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 51939c6b16b5SShri Abhyankar 51949c6b16b5SShri Abhyankar PetscFunctionBegin; 51959c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5196a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5197a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5198a4868fbcSLisandro Dalcin PetscValidType(U,2); 5199a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5200a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5201a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 52028a175baeSEmil Constantinescu PetscValidPointer(norma,5); 52038a175baeSEmil Constantinescu PetscValidPointer(normr,6); 5204a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 52059c6b16b5SShri Abhyankar 52069c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 52079c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 52089c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 52099c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 52109c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 52117453f775SEmil Constantinescu 52127453f775SEmil Constantinescu max=0.; 52137453f775SEmil Constantinescu maxa=0.; 52147453f775SEmil Constantinescu maxr=0.; 52157453f775SEmil Constantinescu 52167453f775SEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 52179c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 52189c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 52199c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 52207453f775SEmil Constantinescu 52217453f775SEmil Constantinescu for (i=0; i<n; i++) { 522276cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 52237453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 52247453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 52257453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 52267453f775SEmil Constantinescu tol = tola+tolr; 52277453f775SEmil Constantinescu if (tola>0.){ 52287453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 52297453f775SEmil Constantinescu } 52307453f775SEmil Constantinescu if (tolr>0.){ 52317453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 52327453f775SEmil Constantinescu } 52337453f775SEmil Constantinescu if (tol>0.){ 52347453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 52357453f775SEmil Constantinescu } 52369c6b16b5SShri Abhyankar } 52379c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 52389c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 52399c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 52409c6b16b5SShri Abhyankar const PetscScalar *atol; 52419c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 52427453f775SEmil Constantinescu for (i=0; i<n; i++) { 524376cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 52447453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 52457453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 52467453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 52477453f775SEmil Constantinescu tol = tola+tolr; 52487453f775SEmil Constantinescu if (tola>0.){ 52497453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 52507453f775SEmil Constantinescu } 52517453f775SEmil Constantinescu if (tolr>0.){ 52527453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 52537453f775SEmil Constantinescu } 52547453f775SEmil Constantinescu if (tol>0.){ 52557453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 52567453f775SEmil Constantinescu } 52579c6b16b5SShri Abhyankar } 52589c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 52599c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 52609c6b16b5SShri Abhyankar const PetscScalar *rtol; 52619c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 52627453f775SEmil Constantinescu 52637453f775SEmil Constantinescu for (i=0; i<n; i++) { 526476cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 52657453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 52667453f775SEmil Constantinescu tola = ts->atol; 52677453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 52687453f775SEmil Constantinescu tol = tola+tolr; 52697453f775SEmil Constantinescu if (tola>0.){ 52707453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 52717453f775SEmil Constantinescu } 52727453f775SEmil Constantinescu if (tolr>0.){ 52737453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 52747453f775SEmil Constantinescu } 52757453f775SEmil Constantinescu if (tol>0.){ 52767453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 52777453f775SEmil Constantinescu } 52789c6b16b5SShri Abhyankar } 52799c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 52809c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 52817453f775SEmil Constantinescu 52827453f775SEmil Constantinescu for (i=0; i<n; i++) { 528376cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 52847453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 52857453f775SEmil Constantinescu tola = ts->atol; 52867453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 52877453f775SEmil Constantinescu tol = tola+tolr; 52887453f775SEmil Constantinescu if (tola>0.){ 52897453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 52907453f775SEmil Constantinescu } 52917453f775SEmil Constantinescu if (tolr>0.){ 52927453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 52937453f775SEmil Constantinescu } 52947453f775SEmil Constantinescu if (tol>0.){ 52957453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 52967453f775SEmil Constantinescu } 52979c6b16b5SShri Abhyankar } 52989c6b16b5SShri Abhyankar } 52999c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 53009c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 53017453f775SEmil Constantinescu err_loc[0] = max; 53027453f775SEmil Constantinescu err_loc[1] = maxa; 53037453f775SEmil Constantinescu err_loc[2] = maxr; 5304a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 53057453f775SEmil Constantinescu gmax = err_glb[0]; 53067453f775SEmil Constantinescu gmaxa = err_glb[1]; 53077453f775SEmil Constantinescu gmaxr = err_glb[2]; 53089c6b16b5SShri Abhyankar 53099c6b16b5SShri Abhyankar *norm = gmax; 53107453f775SEmil Constantinescu *norma = gmaxa; 53117453f775SEmil Constantinescu *normr = gmaxr; 53129c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 53137453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 53147453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 53159c6b16b5SShri Abhyankar PetscFunctionReturn(0); 53169c6b16b5SShri Abhyankar } 53179c6b16b5SShri Abhyankar 53181c3436cfSJed Brown /*@ 53198a175baeSEmil Constantinescu TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances 53201c3436cfSJed Brown 53211c3436cfSJed Brown Collective on TS 53221c3436cfSJed Brown 53231c3436cfSJed Brown Input Arguments: 53241c3436cfSJed Brown + ts - time stepping context 5325a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5326a4868fbcSLisandro Dalcin . Y - state vector to be compared to U 5327a4868fbcSLisandro Dalcin - wnormtype - norm type, either NORM_2 or NORM_INFINITY 53287619abb3SShri 53291c3436cfSJed Brown Output Arguments: 5330a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 53318a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 5332a2b725a8SWilliam Gropp - normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 5333a4868fbcSLisandro Dalcin 5334a4868fbcSLisandro Dalcin Options Database Keys: 5335a4868fbcSLisandro Dalcin . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 5336a4868fbcSLisandro Dalcin 53371c3436cfSJed Brown Level: developer 53381c3436cfSJed Brown 53398a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm 53401c3436cfSJed Brown @*/ 53417453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 53421c3436cfSJed Brown { 53438beabaa1SBarry Smith PetscErrorCode ierr; 53441c3436cfSJed Brown 53451c3436cfSJed Brown PetscFunctionBegin; 5346a4868fbcSLisandro Dalcin if (wnormtype == NORM_2) { 53477453f775SEmil Constantinescu ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 5348a4868fbcSLisandro Dalcin } else if (wnormtype == NORM_INFINITY) { 53497453f775SEmil Constantinescu ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 5350a4868fbcSLisandro Dalcin } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 53511c3436cfSJed Brown PetscFunctionReturn(0); 53521c3436cfSJed Brown } 53531c3436cfSJed Brown 53548a175baeSEmil Constantinescu 53558a175baeSEmil Constantinescu /*@ 53568a175baeSEmil Constantinescu TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances 53578a175baeSEmil Constantinescu 53588a175baeSEmil Constantinescu Collective on TS 53598a175baeSEmil Constantinescu 53608a175baeSEmil Constantinescu Input Arguments: 53618a175baeSEmil Constantinescu + ts - time stepping context 53628a175baeSEmil Constantinescu . E - error vector 53638a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 53648a175baeSEmil Constantinescu - Y - state vector, previous time step 53658a175baeSEmil Constantinescu 53668a175baeSEmil Constantinescu Output Arguments: 5367a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 means that the error matches the tolerances 53688a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 5369a2b725a8SWilliam Gropp - normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 53708a175baeSEmil Constantinescu 53718a175baeSEmil Constantinescu Level: developer 53728a175baeSEmil Constantinescu 53738a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity() 53748a175baeSEmil Constantinescu @*/ 53758a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 53768a175baeSEmil Constantinescu { 53778a175baeSEmil Constantinescu PetscErrorCode ierr; 53788a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 53798a175baeSEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 53808a175baeSEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 53818a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 53828a175baeSEmil Constantinescu PetscReal err,sum,suma,sumr,gsum,gsuma,gsumr; 53838a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 53848a175baeSEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 53858a175baeSEmil Constantinescu 53868a175baeSEmil Constantinescu PetscFunctionBegin; 53878a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 53888a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 53898a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 53908a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 53918a175baeSEmil Constantinescu PetscValidType(E,2); 53928a175baeSEmil Constantinescu PetscValidType(U,3); 53938a175baeSEmil Constantinescu PetscValidType(Y,4); 53948a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 53958a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 53968a175baeSEmil Constantinescu PetscValidPointer(norm,5); 53978a175baeSEmil Constantinescu PetscValidPointer(norma,6); 53988a175baeSEmil Constantinescu PetscValidPointer(normr,7); 53998a175baeSEmil Constantinescu 54008a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 54018a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 54028a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 54038a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 54048a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 54058a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 54068a175baeSEmil Constantinescu sum = 0.; n_loc = 0; 54078a175baeSEmil Constantinescu suma = 0.; na_loc = 0; 54088a175baeSEmil Constantinescu sumr = 0.; nr_loc = 0; 54098a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { 54108a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 54118a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 54128a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 54138a175baeSEmil Constantinescu for (i=0; i<n; i++) { 541476cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 54158a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 54168a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 54178a175baeSEmil Constantinescu if (tola>0.){ 54188a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 54198a175baeSEmil Constantinescu na_loc++; 54208a175baeSEmil Constantinescu } 54218a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 54228a175baeSEmil Constantinescu if (tolr>0.){ 54238a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 54248a175baeSEmil Constantinescu nr_loc++; 54258a175baeSEmil Constantinescu } 54268a175baeSEmil Constantinescu tol=tola+tolr; 54278a175baeSEmil Constantinescu if (tol>0.){ 54288a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 54298a175baeSEmil Constantinescu n_loc++; 54308a175baeSEmil Constantinescu } 54318a175baeSEmil Constantinescu } 54328a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 54338a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 54348a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 54358a175baeSEmil Constantinescu const PetscScalar *atol; 54368a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 54378a175baeSEmil Constantinescu for (i=0; i<n; i++) { 543876cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 54398a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 54408a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 54418a175baeSEmil Constantinescu if (tola>0.){ 54428a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 54438a175baeSEmil Constantinescu na_loc++; 54448a175baeSEmil Constantinescu } 54458a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 54468a175baeSEmil Constantinescu if (tolr>0.){ 54478a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 54488a175baeSEmil Constantinescu nr_loc++; 54498a175baeSEmil Constantinescu } 54508a175baeSEmil Constantinescu tol=tola+tolr; 54518a175baeSEmil Constantinescu if (tol>0.){ 54528a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 54538a175baeSEmil Constantinescu n_loc++; 54548a175baeSEmil Constantinescu } 54558a175baeSEmil Constantinescu } 54568a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 54578a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 54588a175baeSEmil Constantinescu const PetscScalar *rtol; 54598a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 54608a175baeSEmil Constantinescu for (i=0; i<n; i++) { 546176cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 54628a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 54638a175baeSEmil Constantinescu tola = ts->atol; 54648a175baeSEmil Constantinescu if (tola>0.){ 54658a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 54668a175baeSEmil Constantinescu na_loc++; 54678a175baeSEmil Constantinescu } 54688a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 54698a175baeSEmil Constantinescu if (tolr>0.){ 54708a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 54718a175baeSEmil Constantinescu nr_loc++; 54728a175baeSEmil Constantinescu } 54738a175baeSEmil Constantinescu tol=tola+tolr; 54748a175baeSEmil Constantinescu if (tol>0.){ 54758a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 54768a175baeSEmil Constantinescu n_loc++; 54778a175baeSEmil Constantinescu } 54788a175baeSEmil Constantinescu } 54798a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 54808a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 54818a175baeSEmil Constantinescu for (i=0; i<n; i++) { 548276cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 54838a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 54848a175baeSEmil Constantinescu tola = ts->atol; 54858a175baeSEmil Constantinescu if (tola>0.){ 54868a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 54878a175baeSEmil Constantinescu na_loc++; 54888a175baeSEmil Constantinescu } 54898a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 54908a175baeSEmil Constantinescu if (tolr>0.){ 54918a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 54928a175baeSEmil Constantinescu nr_loc++; 54938a175baeSEmil Constantinescu } 54948a175baeSEmil Constantinescu tol=tola+tolr; 54958a175baeSEmil Constantinescu if (tol>0.){ 54968a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 54978a175baeSEmil Constantinescu n_loc++; 54988a175baeSEmil Constantinescu } 54998a175baeSEmil Constantinescu } 55008a175baeSEmil Constantinescu } 55018a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 55028a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 55038a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 55048a175baeSEmil Constantinescu 55058a175baeSEmil Constantinescu err_loc[0] = sum; 55068a175baeSEmil Constantinescu err_loc[1] = suma; 55078a175baeSEmil Constantinescu err_loc[2] = sumr; 55088a175baeSEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 55098a175baeSEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 55108a175baeSEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 55118a175baeSEmil Constantinescu 5512a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 55138a175baeSEmil Constantinescu 55148a175baeSEmil Constantinescu gsum = err_glb[0]; 55158a175baeSEmil Constantinescu gsuma = err_glb[1]; 55168a175baeSEmil Constantinescu gsumr = err_glb[2]; 55178a175baeSEmil Constantinescu n_glb = err_glb[3]; 55188a175baeSEmil Constantinescu na_glb = err_glb[4]; 55198a175baeSEmil Constantinescu nr_glb = err_glb[5]; 55208a175baeSEmil Constantinescu 55218a175baeSEmil Constantinescu *norm = 0.; 55228a175baeSEmil Constantinescu if (n_glb>0.){*norm = PetscSqrtReal(gsum / n_glb);} 55238a175baeSEmil Constantinescu *norma = 0.; 55248a175baeSEmil Constantinescu if (na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 55258a175baeSEmil Constantinescu *normr = 0.; 55268a175baeSEmil Constantinescu if (nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 55278a175baeSEmil Constantinescu 55288a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 55298a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 55308a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 55318a175baeSEmil Constantinescu PetscFunctionReturn(0); 55328a175baeSEmil Constantinescu } 55338a175baeSEmil Constantinescu 55348a175baeSEmil Constantinescu /*@ 55358a175baeSEmil Constantinescu TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances 55368a175baeSEmil Constantinescu Collective on TS 55378a175baeSEmil Constantinescu 55388a175baeSEmil Constantinescu Input Arguments: 55398a175baeSEmil Constantinescu + ts - time stepping context 55408a175baeSEmil Constantinescu . E - error vector 55418a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 55428a175baeSEmil Constantinescu - Y - state vector, previous time step 55438a175baeSEmil Constantinescu 55448a175baeSEmil Constantinescu Output Arguments: 5545a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 means that the error matches the tolerances 55468a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 5547a2b725a8SWilliam Gropp - normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 55488a175baeSEmil Constantinescu 55498a175baeSEmil Constantinescu Level: developer 55508a175baeSEmil Constantinescu 55518a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2() 55528a175baeSEmil Constantinescu @*/ 55538a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 55548a175baeSEmil Constantinescu { 55558a175baeSEmil Constantinescu PetscErrorCode ierr; 55568a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 55578a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 55588a175baeSEmil Constantinescu PetscReal err,max,gmax,maxa,gmaxa,maxr,gmaxr; 55598a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 55608a175baeSEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 55618a175baeSEmil Constantinescu 55628a175baeSEmil Constantinescu PetscFunctionBegin; 55638a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 55648a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 55658a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 55668a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 55678a175baeSEmil Constantinescu PetscValidType(E,2); 55688a175baeSEmil Constantinescu PetscValidType(U,3); 55698a175baeSEmil Constantinescu PetscValidType(Y,4); 55708a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 55718a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 55728a175baeSEmil Constantinescu PetscValidPointer(norm,5); 55738a175baeSEmil Constantinescu PetscValidPointer(norma,6); 55748a175baeSEmil Constantinescu PetscValidPointer(normr,7); 55758a175baeSEmil Constantinescu 55768a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 55778a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 55788a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 55798a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 55808a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 55818a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 55828a175baeSEmil Constantinescu 55838a175baeSEmil Constantinescu max=0.; 55848a175baeSEmil Constantinescu maxa=0.; 55858a175baeSEmil Constantinescu maxr=0.; 55868a175baeSEmil Constantinescu 55878a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 55888a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 55898a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 55908a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 55918a175baeSEmil Constantinescu 55928a175baeSEmil Constantinescu for (i=0; i<n; i++) { 559376cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 55948a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 55958a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 55968a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 55978a175baeSEmil Constantinescu tol = tola+tolr; 55988a175baeSEmil Constantinescu if (tola>0.){ 55998a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 56008a175baeSEmil Constantinescu } 56018a175baeSEmil Constantinescu if (tolr>0.){ 56028a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 56038a175baeSEmil Constantinescu } 56048a175baeSEmil Constantinescu if (tol>0.){ 56058a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 56068a175baeSEmil Constantinescu } 56078a175baeSEmil Constantinescu } 56088a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 56098a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 56108a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 56118a175baeSEmil Constantinescu const PetscScalar *atol; 56128a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 56138a175baeSEmil Constantinescu for (i=0; i<n; i++) { 561476cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 56158a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 56168a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 56178a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 56188a175baeSEmil Constantinescu tol = tola+tolr; 56198a175baeSEmil Constantinescu if (tola>0.){ 56208a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 56218a175baeSEmil Constantinescu } 56228a175baeSEmil Constantinescu if (tolr>0.){ 56238a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 56248a175baeSEmil Constantinescu } 56258a175baeSEmil Constantinescu if (tol>0.){ 56268a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 56278a175baeSEmil Constantinescu } 56288a175baeSEmil Constantinescu } 56298a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 56308a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 56318a175baeSEmil Constantinescu const PetscScalar *rtol; 56328a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 56338a175baeSEmil Constantinescu 56348a175baeSEmil Constantinescu for (i=0; i<n; i++) { 563576cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 56368a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 56378a175baeSEmil Constantinescu tola = ts->atol; 56388a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 56398a175baeSEmil Constantinescu tol = tola+tolr; 56408a175baeSEmil Constantinescu if (tola>0.){ 56418a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 56428a175baeSEmil Constantinescu } 56438a175baeSEmil Constantinescu if (tolr>0.){ 56448a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 56458a175baeSEmil Constantinescu } 56468a175baeSEmil Constantinescu if (tol>0.){ 56478a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 56488a175baeSEmil Constantinescu } 56498a175baeSEmil Constantinescu } 56508a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 56518a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 56528a175baeSEmil Constantinescu 56538a175baeSEmil Constantinescu for (i=0; i<n; i++) { 565476cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 56558a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 56568a175baeSEmil Constantinescu tola = ts->atol; 56578a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 56588a175baeSEmil Constantinescu tol = tola+tolr; 56598a175baeSEmil Constantinescu if (tola>0.){ 56608a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 56618a175baeSEmil Constantinescu } 56628a175baeSEmil Constantinescu if (tolr>0.){ 56638a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 56648a175baeSEmil Constantinescu } 56658a175baeSEmil Constantinescu if (tol>0.){ 56668a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 56678a175baeSEmil Constantinescu } 56688a175baeSEmil Constantinescu } 56698a175baeSEmil Constantinescu } 56708a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 56718a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 56728a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 56738a175baeSEmil Constantinescu err_loc[0] = max; 56748a175baeSEmil Constantinescu err_loc[1] = maxa; 56758a175baeSEmil Constantinescu err_loc[2] = maxr; 5676a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 56778a175baeSEmil Constantinescu gmax = err_glb[0]; 56788a175baeSEmil Constantinescu gmaxa = err_glb[1]; 56798a175baeSEmil Constantinescu gmaxr = err_glb[2]; 56808a175baeSEmil Constantinescu 56818a175baeSEmil Constantinescu *norm = gmax; 56828a175baeSEmil Constantinescu *norma = gmaxa; 56838a175baeSEmil Constantinescu *normr = gmaxr; 56848a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 56858a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 56868a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 56878a175baeSEmil Constantinescu PetscFunctionReturn(0); 56888a175baeSEmil Constantinescu } 56898a175baeSEmil Constantinescu 56908a175baeSEmil Constantinescu /*@ 56918a175baeSEmil Constantinescu TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances 56928a175baeSEmil Constantinescu 56938a175baeSEmil Constantinescu Collective on TS 56948a175baeSEmil Constantinescu 56958a175baeSEmil Constantinescu Input Arguments: 56968a175baeSEmil Constantinescu + ts - time stepping context 56978a175baeSEmil Constantinescu . E - error vector 56988a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 56998a175baeSEmil Constantinescu . Y - state vector, previous time step 57008a175baeSEmil Constantinescu - wnormtype - norm type, either NORM_2 or NORM_INFINITY 57018a175baeSEmil Constantinescu 57028a175baeSEmil Constantinescu Output Arguments: 5703a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 57048a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 5705a2b725a8SWilliam Gropp - normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 57068a175baeSEmil Constantinescu 57078a175baeSEmil Constantinescu Options Database Keys: 57088a175baeSEmil Constantinescu . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 57098a175baeSEmil Constantinescu 57108a175baeSEmil Constantinescu Level: developer 57118a175baeSEmil Constantinescu 57128a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2() 57138a175baeSEmil Constantinescu @*/ 57148a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 57158a175baeSEmil Constantinescu { 57168a175baeSEmil Constantinescu PetscErrorCode ierr; 57178a175baeSEmil Constantinescu 57188a175baeSEmil Constantinescu PetscFunctionBegin; 57198a175baeSEmil Constantinescu if (wnormtype == NORM_2) { 57208a175baeSEmil Constantinescu ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 57218a175baeSEmil Constantinescu } else if (wnormtype == NORM_INFINITY) { 57228a175baeSEmil Constantinescu ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 57238a175baeSEmil Constantinescu } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 57248a175baeSEmil Constantinescu PetscFunctionReturn(0); 57258a175baeSEmil Constantinescu } 57268a175baeSEmil Constantinescu 57278a175baeSEmil Constantinescu 57288d59e960SJed Brown /*@ 57298d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 57308d59e960SJed Brown 57318d59e960SJed Brown Logically Collective on TS 57328d59e960SJed Brown 57338d59e960SJed Brown Input Arguments: 57348d59e960SJed Brown + ts - time stepping context 57358d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 57368d59e960SJed Brown 57378d59e960SJed Brown Note: 57388d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 57398d59e960SJed Brown 57408d59e960SJed Brown Level: intermediate 57418d59e960SJed Brown 57428d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 57438d59e960SJed Brown @*/ 57448d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 57458d59e960SJed Brown { 57468d59e960SJed Brown PetscFunctionBegin; 57478d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 57488d59e960SJed Brown ts->cfltime_local = cfltime; 57498d59e960SJed Brown ts->cfltime = -1.; 57508d59e960SJed Brown PetscFunctionReturn(0); 57518d59e960SJed Brown } 57528d59e960SJed Brown 57538d59e960SJed Brown /*@ 57548d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 57558d59e960SJed Brown 57568d59e960SJed Brown Collective on TS 57578d59e960SJed Brown 57588d59e960SJed Brown Input Arguments: 57598d59e960SJed Brown . ts - time stepping context 57608d59e960SJed Brown 57618d59e960SJed Brown Output Arguments: 57628d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 57638d59e960SJed Brown 57648d59e960SJed Brown Level: advanced 57658d59e960SJed Brown 57668d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 57678d59e960SJed Brown @*/ 57688d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 57698d59e960SJed Brown { 57708d59e960SJed Brown PetscErrorCode ierr; 57718d59e960SJed Brown 57728d59e960SJed Brown PetscFunctionBegin; 57738d59e960SJed Brown if (ts->cfltime < 0) { 5774b2566f29SBarry Smith ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 57758d59e960SJed Brown } 57768d59e960SJed Brown *cfltime = ts->cfltime; 57778d59e960SJed Brown PetscFunctionReturn(0); 57788d59e960SJed Brown } 57798d59e960SJed Brown 5780d6ebe24aSShri Abhyankar /*@ 5781d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 5782d6ebe24aSShri Abhyankar 5783d6ebe24aSShri Abhyankar Input Parameters: 5784a2b725a8SWilliam Gropp + ts - the TS context. 5785d6ebe24aSShri Abhyankar . xl - lower bound. 5786a2b725a8SWilliam Gropp - xu - upper bound. 5787d6ebe24aSShri Abhyankar 5788d6ebe24aSShri Abhyankar Notes: 5789d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 5790e270355aSBarry Smith PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 5791d6ebe24aSShri Abhyankar 57922bd2b0e6SSatish Balay Level: advanced 57932bd2b0e6SSatish Balay 5794d6ebe24aSShri Abhyankar @*/ 5795d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 5796d6ebe24aSShri Abhyankar { 5797d6ebe24aSShri Abhyankar PetscErrorCode ierr; 5798d6ebe24aSShri Abhyankar SNES snes; 5799d6ebe24aSShri Abhyankar 5800d6ebe24aSShri Abhyankar PetscFunctionBegin; 5801d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 5802d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 5803d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 5804d6ebe24aSShri Abhyankar } 5805d6ebe24aSShri Abhyankar 5806f9c1d6abSBarry Smith /*@ 5807f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 5808f9c1d6abSBarry Smith 5809d083f849SBarry Smith Collective on TS 5810f9c1d6abSBarry Smith 5811f9c1d6abSBarry Smith Input Parameters: 5812f9c1d6abSBarry Smith + ts - the TS context 5813f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 5814f9c1d6abSBarry Smith 5815f9c1d6abSBarry Smith Output Parameters: 5816f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 5817f9c1d6abSBarry Smith 5818f9c1d6abSBarry Smith Level: developer 5819f9c1d6abSBarry Smith 5820f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 5821f9c1d6abSBarry Smith @*/ 5822f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 5823f9c1d6abSBarry Smith { 5824f9c1d6abSBarry Smith PetscErrorCode ierr; 5825f9c1d6abSBarry Smith 5826f9c1d6abSBarry Smith PetscFunctionBegin; 5827f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5828ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 5829f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 5830f9c1d6abSBarry Smith PetscFunctionReturn(0); 5831f9c1d6abSBarry Smith } 583224655328SShri 583324655328SShri /*@ 5834dcb233daSLisandro Dalcin TSRestartStep - Flags the solver to restart the next step 5835dcb233daSLisandro Dalcin 5836dcb233daSLisandro Dalcin Collective on TS 5837dcb233daSLisandro Dalcin 5838dcb233daSLisandro Dalcin Input Parameter: 5839dcb233daSLisandro Dalcin . ts - the TS context obtained from TSCreate() 5840dcb233daSLisandro Dalcin 5841dcb233daSLisandro Dalcin Level: advanced 5842dcb233daSLisandro Dalcin 5843dcb233daSLisandro Dalcin Notes: 5844dcb233daSLisandro Dalcin Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of 5845dcb233daSLisandro Dalcin discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution 5846dcb233daSLisandro Dalcin vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For 5847dcb233daSLisandro Dalcin the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce 5848dcb233daSLisandro Dalcin discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with 5849dcb233daSLisandro Dalcin discontinuous source terms). 5850dcb233daSLisandro Dalcin 5851dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep() 5852dcb233daSLisandro Dalcin @*/ 5853dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts) 5854dcb233daSLisandro Dalcin { 5855dcb233daSLisandro Dalcin PetscFunctionBegin; 5856dcb233daSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5857dcb233daSLisandro Dalcin ts->steprestart = PETSC_TRUE; 5858dcb233daSLisandro Dalcin PetscFunctionReturn(0); 5859dcb233daSLisandro Dalcin } 5860dcb233daSLisandro Dalcin 5861dcb233daSLisandro Dalcin /*@ 586224655328SShri TSRollBack - Rolls back one time step 586324655328SShri 586424655328SShri Collective on TS 586524655328SShri 586624655328SShri Input Parameter: 586724655328SShri . ts - the TS context obtained from TSCreate() 586824655328SShri 586924655328SShri Level: advanced 587024655328SShri 587124655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 587224655328SShri @*/ 587324655328SShri PetscErrorCode TSRollBack(TS ts) 587424655328SShri { 587524655328SShri PetscErrorCode ierr; 587624655328SShri 587724655328SShri PetscFunctionBegin; 587824655328SShri PetscValidHeaderSpecific(ts, TS_CLASSID,1); 5879b3de5cdeSLisandro Dalcin if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called"); 588024655328SShri if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 588124655328SShri ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 588224655328SShri ts->time_step = ts->ptime - ts->ptime_prev; 588324655328SShri ts->ptime = ts->ptime_prev; 5884be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime_prev_rollback; 58852808aa04SLisandro Dalcin ts->steps--; 5886b3de5cdeSLisandro Dalcin ts->steprollback = PETSC_TRUE; 588724655328SShri PetscFunctionReturn(0); 588824655328SShri } 5889aeb4809dSShri Abhyankar 5890ff22ae23SHong Zhang /*@ 5891ff22ae23SHong Zhang TSGetStages - Get the number of stages and stage values 5892ff22ae23SHong Zhang 5893ff22ae23SHong Zhang Input Parameter: 5894ff22ae23SHong Zhang . ts - the TS context obtained from TSCreate() 5895ff22ae23SHong Zhang 58960429704eSStefano Zampini Output Parameters: 58970429704eSStefano Zampini + ns - the number of stages 58980429704eSStefano Zampini - Y - the current stage vectors 58990429704eSStefano Zampini 5900ff22ae23SHong Zhang Level: advanced 5901ff22ae23SHong Zhang 59020429704eSStefano Zampini Notes: Both ns and Y can be NULL. 59030429704eSStefano Zampini 5904ff22ae23SHong Zhang .seealso: TSCreate() 5905ff22ae23SHong Zhang @*/ 5906ff22ae23SHong Zhang PetscErrorCode TSGetStages(TS ts,PetscInt *ns,Vec **Y) 5907ff22ae23SHong Zhang { 5908ff22ae23SHong Zhang PetscErrorCode ierr; 5909ff22ae23SHong Zhang 5910ff22ae23SHong Zhang PetscFunctionBegin; 5911ff22ae23SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 59120429704eSStefano Zampini if (ns) PetscValidPointer(ns,2); 59130429704eSStefano Zampini if (Y) PetscValidPointer(Y,3); 59140429704eSStefano Zampini if (!ts->ops->getstages) { 59150429704eSStefano Zampini if (ns) *ns = 0; 59160429704eSStefano Zampini if (Y) *Y = NULL; 59170429704eSStefano Zampini } else { 5918ff22ae23SHong Zhang ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 5919ff22ae23SHong Zhang } 5920ff22ae23SHong Zhang PetscFunctionReturn(0); 5921ff22ae23SHong Zhang } 5922ff22ae23SHong Zhang 5923847ff0e1SMatthew G. Knepley /*@C 5924847ff0e1SMatthew G. Knepley TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 5925847ff0e1SMatthew G. Knepley 5926847ff0e1SMatthew G. Knepley Collective on SNES 5927847ff0e1SMatthew G. Knepley 5928847ff0e1SMatthew G. Knepley Input Parameters: 5929847ff0e1SMatthew G. Knepley + ts - the TS context 5930847ff0e1SMatthew G. Knepley . t - current timestep 5931847ff0e1SMatthew G. Knepley . U - state vector 5932847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector 5933847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below 5934847ff0e1SMatthew G. Knepley - ctx - an optional user context 5935847ff0e1SMatthew G. Knepley 5936847ff0e1SMatthew G. Knepley Output Parameters: 5937847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine) 5938847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J) 5939847ff0e1SMatthew G. Knepley 5940847ff0e1SMatthew G. Knepley Level: intermediate 5941847ff0e1SMatthew G. Knepley 5942847ff0e1SMatthew G. Knepley Notes: 5943847ff0e1SMatthew G. Knepley If F(t,U,Udot)=0 is the DAE, the required Jacobian is 5944847ff0e1SMatthew G. Knepley 5945847ff0e1SMatthew G. Knepley dF/dU + shift*dF/dUdot 5946847ff0e1SMatthew G. Knepley 5947847ff0e1SMatthew G. Knepley Most users should not need to explicitly call this routine, as it 5948847ff0e1SMatthew G. Knepley is used internally within the nonlinear solvers. 5949847ff0e1SMatthew G. Knepley 5950847ff0e1SMatthew G. Knepley This will first try to get the coloring from the DM. If the DM type has no coloring 5951847ff0e1SMatthew G. Knepley routine, then it will try to get the coloring from the matrix. This requires that the 5952847ff0e1SMatthew G. Knepley matrix have nonzero entries precomputed. 5953847ff0e1SMatthew G. Knepley 5954847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction() 5955847ff0e1SMatthew G. Knepley @*/ 5956847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx) 5957847ff0e1SMatthew G. Knepley { 5958847ff0e1SMatthew G. Knepley SNES snes; 5959847ff0e1SMatthew G. Knepley MatFDColoring color; 5960847ff0e1SMatthew G. Knepley PetscBool hascolor, matcolor = PETSC_FALSE; 5961847ff0e1SMatthew G. Knepley PetscErrorCode ierr; 5962847ff0e1SMatthew G. Knepley 5963847ff0e1SMatthew G. Knepley PetscFunctionBegin; 5964c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr); 5965847ff0e1SMatthew G. Knepley ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr); 5966847ff0e1SMatthew G. Knepley if (!color) { 5967847ff0e1SMatthew G. Knepley DM dm; 5968847ff0e1SMatthew G. Knepley ISColoring iscoloring; 5969847ff0e1SMatthew G. Knepley 5970847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 5971847ff0e1SMatthew G. Knepley ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr); 5972847ff0e1SMatthew G. Knepley if (hascolor && !matcolor) { 5973847ff0e1SMatthew G. Knepley ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr); 5974847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 5975847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 5976847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 5977847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 5978847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 5979847ff0e1SMatthew G. Knepley } else { 5980847ff0e1SMatthew G. Knepley MatColoring mc; 5981847ff0e1SMatthew G. Knepley 5982847ff0e1SMatthew G. Knepley ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr); 5983847ff0e1SMatthew G. Knepley ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr); 5984847ff0e1SMatthew G. Knepley ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr); 5985847ff0e1SMatthew G. Knepley ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr); 5986847ff0e1SMatthew G. Knepley ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr); 5987847ff0e1SMatthew G. Knepley ierr = MatColoringDestroy(&mc);CHKERRQ(ierr); 5988847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 5989847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 5990847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 5991847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 5992847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 5993847ff0e1SMatthew G. Knepley } 5994847ff0e1SMatthew G. Knepley ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr); 5995847ff0e1SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr); 5996847ff0e1SMatthew G. Knepley } 5997847ff0e1SMatthew G. Knepley ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 5998847ff0e1SMatthew G. Knepley ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr); 5999847ff0e1SMatthew G. Knepley if (J != B) { 6000847ff0e1SMatthew G. Knepley ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 6001847ff0e1SMatthew G. Knepley ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 6002847ff0e1SMatthew G. Knepley } 6003847ff0e1SMatthew G. Knepley PetscFunctionReturn(0); 6004847ff0e1SMatthew G. Knepley } 600593b34091SDebojyoti Ghosh 6006cb9d8021SPierre Barbier de Reuille /*@ 60076bc98fa9SBarry Smith TSSetFunctionDomainError - Set a function that tests if the current state vector is valid 6008cb9d8021SPierre Barbier de Reuille 6009cb9d8021SPierre Barbier de Reuille Input Parameters: 60106bc98fa9SBarry Smith + ts - the TS context 60116bc98fa9SBarry Smith - func - function called within TSFunctionDomainError 60126bc98fa9SBarry Smith 60136bc98fa9SBarry Smith Calling sequence of func: 60146bc98fa9SBarry Smith $ PetscErrorCode func(TS ts,PetscReal time,Vec state,PetscBool reject) 60156bc98fa9SBarry Smith 60166bc98fa9SBarry Smith + ts - the TS context 60176bc98fa9SBarry Smith . time - the current time (of the stage) 60186bc98fa9SBarry Smith . state - the state to check if it is valid 60196bc98fa9SBarry Smith - reject - (output parameter) PETSC_FALSE if the state is acceptable, PETSC_TRUE if not acceptable 6020cb9d8021SPierre Barbier de Reuille 6021cb9d8021SPierre Barbier de Reuille Level: intermediate 6022cb9d8021SPierre Barbier de Reuille 60236bc98fa9SBarry Smith Notes: 60246bc98fa9SBarry Smith If an implicit ODE solver is being used then, in addition to providing this routine, the 60256bc98fa9SBarry Smith user's code should call SNESSetFunctionDomainError() when domain errors occur during 60266bc98fa9SBarry Smith function evaluations where the functions are provided by TSSetIFunction() or TSSetRHSFunction(). 60276bc98fa9SBarry Smith Use TSGetSNES() to obtain the SNES object 60286bc98fa9SBarry Smith 60296bc98fa9SBarry Smith Developer Notes: 60306bc98fa9SBarry Smith The naming of this function is inconsistent with the SNESSetFunctionDomainError() 60316bc98fa9SBarry Smith since one takes a function pointer and the other does not. 60326bc98fa9SBarry Smith 60336bc98fa9SBarry Smith .seealso: TSAdaptCheckStage(), TSFunctionDomainError(), SNESSetFunctionDomainError(), TSGetSNES() 6034cb9d8021SPierre Barbier de Reuille @*/ 6035cb9d8021SPierre Barbier de Reuille 6036d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*)) 6037cb9d8021SPierre Barbier de Reuille { 6038cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 6039cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts, TS_CLASSID,1); 6040cb9d8021SPierre Barbier de Reuille ts->functiondomainerror = func; 6041cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 6042cb9d8021SPierre Barbier de Reuille } 6043cb9d8021SPierre Barbier de Reuille 6044cb9d8021SPierre Barbier de Reuille /*@ 60456bc98fa9SBarry Smith TSFunctionDomainError - Checks if the current state is valid 6046cb9d8021SPierre Barbier de Reuille 6047cb9d8021SPierre Barbier de Reuille Input Parameters: 60486bc98fa9SBarry Smith + ts - the TS context 60496bc98fa9SBarry Smith . stagetime - time of the simulation 60506bc98fa9SBarry Smith - Y - state vector to check. 6051cb9d8021SPierre Barbier de Reuille 6052cb9d8021SPierre Barbier de Reuille Output Parameter: 60536bc98fa9SBarry Smith . accept - Set to PETSC_FALSE if the current state vector is valid. 6054cb9d8021SPierre Barbier de Reuille 6055cb9d8021SPierre Barbier de Reuille Note: 60566bc98fa9SBarry Smith This function is called by the TS integration routines and calls the user provided function (set with TSSetFunctionDomainError()) 60576bc98fa9SBarry Smith to check if the current state is valid. 605896a0c994SBarry Smith 60596bc98fa9SBarry Smith Level: developer 60606bc98fa9SBarry Smith 60616bc98fa9SBarry Smith .seealso: TSSetFunctionDomainError() 6062cb9d8021SPierre Barbier de Reuille @*/ 6063d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept) 6064cb9d8021SPierre Barbier de Reuille { 6065cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 6066cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6067cb9d8021SPierre Barbier de Reuille *accept = PETSC_TRUE; 6068cb9d8021SPierre Barbier de Reuille if (ts->functiondomainerror) { 6069d183316bSPierre Barbier de Reuille PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept)); 6070cb9d8021SPierre Barbier de Reuille } 6071cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 6072cb9d8021SPierre Barbier de Reuille } 60731ceb14c0SBarry Smith 607493b34091SDebojyoti Ghosh /*@C 6075e5168f73SEmil Constantinescu TSClone - This function clones a time step object. 607693b34091SDebojyoti Ghosh 6077d083f849SBarry Smith Collective 607893b34091SDebojyoti Ghosh 607993b34091SDebojyoti Ghosh Input Parameter: 608093b34091SDebojyoti Ghosh . tsin - The input TS 608193b34091SDebojyoti Ghosh 608293b34091SDebojyoti Ghosh Output Parameter: 6083e5168f73SEmil Constantinescu . tsout - The output TS (cloned) 608493b34091SDebojyoti Ghosh 60855eca1a21SEmil Constantinescu Notes: 60865eca1a21SEmil Constantinescu This function is used to create a clone of a TS object. It is used in ARKIMEX for initializing the slope for first stage explicit methods. It will likely be replaced in the future with a mechanism of switching methods on the fly. 60875eca1a21SEmil Constantinescu 6088928bb9adSStefano Zampini When using TSDestroy() on a clone the user has to first reset the correct TS reference in the embedded SNES object: e.g.: by running SNES snes_dup=NULL; TSGetSNES(ts,&snes_dup); TSSetSNES(ts,snes_dup); 60895eca1a21SEmil Constantinescu 60905eca1a21SEmil Constantinescu Level: developer 609193b34091SDebojyoti Ghosh 6092e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType() 609393b34091SDebojyoti Ghosh @*/ 6094baa10174SEmil Constantinescu PetscErrorCode TSClone(TS tsin, TS *tsout) 609593b34091SDebojyoti Ghosh { 609693b34091SDebojyoti Ghosh TS t; 609793b34091SDebojyoti Ghosh PetscErrorCode ierr; 6098dc846ba4SSatish Balay SNES snes_start; 6099dc846ba4SSatish Balay DM dm; 6100dc846ba4SSatish Balay TSType type; 610193b34091SDebojyoti Ghosh 610293b34091SDebojyoti Ghosh PetscFunctionBegin; 610393b34091SDebojyoti Ghosh PetscValidPointer(tsin,1); 610493b34091SDebojyoti Ghosh *tsout = NULL; 610593b34091SDebojyoti Ghosh 61067a37829fSSatish Balay ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr); 610793b34091SDebojyoti Ghosh 610893b34091SDebojyoti Ghosh /* General TS description */ 610993b34091SDebojyoti Ghosh t->numbermonitors = 0; 6110*d0c080abSJoseph Pusztay t->monitorFrequency = 1; 611193b34091SDebojyoti Ghosh t->setupcalled = 0; 611293b34091SDebojyoti Ghosh t->ksp_its = 0; 611393b34091SDebojyoti Ghosh t->snes_its = 0; 611493b34091SDebojyoti Ghosh t->nwork = 0; 61157d51462cSStefano Zampini t->rhsjacobian.time = PETSC_MIN_REAL; 611693b34091SDebojyoti Ghosh t->rhsjacobian.scale = 1.; 611793b34091SDebojyoti Ghosh t->ijacobian.shift = 1.; 611893b34091SDebojyoti Ghosh 611934561852SEmil Constantinescu ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr); 612034561852SEmil Constantinescu ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr); 6121d15a3a53SEmil Constantinescu 612293b34091SDebojyoti Ghosh ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr); 612393b34091SDebojyoti Ghosh ierr = TSSetDM(t,dm);CHKERRQ(ierr); 612493b34091SDebojyoti Ghosh 612593b34091SDebojyoti Ghosh t->adapt = tsin->adapt; 612651699248SLisandro Dalcin ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr); 612793b34091SDebojyoti Ghosh 6128e7069c78SShri t->trajectory = tsin->trajectory; 6129e7069c78SShri ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr); 6130e7069c78SShri 6131e7069c78SShri t->event = tsin->event; 61326b10a48eSSatish Balay if (t->event) t->event->refct++; 6133e7069c78SShri 613493b34091SDebojyoti Ghosh t->problem_type = tsin->problem_type; 613593b34091SDebojyoti Ghosh t->ptime = tsin->ptime; 6136e7069c78SShri t->ptime_prev = tsin->ptime_prev; 613793b34091SDebojyoti Ghosh t->time_step = tsin->time_step; 613893b34091SDebojyoti Ghosh t->max_time = tsin->max_time; 613993b34091SDebojyoti Ghosh t->steps = tsin->steps; 614093b34091SDebojyoti Ghosh t->max_steps = tsin->max_steps; 614193b34091SDebojyoti Ghosh t->equation_type = tsin->equation_type; 614293b34091SDebojyoti Ghosh t->atol = tsin->atol; 614393b34091SDebojyoti Ghosh t->rtol = tsin->rtol; 614493b34091SDebojyoti Ghosh t->max_snes_failures = tsin->max_snes_failures; 614593b34091SDebojyoti Ghosh t->max_reject = tsin->max_reject; 614693b34091SDebojyoti Ghosh t->errorifstepfailed = tsin->errorifstepfailed; 614793b34091SDebojyoti Ghosh 614893b34091SDebojyoti Ghosh ierr = TSGetType(tsin,&type);CHKERRQ(ierr); 614993b34091SDebojyoti Ghosh ierr = TSSetType(t,type);CHKERRQ(ierr); 615093b34091SDebojyoti Ghosh 615193b34091SDebojyoti Ghosh t->vec_sol = NULL; 615293b34091SDebojyoti Ghosh 615393b34091SDebojyoti Ghosh t->cfltime = tsin->cfltime; 615493b34091SDebojyoti Ghosh t->cfltime_local = tsin->cfltime_local; 615593b34091SDebojyoti Ghosh t->exact_final_time = tsin->exact_final_time; 615693b34091SDebojyoti Ghosh 615793b34091SDebojyoti Ghosh ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr); 615893b34091SDebojyoti Ghosh 61590d4fed19SBarry Smith if (((PetscObject)tsin)->fortran_func_pointers) { 61600d4fed19SBarry Smith PetscInt i; 61610d4fed19SBarry Smith ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr); 61620d4fed19SBarry Smith for (i=0; i<10; i++) { 61630d4fed19SBarry Smith ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i]; 61640d4fed19SBarry Smith } 61650d4fed19SBarry Smith } 616693b34091SDebojyoti Ghosh *tsout = t; 616793b34091SDebojyoti Ghosh PetscFunctionReturn(0); 616893b34091SDebojyoti Ghosh } 6169f3b1f45cSBarry Smith 6170f3b1f45cSBarry Smith static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void* ctx,Vec x,Vec y) 6171f3b1f45cSBarry Smith { 6172f3b1f45cSBarry Smith PetscErrorCode ierr; 6173f3b1f45cSBarry Smith TS ts = (TS) ctx; 6174f3b1f45cSBarry Smith 6175f3b1f45cSBarry Smith PetscFunctionBegin; 6176f3b1f45cSBarry Smith ierr = TSComputeRHSFunction(ts,0,x,y);CHKERRQ(ierr); 6177f3b1f45cSBarry Smith PetscFunctionReturn(0); 6178f3b1f45cSBarry Smith } 6179f3b1f45cSBarry Smith 6180f3b1f45cSBarry Smith /*@ 6181f3b1f45cSBarry Smith TSRHSJacobianTest - Compares the multiply routine provided to the MATSHELL with differencing on the TS given RHS function. 6182f3b1f45cSBarry Smith 6183d083f849SBarry Smith Logically Collective on TS 6184f3b1f45cSBarry Smith 6185f3b1f45cSBarry Smith Input Parameters: 6186f3b1f45cSBarry Smith TS - the time stepping routine 6187f3b1f45cSBarry Smith 6188f3b1f45cSBarry Smith Output Parameter: 6189f3b1f45cSBarry Smith . flg - PETSC_TRUE if the multiply is likely correct 6190f3b1f45cSBarry Smith 6191f3b1f45cSBarry Smith Options Database: 6192f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator 6193f3b1f45cSBarry Smith 6194f3b1f45cSBarry Smith Level: advanced 6195f3b1f45cSBarry Smith 619695452b02SPatrick Sanan Notes: 619795452b02SPatrick Sanan This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian 6198f3b1f45cSBarry Smith 6199f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTestTranspose() 6200f3b1f45cSBarry Smith @*/ 6201f3b1f45cSBarry Smith PetscErrorCode TSRHSJacobianTest(TS ts,PetscBool *flg) 6202f3b1f45cSBarry Smith { 6203f3b1f45cSBarry Smith Mat J,B; 6204f3b1f45cSBarry Smith PetscErrorCode ierr; 6205f3b1f45cSBarry Smith TSRHSJacobian func; 6206f3b1f45cSBarry Smith void* ctx; 6207f3b1f45cSBarry Smith 6208f3b1f45cSBarry Smith PetscFunctionBegin; 6209f3b1f45cSBarry Smith ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr); 6210f3b1f45cSBarry Smith ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr); 6211f3b1f45cSBarry Smith ierr = MatShellTestMult(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr); 6212f3b1f45cSBarry Smith PetscFunctionReturn(0); 6213f3b1f45cSBarry Smith } 6214f3b1f45cSBarry Smith 6215f3b1f45cSBarry Smith /*@C 6216f3b1f45cSBarry Smith TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the MATSHELL with differencing on the TS given RHS function. 6217f3b1f45cSBarry Smith 6218d083f849SBarry Smith Logically Collective on TS 6219f3b1f45cSBarry Smith 6220f3b1f45cSBarry Smith Input Parameters: 6221f3b1f45cSBarry Smith TS - the time stepping routine 6222f3b1f45cSBarry Smith 6223f3b1f45cSBarry Smith Output Parameter: 6224f3b1f45cSBarry Smith . flg - PETSC_TRUE if the multiply is likely correct 6225f3b1f45cSBarry Smith 6226f3b1f45cSBarry Smith Options Database: 6227f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator 6228f3b1f45cSBarry Smith 622995452b02SPatrick Sanan Notes: 623095452b02SPatrick Sanan This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian 6231f3b1f45cSBarry Smith 6232f3b1f45cSBarry Smith Level: advanced 6233f3b1f45cSBarry Smith 6234f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTest() 6235f3b1f45cSBarry Smith @*/ 6236f3b1f45cSBarry Smith PetscErrorCode TSRHSJacobianTestTranspose(TS ts,PetscBool *flg) 6237f3b1f45cSBarry Smith { 6238f3b1f45cSBarry Smith Mat J,B; 6239f3b1f45cSBarry Smith PetscErrorCode ierr; 6240f3b1f45cSBarry Smith void *ctx; 6241f3b1f45cSBarry Smith TSRHSJacobian func; 6242f3b1f45cSBarry Smith 6243f3b1f45cSBarry Smith PetscFunctionBegin; 6244f3b1f45cSBarry Smith ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr); 6245f3b1f45cSBarry Smith ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr); 6246f3b1f45cSBarry Smith ierr = MatShellTestMultTranspose(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr); 6247f3b1f45cSBarry Smith PetscFunctionReturn(0); 6248f3b1f45cSBarry Smith } 62490fe4d17eSHong Zhang 62500fe4d17eSHong Zhang /*@ 62510fe4d17eSHong Zhang TSSetUseSplitRHSFunction - Use the split RHSFunction when a multirate method is used. 62520fe4d17eSHong Zhang 62530fe4d17eSHong Zhang Logically collective 62540fe4d17eSHong Zhang 62550fe4d17eSHong Zhang Input Parameter: 62560fe4d17eSHong Zhang + ts - timestepping context 62570fe4d17eSHong Zhang - use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used 62580fe4d17eSHong Zhang 62590fe4d17eSHong Zhang Options Database: 62600fe4d17eSHong Zhang . -ts_use_splitrhsfunction - <true,false> 62610fe4d17eSHong Zhang 62620fe4d17eSHong Zhang Notes: 62630fe4d17eSHong Zhang This is only useful for multirate methods 62640fe4d17eSHong Zhang 62650fe4d17eSHong Zhang Level: intermediate 62660fe4d17eSHong Zhang 62670fe4d17eSHong Zhang .seealso: TSGetUseSplitRHSFunction() 62680fe4d17eSHong Zhang @*/ 62690fe4d17eSHong Zhang PetscErrorCode TSSetUseSplitRHSFunction(TS ts, PetscBool use_splitrhsfunction) 62700fe4d17eSHong Zhang { 62710fe4d17eSHong Zhang PetscFunctionBegin; 62720fe4d17eSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 62730fe4d17eSHong Zhang ts->use_splitrhsfunction = use_splitrhsfunction; 62740fe4d17eSHong Zhang PetscFunctionReturn(0); 62750fe4d17eSHong Zhang } 62760fe4d17eSHong Zhang 62770fe4d17eSHong Zhang /*@ 62780fe4d17eSHong Zhang TSGetUseSplitRHSFunction - Gets whether to use the split RHSFunction when a multirate method is used. 62790fe4d17eSHong Zhang 62800fe4d17eSHong Zhang Not collective 62810fe4d17eSHong Zhang 62820fe4d17eSHong Zhang Input Parameter: 62830fe4d17eSHong Zhang . ts - timestepping context 62840fe4d17eSHong Zhang 62850fe4d17eSHong Zhang Output Parameter: 62860fe4d17eSHong Zhang . use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used 62870fe4d17eSHong Zhang 62880fe4d17eSHong Zhang Level: intermediate 62890fe4d17eSHong Zhang 62900fe4d17eSHong Zhang .seealso: TSSetUseSplitRHSFunction() 62910fe4d17eSHong Zhang @*/ 62920fe4d17eSHong Zhang PetscErrorCode TSGetUseSplitRHSFunction(TS ts, PetscBool *use_splitrhsfunction) 62930fe4d17eSHong Zhang { 62940fe4d17eSHong Zhang PetscFunctionBegin; 62950fe4d17eSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 62960fe4d17eSHong Zhang *use_splitrhsfunction = ts->use_splitrhsfunction; 62970fe4d17eSHong Zhang PetscFunctionReturn(0); 62980fe4d17eSHong Zhang } 6299d60b7d5cSBarry Smith 6300d60b7d5cSBarry Smith /*@ 6301d60b7d5cSBarry Smith TSSetMatStructure - sets the relationship between the nonzero structure of the RHS Jacobian matrix to the IJacobian matrix. 6302d60b7d5cSBarry Smith 6303d60b7d5cSBarry Smith Logically Collective on ts 6304d60b7d5cSBarry Smith 6305d60b7d5cSBarry Smith Input Parameters: 6306d60b7d5cSBarry Smith + ts - the time-stepper 6307d60b7d5cSBarry Smith - str - the structure (the default is UNKNOWN_NONZERO_PATTERN) 6308d60b7d5cSBarry Smith 6309d60b7d5cSBarry Smith Level: intermediate 6310d60b7d5cSBarry Smith 6311d60b7d5cSBarry Smith Notes: 6312d60b7d5cSBarry Smith When the relationship between the nonzero structures is known and supplied the solution process can be much faster 6313d60b7d5cSBarry Smith 6314d60b7d5cSBarry Smith .seealso: MatAXPY(), MatStructure 6315d60b7d5cSBarry Smith @*/ 6316d60b7d5cSBarry Smith PetscErrorCode TSSetMatStructure(TS ts,MatStructure str) 6317d60b7d5cSBarry Smith { 6318d60b7d5cSBarry Smith PetscFunctionBegin; 6319d60b7d5cSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6320d60b7d5cSBarry Smith ts->axpy_pattern = str; 6321d60b7d5cSBarry Smith PetscFunctionReturn(0); 6322d60b7d5cSBarry Smith } 6323