xref: /petsc/src/ts/interface/ts.c (revision 5f80ce2ab25dff0f4601e710601cbbcecf323266)
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   PetscFunctionBegin;
19b92453a8SLisandro Dalcin   PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1);
20b92453a8SLisandro Dalcin   PetscValidCharPointer(default_type,2);
212ffb9264SLisandro Dalcin   if (!((PetscObject)adapt)->type_name) {
22*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSAdaptSetType(adapt,default_type));
232ffb9264SLisandro Dalcin   }
242ffb9264SLisandro Dalcin   PetscFunctionReturn(0);
252ffb9264SLisandro Dalcin }
262ffb9264SLisandro Dalcin 
27bdad233fSMatthew Knepley /*@
28bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
29bdad233fSMatthew Knepley 
30bdad233fSMatthew Knepley    Collective on TS
31bdad233fSMatthew Knepley 
32bdad233fSMatthew Knepley    Input Parameter:
33bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
34bdad233fSMatthew Knepley 
35bdad233fSMatthew Knepley    Options Database Keys:
36d2567f34SHong Zhang +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE, TSBSYMP, TSIRK
37ef222394SBarry Smith .  -ts_save_trajectory - checkpoint the solution at each time-step
38ef85077eSLisandro Dalcin .  -ts_max_time <time> - maximum time to compute to
39ef85077eSLisandro Dalcin .  -ts_max_steps <steps> - maximum number of time-steps to take
40ef85077eSLisandro Dalcin .  -ts_init_time <time> - initial time to start computation
414dc72f7fSBarry Smith .  -ts_final_time <time> - final time to compute to (deprecated: use -ts_max_time)
423e4cdcaaSBarry Smith .  -ts_dt <dt> - initial time step
431628793fSSatish 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
44a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
45a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
46a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
47a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
4867b8a455SSatish Balay .  -ts_atol <atol> - Absolute tolerance for local truncation error
49f3b1f45cSBarry Smith .  -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - test the Jacobian at each iteration against finite difference with RHS function
50f3b1f45cSBarry 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
5167b8a455SSatish Balay .  -ts_adjoint_solve <yes,no> - After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
52847ff0e1SMatthew G. Knepley .  -ts_fd_color - Use finite differences with coloring to compute IJacobian
53bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
54aee7a9fbSMatthew G. Knepley .  -ts_monitor_cancel - Cancel all monitors
55de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
56de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
577cf37e64SBarry Smith .  -ts_monitor_error - Monitors norm of error
586934998bSLisandro Dalcin .  -ts_monitor_lg_timestep - Monitor timestep size graphically
598b668821SLisandro Dalcin .  -ts_monitor_lg_timestep_log - Monitor log timestep size graphically
60de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
61de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
62de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
63de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
643e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
653e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
66fde5950dSBarry Smith .  -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep
67e4160dc7SJulian Andrej .  -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu)
689e336e28SPatrick Sanan -  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
6953ea634cSHong Zhang 
703d5a8a6aSBarry Smith    Notes:
713d5a8a6aSBarry Smith      See SNESSetFromOptions() and KSPSetFromOptions() for how to control the nonlinear and linear solves used by the time-stepper.
723d5a8a6aSBarry Smith 
733d5a8a6aSBarry Smith      Certain SNES options get reset for each new nonlinear solver, for example -snes_lag_jacobian <its> and -snes_lag_preconditioner <its>, in order
743d5a8a6aSBarry Smith      to retain them over the multiple nonlinear solves that TS uses you mush also provide -snes_lag_jacobian_persists true and
753d5a8a6aSBarry Smith      -snes_lag_preconditioner_persists true
763d5a8a6aSBarry Smith 
779e336e28SPatrick Sanan    Developer Note:
789e336e28SPatrick Sanan      We should unify all the -ts_monitor options in the way that -xxx_view has been unified
79bdad233fSMatthew Knepley 
80bdad233fSMatthew Knepley    Level: beginner
81bdad233fSMatthew Knepley 
82a313700dSBarry Smith .seealso: TSGetType()
83bdad233fSMatthew Knepley @*/
847087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
85bdad233fSMatthew Knepley {
86bc952696SBarry Smith   PetscBool              opt,flg,tflg;
87dfbe8321SBarry Smith   PetscErrorCode         ierr;
88eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
8931748224SBarry Smith   PetscReal              time_step;
9049354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
91d1212d36SBarry Smith   char                   dir[16];
92cd11d68dSLisandro Dalcin   TSIFunction            ifun;
936991f827SBarry Smith   const char             *defaultType;
946991f827SBarry Smith   char                   typeName[256];
95bdad233fSMatthew Knepley 
96bdad233fSMatthew Knepley   PetscFunctionBegin;
970700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
986991f827SBarry Smith 
99*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSRegisterAll());
100*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetIFunction(ts,NULL,&ifun,NULL));
101cd11d68dSLisandro Dalcin 
102cd11d68dSLisandro Dalcin   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
1031ef27442SStefano Zampini   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
1041ef27442SStefano Zampini   else defaultType = ifun ? TSBEULER : TSEULER;
105*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt));
1066991f827SBarry Smith   if (opt) {
107*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSSetType(ts,typeName));
1086991f827SBarry Smith   } else {
109*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSSetType(ts,defaultType));
1106991f827SBarry Smith   }
111bdad233fSMatthew Knepley 
112bdad233fSMatthew Knepley   /* Handle generic TS options */
113*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsDeprecated("-ts_final_time","-ts_max_time","3.10",NULL));
114*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsReal("-ts_max_time","Maximum time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL));
115*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetMaxSteps",ts->max_steps,&ts->max_steps,NULL));
116*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL));
117*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg));
118*5f80ce2aSJacob Faibussowitsch   if (flg) CHKERRQ(TSSetTimeStep(ts,time_step));
119*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsEnum("-ts_exact_final_time","Option for handling of final time step","TSSetExactFinalTime",TSExactFinalTimeOptions,(PetscEnum)ts->exact_final_time,(PetscEnum*)&eftopt,&flg));
120*5f80ce2aSJacob Faibussowitsch   if (flg) CHKERRQ(TSSetExactFinalTime(ts,eftopt));
121*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL));
122*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL));
123*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL));
124*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL));
125*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL));
126bdad233fSMatthew Knepley 
127*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsBool("-ts_rhs_jacobian_test_mult","Test the RHS Jacobian for consistency with RHS at each solve ","None",ts->testjacobian,&ts->testjacobian,NULL));
128*5f80ce2aSJacob Faibussowitsch   CHKERRQ(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));
129*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsBool("-ts_use_splitrhsfunction","Use the split RHS function for multirate solvers ","TSSetUseSplitRHSFunction",ts->use_splitrhsfunction,&ts->use_splitrhsfunction,NULL));
13056f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
13156f85f32SBarry Smith   {
13256f85f32SBarry Smith     PetscBool set;
13356f85f32SBarry Smith     flg  = PETSC_FALSE;
134*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set));
13556f85f32SBarry Smith     if (set) {
136*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscObjectSAWsSetBlock((PetscObject)ts,flg));
13756f85f32SBarry Smith     }
13856f85f32SBarry Smith   }
13956f85f32SBarry Smith #endif
14056f85f32SBarry Smith 
141bdad233fSMatthew Knepley   /* Monitor options */
142*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsInt("-ts_monitor_frequency", "Number of time steps between monitor output", "TSMonitorSetFrequency", ts->monitorFrequency, &ts->monitorFrequency, NULL));
143*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL));
144*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSMonitorSetFromOptions(ts,"-ts_monitor_extreme","Monitor extreme values of the solution","TSMonitorExtreme",TSMonitorExtreme,NULL));
145*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL));
146*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSMonitorSetFromOptions(ts,"-ts_dmswarm_monitor_moments","Monitor moments of particle distribution","TSDMSwarmMonitorMoments",TSDMSwarmMonitorMoments,NULL));
147fde5950dSBarry Smith 
148*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",NULL,monfilename,sizeof(monfilename),&flg));
149*5f80ce2aSJacob Faibussowitsch   if (flg) CHKERRQ(PetscPythonMonitorSet((PetscObject)ts,monfilename));
1505180491cSLisandro Dalcin 
151*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt));
152b3603a34SBarry Smith   if (opt) {
1533923b477SBarry Smith     PetscInt       howoften = 1;
154e669de00SBarry Smith     DM             dm;
155e669de00SBarry Smith     PetscBool      net;
156b3603a34SBarry Smith 
157*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL));
158*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetDM(ts,&dm));
159*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectTypeCompare((PetscObject)dm,DMNETWORK,&net));
160e669de00SBarry Smith     if (net) {
161e669de00SBarry Smith       TSMonitorLGCtxNetwork ctx;
162*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSMonitorLGCtxNetworkCreate(ts,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx));
163*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSMonitorSet(ts,TSMonitorLGCtxNetworkSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxNetworkDestroy));
164*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscOptionsBool("-ts_monitor_lg_solution_semilogy","Plot the solution with a semi-log axis","",ctx->semilogy,&ctx->semilogy,NULL));
165e669de00SBarry Smith     } else {
166e669de00SBarry Smith       TSMonitorLGCtx ctx;
167*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx));
168*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy));
169bdad233fSMatthew Knepley     }
170e669de00SBarry Smith   }
1716ba87a44SLisandro Dalcin 
172*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt));
173ef20d060SBarry Smith   if (opt) {
1740b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1753923b477SBarry Smith     PetscInt       howoften = 1;
176ef20d060SBarry Smith 
177*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL));
178*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx));
179*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy));
180ef20d060SBarry Smith   }
181*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSMonitorSetFromOptions(ts,"-ts_monitor_error","View the error at each timestep","TSMonitorError",TSMonitorError,NULL));
1827cf37e64SBarry Smith 
183*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt));
1846934998bSLisandro Dalcin   if (opt) {
1856934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
1866934998bSLisandro Dalcin     PetscInt       howoften = 1;
1876934998bSLisandro Dalcin 
188*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL));
189*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx));
190*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy));
1916934998bSLisandro Dalcin   }
192*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",&opt));
1938b668821SLisandro Dalcin   if (opt) {
1948b668821SLisandro Dalcin     TSMonitorLGCtx ctx;
1958b668821SLisandro Dalcin     PetscInt       howoften = 1;
1968b668821SLisandro Dalcin 
197*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL));
198*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx));
199*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy));
2008b668821SLisandro Dalcin     ctx->semilogy = PETSC_TRUE;
2018b668821SLisandro Dalcin   }
2028b668821SLisandro Dalcin 
203*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt));
204201da799SBarry Smith   if (opt) {
205201da799SBarry Smith     TSMonitorLGCtx ctx;
206201da799SBarry Smith     PetscInt       howoften = 1;
207201da799SBarry Smith 
208*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL));
209*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx));
210*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy));
211201da799SBarry Smith   }
212*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt));
213201da799SBarry Smith   if (opt) {
214201da799SBarry Smith     TSMonitorLGCtx ctx;
215201da799SBarry Smith     PetscInt       howoften = 1;
216201da799SBarry Smith 
217*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL));
218*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx));
219*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy));
220201da799SBarry Smith   }
221*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt));
2228189c53fSBarry Smith   if (opt) {
2238189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2248189c53fSBarry Smith     PetscInt          howoften = 1;
2258189c53fSBarry Smith 
226*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL));
227*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx));
228*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy));
2298189c53fSBarry Smith   }
230*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_sp_swarm","Display particle phase from the DMSwarm","TSMonitorSPSwarm",&opt));
2311b575b74SJoseph Pusztay   if (opt) {
2321b575b74SJoseph Pusztay     TSMonitorSPCtx  ctx;
233d7462660SMatthew Knepley     PetscInt        howoften = 1, retain = 0;
234d7462660SMatthew Knepley     PetscBool       phase = PETSC_TRUE;
235d7462660SMatthew Knepley 
236*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_sp_swarm","Display particles phase from the DMSwarm", "TSMonitorSPSwarm", howoften, &howoften, NULL));
237*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_sp_swarm_retain", "Retain n points plotted to show trajectory, -1 for all points", "TSMonitorSPSwarm", retain, &retain, NULL));
238*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsBool("-ts_monitor_sp_swarm_phase", "Plot in phase space rather than coordinate space", "TSMonitorSPSwarm", phase, &phase, NULL));
239*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSPCtxCreate(PetscObjectComm((PetscObject) ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, retain, phase, &ctx));
240*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts, TSMonitorSPSwarmSolution, ctx, (PetscErrorCode (*)(void**))TSMonitorSPCtxDestroy));
2411b575b74SJoseph Pusztay   }
242ef20d060SBarry Smith   opt  = PETSC_FALSE;
243*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt));
244a7cc72afSBarry Smith   if (opt) {
24583a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
24683a4ac43SBarry Smith     PetscInt         howoften = 1;
247a80ad3e0SBarry Smith 
248*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL));
249*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx));
250*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy));
251bdad233fSMatthew Knepley   }
252fb1732b5SBarry Smith   opt  = PETSC_FALSE;
253*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt));
2542d5ee99bSBarry Smith   if (opt) {
2552d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2562d5ee99bSBarry Smith     PetscReal        bounds[4];
2572d5ee99bSBarry Smith     PetscInt         n = 4;
2582d5ee99bSBarry Smith     PetscDraw        draw;
2596934998bSLisandro Dalcin     PetscDrawAxis    axis;
2602d5ee99bSBarry Smith 
261*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL));
2623c633725SBarry Smith     PetscCheck(n == 4,PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
263*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx));
264*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerDrawGetDraw(ctx->viewer,0,&draw));
265*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis));
266*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]));
267*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2"));
268*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy));
2692d5ee99bSBarry Smith   }
2702d5ee99bSBarry Smith   opt  = PETSC_FALSE;
271*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt));
2723a471f94SBarry Smith   if (opt) {
27383a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
27483a4ac43SBarry Smith     PetscInt         howoften = 1;
2753a471f94SBarry Smith 
276*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL));
277*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx));
278*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy));
2793a471f94SBarry Smith   }
2800ed3bfb6SBarry Smith   opt  = PETSC_FALSE;
281*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt));
2820ed3bfb6SBarry Smith   if (opt) {
2830ed3bfb6SBarry Smith     TSMonitorDrawCtx ctx;
2840ed3bfb6SBarry Smith     PetscInt         howoften = 1;
2850ed3bfb6SBarry Smith 
286*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL));
287*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx));
288*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy));
2890ed3bfb6SBarry Smith   }
290fde5950dSBarry Smith 
291ed81e22dSJed Brown   opt  = PETSC_FALSE;
292*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",NULL,monfilename,sizeof(monfilename),&flg));
293ed81e22dSJed Brown   if (flg) {
294ed81e22dSJed Brown     const char *ptr,*ptr2;
295ed81e22dSJed Brown     char       *filetemplate;
2963c633725SBarry Smith     PetscCheck(monfilename[0],PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
297ed81e22dSJed Brown     /* Do some cursory validation of the input. */
298*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscStrstr(monfilename,"%",(char**)&ptr));
2993c633725SBarry Smith     PetscCheck(ptr,PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
300ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
301*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscStrchr("DdiouxX",*ptr,(char**)&ptr2));
3023c633725SBarry Smith       PetscCheck(ptr2 || (*ptr >= '0' && *ptr <= '9'),PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03D.vts");
303ed81e22dSJed Brown       if (ptr2) break;
304ed81e22dSJed Brown     }
305*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscStrallocpy(monfilename,&filetemplate));
306*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy));
307ed81e22dSJed Brown   }
308bdad233fSMatthew Knepley 
309*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,sizeof(dir),&flg));
310d1212d36SBarry Smith   if (flg) {
311d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
312d1212d36SBarry Smith     int                  ray = 0;
3133ee9839eSMatthew G. Knepley     DMDirection          ddir;
314d1212d36SBarry Smith     DM                   da;
315d1212d36SBarry Smith     PetscMPIInt          rank;
316d1212d36SBarry Smith 
3173c633725SBarry Smith     PetscCheck(dir[1] == '=',PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
3183ee9839eSMatthew G. Knepley     if (dir[0] == 'x') ddir = DM_X;
3193ee9839eSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DM_Y;
32098921bdaSJacob Faibussowitsch     else SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
321d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
322d1212d36SBarry Smith 
323*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscInfo(((PetscObject)ts),"Displaying DMDA ray %c = %d\n",dir[0],ray));
324*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscNew(&rayctx));
325*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetDM(ts,&da));
326*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter));
327*5f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank));
328dd400576SPatrick Sanan     if (rank == 0) {
329*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerDrawOpen(PETSC_COMM_SELF,NULL,NULL,0,0,600,300,&rayctx->viewer));
330d1212d36SBarry Smith     }
33151b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
332*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy));
333d1212d36SBarry Smith   }
334*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,sizeof(dir),&flg));
33551b4a12fSMatthew G. Knepley   if (flg) {
33651b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
33751b4a12fSMatthew G. Knepley     int                 ray = 0;
3383ee9839eSMatthew G. Knepley     DMDirection         ddir;
33951b4a12fSMatthew G. Knepley     DM                  da;
34051b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
341d1212d36SBarry Smith 
3423c633725SBarry Smith     PetscCheck(dir[1] == '=',PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
3433ee9839eSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DM_X;
3443ee9839eSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DM_Y;
34598921bdaSJacob Faibussowitsch     else SETERRQ(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
34651b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3471c3436cfSJed Brown 
348*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscInfo(((PetscObject) ts),"Displaying LG DMDA ray %c = %d\n", dir[0], ray));
349*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscNew(&rayctx));
350*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetDM(ts, &da));
351*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter));
352*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx));
353*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy));
35451b4a12fSMatthew G. Knepley   }
355a7a1495cSBarry Smith 
356*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt));
357b3d3934dSBarry Smith   if (opt) {
358b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
359b3d3934dSBarry Smith 
360*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorEnvelopeCtxCreate(ts,&ctx));
361*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy));
362b3d3934dSBarry Smith   }
363aee7a9fbSMatthew G. Knepley   flg  = PETSC_FALSE;
364*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsBool("-ts_monitor_cancel","Remove all monitors","TSMonitorCancel",flg,&flg,&opt));
365*5f80ce2aSJacob Faibussowitsch   if (opt && flg) CHKERRQ(TSMonitorCancel(ts));
366b3d3934dSBarry Smith 
367847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
368*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL));
369847ff0e1SMatthew G. Knepley   if (flg) {
370847ff0e1SMatthew G. Knepley     DM   dm;
371847ff0e1SMatthew G. Knepley     DMTS tdm;
372847ff0e1SMatthew G. Knepley 
373*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetDM(ts, &dm));
374*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMGetDMTS(dm, &tdm));
375847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
376*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, NULL));
377*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n"));
378847ff0e1SMatthew G. Knepley   }
379847ff0e1SMatthew G. Knepley 
380d763cef2SBarry Smith   /* Handle specific TS options */
381d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
382*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ts->ops->setfromoptions)(PetscOptionsObject,ts));
383d763cef2SBarry Smith   }
384fbc52257SHong Zhang 
385a7bdc993SLisandro Dalcin   /* Handle TSAdapt options */
386*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetAdapt(ts,&ts->adapt));
387*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type));
388*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt));
389a7bdc993SLisandro Dalcin 
39068bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
3914f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
392*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL));
39368bece0bSHong Zhang   if (tflg) {
394*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSSetSaveTrajectory(ts));
39568bece0bSHong Zhang   }
396a05bf03eSHong Zhang 
397*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSAdjointSetFromOptions(PetscOptionsObject,ts));
398d763cef2SBarry Smith 
399d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
400*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts));
401fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
402d763cef2SBarry Smith 
4034f122a70SLisandro Dalcin   if (ts->trajectory) {
404*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSTrajectorySetFromOptions(ts->trajectory,ts));
405d763cef2SBarry Smith   }
40668bece0bSHong Zhang 
4071ef27442SStefano Zampini   /* why do we have to do this here and not during TSSetUp? */
408*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&ts->snes));
4091ef27442SStefano Zampini   if (ts->problem_type == TS_LINEAR) {
410*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectTypeCompareAny((PetscObject)ts->snes,&flg,SNESKSPONLY,SNESKSPTRANSPOSEONLY,""));
411*5f80ce2aSJacob Faibussowitsch     if (!flg) CHKERRQ(SNESSetType(ts->snes,SNESKSPONLY));
4121ef27442SStefano Zampini   }
413*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESSetFromOptions(ts->snes));
414d763cef2SBarry Smith   PetscFunctionReturn(0);
415d763cef2SBarry Smith }
416d763cef2SBarry Smith 
417d2daff3dSHong Zhang /*@
41878fbdcc8SBarry Smith    TSGetTrajectory - Gets the trajectory from a TS if it exists
41978fbdcc8SBarry Smith 
42078fbdcc8SBarry Smith    Collective on TS
42178fbdcc8SBarry Smith 
42278fbdcc8SBarry Smith    Input Parameters:
42378fbdcc8SBarry Smith .  ts - the TS context obtained from TSCreate()
42478fbdcc8SBarry Smith 
4257a7aea1fSJed Brown    Output Parameters:
42678fbdcc8SBarry Smith .  tr - the TSTrajectory object, if it exists
42778fbdcc8SBarry Smith 
42878fbdcc8SBarry Smith    Note: This routine should be called after all TS options have been set
42978fbdcc8SBarry Smith 
43078fbdcc8SBarry Smith    Level: advanced
43178fbdcc8SBarry Smith 
43278fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate()
43378fbdcc8SBarry Smith 
43478fbdcc8SBarry Smith @*/
43578fbdcc8SBarry Smith PetscErrorCode  TSGetTrajectory(TS ts,TSTrajectory *tr)
43678fbdcc8SBarry Smith {
43778fbdcc8SBarry Smith   PetscFunctionBegin;
43878fbdcc8SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
43978fbdcc8SBarry Smith   *tr = ts->trajectory;
44078fbdcc8SBarry Smith   PetscFunctionReturn(0);
44178fbdcc8SBarry Smith }
44278fbdcc8SBarry Smith 
44378fbdcc8SBarry Smith /*@
444bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
445d2daff3dSHong Zhang 
446d2daff3dSHong Zhang    Collective on TS
447d2daff3dSHong Zhang 
448f899ff85SJose E. Roman    Input Parameter:
449bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
450bc952696SBarry Smith 
45178fbdcc8SBarry Smith    Options Database:
45278fbdcc8SBarry Smith +  -ts_save_trajectory - saves the trajectory to a file
45367b8a455SSatish Balay -  -ts_trajectory_type type - set trajectory type
45478fbdcc8SBarry Smith 
45568bece0bSHong Zhang Note: This routine should be called after all TS options have been set
456d2daff3dSHong Zhang 
457c3a89c15SBarry Smith     The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/lib/petsc/bin/PetscBinaryIOTrajectory.py and
45878fbdcc8SBarry Smith    MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m
45978fbdcc8SBarry Smith 
460d2daff3dSHong Zhang    Level: intermediate
461d2daff3dSHong Zhang 
4622d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve()
463d2daff3dSHong Zhang 
464d2daff3dSHong Zhang @*/
465bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
466d2daff3dSHong Zhang {
467d2daff3dSHong Zhang   PetscFunctionBegin;
468d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
469bc952696SBarry Smith   if (!ts->trajectory) {
470*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory));
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 
48567a3cfb0SHong Zhang .seealso: TSGetTrajectory(), TSAdjointSolve(), TSRemoveTrajectory()
4862d29f1f2SStefano Zampini 
4872d29f1f2SStefano Zampini @*/
4882d29f1f2SStefano Zampini PetscErrorCode  TSResetTrajectory(TS ts)
4892d29f1f2SStefano Zampini {
4902d29f1f2SStefano Zampini   PetscFunctionBegin;
4912d29f1f2SStefano Zampini   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4922d29f1f2SStefano Zampini   if (ts->trajectory) {
493*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSTrajectoryDestroy(&ts->trajectory));
494*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory));
4952d29f1f2SStefano Zampini   }
4962d29f1f2SStefano Zampini   PetscFunctionReturn(0);
4972d29f1f2SStefano Zampini }
4982d29f1f2SStefano Zampini 
4992d29f1f2SStefano Zampini /*@
50067a3cfb0SHong Zhang    TSRemoveTrajectory - Destroys and removes the internal TSTrajectory object from TS
50167a3cfb0SHong Zhang 
50267a3cfb0SHong Zhang    Collective on TS
50367a3cfb0SHong Zhang 
50467a3cfb0SHong Zhang    Input Parameters:
50567a3cfb0SHong Zhang .  ts - the TS context obtained from TSCreate()
50667a3cfb0SHong Zhang 
50767a3cfb0SHong Zhang    Level: intermediate
50867a3cfb0SHong Zhang 
50967a3cfb0SHong Zhang .seealso: TSResetTrajectory(), TSAdjointSolve()
51067a3cfb0SHong Zhang 
51167a3cfb0SHong Zhang @*/
51267a3cfb0SHong Zhang PetscErrorCode TSRemoveTrajectory(TS ts)
51367a3cfb0SHong Zhang {
51467a3cfb0SHong Zhang   PetscFunctionBegin;
51567a3cfb0SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
51667a3cfb0SHong Zhang   if (ts->trajectory) {
517*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSTrajectoryDestroy(&ts->trajectory));
51867a3cfb0SHong Zhang   }
51967a3cfb0SHong Zhang   PetscFunctionReturn(0);
52067a3cfb0SHong Zhang }
52167a3cfb0SHong Zhang 
52267a3cfb0SHong Zhang /*@
523a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
524a7a1495cSBarry Smith       set with TSSetRHSJacobian().
525a7a1495cSBarry Smith 
526d083f849SBarry Smith    Collective on TS
527a7a1495cSBarry Smith 
528a7a1495cSBarry Smith    Input Parameters:
529316643e7SJed Brown +  ts - the TS context
530a7a1495cSBarry Smith .  t - current timestep
5310910c330SBarry Smith -  U - input vector
532a7a1495cSBarry Smith 
533a7a1495cSBarry Smith    Output Parameters:
534a7a1495cSBarry Smith +  A - Jacobian matrix
5356b867d5aSJose E. Roman -  B - optional preconditioning matrix
536a7a1495cSBarry Smith 
537a7a1495cSBarry Smith    Notes:
538a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
539a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
540a7a1495cSBarry Smith 
541a7a1495cSBarry Smith    Level: developer
542a7a1495cSBarry Smith 
54394b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
544a7a1495cSBarry Smith @*/
545d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
546a7a1495cSBarry Smith {
547270bf2e7SJed Brown   PetscObjectState Ustate;
5486c1e1eecSBarry Smith   PetscObjectId    Uid;
54924989b8cSPeter Brune   DM               dm;
550942e3340SBarry Smith   DMTS             tsdm;
55124989b8cSPeter Brune   TSRHSJacobian    rhsjacobianfunc;
55224989b8cSPeter Brune   void             *ctx;
553b2df71adSDebojyoti Ghosh   TSRHSFunction    rhsfunction;
554a7a1495cSBarry Smith 
555a7a1495cSBarry Smith   PetscFunctionBegin;
5560700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5570910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5580910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
559*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
560*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMGetDMTS(dm,&tsdm));
561*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetRHSFunction(dm,&rhsfunction,NULL));
562*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx));
563*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectStateGet((PetscObject)U,&Ustate));
564*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectGetId((PetscObject)U,&Uid));
565971015bcSStefano Zampini 
5662663174eSHong Zhang   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) PetscFunctionReturn(0);
567d90be118SSean Farley 
5683c633725SBarry Smith   PetscCheck(ts->rhsjacobian.shift == 0.0 || !ts->rhsjacobian.reuse,PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Should not call TSComputeRHSJacobian() on a shifted matrix (shift=%lf) when RHSJacobian is reusable.",ts->rhsjacobian.shift);
56924989b8cSPeter Brune   if (rhsjacobianfunc) {
570*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogEventBegin(TS_JacobianEval,ts,U,A,B));
571a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
572*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*rhsjacobianfunc)(ts,t,U,A,B,ctx));
573a7a1495cSBarry Smith     PetscStackPop;
574a6ab3590SBarry Smith     ts->rhsjacs++;
575*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogEventEnd(TS_JacobianEval,ts,U,A,B));
576ef66eb69SBarry Smith   } else {
577*5f80ce2aSJacob Faibussowitsch     CHKERRQ(MatZeroEntries(A));
578*5f80ce2aSJacob Faibussowitsch     if (B && A != B) CHKERRQ(MatZeroEntries(B));
579ef66eb69SBarry Smith   }
5800e4ef248SJed Brown   ts->rhsjacobian.time  = t;
581971015bcSStefano Zampini   ts->rhsjacobian.shift = 0;
582971015bcSStefano Zampini   ts->rhsjacobian.scale = 1.;
583*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid));
584*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate));
585a7a1495cSBarry Smith   PetscFunctionReturn(0);
586a7a1495cSBarry Smith }
587a7a1495cSBarry Smith 
588316643e7SJed Brown /*@
589d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
590d763cef2SBarry Smith 
591d083f849SBarry Smith    Collective on TS
592316643e7SJed Brown 
593316643e7SJed Brown    Input Parameters:
594316643e7SJed Brown +  ts - the TS context
595316643e7SJed Brown .  t - current time
5960910c330SBarry Smith -  U - state vector
597316643e7SJed Brown 
598316643e7SJed Brown    Output Parameter:
599316643e7SJed Brown .  y - right hand side
600316643e7SJed Brown 
601316643e7SJed Brown    Note:
602316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
603316643e7SJed Brown    is used internally within the nonlinear solvers.
604316643e7SJed Brown 
605316643e7SJed Brown    Level: developer
606316643e7SJed Brown 
607316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
608316643e7SJed Brown @*/
6090910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
610d763cef2SBarry Smith {
61124989b8cSPeter Brune   TSRHSFunction  rhsfunction;
61224989b8cSPeter Brune   TSIFunction    ifunction;
61324989b8cSPeter Brune   void           *ctx;
61424989b8cSPeter Brune   DM             dm;
61524989b8cSPeter Brune 
616d763cef2SBarry Smith   PetscFunctionBegin;
6170700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6180910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6190700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
620*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
621*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetRHSFunction(dm,&rhsfunction,&ctx));
622*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetIFunction(dm,&ifunction,NULL));
623d763cef2SBarry Smith 
6243c633725SBarry Smith   PetscCheck(rhsfunction || ifunction,PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
625d763cef2SBarry Smith 
62624989b8cSPeter Brune   if (rhsfunction) {
627*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogEventBegin(TS_FunctionEval,ts,U,y,0));
628*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecLockReadPush(U));
629d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
630*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*rhsfunction)(ts,t,U,y,ctx));
631d763cef2SBarry Smith     PetscStackPop;
632*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecLockReadPop(U));
633a6ab3590SBarry Smith     ts->rhsfuncs++;
634*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogEventEnd(TS_FunctionEval,ts,U,y,0));
635214bc6a2SJed Brown   } else {
636*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecZeroEntries(y));
637b2cd27e8SJed Brown   }
638d763cef2SBarry Smith   PetscFunctionReturn(0);
639d763cef2SBarry Smith }
640d763cef2SBarry Smith 
641ef20d060SBarry Smith /*@
642ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
643ef20d060SBarry Smith 
644d083f849SBarry Smith    Collective on TS
645ef20d060SBarry Smith 
646ef20d060SBarry Smith    Input Parameters:
647ef20d060SBarry Smith +  ts - the TS context
648ef20d060SBarry Smith -  t - current time
649ef20d060SBarry Smith 
650ef20d060SBarry Smith    Output Parameter:
6510910c330SBarry Smith .  U - the solution
652ef20d060SBarry Smith 
653ef20d060SBarry Smith    Note:
654ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
655ef20d060SBarry Smith    is used internally within the nonlinear solvers.
656ef20d060SBarry Smith 
657ef20d060SBarry Smith    Level: developer
658ef20d060SBarry Smith 
659abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
660ef20d060SBarry Smith @*/
6610910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
662ef20d060SBarry Smith {
663ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
664ef20d060SBarry Smith   void               *ctx;
665ef20d060SBarry Smith   DM                 dm;
666ef20d060SBarry Smith 
667ef20d060SBarry Smith   PetscFunctionBegin;
668ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6690910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
670*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
671*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetSolutionFunction(dm,&solutionfunction,&ctx));
672ef20d060SBarry Smith 
673ef20d060SBarry Smith   if (solutionfunction) {
6749b7cd975SBarry Smith     PetscStackPush("TS user solution function");
675*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*solutionfunction)(ts,t,U,ctx));
676ef20d060SBarry Smith     PetscStackPop;
677ef20d060SBarry Smith   }
678ef20d060SBarry Smith   PetscFunctionReturn(0);
679ef20d060SBarry Smith }
6809b7cd975SBarry Smith /*@
6819b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
6829b7cd975SBarry Smith 
683d083f849SBarry Smith    Collective on TS
6849b7cd975SBarry Smith 
6859b7cd975SBarry Smith    Input Parameters:
6869b7cd975SBarry Smith +  ts - the TS context
6879b7cd975SBarry Smith -  t - current time
6889b7cd975SBarry Smith 
6899b7cd975SBarry Smith    Output Parameter:
6909b7cd975SBarry Smith .  U - the function value
6919b7cd975SBarry Smith 
6929b7cd975SBarry Smith    Note:
6939b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
6949b7cd975SBarry Smith    is used internally within the nonlinear solvers.
6959b7cd975SBarry Smith 
6969b7cd975SBarry Smith    Level: developer
6979b7cd975SBarry Smith 
6989b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
6999b7cd975SBarry Smith @*/
7009b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7019b7cd975SBarry Smith {
7029b7cd975SBarry Smith   void              *ctx;
7039b7cd975SBarry Smith   DM                 dm;
704*5f80ce2aSJacob Faibussowitsch   TSForcingFunction  forcing;
7059b7cd975SBarry Smith 
7069b7cd975SBarry Smith   PetscFunctionBegin;
7079b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7089b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
709*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
710*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetForcingFunction(dm,&forcing,&ctx));
7119b7cd975SBarry Smith 
7129b7cd975SBarry Smith   if (forcing) {
7139b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
714*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*forcing)(ts,t,U,ctx));
7159b7cd975SBarry Smith     PetscStackPop;
7169b7cd975SBarry Smith   }
7179b7cd975SBarry Smith   PetscFunctionReturn(0);
7189b7cd975SBarry Smith }
719ef20d060SBarry Smith 
720214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
721214bc6a2SJed Brown {
7222dd45cf8SJed Brown   Vec            F;
723214bc6a2SJed Brown 
724214bc6a2SJed Brown   PetscFunctionBegin;
7250298fd71SBarry Smith   *Frhs = NULL;
726*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetIFunction(ts,&F,NULL,NULL));
727214bc6a2SJed Brown   if (!ts->Frhs) {
728*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecDuplicate(F,&ts->Frhs));
729214bc6a2SJed Brown   }
730214bc6a2SJed Brown   *Frhs = ts->Frhs;
731214bc6a2SJed Brown   PetscFunctionReturn(0);
732214bc6a2SJed Brown }
733214bc6a2SJed Brown 
734971015bcSStefano Zampini PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
735214bc6a2SJed Brown {
736214bc6a2SJed Brown   Mat            A,B;
73741a1d4d2SBarry Smith   TSIJacobian    ijacobian;
738214bc6a2SJed Brown 
739214bc6a2SJed Brown   PetscFunctionBegin;
740c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
741c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
742*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetIJacobian(ts,&A,&B,&ijacobian,NULL));
743214bc6a2SJed Brown   if (Arhs) {
744214bc6a2SJed Brown     if (!ts->Arhs) {
74541a1d4d2SBarry Smith       if (ijacobian) {
746*5f80ce2aSJacob Faibussowitsch         CHKERRQ(MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs));
747*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSSetMatStructure(ts,SAME_NONZERO_PATTERN));
74841a1d4d2SBarry Smith       } else {
74941a1d4d2SBarry Smith         ts->Arhs = A;
750*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscObjectReference((PetscObject)A));
75141a1d4d2SBarry Smith       }
7523565c898SBarry Smith     } else {
7533565c898SBarry Smith       PetscBool flg;
754*5f80ce2aSJacob Faibussowitsch       CHKERRQ(SNESGetUseMatrixFree(ts->snes,NULL,&flg));
7553565c898SBarry Smith       /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */
7563565c898SBarry Smith       if (flg && !ijacobian && ts->Arhs == ts->Brhs) {
757*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscObjectDereference((PetscObject)ts->Arhs));
7583565c898SBarry Smith         ts->Arhs = A;
759*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscObjectReference((PetscObject)A));
7603565c898SBarry Smith       }
761214bc6a2SJed Brown     }
762214bc6a2SJed Brown     *Arhs = ts->Arhs;
763214bc6a2SJed Brown   }
764214bc6a2SJed Brown   if (Brhs) {
765214bc6a2SJed Brown     if (!ts->Brhs) {
766bdb70873SJed Brown       if (A != B) {
76741a1d4d2SBarry Smith         if (ijacobian) {
768*5f80ce2aSJacob Faibussowitsch           CHKERRQ(MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs));
769bdb70873SJed Brown         } else {
77041a1d4d2SBarry Smith           ts->Brhs = B;
771*5f80ce2aSJacob Faibussowitsch           CHKERRQ(PetscObjectReference((PetscObject)B));
77241a1d4d2SBarry Smith         }
77341a1d4d2SBarry Smith       } else {
774*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscObjectReference((PetscObject)ts->Arhs));
77551699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
776bdb70873SJed Brown       }
777214bc6a2SJed Brown     }
778214bc6a2SJed Brown     *Brhs = ts->Brhs;
779214bc6a2SJed Brown   }
780214bc6a2SJed Brown   PetscFunctionReturn(0);
781214bc6a2SJed Brown }
782214bc6a2SJed Brown 
783316643e7SJed Brown /*@
7840910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
785316643e7SJed Brown 
786d083f849SBarry Smith    Collective on TS
787316643e7SJed Brown 
788316643e7SJed Brown    Input Parameters:
789316643e7SJed Brown +  ts - the TS context
790316643e7SJed Brown .  t - current time
7910910c330SBarry Smith .  U - state vector
7920910c330SBarry Smith .  Udot - time derivative of state vector
793214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
794316643e7SJed Brown 
795316643e7SJed Brown    Output Parameter:
796316643e7SJed Brown .  Y - right hand side
797316643e7SJed Brown 
798316643e7SJed Brown    Note:
799316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
800316643e7SJed Brown    is used internally within the nonlinear solvers.
801316643e7SJed Brown 
802316643e7SJed Brown    If the user did did not write their equations in implicit form, this
803316643e7SJed Brown    function recasts them in implicit form.
804316643e7SJed Brown 
805316643e7SJed Brown    Level: developer
806316643e7SJed Brown 
807316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
808316643e7SJed Brown @*/
8090910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
810316643e7SJed Brown {
81124989b8cSPeter Brune   TSIFunction    ifunction;
81224989b8cSPeter Brune   TSRHSFunction  rhsfunction;
81324989b8cSPeter Brune   void           *ctx;
81424989b8cSPeter Brune   DM             dm;
815316643e7SJed Brown 
816316643e7SJed Brown   PetscFunctionBegin;
8170700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8180910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8190910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
8200700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
821316643e7SJed Brown 
822*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
823*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetIFunction(dm,&ifunction,&ctx));
824*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetRHSFunction(dm,&rhsfunction,NULL));
82524989b8cSPeter Brune 
8263c633725SBarry Smith   PetscCheck(rhsfunction || ifunction,PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
827d90be118SSean Farley 
828*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y));
82924989b8cSPeter Brune   if (ifunction) {
830316643e7SJed Brown     PetscStackPush("TS user implicit function");
831*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ifunction)(ts,t,U,Udot,Y,ctx));
832316643e7SJed Brown     PetscStackPop;
833a6ab3590SBarry Smith     ts->ifuncs++;
834214bc6a2SJed Brown   }
835214bc6a2SJed Brown   if (imex) {
83624989b8cSPeter Brune     if (!ifunction) {
837*5f80ce2aSJacob Faibussowitsch       CHKERRQ(VecCopy(Udot,Y));
8382dd45cf8SJed Brown     }
83924989b8cSPeter Brune   } else if (rhsfunction) {
84024989b8cSPeter Brune     if (ifunction) {
841214bc6a2SJed Brown       Vec Frhs;
842*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSGetRHSVec_Private(ts,&Frhs));
843*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSComputeRHSFunction(ts,t,U,Frhs));
844*5f80ce2aSJacob Faibussowitsch       CHKERRQ(VecAXPY(Y,-1,Frhs));
8452dd45cf8SJed Brown     } else {
846*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSComputeRHSFunction(ts,t,U,Y));
847*5f80ce2aSJacob Faibussowitsch       CHKERRQ(VecAYPX(Y,-1,Udot));
848316643e7SJed Brown     }
8494a6899ffSJed Brown   }
850*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y));
851316643e7SJed Brown   PetscFunctionReturn(0);
852316643e7SJed Brown }
853316643e7SJed Brown 
854cfa8a9a2SHong Zhang /*
855cfa8a9a2SHong Zhang    TSRecoverRHSJacobian - Recover the Jacobian matrix so that one can call TSComputeRHSJacobian() on it.
856cfa8a9a2SHong Zhang 
857cfa8a9a2SHong Zhang    Note:
858cfa8a9a2SHong Zhang    This routine is needed when one switches from TSComputeIJacobian() to TSComputeRHSJacobian() because the Jacobian matrix may be shifted or scaled in TSComputeIJacobian().
859cfa8a9a2SHong Zhang 
860cfa8a9a2SHong Zhang */
861cfa8a9a2SHong Zhang static PetscErrorCode TSRecoverRHSJacobian(TS ts,Mat A,Mat B)
862cfa8a9a2SHong Zhang {
863cfa8a9a2SHong Zhang   PetscFunctionBegin;
864cfa8a9a2SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8653c633725SBarry Smith   PetscCheck(A == ts->Arhs,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Invalid Amat");
8663c633725SBarry Smith   PetscCheck(B == ts->Brhs,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Invalid Bmat");
867cfa8a9a2SHong Zhang 
868cfa8a9a2SHong Zhang   if (ts->rhsjacobian.shift) {
869*5f80ce2aSJacob Faibussowitsch     CHKERRQ(MatShift(A,-ts->rhsjacobian.shift));
870cfa8a9a2SHong Zhang   }
871cfa8a9a2SHong Zhang   if (ts->rhsjacobian.scale == -1.) {
872*5f80ce2aSJacob Faibussowitsch     CHKERRQ(MatScale(A,-1));
873cfa8a9a2SHong Zhang   }
874cfa8a9a2SHong Zhang   if (B && B == ts->Brhs && A != B) {
875cfa8a9a2SHong Zhang     if (ts->rhsjacobian.shift) {
876*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatShift(B,-ts->rhsjacobian.shift));
877cfa8a9a2SHong Zhang     }
878cfa8a9a2SHong Zhang     if (ts->rhsjacobian.scale == -1.) {
879*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatScale(B,-1));
880cfa8a9a2SHong Zhang     }
881cfa8a9a2SHong Zhang   }
882cfa8a9a2SHong Zhang   ts->rhsjacobian.shift = 0;
883cfa8a9a2SHong Zhang   ts->rhsjacobian.scale = 1.;
884cfa8a9a2SHong Zhang   PetscFunctionReturn(0);
885cfa8a9a2SHong Zhang }
886cfa8a9a2SHong Zhang 
887316643e7SJed Brown /*@
888316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
889316643e7SJed Brown 
890d083f849SBarry Smith    Collective on TS
891316643e7SJed Brown 
892316643e7SJed Brown    Input
893316643e7SJed Brown       Input Parameters:
894316643e7SJed Brown +  ts - the TS context
895316643e7SJed Brown .  t - current timestep
8960910c330SBarry Smith .  U - state vector
8970910c330SBarry Smith .  Udot - time derivative of state vector
898214bc6a2SJed Brown .  shift - shift to apply, see note below
899214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
900316643e7SJed Brown 
901316643e7SJed Brown    Output Parameters:
902316643e7SJed Brown +  A - Jacobian matrix
9033565c898SBarry Smith -  B - matrix from which the preconditioner is constructed; often the same as A
904316643e7SJed Brown 
905316643e7SJed Brown    Notes:
9060910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
907316643e7SJed Brown 
9080910c330SBarry Smith    dF/dU + shift*dF/dUdot
909316643e7SJed Brown 
910316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
911316643e7SJed Brown    is used internally within the nonlinear solvers.
912316643e7SJed Brown 
913316643e7SJed Brown    Level: developer
914316643e7SJed Brown 
915316643e7SJed Brown .seealso:  TSSetIJacobian()
91663495f91SJed Brown @*/
917d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
918316643e7SJed Brown {
91924989b8cSPeter Brune   TSIJacobian    ijacobian;
92024989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
92124989b8cSPeter Brune   DM             dm;
92224989b8cSPeter Brune   void           *ctx;
923316643e7SJed Brown 
924316643e7SJed Brown   PetscFunctionBegin;
9250700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9260910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9270910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
928316643e7SJed Brown   PetscValidPointer(A,6);
92994ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
930316643e7SJed Brown   PetscValidPointer(B,7);
93194ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
93224989b8cSPeter Brune 
933*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
934*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetIJacobian(dm,&ijacobian,&ctx));
935*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetRHSJacobian(dm,&rhsjacobian,NULL));
93624989b8cSPeter Brune 
9373c633725SBarry Smith   PetscCheck(rhsjacobian || ijacobian,PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
938316643e7SJed Brown 
939*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogEventBegin(TS_JacobianEval,ts,U,A,B));
94024989b8cSPeter Brune   if (ijacobian) {
941316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
942*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ijacobian)(ts,t,U,Udot,shift,A,B,ctx));
943a6ab3590SBarry Smith     ts->ijacs++;
944316643e7SJed Brown     PetscStackPop;
9454a6899ffSJed Brown   }
946214bc6a2SJed Brown   if (imex) {
947b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
9484c26be97Sstefano_zampini       PetscBool assembled;
949971015bcSStefano Zampini       if (rhsjacobian) {
950971015bcSStefano Zampini         Mat Arhs = NULL;
951*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSGetRHSMats_Private(ts,&Arhs,NULL));
952971015bcSStefano Zampini         if (A == Arhs) {
9533c633725SBarry Smith           PetscCheck(rhsjacobian != TSComputeRHSJacobianConstant,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 */
954971015bcSStefano Zampini           ts->rhsjacobian.time = PETSC_MIN_REAL;
955971015bcSStefano Zampini         }
956971015bcSStefano Zampini       }
957*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatZeroEntries(A));
958*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatAssembled(A,&assembled));
9594c26be97Sstefano_zampini       if (!assembled) {
960*5f80ce2aSJacob Faibussowitsch         CHKERRQ(MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY));
961*5f80ce2aSJacob Faibussowitsch         CHKERRQ(MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY));
9624c26be97Sstefano_zampini       }
963*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatShift(A,shift));
96494ab13aaSBarry Smith       if (A != B) {
965*5f80ce2aSJacob Faibussowitsch         CHKERRQ(MatZeroEntries(B));
966*5f80ce2aSJacob Faibussowitsch         CHKERRQ(MatAssembled(B,&assembled));
9674c26be97Sstefano_zampini         if (!assembled) {
968*5f80ce2aSJacob Faibussowitsch           CHKERRQ(MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY));
969*5f80ce2aSJacob Faibussowitsch           CHKERRQ(MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY));
9704c26be97Sstefano_zampini         }
971*5f80ce2aSJacob Faibussowitsch         CHKERRQ(MatShift(B,shift));
972214bc6a2SJed Brown       }
973214bc6a2SJed Brown     }
974214bc6a2SJed Brown   } else {
975e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
976e8b1e424SHong Zhang     if (rhsjacobian) { /* RHSJacobian needs to be converted to part of IJacobian if exists */
977*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSGetRHSMats_Private(ts,&Arhs,&Brhs));
978e1244c69SJed Brown     }
979e8b1e424SHong Zhang     if (Arhs == A) { /* No IJacobian matrix, so we only have the RHS matrix */
980e8b1e424SHong Zhang       PetscObjectState Ustate;
981e8b1e424SHong Zhang       PetscObjectId    Uid;
982e8b1e424SHong Zhang       TSRHSFunction    rhsfunction;
983e8b1e424SHong Zhang 
984*5f80ce2aSJacob Faibussowitsch       CHKERRQ(DMTSGetRHSFunction(dm,&rhsfunction,NULL));
985*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscObjectStateGet((PetscObject)U,&Ustate));
986*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscObjectGetId((PetscObject)U,&Uid));
987097a96a2SHong 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 */
988*5f80ce2aSJacob Faibussowitsch         CHKERRQ(MatShift(A,shift-ts->rhsjacobian.shift)); /* revert the old shift and add the new shift with a single call to MatShift */
98934d322a1SHong Zhang         if (A != B) {
990*5f80ce2aSJacob Faibussowitsch           CHKERRQ(MatShift(B,shift-ts->rhsjacobian.shift));
99134d322a1SHong Zhang         }
992e8b1e424SHong Zhang       } else {
9933565c898SBarry Smith         PetscBool flg;
994e8b1e424SHong Zhang 
995e8b1e424SHong Zhang         if (ts->rhsjacobian.reuse) { /* Undo the damage */
996e8b1e424SHong Zhang           /* MatScale has a short path for this case.
997e8b1e424SHong Zhang              However, this code path is taken the first time TSComputeRHSJacobian is called
998e8b1e424SHong Zhang              and the matrices have not been assembled yet */
999*5f80ce2aSJacob Faibussowitsch           CHKERRQ(TSRecoverRHSJacobian(ts,A,B));
1000e8b1e424SHong Zhang         }
1001*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSComputeRHSJacobian(ts,t,U,A,B));
1002*5f80ce2aSJacob Faibussowitsch         CHKERRQ(SNESGetUseMatrixFree(ts->snes,NULL,&flg));
10033565c898SBarry Smith         /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */
10043565c898SBarry Smith         if (!flg) {
1005*5f80ce2aSJacob Faibussowitsch           CHKERRQ(MatScale(A,-1));
1006*5f80ce2aSJacob Faibussowitsch           CHKERRQ(MatShift(A,shift));
10073565c898SBarry Smith         }
100894ab13aaSBarry Smith         if (A != B) {
1009*5f80ce2aSJacob Faibussowitsch           CHKERRQ(MatScale(B,-1));
1010*5f80ce2aSJacob Faibussowitsch           CHKERRQ(MatShift(B,shift));
1011316643e7SJed Brown         }
1012e8b1e424SHong Zhang       }
1013e8b1e424SHong Zhang       ts->rhsjacobian.scale = -1;
1014e8b1e424SHong Zhang       ts->rhsjacobian.shift = shift;
1015d60b7d5cSBarry Smith     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
1016e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
1017*5f80ce2aSJacob Faibussowitsch         CHKERRQ(MatZeroEntries(A));
1018*5f80ce2aSJacob Faibussowitsch         CHKERRQ(MatShift(A,shift));
101994ab13aaSBarry Smith         if (A != B) {
1020*5f80ce2aSJacob Faibussowitsch           CHKERRQ(MatZeroEntries(B));
1021*5f80ce2aSJacob Faibussowitsch           CHKERRQ(MatShift(B,shift));
1022214bc6a2SJed Brown         }
1023316643e7SJed Brown       }
1024*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSComputeRHSJacobian(ts,t,U,Arhs,Brhs));
1025*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatAXPY(A,-1,Arhs,ts->axpy_pattern));
102694ab13aaSBarry Smith       if (A != B) {
1027*5f80ce2aSJacob Faibussowitsch         CHKERRQ(MatAXPY(B,-1,Brhs,ts->axpy_pattern));
1028316643e7SJed Brown       }
1029316643e7SJed Brown     }
1030316643e7SJed Brown   }
1031*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogEventEnd(TS_JacobianEval,ts,U,A,B));
1032316643e7SJed Brown   PetscFunctionReturn(0);
1033316643e7SJed Brown }
1034316643e7SJed Brown 
1035d763cef2SBarry Smith /*@C
1036d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
1037b5abc632SBarry Smith     where U_t = G(t,u).
1038d763cef2SBarry Smith 
10393f9fe445SBarry Smith     Logically Collective on TS
1040d763cef2SBarry Smith 
1041d763cef2SBarry Smith     Input Parameters:
1042d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
10430298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
1044d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
1045d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
10460298fd71SBarry Smith           function evaluation routine (may be NULL)
1047d763cef2SBarry Smith 
1048a96d6ef6SBarry Smith     Calling sequence of f:
1049a96d6ef6SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,Vec F,void *ctx);
1050d763cef2SBarry Smith 
1051a96d6ef6SBarry Smith +   ts - timestep context
1052a96d6ef6SBarry Smith .   t - current timestep
1053d763cef2SBarry Smith .   u - input vector
1054d763cef2SBarry Smith .   F - function vector
1055d763cef2SBarry Smith -   ctx - [optional] user-defined function context
1056d763cef2SBarry Smith 
1057d763cef2SBarry Smith     Level: beginner
1058d763cef2SBarry Smith 
105995452b02SPatrick Sanan     Notes:
106095452b02SPatrick Sanan     You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
10612bbac0d3SBarry Smith 
1062ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
1063d763cef2SBarry Smith @*/
1064089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
1065d763cef2SBarry Smith {
1066089b2837SJed Brown   SNES           snes;
10670298fd71SBarry Smith   Vec            ralloc = NULL;
106824989b8cSPeter Brune   DM             dm;
1069d763cef2SBarry Smith 
1070089b2837SJed Brown   PetscFunctionBegin;
10710700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1072ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
107324989b8cSPeter Brune 
1074*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1075*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSSetRHSFunction(dm,f,ctx));
1076*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
1077e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1078*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecDuplicate(ts->vec_sol,&ralloc));
1079e856ceecSJed Brown     r = ralloc;
1080e856ceecSJed Brown   }
1081*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESSetFunction(snes,r,SNESTSFormFunction,ts));
1082*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&ralloc));
1083d763cef2SBarry Smith   PetscFunctionReturn(0);
1084d763cef2SBarry Smith }
1085d763cef2SBarry Smith 
1086ef20d060SBarry Smith /*@C
1087abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1088ef20d060SBarry Smith 
1089ef20d060SBarry Smith     Logically Collective on TS
1090ef20d060SBarry Smith 
1091ef20d060SBarry Smith     Input Parameters:
1092ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1093ef20d060SBarry Smith .   f - routine for evaluating the solution
1094ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
10950298fd71SBarry Smith           function evaluation routine (may be NULL)
1096ef20d060SBarry Smith 
1097a96d6ef6SBarry Smith     Calling sequence of f:
1098a96d6ef6SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,void *ctx);
1099ef20d060SBarry Smith 
1100ef20d060SBarry Smith +   t - current timestep
1101ef20d060SBarry Smith .   u - output vector
1102ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1103ef20d060SBarry Smith 
11040ed3bfb6SBarry Smith     Options Database:
11050ed3bfb6SBarry Smith +  -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction()
11060ed3bfb6SBarry Smith -  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
11070ed3bfb6SBarry Smith 
1108abd5a294SJed Brown     Notes:
1109abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1110abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1111abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1112abd5a294SJed Brown 
11134f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1114abd5a294SJed Brown 
1115ef20d060SBarry Smith     Level: beginner
1116ef20d060SBarry Smith 
11170ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError()
1118ef20d060SBarry Smith @*/
1119ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1120ef20d060SBarry Smith {
1121ef20d060SBarry Smith   DM             dm;
1122ef20d060SBarry Smith 
1123ef20d060SBarry Smith   PetscFunctionBegin;
1124ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1125*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1126*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSSetSolutionFunction(dm,f,ctx));
1127ef20d060SBarry Smith   PetscFunctionReturn(0);
1128ef20d060SBarry Smith }
1129ef20d060SBarry Smith 
11309b7cd975SBarry Smith /*@C
11319b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
11329b7cd975SBarry Smith 
11339b7cd975SBarry Smith     Logically Collective on TS
11349b7cd975SBarry Smith 
11359b7cd975SBarry Smith     Input Parameters:
11369b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
1137e162b725SBarry Smith .   func - routine for evaluating the forcing function
11389b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
11390298fd71SBarry Smith           function evaluation routine (may be NULL)
11409b7cd975SBarry Smith 
11419b7cd975SBarry Smith     Calling sequence of func:
11426bc98fa9SBarry Smith $     PetscErrorCode func (TS ts,PetscReal t,Vec f,void *ctx);
11439b7cd975SBarry Smith 
11449b7cd975SBarry Smith +   t - current timestep
1145e162b725SBarry Smith .   f - output vector
11469b7cd975SBarry Smith -   ctx - [optional] user-defined function context
11479b7cd975SBarry Smith 
11489b7cd975SBarry Smith     Notes:
11499b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
1150e162b725SBarry 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
1151e162b725SBarry Smith     definition of the problem you are solving and hence possibly introducing bugs.
1152e162b725SBarry Smith 
1153e162b725SBarry Smith     This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0
1154e162b725SBarry Smith 
1155e162b725SBarry 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
1156e162b725SBarry Smith     parameters can be passed in the ctx variable.
11579b7cd975SBarry Smith 
11589b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
11599b7cd975SBarry Smith 
11609b7cd975SBarry Smith     Level: beginner
11619b7cd975SBarry Smith 
11629b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
11639b7cd975SBarry Smith @*/
1164e162b725SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx)
11659b7cd975SBarry Smith {
11669b7cd975SBarry Smith   DM             dm;
11679b7cd975SBarry Smith 
11689b7cd975SBarry Smith   PetscFunctionBegin;
11699b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1170*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1171*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSSetForcingFunction(dm,func,ctx));
11729b7cd975SBarry Smith   PetscFunctionReturn(0);
11739b7cd975SBarry Smith }
11749b7cd975SBarry Smith 
1175d763cef2SBarry Smith /*@C
1176f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1177b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1178d763cef2SBarry Smith 
11793f9fe445SBarry Smith    Logically Collective on TS
1180d763cef2SBarry Smith 
1181d763cef2SBarry Smith    Input Parameters:
1182d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1183e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1184e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1185d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1186d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
11870298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1188d763cef2SBarry Smith 
1189f7ab8db6SBarry Smith    Calling sequence of f:
1190a96d6ef6SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1191d763cef2SBarry Smith 
1192d763cef2SBarry Smith +  t - current timestep
1193d763cef2SBarry Smith .  u - input vector
1194e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1195e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1196d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1197d763cef2SBarry Smith 
11986cd88445SBarry Smith    Notes:
11996cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
12006cd88445SBarry Smith 
12016cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1202ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1203d763cef2SBarry Smith 
1204d763cef2SBarry Smith    Level: beginner
1205d763cef2SBarry Smith 
1206ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1207d763cef2SBarry Smith 
1208d763cef2SBarry Smith @*/
1209e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1210d763cef2SBarry Smith {
1211089b2837SJed Brown   SNES           snes;
121224989b8cSPeter Brune   DM             dm;
121324989b8cSPeter Brune   TSIJacobian    ijacobian;
1214277b19d0SLisandro Dalcin 
1215d763cef2SBarry Smith   PetscFunctionBegin;
12160700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1217e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1218e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1219e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1220e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1221d763cef2SBarry Smith 
1222*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1223*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSSetRHSJacobian(dm,f,ctx));
1224*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetIJacobian(dm,&ijacobian,NULL));
1225*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
12265f659677SPeter Brune   if (!ijacobian) {
1227*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts));
12280e4ef248SJed Brown   }
1229e5d3d808SBarry Smith   if (Amat) {
1230*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectReference((PetscObject)Amat));
1231*5f80ce2aSJacob Faibussowitsch     CHKERRQ(MatDestroy(&ts->Arhs));
1232e5d3d808SBarry Smith     ts->Arhs = Amat;
12330e4ef248SJed Brown   }
1234e5d3d808SBarry Smith   if (Pmat) {
1235*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectReference((PetscObject)Pmat));
1236*5f80ce2aSJacob Faibussowitsch     CHKERRQ(MatDestroy(&ts->Brhs));
1237e5d3d808SBarry Smith     ts->Brhs = Pmat;
12380e4ef248SJed Brown   }
1239d763cef2SBarry Smith   PetscFunctionReturn(0);
1240d763cef2SBarry Smith }
1241d763cef2SBarry Smith 
1242316643e7SJed Brown /*@C
1243b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1244316643e7SJed Brown 
12453f9fe445SBarry Smith    Logically Collective on TS
1246316643e7SJed Brown 
1247316643e7SJed Brown    Input Parameters:
1248316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
12490298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1250316643e7SJed Brown .  f   - the function evaluation routine
12510298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1252316643e7SJed Brown 
1253316643e7SJed Brown    Calling sequence of f:
12546bc98fa9SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1255316643e7SJed Brown 
1256316643e7SJed Brown +  t   - time at step/stage being solved
1257316643e7SJed Brown .  u   - state vector
1258316643e7SJed Brown .  u_t - time derivative of state vector
1259316643e7SJed Brown .  F   - function vector
1260316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1261316643e7SJed Brown 
1262316643e7SJed Brown    Important:
12632bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1264316643e7SJed Brown 
1265316643e7SJed Brown    Level: beginner
1266316643e7SJed Brown 
1267d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1268316643e7SJed Brown @*/
126951699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1270316643e7SJed Brown {
1271089b2837SJed Brown   SNES           snes;
127251699248SLisandro Dalcin   Vec            ralloc = NULL;
127324989b8cSPeter Brune   DM             dm;
1274316643e7SJed Brown 
1275316643e7SJed Brown   PetscFunctionBegin;
12760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
127751699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
127824989b8cSPeter Brune 
1279*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1280*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSSetIFunction(dm,f,ctx));
128124989b8cSPeter Brune 
1282*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
128351699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
1284*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecDuplicate(ts->vec_sol,&ralloc));
128551699248SLisandro Dalcin     r  = ralloc;
1286e856ceecSJed Brown   }
1287*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESSetFunction(snes,r,SNESTSFormFunction,ts));
1288*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&ralloc));
1289089b2837SJed Brown   PetscFunctionReturn(0);
1290089b2837SJed Brown }
1291089b2837SJed Brown 
1292089b2837SJed Brown /*@C
1293a5b23f4aSJose E. Roman    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/context to compute it.
1294089b2837SJed Brown 
1295089b2837SJed Brown    Not Collective
1296089b2837SJed Brown 
1297089b2837SJed Brown    Input Parameter:
1298089b2837SJed Brown .  ts - the TS context
1299089b2837SJed Brown 
1300d8d19677SJose E. Roman    Output Parameters:
13010298fd71SBarry Smith +  r - vector to hold residual (or NULL)
13020298fd71SBarry Smith .  func - the function to compute residual (or NULL)
13030298fd71SBarry Smith -  ctx - the function context (or NULL)
1304089b2837SJed Brown 
1305089b2837SJed Brown    Level: advanced
1306089b2837SJed Brown 
1307089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1308089b2837SJed Brown @*/
1309089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1310089b2837SJed Brown {
1311089b2837SJed Brown   SNES           snes;
131224989b8cSPeter Brune   DM             dm;
1313089b2837SJed Brown 
1314089b2837SJed Brown   PetscFunctionBegin;
1315089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1316*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
1317*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESGetFunction(snes,r,NULL,NULL));
1318*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1319*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetIFunction(dm,func,ctx));
1320089b2837SJed Brown   PetscFunctionReturn(0);
1321089b2837SJed Brown }
1322089b2837SJed Brown 
1323089b2837SJed Brown /*@C
1324089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1325089b2837SJed Brown 
1326089b2837SJed Brown    Not Collective
1327089b2837SJed Brown 
1328089b2837SJed Brown    Input Parameter:
1329089b2837SJed Brown .  ts - the TS context
1330089b2837SJed Brown 
1331d8d19677SJose E. Roman    Output Parameters:
13320298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
13330298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
13340298fd71SBarry Smith -  ctx - the function context (or NULL)
1335089b2837SJed Brown 
1336089b2837SJed Brown    Level: advanced
1337089b2837SJed Brown 
13382bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1339089b2837SJed Brown @*/
1340089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1341089b2837SJed Brown {
1342089b2837SJed Brown   SNES           snes;
134324989b8cSPeter Brune   DM             dm;
1344089b2837SJed Brown 
1345089b2837SJed Brown   PetscFunctionBegin;
1346089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1347*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
1348*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESGetFunction(snes,r,NULL,NULL));
1349*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1350*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetRHSFunction(dm,func,ctx));
1351316643e7SJed Brown   PetscFunctionReturn(0);
1352316643e7SJed Brown }
1353316643e7SJed Brown 
1354316643e7SJed Brown /*@C
1355a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1356ae8867d6SBarry Smith         provided with TSSetIFunction().
1357316643e7SJed Brown 
13583f9fe445SBarry Smith    Logically Collective on TS
1359316643e7SJed Brown 
1360316643e7SJed Brown    Input Parameters:
1361316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1362e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1363e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1364316643e7SJed Brown .  f   - the Jacobian evaluation routine
13650298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1366316643e7SJed Brown 
1367316643e7SJed Brown    Calling sequence of f:
13686bc98fa9SBarry Smith $    PetscErrorCode f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1369316643e7SJed Brown 
1370316643e7SJed Brown +  t    - time at step/stage being solved
13711b4a444bSJed Brown .  U    - state vector
13721b4a444bSJed Brown .  U_t  - time derivative of state vector
1373316643e7SJed Brown .  a    - shift
1374e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1375e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1376316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1377316643e7SJed Brown 
1378316643e7SJed Brown    Notes:
1379e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1380316643e7SJed Brown 
1381895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1382895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1383895c21f2SBarry Smith 
1384a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1385b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1386a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1387a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1388a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1389a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1390a4f0a591SBarry Smith 
13916cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
13926cd88445SBarry Smith 
13936cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1394ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1395ca5f011dSBarry Smith 
1396316643e7SJed Brown    Level: beginner
1397316643e7SJed Brown 
1398ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1399316643e7SJed Brown 
1400316643e7SJed Brown @*/
1401e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1402316643e7SJed Brown {
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 
1413*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1414*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSSetIJacobian(dm,f,ctx));
141524989b8cSPeter Brune 
1416*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
1417*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts));
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 
14294165533cSJose E. Roman    Input Parameters:
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 
1473efe9872eSLisandro Dalcin   PetscFunctionBegin;
1474efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1475efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2);
1476*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetIFunction(ts,F,NULL,NULL));
1477*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1478*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSSetI2Function(dm,fun,ctx));
1479efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1480efe9872eSLisandro Dalcin }
1481efe9872eSLisandro Dalcin 
1482efe9872eSLisandro Dalcin /*@C
1483a5b23f4aSJose E. Roman   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/context to compute it.
1484efe9872eSLisandro Dalcin 
1485efe9872eSLisandro Dalcin   Not Collective
1486efe9872eSLisandro Dalcin 
1487efe9872eSLisandro Dalcin   Input Parameter:
1488efe9872eSLisandro Dalcin . ts - the TS context
1489efe9872eSLisandro Dalcin 
1490d8d19677SJose E. Roman   Output Parameters:
1491efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL)
1492efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL)
1493efe9872eSLisandro Dalcin - ctx - the function context (or NULL)
1494efe9872eSLisandro Dalcin 
1495efe9872eSLisandro Dalcin   Level: advanced
1496efe9872eSLisandro Dalcin 
1497a96d6ef6SBarry Smith .seealso: TSSetIFunction(), SNESGetFunction(), TSCreate()
1498efe9872eSLisandro Dalcin @*/
1499efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1500efe9872eSLisandro Dalcin {
1501efe9872eSLisandro Dalcin   SNES           snes;
1502efe9872eSLisandro Dalcin   DM             dm;
1503efe9872eSLisandro Dalcin 
1504efe9872eSLisandro Dalcin   PetscFunctionBegin;
1505efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1506*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
1507*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESGetFunction(snes,r,NULL,NULL));
1508*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1509*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetI2Function(dm,fun,ctx));
1510efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1511efe9872eSLisandro Dalcin }
1512efe9872eSLisandro Dalcin 
1513efe9872eSLisandro Dalcin /*@C
1514bc77d74cSLisandro Dalcin    TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1515efe9872eSLisandro Dalcin         where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1516efe9872eSLisandro Dalcin 
1517efe9872eSLisandro Dalcin    Logically Collective on TS
1518efe9872eSLisandro Dalcin 
1519efe9872eSLisandro Dalcin    Input Parameters:
1520efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1521efe9872eSLisandro Dalcin .  J   - Jacobian matrix
1522efe9872eSLisandro Dalcin .  P   - preconditioning matrix for J (may be same as J)
1523efe9872eSLisandro Dalcin .  jac - the Jacobian evaluation routine
1524efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1525efe9872eSLisandro Dalcin 
1526efe9872eSLisandro Dalcin    Calling sequence of jac:
15276bc98fa9SBarry 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);
1528efe9872eSLisandro Dalcin 
1529efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1530efe9872eSLisandro Dalcin .  U    - state vector
1531efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1532efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1533efe9872eSLisandro Dalcin .  v    - shift for U_t
1534efe9872eSLisandro Dalcin .  a    - shift for U_tt
1535efe9872eSLisandro 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
1536efe9872eSLisandro Dalcin .  P    - preconditioning matrix for J, may be same as J
1537efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine
1538efe9872eSLisandro Dalcin 
1539efe9872eSLisandro Dalcin    Notes:
1540efe9872eSLisandro Dalcin    The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1541efe9872eSLisandro Dalcin 
1542efe9872eSLisandro Dalcin    The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1543efe9872eSLisandro 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.
1544efe9872eSLisandro Dalcin    The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1545bc77d74cSLisandro Dalcin    parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1546efe9872eSLisandro Dalcin 
1547efe9872eSLisandro Dalcin    Level: beginner
1548efe9872eSLisandro Dalcin 
1549a96d6ef6SBarry Smith .seealso: TSSetI2Function(), TSGetI2Jacobian()
1550efe9872eSLisandro Dalcin @*/
1551efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1552efe9872eSLisandro Dalcin {
1553efe9872eSLisandro Dalcin   DM             dm;
1554efe9872eSLisandro Dalcin 
1555efe9872eSLisandro Dalcin   PetscFunctionBegin;
1556efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1557efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2);
1558efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3);
1559*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetIJacobian(ts,J,P,NULL,NULL));
1560*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1561*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSSetI2Jacobian(dm,jac,ctx));
1562efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1563efe9872eSLisandro Dalcin }
1564efe9872eSLisandro Dalcin 
1565efe9872eSLisandro Dalcin /*@C
1566efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1567efe9872eSLisandro Dalcin 
1568efe9872eSLisandro Dalcin   Not Collective, but parallel objects are returned if TS is parallel
1569efe9872eSLisandro Dalcin 
1570efe9872eSLisandro Dalcin   Input Parameter:
1571efe9872eSLisandro Dalcin . ts  - The TS context obtained from TSCreate()
1572efe9872eSLisandro Dalcin 
1573efe9872eSLisandro Dalcin   Output Parameters:
1574efe9872eSLisandro Dalcin + J  - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1575efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J
1576efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1577efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1578efe9872eSLisandro Dalcin 
157995452b02SPatrick Sanan   Notes:
158095452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
1581efe9872eSLisandro Dalcin 
1582efe9872eSLisandro Dalcin   Level: advanced
1583efe9872eSLisandro Dalcin 
1584a96d6ef6SBarry Smith .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber(), TSSetI2Jacobian(), TSGetI2Function(), TSCreate()
1585efe9872eSLisandro Dalcin 
1586efe9872eSLisandro Dalcin @*/
1587efe9872eSLisandro Dalcin PetscErrorCode  TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1588efe9872eSLisandro Dalcin {
1589efe9872eSLisandro Dalcin   SNES           snes;
1590efe9872eSLisandro Dalcin   DM             dm;
1591efe9872eSLisandro Dalcin 
1592efe9872eSLisandro Dalcin   PetscFunctionBegin;
1593*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
1594*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESSetUpMatrices(snes));
1595*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESGetJacobian(snes,J,P,NULL,NULL));
1596*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1597*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetI2Jacobian(dm,jac,ctx));
1598efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1599efe9872eSLisandro Dalcin }
1600efe9872eSLisandro Dalcin 
1601efe9872eSLisandro Dalcin /*@
1602efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1603efe9872eSLisandro Dalcin 
1604d083f849SBarry Smith   Collective on TS
1605efe9872eSLisandro Dalcin 
1606efe9872eSLisandro Dalcin   Input Parameters:
1607efe9872eSLisandro Dalcin + ts - the TS context
1608efe9872eSLisandro Dalcin . t - current time
1609efe9872eSLisandro Dalcin . U - state vector
1610efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t)
1611efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt)
1612efe9872eSLisandro Dalcin 
1613efe9872eSLisandro Dalcin   Output Parameter:
1614efe9872eSLisandro Dalcin . F - the residual vector
1615efe9872eSLisandro Dalcin 
1616efe9872eSLisandro Dalcin   Note:
1617efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1618efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1619efe9872eSLisandro Dalcin 
1620efe9872eSLisandro Dalcin   Level: developer
1621efe9872eSLisandro Dalcin 
1622a96d6ef6SBarry Smith .seealso: TSSetI2Function(), TSGetI2Function()
1623efe9872eSLisandro Dalcin @*/
1624efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1625efe9872eSLisandro Dalcin {
1626efe9872eSLisandro Dalcin   DM             dm;
1627efe9872eSLisandro Dalcin   TSI2Function   I2Function;
1628efe9872eSLisandro Dalcin   void           *ctx;
1629efe9872eSLisandro Dalcin   TSRHSFunction  rhsfunction;
1630efe9872eSLisandro Dalcin 
1631efe9872eSLisandro Dalcin   PetscFunctionBegin;
1632efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1633efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1634efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1635efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1636efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F,VEC_CLASSID,6);
1637efe9872eSLisandro Dalcin 
1638*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1639*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetI2Function(dm,&I2Function,&ctx));
1640*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetRHSFunction(dm,&rhsfunction,NULL));
1641efe9872eSLisandro Dalcin 
1642efe9872eSLisandro Dalcin   if (!I2Function) {
1643*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE));
1644efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1645efe9872eSLisandro Dalcin   }
1646efe9872eSLisandro Dalcin 
1647*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogEventBegin(TS_FunctionEval,ts,U,V,F));
1648efe9872eSLisandro Dalcin 
1649efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit function");
1650*5f80ce2aSJacob Faibussowitsch   CHKERRQ(I2Function(ts,t,U,V,A,F,ctx));
1651efe9872eSLisandro Dalcin   PetscStackPop;
1652efe9872eSLisandro Dalcin 
1653efe9872eSLisandro Dalcin   if (rhsfunction) {
1654efe9872eSLisandro Dalcin     Vec Frhs;
1655*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetRHSVec_Private(ts,&Frhs));
1656*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSComputeRHSFunction(ts,t,U,Frhs));
1657*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecAXPY(F,-1,Frhs));
1658efe9872eSLisandro Dalcin   }
1659efe9872eSLisandro Dalcin 
1660*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogEventEnd(TS_FunctionEval,ts,U,V,F));
1661efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1662efe9872eSLisandro Dalcin }
1663efe9872eSLisandro Dalcin 
1664efe9872eSLisandro Dalcin /*@
1665efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1666efe9872eSLisandro Dalcin 
1667d083f849SBarry Smith   Collective on TS
1668efe9872eSLisandro Dalcin 
1669efe9872eSLisandro Dalcin   Input Parameters:
1670efe9872eSLisandro Dalcin + ts - the TS context
1671efe9872eSLisandro Dalcin . t - current timestep
1672efe9872eSLisandro Dalcin . U - state vector
1673efe9872eSLisandro Dalcin . V - time derivative of state vector
1674efe9872eSLisandro Dalcin . A - second time derivative of state vector
1675efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1676efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1677efe9872eSLisandro Dalcin 
1678efe9872eSLisandro Dalcin   Output Parameters:
1679efe9872eSLisandro Dalcin + J - Jacobian matrix
1680efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1681efe9872eSLisandro Dalcin 
1682efe9872eSLisandro Dalcin   Notes:
1683efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1684efe9872eSLisandro Dalcin 
1685efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1686efe9872eSLisandro Dalcin 
1687efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1688efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1689efe9872eSLisandro Dalcin 
1690efe9872eSLisandro Dalcin   Level: developer
1691efe9872eSLisandro Dalcin 
1692efe9872eSLisandro Dalcin .seealso:  TSSetI2Jacobian()
1693efe9872eSLisandro Dalcin @*/
1694efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1695efe9872eSLisandro Dalcin {
1696efe9872eSLisandro Dalcin   DM             dm;
1697efe9872eSLisandro Dalcin   TSI2Jacobian   I2Jacobian;
1698efe9872eSLisandro Dalcin   void           *ctx;
1699efe9872eSLisandro Dalcin   TSRHSJacobian  rhsjacobian;
1700efe9872eSLisandro Dalcin 
1701efe9872eSLisandro Dalcin   PetscFunctionBegin;
1702efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1703efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1704efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1705efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1706efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J,MAT_CLASSID,8);
1707efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P,MAT_CLASSID,9);
1708efe9872eSLisandro Dalcin 
1709*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1710*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx));
1711*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetRHSJacobian(dm,&rhsjacobian,NULL));
1712efe9872eSLisandro Dalcin 
1713efe9872eSLisandro Dalcin   if (!I2Jacobian) {
1714*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE));
1715efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1716efe9872eSLisandro Dalcin   }
1717efe9872eSLisandro Dalcin 
1718*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogEventBegin(TS_JacobianEval,ts,U,J,P));
1719efe9872eSLisandro Dalcin 
1720efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit Jacobian");
1721*5f80ce2aSJacob Faibussowitsch   CHKERRQ(I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx));
1722efe9872eSLisandro Dalcin   PetscStackPop;
1723efe9872eSLisandro Dalcin 
1724efe9872eSLisandro Dalcin   if (rhsjacobian) {
1725d60b7d5cSBarry Smith     Mat Jrhs,Prhs;
1726*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetRHSMats_Private(ts,&Jrhs,&Prhs));
1727*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs));
1728*5f80ce2aSJacob Faibussowitsch     CHKERRQ(MatAXPY(J,-1,Jrhs,ts->axpy_pattern));
1729*5f80ce2aSJacob Faibussowitsch     if (P != J) CHKERRQ(MatAXPY(P,-1,Prhs,ts->axpy_pattern));
1730efe9872eSLisandro Dalcin   }
1731efe9872eSLisandro Dalcin 
1732*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogEventEnd(TS_JacobianEval,ts,U,J,P));
1733efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1734efe9872eSLisandro Dalcin }
1735efe9872eSLisandro Dalcin 
1736438f35afSJed Brown /*@C
1737438f35afSJed Brown    TSSetTransientVariable - sets function to transform from state to transient variables
1738438f35afSJed Brown 
1739438f35afSJed Brown    Logically Collective
1740438f35afSJed Brown 
17414165533cSJose E. Roman    Input Parameters:
1742438f35afSJed Brown +  ts - time stepping context on which to change the transient variable
1743a96d6ef6SBarry Smith .  tvar - a function that transforms to transient variables
1744438f35afSJed Brown -  ctx - a context for tvar
1745438f35afSJed Brown 
1746a96d6ef6SBarry Smith     Calling sequence of tvar:
1747a96d6ef6SBarry Smith $     PetscErrorCode tvar(TS ts,Vec p,Vec c,void *ctx);
1748a96d6ef6SBarry Smith 
1749a96d6ef6SBarry Smith +   ts - timestep context
1750a96d6ef6SBarry Smith .   p - input vector (primative form)
1751a96d6ef6SBarry Smith .   c - output vector, transient variables (conservative form)
1752a96d6ef6SBarry Smith -   ctx - [optional] user-defined function context
1753a96d6ef6SBarry Smith 
1754438f35afSJed Brown    Level: advanced
1755438f35afSJed Brown 
1756438f35afSJed Brown    Notes:
1757438f35afSJed Brown    This is typically used to transform from primitive to conservative variables so that a time integrator (e.g., TSBDF)
1758438f35afSJed Brown    can be conservative.  In this context, primitive variables P are used to model the state (e.g., because they lead to
1759438f35afSJed Brown    well-conditioned formulations even in limiting cases such as low-Mach or zero porosity).  The transient variable is
1760438f35afSJed Brown    C(P), specified by calling this function.  An IFunction thus receives arguments (P, Cdot) and the IJacobian must be
1761438f35afSJed Brown    evaluated via the chain rule, as in
1762438f35afSJed Brown 
1763438f35afSJed Brown      dF/dP + shift * dF/dCdot dC/dP.
1764438f35afSJed Brown 
1765438f35afSJed Brown .seealso: DMTSSetTransientVariable(), DMTSGetTransientVariable(), TSSetIFunction(), TSSetIJacobian()
1766438f35afSJed Brown @*/
1767438f35afSJed Brown PetscErrorCode TSSetTransientVariable(TS ts,TSTransientVariable tvar,void *ctx)
1768438f35afSJed Brown {
1769438f35afSJed Brown   DM             dm;
1770438f35afSJed Brown 
1771438f35afSJed Brown   PetscFunctionBegin;
1772438f35afSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1773*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1774*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSSetTransientVariable(dm,tvar,ctx));
1775438f35afSJed Brown   PetscFunctionReturn(0);
1776438f35afSJed Brown }
1777438f35afSJed Brown 
1778efe9872eSLisandro Dalcin /*@
1779e3c11fc1SJed Brown    TSComputeTransientVariable - transforms state (primitive) variables to transient (conservative) variables
1780e3c11fc1SJed Brown 
1781e3c11fc1SJed Brown    Logically Collective
1782e3c11fc1SJed Brown 
1783e3c11fc1SJed Brown    Input Parameters:
1784e3c11fc1SJed Brown +  ts - TS on which to compute
1785e3c11fc1SJed Brown -  U - state vector to be transformed to transient variables
1786e3c11fc1SJed Brown 
1787e3c11fc1SJed Brown    Output Parameters:
1788e3c11fc1SJed Brown .  C - transient (conservative) variable
1789e3c11fc1SJed Brown 
1790e3c11fc1SJed Brown    Developer Notes:
1791e3c11fc1SJed Brown    If DMTSSetTransientVariable() has not been called, then C is not modified in this routine and C=NULL is allowed.
1792e3c11fc1SJed Brown    This makes it safe to call without a guard.  One can use TSHasTransientVariable() to check if transient variables are
1793e3c11fc1SJed Brown    being used.
1794e3c11fc1SJed Brown 
1795e3c11fc1SJed Brown    Level: developer
1796e3c11fc1SJed Brown 
1797e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeIFunction(), TSComputeIJacobian()
1798e3c11fc1SJed Brown @*/
1799e3c11fc1SJed Brown PetscErrorCode TSComputeTransientVariable(TS ts,Vec U,Vec C)
1800e3c11fc1SJed Brown {
1801e3c11fc1SJed Brown   DM             dm;
1802e3c11fc1SJed Brown   DMTS           dmts;
1803e3c11fc1SJed Brown 
1804e3c11fc1SJed Brown   PetscFunctionBegin;
1805e3c11fc1SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1806e3c11fc1SJed Brown   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
1807*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1808*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMGetDMTS(dm,&dmts));
1809e3c11fc1SJed Brown   if (dmts->ops->transientvar) {
1810e3c11fc1SJed Brown     PetscValidHeaderSpecific(C,VEC_CLASSID,3);
1811*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*dmts->ops->transientvar)(ts,U,C,dmts->transientvarctx));
1812e3c11fc1SJed Brown   }
1813e3c11fc1SJed Brown   PetscFunctionReturn(0);
1814e3c11fc1SJed Brown }
1815e3c11fc1SJed Brown 
1816e3c11fc1SJed Brown /*@
1817e3c11fc1SJed Brown    TSHasTransientVariable - determine whether transient variables have been set
1818e3c11fc1SJed Brown 
1819e3c11fc1SJed Brown    Logically Collective
1820e3c11fc1SJed Brown 
1821e3c11fc1SJed Brown    Input Parameters:
1822e3c11fc1SJed Brown .  ts - TS on which to compute
1823e3c11fc1SJed Brown 
1824e3c11fc1SJed Brown    Output Parameters:
1825e3c11fc1SJed Brown .  has - PETSC_TRUE if transient variables have been set
1826e3c11fc1SJed Brown 
1827e3c11fc1SJed Brown    Level: developer
1828e3c11fc1SJed Brown 
1829e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeTransientVariable()
1830e3c11fc1SJed Brown @*/
1831e3c11fc1SJed Brown PetscErrorCode TSHasTransientVariable(TS ts,PetscBool *has)
1832e3c11fc1SJed Brown {
1833e3c11fc1SJed Brown   DM             dm;
1834e3c11fc1SJed Brown   DMTS           dmts;
1835e3c11fc1SJed Brown 
1836e3c11fc1SJed Brown   PetscFunctionBegin;
1837e3c11fc1SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1838*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
1839*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMGetDMTS(dm,&dmts));
1840e3c11fc1SJed Brown   *has = dmts->ops->transientvar ? PETSC_TRUE : PETSC_FALSE;
1841e3c11fc1SJed Brown   PetscFunctionReturn(0);
1842e3c11fc1SJed Brown }
1843e3c11fc1SJed Brown 
1844e3c11fc1SJed Brown /*@
1845efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1846efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1847efe9872eSLisandro Dalcin 
1848d083f849SBarry Smith    Logically Collective on TS
1849efe9872eSLisandro Dalcin 
1850efe9872eSLisandro Dalcin    Input Parameters:
1851efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1852efe9872eSLisandro Dalcin .  u - the solution vector
1853efe9872eSLisandro Dalcin -  v - the time derivative vector
1854efe9872eSLisandro Dalcin 
1855efe9872eSLisandro Dalcin    Level: beginner
1856efe9872eSLisandro Dalcin 
1857efe9872eSLisandro Dalcin @*/
1858efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1859efe9872eSLisandro Dalcin {
1860efe9872eSLisandro Dalcin   PetscFunctionBegin;
1861efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1862efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1863efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1864*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetSolution(ts,u));
1865*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectReference((PetscObject)v));
1866*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&ts->vec_dot));
1867efe9872eSLisandro Dalcin   ts->vec_dot = v;
1868efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1869efe9872eSLisandro Dalcin }
1870efe9872eSLisandro Dalcin 
1871efe9872eSLisandro Dalcin /*@
1872efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1873efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1874efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1875efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1876efe9872eSLisandro Dalcin 
1877efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1878efe9872eSLisandro Dalcin 
1879efe9872eSLisandro Dalcin    Input Parameter:
1880efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1881efe9872eSLisandro Dalcin 
1882d8d19677SJose E. Roman    Output Parameters:
1883efe9872eSLisandro Dalcin +  u - the vector containing the solution
1884efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1885efe9872eSLisandro Dalcin 
1886efe9872eSLisandro Dalcin    Level: intermediate
1887efe9872eSLisandro Dalcin 
1888efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1889efe9872eSLisandro Dalcin 
1890efe9872eSLisandro Dalcin @*/
1891efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1892efe9872eSLisandro Dalcin {
1893efe9872eSLisandro Dalcin   PetscFunctionBegin;
1894efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1895efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1896efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1897efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1898efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1899efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1900efe9872eSLisandro Dalcin }
1901efe9872eSLisandro Dalcin 
190255849f57SBarry Smith /*@C
190355849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
190455849f57SBarry Smith 
190555849f57SBarry Smith   Collective on PetscViewer
190655849f57SBarry Smith 
190755849f57SBarry Smith   Input Parameters:
190855849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
190955849f57SBarry Smith            some related function before a call to TSLoad().
191055849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
191155849f57SBarry Smith 
191255849f57SBarry Smith    Level: intermediate
191355849f57SBarry Smith 
191455849f57SBarry Smith   Notes:
191555849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
191655849f57SBarry Smith 
191755849f57SBarry Smith   Notes for advanced users:
191855849f57SBarry Smith   Most users should not need to know the details of the binary storage
191955849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
192055849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
192155849f57SBarry Smith   format is
192255849f57SBarry Smith .vb
192355849f57SBarry Smith      has not yet been determined
192455849f57SBarry Smith .ve
192555849f57SBarry Smith 
192655849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
192755849f57SBarry Smith @*/
1928f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
192955849f57SBarry Smith {
193055849f57SBarry Smith   PetscBool      isbinary;
193155849f57SBarry Smith   PetscInt       classid;
193255849f57SBarry Smith   char           type[256];
19332d53ad75SBarry Smith   DMTS           sdm;
1934ad6bc421SBarry Smith   DM             dm;
193555849f57SBarry Smith 
193655849f57SBarry Smith   PetscFunctionBegin;
1937f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
193855849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1939*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary));
19403c633725SBarry Smith   PetscCheck(isbinary,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
194155849f57SBarry Smith 
1942*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT));
19433c633725SBarry Smith   PetscCheck(classid == TS_FILE_CLASSID,PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1944*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR));
1945*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetType(ts, type));
1946f2c2a1b9SBarry Smith   if (ts->ops->load) {
1947*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ts->ops->load)(ts,viewer));
1948f2c2a1b9SBarry Smith   }
1949*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMCreate(PetscObjectComm((PetscObject)ts),&dm));
1950*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMLoad(dm,viewer));
1951*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetDM(ts,dm));
1952*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMCreateGlobalVector(ts->dm,&ts->vec_sol));
1953*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecLoad(ts->vec_sol,viewer));
1954*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMGetDMTS(ts->dm,&sdm));
1955*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSLoad(sdm,viewer));
195655849f57SBarry Smith   PetscFunctionReturn(0);
195755849f57SBarry Smith }
195855849f57SBarry Smith 
19599804daf3SBarry Smith #include <petscdraw.h>
1960e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1961e04113cfSBarry Smith #include <petscviewersaws.h>
1962f05ece33SBarry Smith #endif
1963fe2efc57SMark 
1964fe2efc57SMark /*@C
1965fe2efc57SMark    TSViewFromOptions - View from Options
1966fe2efc57SMark 
1967fe2efc57SMark    Collective on TS
1968fe2efc57SMark 
1969fe2efc57SMark    Input Parameters:
1970fe2efc57SMark +  A - the application ordering context
1971736c3998SJose E. Roman .  obj - Optional object
1972736c3998SJose E. Roman -  name - command line option
1973fe2efc57SMark 
1974fe2efc57SMark    Level: intermediate
1975fe2efc57SMark .seealso:  TS, TSView, PetscObjectViewFromOptions(), TSCreate()
1976fe2efc57SMark @*/
1977fe2efc57SMark PetscErrorCode  TSViewFromOptions(TS A,PetscObject obj,const char name[])
1978fe2efc57SMark {
1979fe2efc57SMark   PetscFunctionBegin;
1980fe2efc57SMark   PetscValidHeaderSpecific(A,TS_CLASSID,1);
1981*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectViewFromOptions((PetscObject)A,obj,name));
1982fe2efc57SMark   PetscFunctionReturn(0);
1983fe2efc57SMark }
1984fe2efc57SMark 
19857e2c5f70SBarry Smith /*@C
1986d763cef2SBarry Smith     TSView - Prints the TS data structure.
1987d763cef2SBarry Smith 
19884c49b128SBarry Smith     Collective on TS
1989d763cef2SBarry Smith 
1990d763cef2SBarry Smith     Input Parameters:
1991d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1992d763cef2SBarry Smith -   viewer - visualization context
1993d763cef2SBarry Smith 
1994d763cef2SBarry Smith     Options Database Key:
1995d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1996d763cef2SBarry Smith 
1997d763cef2SBarry Smith     Notes:
1998d763cef2SBarry Smith     The available visualization contexts include
1999b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
2000b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
2001d763cef2SBarry Smith          output where only the first processor opens
2002d763cef2SBarry Smith          the file.  All other processors send their
2003d763cef2SBarry Smith          data to the first processor to print.
2004d763cef2SBarry Smith 
2005d763cef2SBarry Smith     The user can open an alternative visualization context with
2006b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
2007d763cef2SBarry Smith 
2008595c91d4SBarry Smith     In the debugger you can do "call TSView(ts,0)" to display the TS solver. (The same holds for any PETSc object viewer).
2009595c91d4SBarry Smith 
2010d763cef2SBarry Smith     Level: beginner
2011d763cef2SBarry Smith 
2012b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
2013d763cef2SBarry Smith @*/
20147087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
2015d763cef2SBarry Smith {
201619fd82e9SBarry Smith   TSType         type;
20172b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
20182d53ad75SBarry Smith   DMTS           sdm;
2019e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2020536b137fSBarry Smith   PetscBool      issaws;
2021f05ece33SBarry Smith #endif
2022d763cef2SBarry Smith 
2023d763cef2SBarry Smith   PetscFunctionBegin;
20240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20253050cee2SBarry Smith   if (!viewer) {
2026*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer));
20273050cee2SBarry Smith   }
20280700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
2029c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
2030fd16b177SBarry Smith 
2031*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii));
2032*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring));
2033*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary));
2034*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw));
2035e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2036*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws));
2037f05ece33SBarry Smith #endif
203832077d6dSBarry Smith   if (iascii) {
2039*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer));
2040efd4aadfSBarry Smith     if (ts->ops->view) {
2041*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPushTab(viewer));
2042*5f80ce2aSJacob Faibussowitsch       CHKERRQ((*ts->ops->view)(ts,viewer));
2043*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPopTab(viewer));
2044efd4aadfSBarry Smith     }
2045ef85077eSLisandro Dalcin     if (ts->max_steps < PETSC_MAX_INT) {
2046*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps));
2047ef85077eSLisandro Dalcin     }
2048ef85077eSLisandro Dalcin     if (ts->max_time < PETSC_MAX_REAL) {
2049*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time));
2050ef85077eSLisandro Dalcin     }
2051a6ab3590SBarry Smith     if (ts->ifuncs) {
2052*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  total number of I function evaluations=%D\n",ts->ifuncs));
2053a6ab3590SBarry Smith     }
2054a6ab3590SBarry Smith     if (ts->ijacs) {
2055*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  total number of I Jacobian evaluations=%D\n",ts->ijacs));
2056a6ab3590SBarry Smith     }
2057a6ab3590SBarry Smith     if (ts->rhsfuncs) {
2058*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  total number of RHS function evaluations=%D\n",ts->rhsfuncs));
2059a6ab3590SBarry Smith     }
2060a6ab3590SBarry Smith     if (ts->rhsjacs) {
2061*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  total number of RHS Jacobian evaluations=%D\n",ts->rhsjacs));
2062a6ab3590SBarry Smith     }
2063efd4aadfSBarry Smith     if (ts->usessnes) {
2064efd4aadfSBarry Smith       PetscBool lin;
2065d763cef2SBarry Smith       if (ts->problem_type == TS_NONLINEAR) {
2066*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its));
2067d763cef2SBarry Smith       }
2068*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its));
2069*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscObjectTypeCompareAny((PetscObject)ts->snes,&lin,SNESKSPONLY,SNESKSPTRANSPOSEONLY,""));
2070*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures));
2071efd4aadfSBarry Smith     }
2072*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject));
2073a0af407cSBarry Smith     if (ts->vrtol) {
2074*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  using vector of relative error tolerances, "));
2075a0af407cSBarry Smith     } else {
2076*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  using relative error tolerance of %g, ",(double)ts->rtol));
2077a0af407cSBarry Smith     }
2078a0af407cSBarry Smith     if (ts->vatol) {
2079*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  using vector of absolute error tolerances\n"));
2080a0af407cSBarry Smith     } else {
2081*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"  using absolute error tolerance of %g\n",(double)ts->atol));
2082a0af407cSBarry Smith     }
2083*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerASCIIPushTab(viewer));
2084*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSAdaptView(ts->adapt,viewer));
2085*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerASCIIPopTab(viewer));
20860f5bd95cSBarry Smith   } else if (isstring) {
2087*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetType(ts,&type));
2088*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerStringSPrintf(viewer," TSType: %-7.7s",type));
2089*5f80ce2aSJacob Faibussowitsch     if (ts->ops->view) CHKERRQ((*ts->ops->view)(ts,viewer));
209055849f57SBarry Smith   } else if (isbinary) {
209155849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
209255849f57SBarry Smith     MPI_Comm    comm;
209355849f57SBarry Smith     PetscMPIInt rank;
209455849f57SBarry Smith     char        type[256];
209555849f57SBarry Smith 
2096*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectGetComm((PetscObject)ts,&comm));
2097*5f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Comm_rank(comm,&rank));
2098dd400576SPatrick Sanan     if (rank == 0) {
2099*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT));
2100*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscStrncpy(type,((PetscObject)ts)->type_name,256));
2101*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR));
210255849f57SBarry Smith     }
210355849f57SBarry Smith     if (ts->ops->view) {
2104*5f80ce2aSJacob Faibussowitsch       CHKERRQ((*ts->ops->view)(ts,viewer));
210555849f57SBarry Smith     }
2106*5f80ce2aSJacob Faibussowitsch     if (ts->adapt) CHKERRQ(TSAdaptView(ts->adapt,viewer));
2107*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMView(ts->dm,viewer));
2108*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecView(ts->vec_sol,viewer));
2109*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMGetDMTS(ts->dm,&sdm));
2110*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMTSView(sdm,viewer));
21112b0a91c0SBarry Smith   } else if (isdraw) {
21122b0a91c0SBarry Smith     PetscDraw draw;
21132b0a91c0SBarry Smith     char      str[36];
211489fd9fafSBarry Smith     PetscReal x,y,bottom,h;
21152b0a91c0SBarry Smith 
2116*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerDrawGetDraw(viewer,0,&draw));
2117*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscDrawGetCurrentPoint(draw,&x,&y));
2118*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscStrcpy(str,"TS: "));
2119*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscStrcat(str,((PetscObject)ts)->type_name));
2120*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h));
212189fd9fafSBarry Smith     bottom = y - h;
2122*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscDrawPushCurrentPoint(draw,x,bottom));
21232b0a91c0SBarry Smith     if (ts->ops->view) {
2124*5f80ce2aSJacob Faibussowitsch       CHKERRQ((*ts->ops->view)(ts,viewer));
21252b0a91c0SBarry Smith     }
2126*5f80ce2aSJacob Faibussowitsch     if (ts->adapt) CHKERRQ(TSAdaptView(ts->adapt,viewer));
2127*5f80ce2aSJacob Faibussowitsch     if (ts->snes)  CHKERRQ(SNESView(ts->snes,viewer));
2128*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscDrawPopCurrentPoint(draw));
2129e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2130536b137fSBarry Smith   } else if (issaws) {
2131d45a07a7SBarry Smith     PetscMPIInt rank;
21322657e9d9SBarry Smith     const char  *name;
21332657e9d9SBarry Smith 
2134*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectGetName((PetscObject)ts,&name));
2135*5f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Comm_rank(PETSC_COMM_WORLD,&rank));
2136dd400576SPatrick Sanan     if (!((PetscObject)ts)->amsmem && rank == 0) {
2137d45a07a7SBarry Smith       char       dir[1024];
2138d45a07a7SBarry Smith 
2139*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscObjectViewSAWs((PetscObject)ts,viewer));
2140*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name));
21412657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
2142*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name));
21432657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
2144d763cef2SBarry Smith     }
21450acecf5bSBarry Smith     if (ts->ops->view) {
2146*5f80ce2aSJacob Faibussowitsch       CHKERRQ((*ts->ops->view)(ts,viewer));
21470acecf5bSBarry Smith     }
2148f05ece33SBarry Smith #endif
2149f05ece33SBarry Smith   }
215036a9e3b9SBarry Smith   if (ts->snes && ts->usessnes)  {
2151*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerASCIIPushTab(viewer));
2152*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SNESView(ts->snes,viewer));
2153*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerASCIIPopTab(viewer));
215436a9e3b9SBarry Smith   }
2155*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMGetDMTS(ts->dm,&sdm));
2156*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSView(sdm,viewer));
2157f05ece33SBarry Smith 
2158*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPushTab(viewer));
2159*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials));
2160*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPopTab(viewer));
2161d763cef2SBarry Smith   PetscFunctionReturn(0);
2162d763cef2SBarry Smith }
2163d763cef2SBarry Smith 
2164b07ff414SBarry Smith /*@
2165d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2166d763cef2SBarry Smith    the timesteppers.
2167d763cef2SBarry Smith 
21683f9fe445SBarry Smith    Logically Collective on TS
2169d763cef2SBarry Smith 
2170d763cef2SBarry Smith    Input Parameters:
2171d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2172d763cef2SBarry Smith -  usrP - optional user context
2173d763cef2SBarry Smith 
217495452b02SPatrick Sanan    Fortran Notes:
217595452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2176daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2177daf670e6SBarry Smith 
2178d763cef2SBarry Smith    Level: intermediate
2179d763cef2SBarry Smith 
2180d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2181d763cef2SBarry Smith @*/
21827087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2183d763cef2SBarry Smith {
2184d763cef2SBarry Smith   PetscFunctionBegin;
21850700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2186d763cef2SBarry Smith   ts->user = usrP;
2187d763cef2SBarry Smith   PetscFunctionReturn(0);
2188d763cef2SBarry Smith }
2189d763cef2SBarry Smith 
2190b07ff414SBarry Smith /*@
2191d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2192d763cef2SBarry Smith     timestepper.
2193d763cef2SBarry Smith 
2194d763cef2SBarry Smith     Not Collective
2195d763cef2SBarry Smith 
2196d763cef2SBarry Smith     Input Parameter:
2197d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2198d763cef2SBarry Smith 
2199d763cef2SBarry Smith     Output Parameter:
2200d763cef2SBarry Smith .   usrP - user context
2201d763cef2SBarry Smith 
220295452b02SPatrick Sanan    Fortran Notes:
220395452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2204daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2205daf670e6SBarry Smith 
2206d763cef2SBarry Smith     Level: intermediate
2207d763cef2SBarry Smith 
2208d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2209d763cef2SBarry Smith @*/
2210e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2211d763cef2SBarry Smith {
2212d763cef2SBarry Smith   PetscFunctionBegin;
22130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2214e71120c6SJed Brown   *(void**)usrP = ts->user;
2215d763cef2SBarry Smith   PetscFunctionReturn(0);
2216d763cef2SBarry Smith }
2217d763cef2SBarry Smith 
2218d763cef2SBarry Smith /*@
221980275a0aSLisandro Dalcin    TSGetStepNumber - Gets the number of steps completed.
2220d763cef2SBarry Smith 
2221d763cef2SBarry Smith    Not Collective
2222d763cef2SBarry Smith 
2223d763cef2SBarry Smith    Input Parameter:
2224d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2225d763cef2SBarry Smith 
2226d763cef2SBarry Smith    Output Parameter:
222780275a0aSLisandro Dalcin .  steps - number of steps completed so far
2228d763cef2SBarry Smith 
2229d763cef2SBarry Smith    Level: intermediate
2230d763cef2SBarry Smith 
22319be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2232d763cef2SBarry Smith @*/
223380275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps)
2234d763cef2SBarry Smith {
2235d763cef2SBarry Smith   PetscFunctionBegin;
22360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
223780275a0aSLisandro Dalcin   PetscValidIntPointer(steps,2);
223880275a0aSLisandro Dalcin   *steps = ts->steps;
223980275a0aSLisandro Dalcin   PetscFunctionReturn(0);
224080275a0aSLisandro Dalcin }
224180275a0aSLisandro Dalcin 
224280275a0aSLisandro Dalcin /*@
224380275a0aSLisandro Dalcin    TSSetStepNumber - Sets the number of steps completed.
224480275a0aSLisandro Dalcin 
224580275a0aSLisandro Dalcin    Logically Collective on TS
224680275a0aSLisandro Dalcin 
224780275a0aSLisandro Dalcin    Input Parameters:
224880275a0aSLisandro Dalcin +  ts - the TS context
224980275a0aSLisandro Dalcin -  steps - number of steps completed so far
225080275a0aSLisandro Dalcin 
225180275a0aSLisandro Dalcin    Notes:
225280275a0aSLisandro Dalcin    For most uses of the TS solvers the user need not explicitly call
225380275a0aSLisandro Dalcin    TSSetStepNumber(), as the step counter is appropriately updated in
225480275a0aSLisandro Dalcin    TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to
225580275a0aSLisandro Dalcin    reinitialize timestepping by setting the step counter to zero (and time
225680275a0aSLisandro Dalcin    to the initial time) to solve a similar problem with different initial
225780275a0aSLisandro Dalcin    conditions or parameters. Other possible use case is to continue
225880275a0aSLisandro Dalcin    timestepping from a previously interrupted run in such a way that TS
225980275a0aSLisandro Dalcin    monitors will be called with a initial nonzero step counter.
226080275a0aSLisandro Dalcin 
226180275a0aSLisandro Dalcin    Level: advanced
226280275a0aSLisandro Dalcin 
226380275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution()
226480275a0aSLisandro Dalcin @*/
226580275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps)
226680275a0aSLisandro Dalcin {
226780275a0aSLisandro Dalcin   PetscFunctionBegin;
226880275a0aSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
226980275a0aSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,steps,2);
22703c633725SBarry Smith   PetscCheck(steps >= 0,PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative");
227180275a0aSLisandro Dalcin   ts->steps = steps;
2272d763cef2SBarry Smith   PetscFunctionReturn(0);
2273d763cef2SBarry Smith }
2274d763cef2SBarry Smith 
2275d763cef2SBarry Smith /*@
2276d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2277d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2278d763cef2SBarry Smith 
22793f9fe445SBarry Smith    Logically Collective on TS
2280d763cef2SBarry Smith 
2281d763cef2SBarry Smith    Input Parameters:
2282d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2283d763cef2SBarry Smith -  time_step - the size of the timestep
2284d763cef2SBarry Smith 
2285d763cef2SBarry Smith    Level: intermediate
2286d763cef2SBarry Smith 
2287aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime()
2288d763cef2SBarry Smith 
2289d763cef2SBarry Smith @*/
22907087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2291d763cef2SBarry Smith {
2292d763cef2SBarry Smith   PetscFunctionBegin;
22930700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2294c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2295d763cef2SBarry Smith   ts->time_step = time_step;
2296d763cef2SBarry Smith   PetscFunctionReturn(0);
2297d763cef2SBarry Smith }
2298d763cef2SBarry Smith 
2299a43b19c4SJed Brown /*@
230049354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
230149354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
230249354f04SShri Abhyankar      or just return at the final time TS computed.
2303a43b19c4SJed Brown 
2304a43b19c4SJed Brown   Logically Collective on TS
2305a43b19c4SJed Brown 
2306d8d19677SJose E. Roman    Input Parameters:
2307a43b19c4SJed Brown +   ts - the time-step context
230849354f04SShri Abhyankar -   eftopt - exact final time option
2309a43b19c4SJed Brown 
2310feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2311feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2312feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2313feed9e9dSBarry Smith 
2314feed9e9dSBarry Smith    Options Database:
2315feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2316feed9e9dSBarry Smith 
2317ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2318ee346746SBarry Smith     then the final time you selected.
2319ee346746SBarry Smith 
2320a43b19c4SJed Brown    Level: beginner
2321a43b19c4SJed Brown 
2322f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime()
2323a43b19c4SJed Brown @*/
232449354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2325a43b19c4SJed Brown {
2326a43b19c4SJed Brown   PetscFunctionBegin;
2327a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
232849354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
232949354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2330a43b19c4SJed Brown   PetscFunctionReturn(0);
2331a43b19c4SJed Brown }
2332a43b19c4SJed Brown 
2333d763cef2SBarry Smith /*@
2334f6953c82SLisandro Dalcin    TSGetExactFinalTime - Gets the exact final time option.
2335f6953c82SLisandro Dalcin 
2336f6953c82SLisandro Dalcin    Not Collective
2337f6953c82SLisandro Dalcin 
2338f6953c82SLisandro Dalcin    Input Parameter:
2339f6953c82SLisandro Dalcin .  ts - the TS context
2340f6953c82SLisandro Dalcin 
2341f6953c82SLisandro Dalcin    Output Parameter:
2342f6953c82SLisandro Dalcin .  eftopt - exact final time option
2343f6953c82SLisandro Dalcin 
2344f6953c82SLisandro Dalcin    Level: beginner
2345f6953c82SLisandro Dalcin 
2346f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime()
2347f6953c82SLisandro Dalcin @*/
2348f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt)
2349f6953c82SLisandro Dalcin {
2350f6953c82SLisandro Dalcin   PetscFunctionBegin;
2351f6953c82SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2352f6953c82SLisandro Dalcin   PetscValidPointer(eftopt,2);
2353f6953c82SLisandro Dalcin   *eftopt = ts->exact_final_time;
2354f6953c82SLisandro Dalcin   PetscFunctionReturn(0);
2355f6953c82SLisandro Dalcin }
2356f6953c82SLisandro Dalcin 
2357f6953c82SLisandro Dalcin /*@
2358d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2359d763cef2SBarry Smith 
2360d763cef2SBarry Smith    Not Collective
2361d763cef2SBarry Smith 
2362d763cef2SBarry Smith    Input Parameter:
2363d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2364d763cef2SBarry Smith 
2365d763cef2SBarry Smith    Output Parameter:
2366d763cef2SBarry Smith .  dt - the current timestep size
2367d763cef2SBarry Smith 
2368d763cef2SBarry Smith    Level: intermediate
2369d763cef2SBarry Smith 
2370aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime()
2371d763cef2SBarry Smith 
2372d763cef2SBarry Smith @*/
23737087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2374d763cef2SBarry Smith {
2375d763cef2SBarry Smith   PetscFunctionBegin;
23760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2377f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2378d763cef2SBarry Smith   *dt = ts->time_step;
2379d763cef2SBarry Smith   PetscFunctionReturn(0);
2380d763cef2SBarry Smith }
2381d763cef2SBarry Smith 
2382d8e5e3e6SSatish Balay /*@
2383d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2384d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2385d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2386d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2387d763cef2SBarry Smith 
2388d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2389d763cef2SBarry Smith 
2390d763cef2SBarry Smith    Input Parameter:
2391d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2392d763cef2SBarry Smith 
2393d763cef2SBarry Smith    Output Parameter:
2394d763cef2SBarry Smith .  v - the vector containing the solution
2395d763cef2SBarry Smith 
239663e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
239763e21af5SBarry Smith    final time. It returns the solution at the next timestep.
239863e21af5SBarry Smith 
2399d763cef2SBarry Smith    Level: intermediate
2400d763cef2SBarry Smith 
24010ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction()
2402d763cef2SBarry Smith 
2403d763cef2SBarry Smith @*/
24047087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2405d763cef2SBarry Smith {
2406d763cef2SBarry Smith   PetscFunctionBegin;
24070700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24084482741eSBarry Smith   PetscValidPointer(v,2);
24098737fe31SLisandro Dalcin   *v = ts->vec_sol;
2410d763cef2SBarry Smith   PetscFunctionReturn(0);
2411d763cef2SBarry Smith }
2412d763cef2SBarry Smith 
241303fe5f5eSDebojyoti Ghosh /*@
2414b2bf4f3aSDebojyoti Ghosh    TSGetSolutionComponents - Returns any solution components at the present
241503fe5f5eSDebojyoti Ghosh    timestep, if available for the time integration method being used.
2416b2bf4f3aSDebojyoti Ghosh    Solution components are quantities that share the same size and
241703fe5f5eSDebojyoti Ghosh    structure as the solution vector.
241803fe5f5eSDebojyoti Ghosh 
241903fe5f5eSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
242003fe5f5eSDebojyoti Ghosh 
242103fe5f5eSDebojyoti Ghosh    Parameters :
2422a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2423b2bf4f3aSDebojyoti Ghosh .  n - If v is PETSC_NULL, then the number of solution components is
2424b2bf4f3aSDebojyoti Ghosh        returned through n, else the n-th solution component is
242503fe5f5eSDebojyoti Ghosh        returned in v.
2426a2b725a8SWilliam Gropp -  v - the vector containing the n-th solution component
242703fe5f5eSDebojyoti Ghosh        (may be PETSC_NULL to use this function to find out
2428b2bf4f3aSDebojyoti Ghosh         the number of solutions components).
242903fe5f5eSDebojyoti Ghosh 
24304cdd57e5SDebojyoti Ghosh    Level: advanced
243103fe5f5eSDebojyoti Ghosh 
243203fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution()
243303fe5f5eSDebojyoti Ghosh 
243403fe5f5eSDebojyoti Ghosh @*/
2435b2bf4f3aSDebojyoti Ghosh PetscErrorCode  TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v)
243603fe5f5eSDebojyoti Ghosh {
243703fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
243803fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2439b2bf4f3aSDebojyoti Ghosh   if (!ts->ops->getsolutioncomponents) *n = 0;
244003fe5f5eSDebojyoti Ghosh   else {
2441*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ts->ops->getsolutioncomponents)(ts,n,v));
244203fe5f5eSDebojyoti Ghosh   }
244303fe5f5eSDebojyoti Ghosh   PetscFunctionReturn(0);
244403fe5f5eSDebojyoti Ghosh }
244503fe5f5eSDebojyoti Ghosh 
24464cdd57e5SDebojyoti Ghosh /*@
24474cdd57e5SDebojyoti Ghosh    TSGetAuxSolution - Returns an auxiliary solution at the present
24484cdd57e5SDebojyoti Ghosh    timestep, if available for the time integration method being used.
24494cdd57e5SDebojyoti Ghosh 
24504cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
24514cdd57e5SDebojyoti Ghosh 
24524cdd57e5SDebojyoti Ghosh    Parameters :
2453a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2454a2b725a8SWilliam Gropp -  v - the vector containing the auxiliary solution
24554cdd57e5SDebojyoti Ghosh 
24564cdd57e5SDebojyoti Ghosh    Level: intermediate
24574cdd57e5SDebojyoti Ghosh 
24584cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution()
24594cdd57e5SDebojyoti Ghosh 
24604cdd57e5SDebojyoti Ghosh @*/
24614cdd57e5SDebojyoti Ghosh PetscErrorCode  TSGetAuxSolution(TS ts,Vec *v)
24624cdd57e5SDebojyoti Ghosh {
24634cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
24644cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2465f6356ec7SDebojyoti Ghosh   if (ts->ops->getauxsolution) {
2466*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ts->ops->getauxsolution)(ts,v));
2467f6356ec7SDebojyoti Ghosh   } else {
2468*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecZeroEntries(*v));
2469f6356ec7SDebojyoti Ghosh   }
24704cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
24714cdd57e5SDebojyoti Ghosh }
24724cdd57e5SDebojyoti Ghosh 
24734cdd57e5SDebojyoti Ghosh /*@
24744cdd57e5SDebojyoti Ghosh    TSGetTimeError - Returns the estimated error vector, if the chosen
24754cdd57e5SDebojyoti Ghosh    TSType has an error estimation functionality.
24764cdd57e5SDebojyoti Ghosh 
24774cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
24784cdd57e5SDebojyoti Ghosh 
24799657682dSDebojyoti Ghosh    Note: MUST call after TSSetUp()
24809657682dSDebojyoti Ghosh 
24814cdd57e5SDebojyoti Ghosh    Parameters :
2482a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2483657c1e31SEmil Constantinescu .  n - current estimate (n=0) or previous one (n=-1)
2484a2b725a8SWilliam Gropp -  v - the vector containing the error (same size as the solution).
24854cdd57e5SDebojyoti Ghosh 
24864cdd57e5SDebojyoti Ghosh    Level: intermediate
24874cdd57e5SDebojyoti Ghosh 
248857df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError()
24894cdd57e5SDebojyoti Ghosh 
24904cdd57e5SDebojyoti Ghosh @*/
24910a01e1b2SEmil Constantinescu PetscErrorCode  TSGetTimeError(TS ts,PetscInt n,Vec *v)
24924cdd57e5SDebojyoti Ghosh {
24934cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
24944cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2495f6356ec7SDebojyoti Ghosh   if (ts->ops->gettimeerror) {
2496*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ts->ops->gettimeerror)(ts,n,v));
2497f6356ec7SDebojyoti Ghosh   } else {
2498*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecZeroEntries(*v));
2499f6356ec7SDebojyoti Ghosh   }
25004cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
25014cdd57e5SDebojyoti Ghosh }
25024cdd57e5SDebojyoti Ghosh 
250357df6a1bSDebojyoti Ghosh /*@
250457df6a1bSDebojyoti Ghosh    TSSetTimeError - Sets the estimated error vector, if the chosen
250557df6a1bSDebojyoti Ghosh    TSType has an error estimation functionality. This can be used
250657df6a1bSDebojyoti Ghosh    to restart such a time integrator with a given error vector.
250757df6a1bSDebojyoti Ghosh 
250857df6a1bSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
250957df6a1bSDebojyoti Ghosh 
251057df6a1bSDebojyoti Ghosh    Parameters :
2511a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2512a2b725a8SWilliam Gropp -  v - the vector containing the error (same size as the solution).
251357df6a1bSDebojyoti Ghosh 
251457df6a1bSDebojyoti Ghosh    Level: intermediate
251557df6a1bSDebojyoti Ghosh 
251657df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError)
251757df6a1bSDebojyoti Ghosh 
251857df6a1bSDebojyoti Ghosh @*/
251957df6a1bSDebojyoti Ghosh PetscErrorCode  TSSetTimeError(TS ts,Vec v)
252057df6a1bSDebojyoti Ghosh {
252157df6a1bSDebojyoti Ghosh   PetscFunctionBegin;
252257df6a1bSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25233c633725SBarry Smith   PetscCheck(ts->setupcalled,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first");
252457df6a1bSDebojyoti Ghosh   if (ts->ops->settimeerror) {
2525*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ts->ops->settimeerror)(ts,v));
252657df6a1bSDebojyoti Ghosh   }
252757df6a1bSDebojyoti Ghosh   PetscFunctionReturn(0);
252857df6a1bSDebojyoti Ghosh }
252957df6a1bSDebojyoti Ghosh 
2530bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
2531d8e5e3e6SSatish Balay /*@
2532bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2533d763cef2SBarry Smith 
2534bdad233fSMatthew Knepley   Not collective
2535d763cef2SBarry Smith 
2536bdad233fSMatthew Knepley   Input Parameters:
2537bdad233fSMatthew Knepley + ts   - The TS
2538bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2539d763cef2SBarry Smith .vb
25400910c330SBarry Smith          U_t - A U = 0      (linear)
25410910c330SBarry Smith          U_t - A(t) U = 0   (linear)
25420910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2543d763cef2SBarry Smith .ve
2544d763cef2SBarry Smith 
2545d763cef2SBarry Smith    Level: beginner
2546d763cef2SBarry Smith 
2547bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2548d763cef2SBarry Smith @*/
25497087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2550a7cc72afSBarry Smith {
2551d763cef2SBarry Smith   PetscFunctionBegin;
25520700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2553bdad233fSMatthew Knepley   ts->problem_type = type;
25549e2a6581SJed Brown   if (type == TS_LINEAR) {
25559e2a6581SJed Brown     SNES snes;
2556*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetSNES(ts,&snes));
2557*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SNESSetType(snes,SNESKSPONLY));
25589e2a6581SJed Brown   }
2559d763cef2SBarry Smith   PetscFunctionReturn(0);
2560d763cef2SBarry Smith }
2561d763cef2SBarry Smith 
2562bdad233fSMatthew Knepley /*@C
2563bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2564bdad233fSMatthew Knepley 
2565bdad233fSMatthew Knepley   Not collective
2566bdad233fSMatthew Knepley 
2567bdad233fSMatthew Knepley   Input Parameter:
2568bdad233fSMatthew Knepley . ts   - The TS
2569bdad233fSMatthew Knepley 
2570bdad233fSMatthew Knepley   Output Parameter:
2571bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2572bdad233fSMatthew Knepley .vb
2573089b2837SJed Brown          M U_t = A U
2574089b2837SJed Brown          M(t) U_t = A(t) U
2575b5abc632SBarry Smith          F(t,U,U_t)
2576bdad233fSMatthew Knepley .ve
2577bdad233fSMatthew Knepley 
2578bdad233fSMatthew Knepley    Level: beginner
2579bdad233fSMatthew Knepley 
2580bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2581bdad233fSMatthew Knepley @*/
25827087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2583a7cc72afSBarry Smith {
2584bdad233fSMatthew Knepley   PetscFunctionBegin;
25850700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
25864482741eSBarry Smith   PetscValidIntPointer(type,2);
2587bdad233fSMatthew Knepley   *type = ts->problem_type;
2588bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2589bdad233fSMatthew Knepley }
2590d763cef2SBarry Smith 
2591303a5415SBarry Smith /*
2592303a5415SBarry 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()
2593303a5415SBarry Smith */
2594303a5415SBarry Smith static PetscErrorCode TSSetExactFinalTimeDefault(TS ts)
2595303a5415SBarry Smith {
2596303a5415SBarry Smith   PetscBool      isnone;
2597303a5415SBarry Smith 
2598303a5415SBarry Smith   PetscFunctionBegin;
2599*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetAdapt(ts,&ts->adapt));
2600*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type));
2601303a5415SBarry Smith 
2602*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone));
2603303a5415SBarry Smith   if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) {
2604303a5415SBarry Smith     ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP;
2605303a5415SBarry Smith   } else if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) {
2606303a5415SBarry Smith     ts->exact_final_time = TS_EXACTFINALTIME_INTERPOLATE;
2607303a5415SBarry Smith   }
2608303a5415SBarry Smith   PetscFunctionReturn(0);
2609303a5415SBarry Smith }
2610303a5415SBarry Smith 
2611d763cef2SBarry Smith /*@
2612303a5415SBarry Smith    TSSetUp - Sets up the internal data structures for the later use of a timestepper.
2613d763cef2SBarry Smith 
2614d763cef2SBarry Smith    Collective on TS
2615d763cef2SBarry Smith 
2616d763cef2SBarry Smith    Input Parameter:
2617d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2618d763cef2SBarry Smith 
2619d763cef2SBarry Smith    Notes:
2620d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2621d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2622141bd67dSStefano Zampini    the call to TSStep() or TSSolve().  However, if one wishes to control this
2623d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2624141bd67dSStefano Zampini    and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve().
2625d763cef2SBarry Smith 
2626d763cef2SBarry Smith    Level: advanced
2627d763cef2SBarry Smith 
2628141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve()
2629d763cef2SBarry Smith @*/
26307087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2631d763cef2SBarry Smith {
26326c6b9e74SPeter Brune   DM             dm;
26336c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2634d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2635cd11d68dSLisandro Dalcin   TSIFunction    ifun;
26366c6b9e74SPeter Brune   TSIJacobian    ijac;
2637efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
26386c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
2639d763cef2SBarry Smith 
2640d763cef2SBarry Smith   PetscFunctionBegin;
26410700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2642277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2643277b19d0SLisandro Dalcin 
26447adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2645*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetIFunction(ts,NULL,&ifun,NULL));
2646*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSSetType(ts,ifun ? TSBEULER : TSEULER));
2647d763cef2SBarry Smith   }
2648277b19d0SLisandro Dalcin 
26491a638600SStefano Zampini   if (!ts->vec_sol) {
26501a638600SStefano Zampini     if (ts->dm) {
2651*5f80ce2aSJacob Faibussowitsch       CHKERRQ(DMCreateGlobalVector(ts->dm,&ts->vec_sol));
26521a638600SStefano Zampini     } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
26531a638600SStefano Zampini   }
2654277b19d0SLisandro Dalcin 
2655298bade4SHong Zhang   if (!ts->Jacp && ts->Jacprhs) { /* IJacobianP shares the same matrix with RHSJacobianP if only RHSJacobianP is provided */
2656*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectReference((PetscObject)ts->Jacprhs));
2657298bade4SHong Zhang     ts->Jacp = ts->Jacprhs;
2658298bade4SHong Zhang   }
2659298bade4SHong Zhang 
2660cd4cee2dSHong Zhang   if (ts->quadraturets) {
2661*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSSetUp(ts->quadraturets));
2662*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecDestroy(&ts->vec_costintegrand));
2663*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecDuplicate(ts->quadraturets->vec_sol,&ts->vec_costintegrand));
2664cd4cee2dSHong Zhang   }
2665cd4cee2dSHong Zhang 
2666*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetRHSJacobian(ts,NULL,NULL,&rhsjac,NULL));
2667f23ba4b3SHong Zhang   if (rhsjac == TSComputeRHSJacobianConstant) {
2668e1244c69SJed Brown     Mat Amat,Pmat;
2669e1244c69SJed Brown     SNES snes;
2670*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetSNES(ts,&snes));
2671*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL));
2672e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2673e1244c69SJed Brown      * have displaced the RHS matrix */
2674971015bcSStefano Zampini     if (Amat && Amat == ts->Arhs) {
2675abc0d4abSBarry 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 */
2676*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat));
2677*5f80ce2aSJacob Faibussowitsch       CHKERRQ(SNESSetJacobian(snes,Amat,NULL,NULL,NULL));
2678*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatDestroy(&Amat));
2679e1244c69SJed Brown     }
2680971015bcSStefano Zampini     if (Pmat && Pmat == ts->Brhs) {
2681*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat));
2682*5f80ce2aSJacob Faibussowitsch       CHKERRQ(SNESSetJacobian(snes,NULL,Pmat,NULL,NULL));
2683*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatDestroy(&Pmat));
2684e1244c69SJed Brown     }
2685e1244c69SJed Brown   }
26862ffb9264SLisandro Dalcin 
2687*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetAdapt(ts,&ts->adapt));
2688*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type));
26892ffb9264SLisandro Dalcin 
2690277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2691*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ts->ops->setup)(ts));
2692277b19d0SLisandro Dalcin   }
2693277b19d0SLisandro Dalcin 
2694*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetExactFinalTimeDefault(ts));
26952ffb9264SLisandro Dalcin 
2696a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
26976c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
26986c6b9e74SPeter Brune    */
2699*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
2700*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMSNESGetFunction(dm,&func,NULL));
27016c6b9e74SPeter Brune   if (!func) {
2702*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMSNESSetFunction(dm,SNESTSFormFunction,ts));
27036c6b9e74SPeter Brune   }
2704a6772fa2SLisandro 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.
27056c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
27066c6b9e74SPeter Brune    */
2707*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMSNESGetJacobian(dm,&jac,NULL));
2708*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetIJacobian(dm,&ijac,NULL));
2709*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetI2Jacobian(dm,&i2jac,NULL));
2710*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetRHSJacobian(dm,&rhsjac,NULL));
2711efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
2712*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMSNESSetJacobian(dm,SNESTSFormJacobian,ts));
27136c6b9e74SPeter Brune   }
2714c0517034SDebojyoti Ghosh 
2715c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2716c0517034SDebojyoti Ghosh   if (ts->ops->startingmethod) {
2717*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ts->ops->startingmethod)(ts));
2718c0517034SDebojyoti Ghosh   }
2719c0517034SDebojyoti Ghosh 
2720277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2721277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2722277b19d0SLisandro Dalcin }
2723277b19d0SLisandro Dalcin 
2724f6a906c0SBarry Smith /*@
2725277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2726277b19d0SLisandro Dalcin 
2727277b19d0SLisandro Dalcin    Collective on TS
2728277b19d0SLisandro Dalcin 
2729277b19d0SLisandro Dalcin    Input Parameter:
2730277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2731277b19d0SLisandro Dalcin 
2732277b19d0SLisandro Dalcin    Level: beginner
2733277b19d0SLisandro Dalcin 
2734277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2735277b19d0SLisandro Dalcin @*/
2736277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2737277b19d0SLisandro Dalcin {
27381d06f6b3SHong Zhang   TS_RHSSplitLink ilink = ts->tsrhssplit,next;
2739277b19d0SLisandro Dalcin 
2740277b19d0SLisandro Dalcin   PetscFunctionBegin;
2741277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2742b18ea86cSHong Zhang 
2743277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2744*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ts->ops->reset)(ts));
2745277b19d0SLisandro Dalcin   }
2746*5f80ce2aSJacob Faibussowitsch   if (ts->snes) CHKERRQ(SNESReset(ts->snes));
2747*5f80ce2aSJacob Faibussowitsch   if (ts->adapt) CHKERRQ(TSAdaptReset(ts->adapt));
2748bbd56ea5SKarl Rupp 
2749*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatDestroy(&ts->Arhs));
2750*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatDestroy(&ts->Brhs));
2751*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&ts->Frhs));
2752*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&ts->vec_sol));
2753*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&ts->vec_dot));
2754*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&ts->vatol));
2755*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&ts->vrtol));
2756*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroyVecs(ts->nwork,&ts->work));
2757bbd56ea5SKarl Rupp 
2758*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatDestroy(&ts->Jacprhs));
2759*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatDestroy(&ts->Jacp));
2760ecf68647SHong Zhang   if (ts->forward_solve) {
2761*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSForwardReset(ts));
2762ecf68647SHong Zhang   }
2763cd4cee2dSHong Zhang   if (ts->quadraturets) {
2764*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSReset(ts->quadraturets));
2765*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecDestroy(&ts->vec_costintegrand));
2766cd4cee2dSHong Zhang   }
27671d06f6b3SHong Zhang   while (ilink) {
27681d06f6b3SHong Zhang     next = ilink->next;
2769*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSDestroy(&ilink->ts));
2770*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFree(ilink->splitname));
2771*5f80ce2aSJacob Faibussowitsch     CHKERRQ(ISDestroy(&ilink->is));
2772*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFree(ilink));
27731d06f6b3SHong Zhang     ilink = next;
277487f4e208SHong Zhang   }
27756bf673ebSJoe Pusztay   ts->tsrhssplit = NULL;
2776545aaa6fSHong Zhang   ts->num_rhs_splits = 0;
2777277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2778d763cef2SBarry Smith   PetscFunctionReturn(0);
2779d763cef2SBarry Smith }
2780d763cef2SBarry Smith 
27811fb7b255SJunchao Zhang /*@C
2782d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2783d763cef2SBarry Smith    with TSCreate().
2784d763cef2SBarry Smith 
2785d763cef2SBarry Smith    Collective on TS
2786d763cef2SBarry Smith 
2787d763cef2SBarry Smith    Input Parameter:
2788d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2789d763cef2SBarry Smith 
2790d763cef2SBarry Smith    Level: beginner
2791d763cef2SBarry Smith 
2792d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2793d763cef2SBarry Smith @*/
27946bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2795d763cef2SBarry Smith {
2796d763cef2SBarry Smith   PetscFunctionBegin;
27976bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
2798ecf68647SHong Zhang   PetscValidHeaderSpecific(*ts,TS_CLASSID,1);
2799c793f718SLisandro Dalcin   if (--((PetscObject)(*ts))->refct > 0) {*ts = NULL; PetscFunctionReturn(0);}
2800d763cef2SBarry Smith 
2801*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSReset(*ts));
2802*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSAdjointReset(*ts));
2803ecf68647SHong Zhang   if ((*ts)->forward_solve) {
2804*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSForwardReset(*ts));
2805ecf68647SHong Zhang   }
2806e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2807*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectSAWsViewOff((PetscObject)*ts));
2808*5f80ce2aSJacob Faibussowitsch   if ((*ts)->ops->destroy) CHKERRQ((*(*ts)->ops->destroy)((*ts)));
28096d4c513bSLisandro Dalcin 
2810*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSTrajectoryDestroy(&(*ts)->trajectory));
2811bc952696SBarry Smith 
2812*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSAdaptDestroy(&(*ts)->adapt));
2813*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSEventDestroy(&(*ts)->event));
28146427ac75SLisandro Dalcin 
2815*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESDestroy(&(*ts)->snes));
2816*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMDestroy(&(*ts)->dm));
2817*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSMonitorCancel((*ts)));
2818*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSAdjointMonitorCancel((*ts)));
28196d4c513bSLisandro Dalcin 
2820*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSDestroy(&(*ts)->quadraturets));
2821*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscHeaderDestroy(ts));
2822d763cef2SBarry Smith   PetscFunctionReturn(0);
2823d763cef2SBarry Smith }
2824d763cef2SBarry Smith 
2825d8e5e3e6SSatish Balay /*@
2826d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2827d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2828d763cef2SBarry Smith 
2829d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2830d763cef2SBarry Smith 
2831d763cef2SBarry Smith    Input Parameter:
2832d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2833d763cef2SBarry Smith 
2834d763cef2SBarry Smith    Output Parameter:
2835d763cef2SBarry Smith .  snes - the nonlinear solver context
2836d763cef2SBarry Smith 
2837d763cef2SBarry Smith    Notes:
2838d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2839d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
284094b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2841d763cef2SBarry Smith 
2842d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
28430298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2844d763cef2SBarry Smith 
2845d763cef2SBarry Smith    Level: beginner
2846d763cef2SBarry Smith 
2847d763cef2SBarry Smith @*/
28487087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2849d763cef2SBarry Smith {
2850d763cef2SBarry Smith   PetscFunctionBegin;
28510700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28524482741eSBarry Smith   PetscValidPointer(snes,2);
2853d372ba47SLisandro Dalcin   if (!ts->snes) {
2854*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes));
2855*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectSetOptions((PetscObject)ts->snes,((PetscObject)ts)->options));
2856*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts));
2857*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes));
2858*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1));
2859*5f80ce2aSJacob Faibussowitsch     if (ts->dm) CHKERRQ(SNESSetDM(ts->snes,ts->dm));
28609e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
2861*5f80ce2aSJacob Faibussowitsch       CHKERRQ(SNESSetType(ts->snes,SNESKSPONLY));
28629e2a6581SJed Brown     }
2863d372ba47SLisandro Dalcin   }
2864d763cef2SBarry Smith   *snes = ts->snes;
2865d763cef2SBarry Smith   PetscFunctionReturn(0);
2866d763cef2SBarry Smith }
2867d763cef2SBarry Smith 
2868deb2cd25SJed Brown /*@
2869deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2870deb2cd25SJed Brown 
2871deb2cd25SJed Brown    Collective
2872deb2cd25SJed Brown 
2873d8d19677SJose E. Roman    Input Parameters:
2874deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2875deb2cd25SJed Brown -  snes - the nonlinear solver context
2876deb2cd25SJed Brown 
2877deb2cd25SJed Brown    Notes:
2878deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2879deb2cd25SJed Brown 
2880deb2cd25SJed Brown    Level: developer
2881deb2cd25SJed Brown 
2882deb2cd25SJed Brown @*/
2883deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2884deb2cd25SJed Brown {
2885d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2886deb2cd25SJed Brown 
2887deb2cd25SJed Brown   PetscFunctionBegin;
2888deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2889deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2890*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectReference((PetscObject)snes));
2891*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESDestroy(&ts->snes));
2892bbd56ea5SKarl Rupp 
2893deb2cd25SJed Brown   ts->snes = snes;
2894bbd56ea5SKarl Rupp 
2895*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts));
2896*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL));
2897740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
2898*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts));
2899740132f1SEmil Constantinescu   }
2900deb2cd25SJed Brown   PetscFunctionReturn(0);
2901deb2cd25SJed Brown }
2902deb2cd25SJed Brown 
2903d8e5e3e6SSatish Balay /*@
290494b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2905d763cef2SBarry Smith    a TS (timestepper) context.
2906d763cef2SBarry Smith 
290794b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2908d763cef2SBarry Smith 
2909d763cef2SBarry Smith    Input Parameter:
2910d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2911d763cef2SBarry Smith 
2912d763cef2SBarry Smith    Output Parameter:
291394b7f48cSBarry Smith .  ksp - the nonlinear solver context
2914d763cef2SBarry Smith 
2915d763cef2SBarry Smith    Notes:
291694b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2917d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2918d763cef2SBarry Smith    KSP and PC contexts as well.
2919d763cef2SBarry Smith 
292094b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
29210298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2922d763cef2SBarry Smith 
2923d763cef2SBarry Smith    Level: beginner
2924d763cef2SBarry Smith 
2925d763cef2SBarry Smith @*/
29267087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2927d763cef2SBarry Smith {
2928089b2837SJed Brown   SNES           snes;
2929d372ba47SLisandro Dalcin 
2930d763cef2SBarry Smith   PetscFunctionBegin;
29310700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29324482741eSBarry Smith   PetscValidPointer(ksp,2);
29333c633725SBarry Smith   PetscCheck(((PetscObject)ts)->type_name,PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
29343c633725SBarry Smith   PetscCheck(ts->problem_type == TS_LINEAR,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2935*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
2936*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESGetKSP(snes,ksp));
2937d763cef2SBarry Smith   PetscFunctionReturn(0);
2938d763cef2SBarry Smith }
2939d763cef2SBarry Smith 
2940d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2941d763cef2SBarry Smith 
2942adb62b0dSMatthew Knepley /*@
2943618ce8baSLisandro Dalcin    TSSetMaxSteps - Sets the maximum number of steps to use.
2944618ce8baSLisandro Dalcin 
2945618ce8baSLisandro Dalcin    Logically Collective on TS
2946618ce8baSLisandro Dalcin 
2947618ce8baSLisandro Dalcin    Input Parameters:
2948618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2949618ce8baSLisandro Dalcin -  maxsteps - maximum number of steps to use
2950618ce8baSLisandro Dalcin 
2951618ce8baSLisandro Dalcin    Options Database Keys:
2952618ce8baSLisandro Dalcin .  -ts_max_steps <maxsteps> - Sets maxsteps
2953618ce8baSLisandro Dalcin 
2954618ce8baSLisandro Dalcin    Notes:
2955618ce8baSLisandro Dalcin    The default maximum number of steps is 5000
2956618ce8baSLisandro Dalcin 
2957618ce8baSLisandro Dalcin    Level: intermediate
2958618ce8baSLisandro Dalcin 
2959618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime()
2960618ce8baSLisandro Dalcin @*/
2961618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps)
2962618ce8baSLisandro Dalcin {
2963618ce8baSLisandro Dalcin   PetscFunctionBegin;
2964618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2965618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
29663c633725SBarry Smith   PetscCheck(maxsteps >= 0,PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative");
2967618ce8baSLisandro Dalcin   ts->max_steps = maxsteps;
2968618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2969618ce8baSLisandro Dalcin }
2970618ce8baSLisandro Dalcin 
2971618ce8baSLisandro Dalcin /*@
2972618ce8baSLisandro Dalcin    TSGetMaxSteps - Gets the maximum number of steps to use.
2973618ce8baSLisandro Dalcin 
2974618ce8baSLisandro Dalcin    Not Collective
2975618ce8baSLisandro Dalcin 
2976618ce8baSLisandro Dalcin    Input Parameters:
2977618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2978618ce8baSLisandro Dalcin 
2979618ce8baSLisandro Dalcin    Output Parameter:
2980618ce8baSLisandro Dalcin .  maxsteps - maximum number of steps to use
2981618ce8baSLisandro Dalcin 
2982618ce8baSLisandro Dalcin    Level: advanced
2983618ce8baSLisandro Dalcin 
2984618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime()
2985618ce8baSLisandro Dalcin @*/
2986618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps)
2987618ce8baSLisandro Dalcin {
2988618ce8baSLisandro Dalcin   PetscFunctionBegin;
2989618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2990618ce8baSLisandro Dalcin   PetscValidIntPointer(maxsteps,2);
2991618ce8baSLisandro Dalcin   *maxsteps = ts->max_steps;
2992618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2993618ce8baSLisandro Dalcin }
2994618ce8baSLisandro Dalcin 
2995618ce8baSLisandro Dalcin /*@
2996618ce8baSLisandro Dalcin    TSSetMaxTime - Sets the maximum (or final) time for timestepping.
2997618ce8baSLisandro Dalcin 
2998618ce8baSLisandro Dalcin    Logically Collective on TS
2999618ce8baSLisandro Dalcin 
3000618ce8baSLisandro Dalcin    Input Parameters:
3001618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
3002618ce8baSLisandro Dalcin -  maxtime - final time to step to
3003618ce8baSLisandro Dalcin 
3004618ce8baSLisandro Dalcin    Options Database Keys:
3005ef85077eSLisandro Dalcin .  -ts_max_time <maxtime> - Sets maxtime
3006618ce8baSLisandro Dalcin 
3007618ce8baSLisandro Dalcin    Notes:
3008618ce8baSLisandro Dalcin    The default maximum time is 5.0
3009618ce8baSLisandro Dalcin 
3010618ce8baSLisandro Dalcin    Level: intermediate
3011618ce8baSLisandro Dalcin 
3012618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime()
3013618ce8baSLisandro Dalcin @*/
3014618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime)
3015618ce8baSLisandro Dalcin {
3016618ce8baSLisandro Dalcin   PetscFunctionBegin;
3017618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3018618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveReal(ts,maxtime,2);
3019618ce8baSLisandro Dalcin   ts->max_time = maxtime;
3020618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3021618ce8baSLisandro Dalcin }
3022618ce8baSLisandro Dalcin 
3023618ce8baSLisandro Dalcin /*@
3024618ce8baSLisandro Dalcin    TSGetMaxTime - Gets the maximum (or final) time for timestepping.
3025618ce8baSLisandro Dalcin 
3026618ce8baSLisandro Dalcin    Not Collective
3027618ce8baSLisandro Dalcin 
3028618ce8baSLisandro Dalcin    Input Parameters:
3029618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
3030618ce8baSLisandro Dalcin 
3031618ce8baSLisandro Dalcin    Output Parameter:
3032618ce8baSLisandro Dalcin .  maxtime - final time to step to
3033618ce8baSLisandro Dalcin 
3034618ce8baSLisandro Dalcin    Level: advanced
3035618ce8baSLisandro Dalcin 
3036618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps()
3037618ce8baSLisandro Dalcin @*/
3038618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime)
3039618ce8baSLisandro Dalcin {
3040618ce8baSLisandro Dalcin   PetscFunctionBegin;
3041618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3042618ce8baSLisandro Dalcin   PetscValidRealPointer(maxtime,2);
3043618ce8baSLisandro Dalcin   *maxtime = ts->max_time;
3044618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3045618ce8baSLisandro Dalcin }
3046618ce8baSLisandro Dalcin 
3047618ce8baSLisandro Dalcin /*@
3048aaa6c58dSLisandro Dalcin    TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep().
3049edc382c3SSatish Balay 
3050edc382c3SSatish Balay    Level: deprecated
3051edc382c3SSatish Balay 
3052aaa6c58dSLisandro Dalcin @*/
3053aaa6c58dSLisandro Dalcin PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
3054aaa6c58dSLisandro Dalcin {
3055aaa6c58dSLisandro Dalcin   PetscFunctionBegin;
3056aaa6c58dSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3057*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetTime(ts,initial_time));
3058*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetTimeStep(ts,time_step));
3059aaa6c58dSLisandro Dalcin   PetscFunctionReturn(0);
3060aaa6c58dSLisandro Dalcin }
3061aaa6c58dSLisandro Dalcin 
3062aaa6c58dSLisandro Dalcin /*@
306319eac22cSLisandro Dalcin    TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime().
3064edc382c3SSatish Balay 
3065edc382c3SSatish Balay    Level: deprecated
3066edc382c3SSatish Balay 
3067adb62b0dSMatthew Knepley @*/
30687087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
3069adb62b0dSMatthew Knepley {
3070adb62b0dSMatthew Knepley   PetscFunctionBegin;
30710700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3072abc0a331SBarry Smith   if (maxsteps) {
30734482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
3074adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
3075adb62b0dSMatthew Knepley   }
3076abc0a331SBarry Smith   if (maxtime) {
3077064a246eSJacob Faibussowitsch     PetscValidRealPointer(maxtime,3);
3078adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
3079adb62b0dSMatthew Knepley   }
3080adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
3081adb62b0dSMatthew Knepley }
3082adb62b0dSMatthew Knepley 
3083d763cef2SBarry Smith /*@
308419eac22cSLisandro Dalcin    TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime().
3085edc382c3SSatish Balay 
3086edc382c3SSatish Balay    Level: deprecated
3087edc382c3SSatish Balay 
3088d763cef2SBarry Smith @*/
30897087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
3090d763cef2SBarry Smith {
3091d763cef2SBarry Smith   PetscFunctionBegin;
30920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3093c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
3094064a246eSJacob Faibussowitsch   PetscValidLogicalCollectiveReal(ts,maxtime,3);
309539b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
309639b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
3097d763cef2SBarry Smith   PetscFunctionReturn(0);
3098d763cef2SBarry Smith }
3099d763cef2SBarry Smith 
3100d763cef2SBarry Smith /*@
31015c5f5948SLisandro Dalcin    TSGetTimeStepNumber - Deprecated, use TSGetStepNumber().
3102edc382c3SSatish Balay 
3103edc382c3SSatish Balay    Level: deprecated
3104edc382c3SSatish Balay 
31055c5f5948SLisandro Dalcin @*/
3106e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31075c5f5948SLisandro Dalcin 
310819eac22cSLisandro Dalcin /*@
31094f4e0956SLisandro Dalcin    TSGetTotalSteps - Deprecated, use TSGetStepNumber().
3110edc382c3SSatish Balay 
3111edc382c3SSatish Balay    Level: deprecated
3112edc382c3SSatish Balay 
31134f4e0956SLisandro Dalcin @*/
31144f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31154f4e0956SLisandro Dalcin 
31164f4e0956SLisandro Dalcin /*@
3117d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
3118d763cef2SBarry Smith    for use by the TS routines.
3119d763cef2SBarry Smith 
3120d083f849SBarry Smith    Logically Collective on TS
3121d763cef2SBarry Smith 
3122d763cef2SBarry Smith    Input Parameters:
3123d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
31240910c330SBarry Smith -  u - the solution vector
3125d763cef2SBarry Smith 
3126d763cef2SBarry Smith    Level: beginner
3127d763cef2SBarry Smith 
31280ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate()
3129d763cef2SBarry Smith @*/
31300910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
3131d763cef2SBarry Smith {
3132496e6a7aSJed Brown   DM             dm;
31338737fe31SLisandro Dalcin 
3134d763cef2SBarry Smith   PetscFunctionBegin;
31350700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31360910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3137*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectReference((PetscObject)u));
3138*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecDestroy(&ts->vec_sol));
31390910c330SBarry Smith   ts->vec_sol = u;
3140bbd56ea5SKarl Rupp 
3141*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
3142*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMShellSetGlobalVector(dm,u));
3143d763cef2SBarry Smith   PetscFunctionReturn(0);
3144d763cef2SBarry Smith }
3145d763cef2SBarry Smith 
3146ac226902SBarry Smith /*@C
3147000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
31483f2090d5SJed Brown   called once at the beginning of each time step.
3149000e7ae3SMatthew Knepley 
31503f9fe445SBarry Smith   Logically Collective on TS
3151000e7ae3SMatthew Knepley 
3152000e7ae3SMatthew Knepley   Input Parameters:
3153000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3154000e7ae3SMatthew Knepley - func - The function
3155000e7ae3SMatthew Knepley 
3156000e7ae3SMatthew Knepley   Calling sequence of func:
315767b8a455SSatish Balay .vb
315867b8a455SSatish Balay   PetscErrorCode func (TS ts);
315967b8a455SSatish Balay .ve
3160000e7ae3SMatthew Knepley 
3161000e7ae3SMatthew Knepley   Level: intermediate
3162000e7ae3SMatthew Knepley 
3163dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep()
3164000e7ae3SMatthew Knepley @*/
31657087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3166000e7ae3SMatthew Knepley {
3167000e7ae3SMatthew Knepley   PetscFunctionBegin;
31680700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3169ae60f76fSBarry Smith   ts->prestep = func;
3170000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3171000e7ae3SMatthew Knepley }
3172000e7ae3SMatthew Knepley 
317309ee8438SJed Brown /*@
31743f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
31753f2090d5SJed Brown 
31763f2090d5SJed Brown   Collective on TS
31773f2090d5SJed Brown 
31783f2090d5SJed Brown   Input Parameters:
31793f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
31803f2090d5SJed Brown 
31813f2090d5SJed Brown   Notes:
31823f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
31833f2090d5SJed Brown   so most users would not generally call this routine themselves.
31843f2090d5SJed Brown 
31853f2090d5SJed Brown   Level: developer
31863f2090d5SJed Brown 
31879be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
31883f2090d5SJed Brown @*/
31897087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
31903f2090d5SJed Brown {
31913f2090d5SJed Brown   PetscFunctionBegin;
31920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3193ae60f76fSBarry Smith   if (ts->prestep) {
31945efd42a4SStefano Zampini     Vec              U;
3195ef8d1ce0SJohann Rudi     PetscObjectId    idprev;
3196ef8d1ce0SJohann Rudi     PetscBool        sameObject;
31975efd42a4SStefano Zampini     PetscObjectState sprev,spost;
31985efd42a4SStefano Zampini 
3199*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetSolution(ts,&U));
3200*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectGetId((PetscObject)U,&idprev));
3201*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectStateGet((PetscObject)U,&sprev));
3202a74df02fSJacob Faibussowitsch     PetscStackCallStandard((*ts->prestep),ts);
3203*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetSolution(ts,&U));
3204*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectCompareId((PetscObject)U,idprev,&sameObject));
3205*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectStateGet((PetscObject)U,&spost));
3206*5f80ce2aSJacob Faibussowitsch     if (!sameObject || sprev != spost) CHKERRQ(TSRestartStep(ts));
3207312ce896SJed Brown   }
32083f2090d5SJed Brown   PetscFunctionReturn(0);
32093f2090d5SJed Brown }
32103f2090d5SJed Brown 
3211b8123daeSJed Brown /*@C
3212b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3213b8123daeSJed Brown   called once at the beginning of each stage.
3214b8123daeSJed Brown 
3215b8123daeSJed Brown   Logically Collective on TS
3216b8123daeSJed Brown 
3217b8123daeSJed Brown   Input Parameters:
3218b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3219b8123daeSJed Brown - func - The function
3220b8123daeSJed Brown 
3221b8123daeSJed Brown   Calling sequence of func:
322267b8a455SSatish Balay .vb
322367b8a455SSatish Balay   PetscErrorCode func(TS ts, PetscReal stagetime);
322467b8a455SSatish Balay .ve
3225b8123daeSJed Brown 
3226b8123daeSJed Brown   Level: intermediate
3227b8123daeSJed Brown 
3228b8123daeSJed Brown   Note:
3229b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
323080275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
3231b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3232b8123daeSJed Brown 
32339be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3234b8123daeSJed Brown @*/
3235b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3236b8123daeSJed Brown {
3237b8123daeSJed Brown   PetscFunctionBegin;
3238b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3239ae60f76fSBarry Smith   ts->prestage = func;
3240b8123daeSJed Brown   PetscFunctionReturn(0);
3241b8123daeSJed Brown }
3242b8123daeSJed Brown 
32439be3e283SDebojyoti Ghosh /*@C
32449be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
32459be3e283SDebojyoti Ghosh   called once at the end of each stage.
32469be3e283SDebojyoti Ghosh 
32479be3e283SDebojyoti Ghosh   Logically Collective on TS
32489be3e283SDebojyoti Ghosh 
32499be3e283SDebojyoti Ghosh   Input Parameters:
32509be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
32519be3e283SDebojyoti Ghosh - func - The function
32529be3e283SDebojyoti Ghosh 
32539be3e283SDebojyoti Ghosh   Calling sequence of func:
325467b8a455SSatish Balay .vb
325567b8a455SSatish Balay   PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
325667b8a455SSatish Balay .ve
32579be3e283SDebojyoti Ghosh 
32589be3e283SDebojyoti Ghosh   Level: intermediate
32599be3e283SDebojyoti Ghosh 
32609be3e283SDebojyoti Ghosh   Note:
32619be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
326280275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
32639be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
32649be3e283SDebojyoti Ghosh 
32659be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
32669be3e283SDebojyoti Ghosh @*/
32679be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
32689be3e283SDebojyoti Ghosh {
32699be3e283SDebojyoti Ghosh   PetscFunctionBegin;
32709be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
32719be3e283SDebojyoti Ghosh   ts->poststage = func;
32729be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
32739be3e283SDebojyoti Ghosh }
32749be3e283SDebojyoti Ghosh 
3275c688d042SShri Abhyankar /*@C
3276c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3277c688d042SShri Abhyankar   called once at the end of each step evaluation.
3278c688d042SShri Abhyankar 
3279c688d042SShri Abhyankar   Logically Collective on TS
3280c688d042SShri Abhyankar 
3281c688d042SShri Abhyankar   Input Parameters:
3282c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3283c688d042SShri Abhyankar - func - The function
3284c688d042SShri Abhyankar 
3285c688d042SShri Abhyankar   Calling sequence of func:
328667b8a455SSatish Balay .vb
328767b8a455SSatish Balay   PetscErrorCode func(TS ts);
328867b8a455SSatish Balay .ve
3289c688d042SShri Abhyankar 
3290c688d042SShri Abhyankar   Level: intermediate
3291c688d042SShri Abhyankar 
3292c688d042SShri Abhyankar   Note:
32931785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
32941785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3295e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3296e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3297e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3298c688d042SShri Abhyankar 
3299c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3300c688d042SShri Abhyankar @*/
3301c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3302c688d042SShri Abhyankar {
3303c688d042SShri Abhyankar   PetscFunctionBegin;
3304c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3305c688d042SShri Abhyankar   ts->postevaluate = func;
3306c688d042SShri Abhyankar   PetscFunctionReturn(0);
3307c688d042SShri Abhyankar }
3308c688d042SShri Abhyankar 
3309b8123daeSJed Brown /*@
3310b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3311b8123daeSJed Brown 
3312b8123daeSJed Brown   Collective on TS
3313b8123daeSJed Brown 
3314b8123daeSJed Brown   Input Parameters:
3315b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
33169be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3317b8123daeSJed Brown 
3318b8123daeSJed Brown   Notes:
3319b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3320b8123daeSJed Brown   most users would not generally call this routine themselves.
3321b8123daeSJed Brown 
3322b8123daeSJed Brown   Level: developer
3323b8123daeSJed Brown 
33249be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3325b8123daeSJed Brown @*/
3326b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3327b8123daeSJed Brown {
3328b8123daeSJed Brown   PetscFunctionBegin;
3329b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3330ae60f76fSBarry Smith   if (ts->prestage) {
3331a74df02fSJacob Faibussowitsch     PetscStackCallStandard((*ts->prestage),ts,stagetime);
3332b8123daeSJed Brown   }
3333b8123daeSJed Brown   PetscFunctionReturn(0);
3334b8123daeSJed Brown }
3335b8123daeSJed Brown 
33369be3e283SDebojyoti Ghosh /*@
33379be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
33389be3e283SDebojyoti Ghosh 
33399be3e283SDebojyoti Ghosh   Collective on TS
33409be3e283SDebojyoti Ghosh 
33419be3e283SDebojyoti Ghosh   Input Parameters:
33429be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
33439be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
33449be3e283SDebojyoti Ghosh   stageindex  - Stage number
33459be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
33469be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
33479be3e283SDebojyoti Ghosh 
33489be3e283SDebojyoti Ghosh   Notes:
33499be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
33509be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
33519be3e283SDebojyoti Ghosh 
33529be3e283SDebojyoti Ghosh   Level: developer
33539be3e283SDebojyoti Ghosh 
33549be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
33559be3e283SDebojyoti Ghosh @*/
33569be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
33579be3e283SDebojyoti Ghosh {
33589be3e283SDebojyoti Ghosh   PetscFunctionBegin;
33599be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33604beae5d8SLisandro Dalcin   if (ts->poststage) {
3361a74df02fSJacob Faibussowitsch     PetscStackCallStandard((*ts->poststage),ts,stagetime,stageindex,Y);
33629be3e283SDebojyoti Ghosh   }
33639be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
33649be3e283SDebojyoti Ghosh }
33659be3e283SDebojyoti Ghosh 
3366c688d042SShri Abhyankar /*@
3367c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3368c688d042SShri Abhyankar 
3369c688d042SShri Abhyankar   Collective on TS
3370c688d042SShri Abhyankar 
3371c688d042SShri Abhyankar   Input Parameters:
3372c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3373c688d042SShri Abhyankar 
3374c688d042SShri Abhyankar   Notes:
3375c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3376c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3377c688d042SShri Abhyankar 
3378c688d042SShri Abhyankar   Level: developer
3379c688d042SShri Abhyankar 
3380c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3381c688d042SShri Abhyankar @*/
3382c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3383c688d042SShri Abhyankar {
3384c688d042SShri Abhyankar   PetscFunctionBegin;
3385c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3386c688d042SShri Abhyankar   if (ts->postevaluate) {
3387dcb233daSLisandro Dalcin     Vec              U;
3388dcb233daSLisandro Dalcin     PetscObjectState sprev,spost;
3389dcb233daSLisandro Dalcin 
3390*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetSolution(ts,&U));
3391*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectStateGet((PetscObject)U,&sprev));
3392a74df02fSJacob Faibussowitsch     PetscStackCallStandard((*ts->postevaluate),ts);
3393*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectStateGet((PetscObject)U,&spost));
3394*5f80ce2aSJacob Faibussowitsch     if (sprev != spost) CHKERRQ(TSRestartStep(ts));
3395c688d042SShri Abhyankar   }
3396c688d042SShri Abhyankar   PetscFunctionReturn(0);
3397c688d042SShri Abhyankar }
3398c688d042SShri Abhyankar 
3399ac226902SBarry Smith /*@C
3400000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
34013f2090d5SJed Brown   called once at the end of each time step.
3402000e7ae3SMatthew Knepley 
34033f9fe445SBarry Smith   Logically Collective on TS
3404000e7ae3SMatthew Knepley 
3405000e7ae3SMatthew Knepley   Input Parameters:
3406000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3407000e7ae3SMatthew Knepley - func - The function
3408000e7ae3SMatthew Knepley 
3409000e7ae3SMatthew Knepley   Calling sequence of func:
3410b8123daeSJed Brown $ func (TS ts);
3411000e7ae3SMatthew Knepley 
34121785ff2aSShri Abhyankar   Notes:
34131785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
34141785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
34151785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
34161785ff2aSShri Abhyankar 
3417000e7ae3SMatthew Knepley   Level: intermediate
3418000e7ae3SMatthew Knepley 
3419dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep()
3420000e7ae3SMatthew Knepley @*/
34217087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3422000e7ae3SMatthew Knepley {
3423000e7ae3SMatthew Knepley   PetscFunctionBegin;
34240700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3425ae60f76fSBarry Smith   ts->poststep = func;
3426000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3427000e7ae3SMatthew Knepley }
3428000e7ae3SMatthew Knepley 
342909ee8438SJed Brown /*@
34303f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
34313f2090d5SJed Brown 
34323f2090d5SJed Brown   Collective on TS
34333f2090d5SJed Brown 
34343f2090d5SJed Brown   Input Parameters:
34353f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
34363f2090d5SJed Brown 
34373f2090d5SJed Brown   Notes:
34383f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
34393f2090d5SJed Brown   so most users would not generally call this routine themselves.
34403f2090d5SJed Brown 
34413f2090d5SJed Brown   Level: developer
34423f2090d5SJed Brown 
34433f2090d5SJed Brown @*/
34447087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
34453f2090d5SJed Brown {
34463f2090d5SJed Brown   PetscFunctionBegin;
34470700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3448ae60f76fSBarry Smith   if (ts->poststep) {
34495efd42a4SStefano Zampini     Vec              U;
3450ef8d1ce0SJohann Rudi     PetscObjectId    idprev;
3451ef8d1ce0SJohann Rudi     PetscBool        sameObject;
34525efd42a4SStefano Zampini     PetscObjectState sprev,spost;
34535efd42a4SStefano Zampini 
3454*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetSolution(ts,&U));
3455*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectGetId((PetscObject)U,&idprev));
3456*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectStateGet((PetscObject)U,&sprev));
3457a74df02fSJacob Faibussowitsch     PetscStackCallStandard((*ts->poststep),ts);
3458*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetSolution(ts,&U));
3459*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectCompareId((PetscObject)U,idprev,&sameObject));
3460*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectStateGet((PetscObject)U,&spost));
3461*5f80ce2aSJacob Faibussowitsch     if (!sameObject || sprev != spost) CHKERRQ(TSRestartStep(ts));
346272ac3e02SJed Brown   }
34633f2090d5SJed Brown   PetscFunctionReturn(0);
34643f2090d5SJed Brown }
34653f2090d5SJed Brown 
3466cd652676SJed Brown /*@
3467cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3468cd652676SJed Brown 
3469cd652676SJed Brown    Collective on TS
3470cd652676SJed Brown 
34714165533cSJose E. Roman    Input Parameters:
3472cd652676SJed Brown +  ts - time stepping context
3473cd652676SJed Brown -  t - time to interpolate to
3474cd652676SJed Brown 
34754165533cSJose E. Roman    Output Parameter:
34760910c330SBarry Smith .  U - state at given time
3477cd652676SJed Brown 
3478cd652676SJed Brown    Level: intermediate
3479cd652676SJed Brown 
3480cd652676SJed Brown    Developer Notes:
3481cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3482cd652676SJed Brown 
3483874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
3484cd652676SJed Brown @*/
34850910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3486cd652676SJed Brown {
3487cd652676SJed Brown   PetscFunctionBegin;
3488cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3489b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
34903c633725SBarry Smith   PetscCheck(t >= ts->ptime_prev && t <= ts->ptime,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);
34913c633725SBarry Smith   PetscCheck(ts->ops->interpolate,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
3492*5f80ce2aSJacob Faibussowitsch   CHKERRQ((*ts->ops->interpolate)(ts,t,U));
3493cd652676SJed Brown   PetscFunctionReturn(0);
3494cd652676SJed Brown }
3495cd652676SJed Brown 
3496d763cef2SBarry Smith /*@
34976d9e5789SSean Farley    TSStep - Steps one time step
3498d763cef2SBarry Smith 
3499d763cef2SBarry Smith    Collective on TS
3500d763cef2SBarry Smith 
3501d763cef2SBarry Smith    Input Parameter:
3502d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3503d763cef2SBarry Smith 
350427829d71SBarry Smith    Level: developer
3505d763cef2SBarry Smith 
3506b8123daeSJed Brown    Notes:
350727829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
350827829d71SBarry Smith 
3509b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3510b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3511b8123daeSJed Brown 
351219eac22cSLisandro Dalcin    This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the
351319eac22cSLisandro Dalcin    time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
351425cb2221SBarry Smith 
35159be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3516d763cef2SBarry Smith @*/
3517193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3518d763cef2SBarry Smith {
3519dfbe8321SBarry Smith   PetscErrorCode   ierr;
3520fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3521be5899b3SLisandro Dalcin   PetscReal        ptime;
3522d763cef2SBarry Smith 
3523d763cef2SBarry Smith   PetscFunctionBegin;
35240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3525f1d62c27SHong Zhang   ierr = PetscCitationsRegister("@article{tspaper,\n"
3526fffbeea8SBarry Smith                                 "  title         = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3527f1d62c27SHong Zhang                                 "  author        = {Abhyankar, Shrirang and Brown, Jed and Constantinescu, Emil and Ghosh, Debojyoti and Smith, Barry F. and Zhang, Hong},\n"
3528f1d62c27SHong Zhang                                 "  journal       = {arXiv e-preprints},\n"
3529f1d62c27SHong Zhang                                 "  eprint        = {1806.01437},\n"
3530f1d62c27SHong Zhang                                 "  archivePrefix = {arXiv},\n"
3531f1d62c27SHong Zhang                                 "  year          = {2018}\n}\n",&cite);CHKERRQ(ierr);
3532fffbeea8SBarry Smith 
3533*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetUp(ts));
3534*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSTrajectorySetUp(ts->trajectory,ts));
3535d405a339SMatthew Knepley 
35363c633725SBarry Smith   PetscCheck(ts->ops->step,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
35373c633725SBarry Smith   PetscCheck(ts->max_time < PETSC_MAX_REAL || ts->max_steps != PETSC_MAX_INT,PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>");
35383c633725SBarry Smith   PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_UNSPECIFIED,PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSStep()");
35393c633725SBarry Smith   PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_MATCHSTEP || ts->adapt,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
3540a6772fa2SLisandro Dalcin 
3541be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
3542be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
35432808aa04SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3544fc8dbba5SLisandro Dalcin 
3545*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogEventBegin(TS_Step,ts,0,0,0));
3546*5f80ce2aSJacob Faibussowitsch   CHKERRQ((*ts->ops->step)(ts));
3547*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogEventEnd(TS_Step,ts,0,0,0));
3548fc8dbba5SLisandro Dalcin 
3549fc8dbba5SLisandro Dalcin   if (ts->reason >= 0) {
3550be5899b3SLisandro Dalcin     ts->ptime_prev = ptime;
35512808aa04SLisandro Dalcin     ts->steps++;
3552be5899b3SLisandro Dalcin     ts->steprollback = PETSC_FALSE;
355328d5b5d6SLisandro Dalcin     ts->steprestart  = PETSC_FALSE;
3554d2daff3dSHong Zhang   }
3555fc8dbba5SLisandro Dalcin 
3556fc8dbba5SLisandro Dalcin   if (!ts->reason) {
355708c7845fSBarry Smith     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
355808c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
355908c7845fSBarry Smith   }
3560fc8dbba5SLisandro Dalcin 
35613c633725SBarry Smith   PetscCheck(ts->reason >= 0 || !ts->errorifstepfailed || ts->reason != TS_DIVERGED_NONLINEAR_SOLVE,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]);
35623c633725SBarry Smith   PetscCheck(ts->reason >= 0 || !ts->errorifstepfailed,PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
356308c7845fSBarry Smith   PetscFunctionReturn(0);
356408c7845fSBarry Smith }
356508c7845fSBarry Smith 
356608c7845fSBarry Smith /*@
35677cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
35687cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
35697cbde773SLisandro Dalcin 
35707cbde773SLisandro Dalcin    Collective on TS
35717cbde773SLisandro Dalcin 
35724165533cSJose E. Roman    Input Parameters:
35737cbde773SLisandro Dalcin +  ts - time stepping context
357497bb3fdcSJose E. Roman -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
35757cbde773SLisandro Dalcin 
357697bb3fdcSJose E. Roman    Input/Output Parameter:
357797bb3fdcSJose E. Roman .  order - optional, desired order for the error evaluation or PETSC_DECIDE;
357897bb3fdcSJose E. Roman            on output, the actual order of the error evaluation
357997bb3fdcSJose E. Roman 
358097bb3fdcSJose E. Roman    Output Parameter:
358197bb3fdcSJose E. Roman .  wlte - the weighted local truncation error norm
35827cbde773SLisandro Dalcin 
35837cbde773SLisandro Dalcin    Level: advanced
35847cbde773SLisandro Dalcin 
35857cbde773SLisandro Dalcin    Notes:
35867cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
35877cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
35887cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
35897cbde773SLisandro Dalcin 
35907cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
35917cbde773SLisandro Dalcin @*/
35927cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
35937cbde773SLisandro Dalcin {
35947cbde773SLisandro Dalcin   PetscFunctionBegin;
35957cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
35967cbde773SLisandro Dalcin   PetscValidType(ts,1);
3597064a246eSJacob Faibussowitsch   PetscValidLogicalCollectiveEnum(ts,wnormtype,2);
35987cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
35997cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
36007cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
36013c633725SBarry Smith   PetscCheck(wnormtype == NORM_2 || wnormtype == NORM_INFINITY,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
36023c633725SBarry Smith   PetscCheck(ts->ops->evaluatewlte,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
3603*5f80ce2aSJacob Faibussowitsch   CHKERRQ((*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte));
36047cbde773SLisandro Dalcin   PetscFunctionReturn(0);
36057cbde773SLisandro Dalcin }
36067cbde773SLisandro Dalcin 
360705175c85SJed Brown /*@
360805175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
360905175c85SJed Brown 
36101c3436cfSJed Brown    Collective on TS
361105175c85SJed Brown 
36124165533cSJose E. Roman    Input Parameters:
36131c3436cfSJed Brown +  ts - time stepping context
36141c3436cfSJed Brown .  order - desired order of accuracy
36150298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
361605175c85SJed Brown 
36174165533cSJose E. Roman    Output Parameter:
36180910c330SBarry Smith .  U - state at the end of the current step
361905175c85SJed Brown 
362005175c85SJed Brown    Level: advanced
362105175c85SJed Brown 
3622108c343cSJed Brown    Notes:
3623108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3624108c343cSJed 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.
3625108c343cSJed Brown 
36261c3436cfSJed Brown .seealso: TSStep(), TSAdapt
362705175c85SJed Brown @*/
36280910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
362905175c85SJed Brown {
363005175c85SJed Brown   PetscFunctionBegin;
363105175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
363205175c85SJed Brown   PetscValidType(ts,1);
36330910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
36343c633725SBarry Smith   PetscCheck(ts->ops->evaluatestep,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3635*5f80ce2aSJacob Faibussowitsch   CHKERRQ((*ts->ops->evaluatestep)(ts,order,U,done));
363605175c85SJed Brown   PetscFunctionReturn(0);
363705175c85SJed Brown }
363805175c85SJed Brown 
3639aad739acSMatthew G. Knepley /*@C
36402e61be88SMatthew G. Knepley   TSGetComputeInitialCondition - Get the function used to automatically compute an initial condition for the timestepping.
3641aad739acSMatthew G. Knepley 
3642aad739acSMatthew G. Knepley   Not collective
3643aad739acSMatthew G. Knepley 
36444165533cSJose E. Roman   Input Parameter:
3645aad739acSMatthew G. Knepley . ts        - time stepping context
3646aad739acSMatthew G. Knepley 
36474165533cSJose E. Roman   Output Parameter:
36482e61be88SMatthew G. Knepley . initConditions - The function which computes an initial condition
3649aad739acSMatthew G. Knepley 
3650aad739acSMatthew G. Knepley    Level: advanced
3651aad739acSMatthew G. Knepley 
3652aad739acSMatthew G. Knepley    Notes:
3653aad739acSMatthew G. Knepley    The calling sequence for the function is
36542e61be88SMatthew G. Knepley $ initCondition(TS ts, Vec u)
3655aad739acSMatthew G. Knepley $ ts - The timestepping context
36562e61be88SMatthew G. Knepley $ u  - The input vector in which the initial condition is stored
3657aad739acSMatthew G. Knepley 
36582e61be88SMatthew G. Knepley .seealso: TSSetComputeInitialCondition(), TSComputeInitialCondition()
3659aad739acSMatthew G. Knepley @*/
36602e61be88SMatthew G. Knepley PetscErrorCode TSGetComputeInitialCondition(TS ts, PetscErrorCode (**initCondition)(TS, Vec))
3661aad739acSMatthew G. Knepley {
3662aad739acSMatthew G. Knepley   PetscFunctionBegin;
3663aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
36642e61be88SMatthew G. Knepley   PetscValidPointer(initCondition, 2);
36652e61be88SMatthew G. Knepley   *initCondition = ts->ops->initcondition;
3666aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3667aad739acSMatthew G. Knepley }
3668aad739acSMatthew G. Knepley 
3669aad739acSMatthew G. Knepley /*@C
36702e61be88SMatthew G. Knepley   TSSetComputeInitialCondition - Set the function used to automatically compute an initial condition for the timestepping.
3671aad739acSMatthew G. Knepley 
3672aad739acSMatthew G. Knepley   Logically collective on ts
3673aad739acSMatthew G. Knepley 
36744165533cSJose E. Roman   Input Parameters:
3675aad739acSMatthew G. Knepley + ts        - time stepping context
36762e61be88SMatthew G. Knepley - initCondition - The function which computes an initial condition
3677aad739acSMatthew G. Knepley 
3678aad739acSMatthew G. Knepley   Level: advanced
3679aad739acSMatthew G. Knepley 
3680a96d6ef6SBarry Smith   Calling sequence for initCondition:
3681a96d6ef6SBarry Smith $ PetscErrorCode initCondition(TS ts, Vec u)
3682a96d6ef6SBarry Smith 
3683a96d6ef6SBarry Smith + ts - The timestepping context
3684a96d6ef6SBarry Smith - u  - The input vector in which the initial condition is to be stored
3685aad739acSMatthew G. Knepley 
36862e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSComputeInitialCondition()
3687aad739acSMatthew G. Knepley @*/
36882e61be88SMatthew G. Knepley PetscErrorCode TSSetComputeInitialCondition(TS ts, PetscErrorCode (*initCondition)(TS, Vec))
3689aad739acSMatthew G. Knepley {
3690aad739acSMatthew G. Knepley   PetscFunctionBegin;
3691aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
36922e61be88SMatthew G. Knepley   PetscValidFunction(initCondition, 2);
36932e61be88SMatthew G. Knepley   ts->ops->initcondition = initCondition;
3694aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3695aad739acSMatthew G. Knepley }
3696aad739acSMatthew G. Knepley 
3697aad739acSMatthew G. Knepley /*@
36982e61be88SMatthew G. Knepley   TSComputeInitialCondition - Compute an initial condition for the timestepping using the function previously set.
3699aad739acSMatthew G. Knepley 
3700aad739acSMatthew G. Knepley   Collective on ts
3701aad739acSMatthew G. Knepley 
37024165533cSJose E. Roman   Input Parameters:
3703aad739acSMatthew G. Knepley + ts - time stepping context
37042e61be88SMatthew G. Knepley - u  - The Vec to store the condition in which will be used in TSSolve()
3705aad739acSMatthew G. Knepley 
3706aad739acSMatthew G. Knepley   Level: advanced
3707aad739acSMatthew G. Knepley 
37082e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve()
3709aad739acSMatthew G. Knepley @*/
37102e61be88SMatthew G. Knepley PetscErrorCode TSComputeInitialCondition(TS ts, Vec u)
3711aad739acSMatthew G. Knepley {
3712aad739acSMatthew G. Knepley   PetscFunctionBegin;
3713aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3714aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
3715*5f80ce2aSJacob Faibussowitsch   if (ts->ops->initcondition) CHKERRQ((*ts->ops->initcondition)(ts, u));
3716aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3717aad739acSMatthew G. Knepley }
3718aad739acSMatthew G. Knepley 
3719aad739acSMatthew G. Knepley /*@C
3720aad739acSMatthew G. Knepley   TSGetComputeExactError - Get the function used to automatically compute the exact error for the timestepping.
3721aad739acSMatthew G. Knepley 
3722aad739acSMatthew G. Knepley   Not collective
3723aad739acSMatthew G. Knepley 
37244165533cSJose E. Roman   Input Parameter:
3725aad739acSMatthew G. Knepley . ts         - time stepping context
3726aad739acSMatthew G. Knepley 
37274165533cSJose E. Roman   Output Parameter:
3728aad739acSMatthew G. Knepley . exactError - The function which computes the solution error
3729aad739acSMatthew G. Knepley 
3730aad739acSMatthew G. Knepley   Level: advanced
3731aad739acSMatthew G. Knepley 
3732a96d6ef6SBarry Smith   Calling sequence for exactError:
3733a96d6ef6SBarry Smith $ PetscErrorCode exactError(TS ts, Vec u)
3734a96d6ef6SBarry Smith 
3735a96d6ef6SBarry Smith + ts - The timestepping context
3736a96d6ef6SBarry Smith . u  - The approximate solution vector
3737a96d6ef6SBarry Smith - e  - The input vector in which the error is stored
3738aad739acSMatthew G. Knepley 
3739aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError()
3740aad739acSMatthew G. Knepley @*/
3741aad739acSMatthew G. Knepley PetscErrorCode TSGetComputeExactError(TS ts, PetscErrorCode (**exactError)(TS, Vec, Vec))
3742aad739acSMatthew G. Knepley {
3743aad739acSMatthew G. Knepley   PetscFunctionBegin;
3744aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3745aad739acSMatthew G. Knepley   PetscValidPointer(exactError, 2);
3746aad739acSMatthew G. Knepley   *exactError = ts->ops->exacterror;
3747aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3748aad739acSMatthew G. Knepley }
3749aad739acSMatthew G. Knepley 
3750aad739acSMatthew G. Knepley /*@C
3751aad739acSMatthew G. Knepley   TSSetComputeExactError - Set the function used to automatically compute the exact error for the timestepping.
3752aad739acSMatthew G. Knepley 
3753aad739acSMatthew G. Knepley   Logically collective on ts
3754aad739acSMatthew G. Knepley 
37554165533cSJose E. Roman   Input Parameters:
3756aad739acSMatthew G. Knepley + ts         - time stepping context
3757aad739acSMatthew G. Knepley - exactError - The function which computes the solution error
3758aad739acSMatthew G. Knepley 
3759aad739acSMatthew G. Knepley   Level: advanced
3760aad739acSMatthew G. Knepley 
3761a96d6ef6SBarry Smith   Calling sequence for exactError:
3762a96d6ef6SBarry Smith $ PetscErrorCode exactError(TS ts, Vec u)
3763a96d6ef6SBarry Smith 
3764a96d6ef6SBarry Smith + ts - The timestepping context
3765a96d6ef6SBarry Smith . u  - The approximate solution vector
3766a96d6ef6SBarry Smith - e  - The input vector in which the error is stored
3767aad739acSMatthew G. Knepley 
3768aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError()
3769aad739acSMatthew G. Knepley @*/
3770aad739acSMatthew G. Knepley PetscErrorCode TSSetComputeExactError(TS ts, PetscErrorCode (*exactError)(TS, Vec, Vec))
3771aad739acSMatthew G. Knepley {
3772aad739acSMatthew G. Knepley   PetscFunctionBegin;
3773aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3774f907fdbfSMatthew G. Knepley   PetscValidFunction(exactError, 2);
3775aad739acSMatthew G. Knepley   ts->ops->exacterror = exactError;
3776aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3777aad739acSMatthew G. Knepley }
3778aad739acSMatthew G. Knepley 
3779aad739acSMatthew G. Knepley /*@
3780aad739acSMatthew G. Knepley   TSComputeExactError - Compute the solution error for the timestepping using the function previously set.
3781aad739acSMatthew G. Knepley 
3782aad739acSMatthew G. Knepley   Collective on ts
3783aad739acSMatthew G. Knepley 
37844165533cSJose E. Roman   Input Parameters:
3785aad739acSMatthew G. Knepley + ts - time stepping context
3786aad739acSMatthew G. Knepley . u  - The approximate solution
3787aad739acSMatthew G. Knepley - e  - The Vec used to store the error
3788aad739acSMatthew G. Knepley 
3789aad739acSMatthew G. Knepley   Level: advanced
3790aad739acSMatthew G. Knepley 
37912e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve()
3792aad739acSMatthew G. Knepley @*/
3793aad739acSMatthew G. Knepley PetscErrorCode TSComputeExactError(TS ts, Vec u, Vec e)
3794aad739acSMatthew G. Knepley {
3795aad739acSMatthew G. Knepley   PetscFunctionBegin;
3796aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3797aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
3798aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(e, VEC_CLASSID, 3);
3799*5f80ce2aSJacob Faibussowitsch   if (ts->ops->exacterror) CHKERRQ((*ts->ops->exacterror)(ts, u, e));
3800aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3801aad739acSMatthew G. Knepley }
3802aad739acSMatthew G. Knepley 
3803b1cb36f3SHong Zhang /*@
38046a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
38056a4d4014SLisandro Dalcin 
38066a4d4014SLisandro Dalcin    Collective on TS
38076a4d4014SLisandro Dalcin 
3808d8d19677SJose E. Roman    Input Parameters:
38096a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
381063e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
381163e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
38125a3a76d0SJed Brown 
38136a4d4014SLisandro Dalcin    Level: beginner
38146a4d4014SLisandro Dalcin 
38155a3a76d0SJed Brown    Notes:
38165a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
38175a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
38185a3a76d0SJed Brown    stepped over the final time.
38195a3a76d0SJed Brown 
382063e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
38216a4d4014SLisandro Dalcin @*/
3822cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
38236a4d4014SLisandro Dalcin {
3824b06615a5SLisandro Dalcin   Vec               solution;
3825f22f69f0SBarry Smith 
38266a4d4014SLisandro Dalcin   PetscFunctionBegin;
38270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3828f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3829303a5415SBarry Smith 
3830*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetExactFinalTimeDefault(ts));
3831ee41a567SStefano 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 */
38320910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3833*5f80ce2aSJacob Faibussowitsch       CHKERRQ(VecDuplicate(u,&solution));
3834*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSSetSolution(ts,solution));
3835*5f80ce2aSJacob Faibussowitsch       CHKERRQ(VecDestroy(&solution)); /* grant ownership */
38365a3a76d0SJed Brown     }
3837*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecCopy(u,ts->vec_sol));
38383c633725SBarry Smith     PetscCheck(!ts->forward_solve,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
3839bbd56ea5SKarl Rupp   } else if (u) {
3840*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSSetSolution(ts,u));
38415a3a76d0SJed Brown   }
3842*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetUp(ts));
3843*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSTrajectorySetUp(ts->trajectory,ts));
3844a6772fa2SLisandro Dalcin 
38453c633725SBarry Smith   PetscCheck(ts->max_time < PETSC_MAX_REAL || ts->max_steps != PETSC_MAX_INT,PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>");
38463c633725SBarry Smith   PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_UNSPECIFIED,PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSSolve()");
38473c633725SBarry Smith   PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_MATCHSTEP || ts->adapt,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
3848a6772fa2SLisandro Dalcin 
3849715f1b00SHong Zhang   if (ts->forward_solve) {
3850*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSForwardSetUp(ts));
3851715f1b00SHong Zhang   }
3852715f1b00SHong Zhang 
3853e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
3854715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
3855e7069c78SShri      TSTrajectory to incorrectly save the output files
3856e7069c78SShri   */
3857715f1b00SHong Zhang   /* reset time step and iteration counters */
38582808aa04SLisandro Dalcin   if (!ts->steps) {
38595ef26d82SJed Brown     ts->ksp_its           = 0;
38605ef26d82SJed Brown     ts->snes_its          = 0;
3861c610991cSLisandro Dalcin     ts->num_snes_failures = 0;
3862c610991cSLisandro Dalcin     ts->reject            = 0;
38632808aa04SLisandro Dalcin     ts->steprestart       = PETSC_TRUE;
38642808aa04SLisandro Dalcin     ts->steprollback      = PETSC_FALSE;
38657d51462cSStefano Zampini     ts->rhsjacobian.time  = PETSC_MIN_REAL;
38662808aa04SLisandro Dalcin   }
3867e97c63d7SStefano Zampini 
3868e97c63d7SStefano Zampini   /* make sure initial time step does not overshoot final time */
3869e97c63d7SStefano Zampini   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP) {
3870e97c63d7SStefano Zampini     PetscReal maxdt = ts->max_time-ts->ptime;
3871e97c63d7SStefano Zampini     PetscReal dt = ts->time_step;
3872e97c63d7SStefano Zampini 
3873e97c63d7SStefano Zampini     ts->time_step = dt >= maxdt ? maxdt : (PetscIsCloseAtTol(dt,maxdt,10*PETSC_MACHINE_EPSILON,0) ? maxdt : dt);
3874e97c63d7SStefano Zampini   }
3875193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
3876193ac0bcSJed Brown 
3877900f6b5bSMatthew G. Knepley   {
3878900f6b5bSMatthew G. Knepley     PetscViewer       viewer;
3879900f6b5bSMatthew G. Knepley     PetscViewerFormat format;
3880900f6b5bSMatthew G. Knepley     PetscBool         flg;
3881900f6b5bSMatthew G. Knepley     static PetscBool  incall = PETSC_FALSE;
3882900f6b5bSMatthew G. Knepley 
3883900f6b5bSMatthew G. Knepley     if (!incall) {
3884900f6b5bSMatthew G. Knepley       /* Estimate the convergence rate of the time discretization */
3885*5f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscOptionsGetViewer(PetscObjectComm((PetscObject) ts),((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_estimate", &viewer, &format, &flg));
3886900f6b5bSMatthew G. Knepley       if (flg) {
3887900f6b5bSMatthew G. Knepley         PetscConvEst conv;
3888900f6b5bSMatthew G. Knepley         DM           dm;
3889900f6b5bSMatthew G. Knepley         PetscReal   *alpha; /* Convergence rate of the solution error for each field in the L_2 norm */
3890900f6b5bSMatthew G. Knepley         PetscInt     Nf;
3891f2ed2dc7SMatthew G. Knepley         PetscBool    checkTemporal = PETSC_TRUE;
3892900f6b5bSMatthew G. Knepley 
3893900f6b5bSMatthew G. Knepley         incall = PETSC_TRUE;
3894*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscOptionsGetBool(((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_temporal", &checkTemporal, &flg));
3895*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSGetDM(ts, &dm));
3896*5f80ce2aSJacob Faibussowitsch         CHKERRQ(DMGetNumFields(dm, &Nf));
3897*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscCalloc1(PetscMax(Nf, 1), &alpha));
3898*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscConvEstCreate(PetscObjectComm((PetscObject) ts), &conv));
3899*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscConvEstUseTS(conv, checkTemporal));
3900*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscConvEstSetSolver(conv, (PetscObject) ts));
3901*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscConvEstSetFromOptions(conv));
3902*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscConvEstSetUp(conv));
3903*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscConvEstGetConvRate(conv, alpha));
3904*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscViewerPushFormat(viewer, format));
3905*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscConvEstRateView(conv, alpha, viewer));
3906*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscViewerPopFormat(viewer));
3907*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscViewerDestroy(&viewer));
3908*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscConvEstDestroy(&conv));
3909*5f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscFree(alpha));
3910900f6b5bSMatthew G. Knepley         incall = PETSC_FALSE;
3911900f6b5bSMatthew G. Knepley       }
3912900f6b5bSMatthew G. Knepley     }
3913900f6b5bSMatthew G. Knepley   }
3914900f6b5bSMatthew G. Knepley 
3915*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSViewFromOptions(ts,NULL,"-ts_view_pre"));
3916f05ece33SBarry Smith 
3917193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
3918*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ts->ops->solve)(ts));
3919*5f80ce2aSJacob Faibussowitsch     if (u) CHKERRQ(VecCopy(ts->vec_sol,u));
3920cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3921a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
3922be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
3923db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
3924db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3925e7069c78SShri 
39262808aa04SLisandro Dalcin     if (!ts->steps) {
3927*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol));
3928*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol));
39292808aa04SLisandro Dalcin     }
39306427ac75SLisandro Dalcin 
3931e1a7a14fSJed Brown     while (!ts->reason) {
3932*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol));
39339687d888SLisandro Dalcin       if (!ts->steprollback) {
3934*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSPreStep(ts));
39359687d888SLisandro Dalcin       }
3936*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSStep(ts));
3937f3b1f45cSBarry Smith       if (ts->testjacobian) {
3938*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSRHSJacobianTest(ts,NULL));
3939f3b1f45cSBarry Smith       }
3940f3b1f45cSBarry Smith       if (ts->testjacobiantranspose) {
3941*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSRHSJacobianTestTranspose(ts,NULL));
3942f3b1f45cSBarry Smith       }
3943cd4cee2dSHong Zhang       if (ts->quadraturets && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */
39447b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */
3945*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSForwardCostIntegral(ts));
39467b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps++;
3947b1cb36f3SHong Zhang       }
394858818c2dSLisandro Dalcin       if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */
39497b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */
3950*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSForwardStep(ts));
39517b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps++;
3952715f1b00SHong Zhang       }
3953*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSPostEvaluate(ts));
3954*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSEventHandler(ts)); /* The right-hand side may be changed due to event. Be careful with Any computation using the RHS information after this point. */
395558818c2dSLisandro Dalcin       if (ts->steprollback) {
3956*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSPostEvaluate(ts));
395758818c2dSLisandro Dalcin       }
3958e783b05fSHong Zhang       if (!ts->steprollback) {
3959*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol));
3960*5f80ce2aSJacob Faibussowitsch         CHKERRQ(TSPostStep(ts));
3961aeb4809dSShri Abhyankar       }
3962193ac0bcSJed Brown     }
3963*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol));
39646427ac75SLisandro Dalcin 
396549354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
3966*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSInterpolate(ts,ts->max_time,u));
3967cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3968b06615a5SLisandro Dalcin       solution = u;
3969*5f80ce2aSJacob Faibussowitsch       CHKERRQ(TSMonitor(ts,-1,ts->solvetime,solution));
39700574a7fbSJed Brown     } else {
3971*5f80ce2aSJacob Faibussowitsch       if (u) CHKERRQ(VecCopy(ts->vec_sol,u));
3972cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3973b06615a5SLisandro Dalcin       solution = ts->vec_sol;
39740574a7fbSJed Brown     }
3975193ac0bcSJed Brown   }
3976d2daff3dSHong Zhang 
3977*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSViewFromOptions(ts,NULL,"-ts_view"));
3978*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecViewFromOptions(solution,(PetscObject)ts,"-ts_view_solution"));
3979*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectSAWsBlock((PetscObject)ts));
3980ef222394SBarry Smith   if (ts->adjoint_solve) {
3981*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSAdjointSolve(ts));
39822b0a91c0SBarry Smith   }
39836a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
39846a4d4014SLisandro Dalcin }
39856a4d4014SLisandro Dalcin 
3986d763cef2SBarry Smith /*@
3987b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3988d763cef2SBarry Smith 
3989d763cef2SBarry Smith    Not Collective
3990d763cef2SBarry Smith 
3991d763cef2SBarry Smith    Input Parameter:
3992d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3993d763cef2SBarry Smith 
3994d763cef2SBarry Smith    Output Parameter:
399519eac22cSLisandro Dalcin .  t  - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime().
3996d763cef2SBarry Smith 
3997d763cef2SBarry Smith    Level: beginner
3998d763cef2SBarry Smith 
3999b8123daeSJed Brown    Note:
4000b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
40019be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4002b8123daeSJed Brown 
40038f199f4dSPatrick Sanan .seealso:  TSGetSolveTime(), TSSetTime(), TSGetTimeStep(), TSGetStepNumber()
4004d763cef2SBarry Smith 
4005d763cef2SBarry Smith @*/
40067087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4007d763cef2SBarry Smith {
4008d763cef2SBarry Smith   PetscFunctionBegin;
40090700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4010f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4011d763cef2SBarry Smith   *t = ts->ptime;
4012d763cef2SBarry Smith   PetscFunctionReturn(0);
4013d763cef2SBarry Smith }
4014d763cef2SBarry Smith 
4015e5e524a1SHong Zhang /*@
4016e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4017e5e524a1SHong Zhang 
4018e5e524a1SHong Zhang    Not Collective
4019e5e524a1SHong Zhang 
4020e5e524a1SHong Zhang    Input Parameter:
4021e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4022e5e524a1SHong Zhang 
4023e5e524a1SHong Zhang    Output Parameter:
4024e5e524a1SHong Zhang .  t  - the previous time
4025e5e524a1SHong Zhang 
4026e5e524a1SHong Zhang    Level: beginner
4027e5e524a1SHong Zhang 
4028aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep()
4029e5e524a1SHong Zhang 
4030e5e524a1SHong Zhang @*/
4031e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4032e5e524a1SHong Zhang {
4033e5e524a1SHong Zhang   PetscFunctionBegin;
4034e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4035e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4036e5e524a1SHong Zhang   *t = ts->ptime_prev;
4037e5e524a1SHong Zhang   PetscFunctionReturn(0);
4038e5e524a1SHong Zhang }
4039e5e524a1SHong Zhang 
40406a4d4014SLisandro Dalcin /*@
40416a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
40426a4d4014SLisandro Dalcin 
40433f9fe445SBarry Smith    Logically Collective on TS
40446a4d4014SLisandro Dalcin 
40456a4d4014SLisandro Dalcin    Input Parameters:
40466a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
40476a4d4014SLisandro Dalcin -  time - the time
40486a4d4014SLisandro Dalcin 
40496a4d4014SLisandro Dalcin    Level: intermediate
40506a4d4014SLisandro Dalcin 
405119eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps()
40526a4d4014SLisandro Dalcin 
40536a4d4014SLisandro Dalcin @*/
40547087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
40556a4d4014SLisandro Dalcin {
40566a4d4014SLisandro Dalcin   PetscFunctionBegin;
40570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4058c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
40596a4d4014SLisandro Dalcin   ts->ptime = t;
40606a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
40616a4d4014SLisandro Dalcin }
40626a4d4014SLisandro Dalcin 
4063d763cef2SBarry Smith /*@C
4064d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4065d763cef2SBarry Smith    TS options in the database.
4066d763cef2SBarry Smith 
40673f9fe445SBarry Smith    Logically Collective on TS
4068d763cef2SBarry Smith 
4069d8d19677SJose E. Roman    Input Parameters:
4070d763cef2SBarry Smith +  ts     - The TS context
4071d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4072d763cef2SBarry Smith 
4073d763cef2SBarry Smith    Notes:
4074d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4075d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4076d763cef2SBarry Smith    hyphen.
4077d763cef2SBarry Smith 
4078d763cef2SBarry Smith    Level: advanced
4079d763cef2SBarry Smith 
4080d763cef2SBarry Smith .seealso: TSSetFromOptions()
4081d763cef2SBarry Smith 
4082d763cef2SBarry Smith @*/
40837087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4084d763cef2SBarry Smith {
4085089b2837SJed Brown   SNES           snes;
4086d763cef2SBarry Smith 
4087d763cef2SBarry Smith   PetscFunctionBegin;
40880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4089*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectSetOptionsPrefix((PetscObject)ts,prefix));
4090*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
4091*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESSetOptionsPrefix(snes,prefix));
4092d763cef2SBarry Smith   PetscFunctionReturn(0);
4093d763cef2SBarry Smith }
4094d763cef2SBarry Smith 
4095d763cef2SBarry Smith /*@C
4096d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4097d763cef2SBarry Smith    TS options in the database.
4098d763cef2SBarry Smith 
40993f9fe445SBarry Smith    Logically Collective on TS
4100d763cef2SBarry Smith 
4101d8d19677SJose E. Roman    Input Parameters:
4102d763cef2SBarry Smith +  ts     - The TS context
4103d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4104d763cef2SBarry Smith 
4105d763cef2SBarry Smith    Notes:
4106d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4107d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4108d763cef2SBarry Smith    hyphen.
4109d763cef2SBarry Smith 
4110d763cef2SBarry Smith    Level: advanced
4111d763cef2SBarry Smith 
4112d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4113d763cef2SBarry Smith 
4114d763cef2SBarry Smith @*/
41157087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4116d763cef2SBarry Smith {
4117089b2837SJed Brown   SNES           snes;
4118d763cef2SBarry Smith 
4119d763cef2SBarry Smith   PetscFunctionBegin;
41200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4121*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix));
4122*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
4123*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESAppendOptionsPrefix(snes,prefix));
4124d763cef2SBarry Smith   PetscFunctionReturn(0);
4125d763cef2SBarry Smith }
4126d763cef2SBarry Smith 
4127d763cef2SBarry Smith /*@C
4128d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4129d763cef2SBarry Smith    TS options in the database.
4130d763cef2SBarry Smith 
4131d763cef2SBarry Smith    Not Collective
4132d763cef2SBarry Smith 
4133d763cef2SBarry Smith    Input Parameter:
4134d763cef2SBarry Smith .  ts - The TS context
4135d763cef2SBarry Smith 
4136d763cef2SBarry Smith    Output Parameter:
4137d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4138d763cef2SBarry Smith 
413995452b02SPatrick Sanan    Notes:
414095452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prifix' of
4141d763cef2SBarry Smith    sufficient length to hold the prefix.
4142d763cef2SBarry Smith 
4143d763cef2SBarry Smith    Level: intermediate
4144d763cef2SBarry Smith 
4145d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4146d763cef2SBarry Smith @*/
41477087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4148d763cef2SBarry Smith {
4149d763cef2SBarry Smith   PetscFunctionBegin;
41500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
41514482741eSBarry Smith   PetscValidPointer(prefix,2);
4152*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectGetOptionsPrefix((PetscObject)ts,prefix));
4153d763cef2SBarry Smith   PetscFunctionReturn(0);
4154d763cef2SBarry Smith }
4155d763cef2SBarry Smith 
4156d763cef2SBarry Smith /*@C
4157d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4158d763cef2SBarry Smith 
4159d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4160d763cef2SBarry Smith 
4161d763cef2SBarry Smith    Input Parameter:
4162d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4163d763cef2SBarry Smith 
4164d763cef2SBarry Smith    Output Parameters:
4165e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4166e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4167e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4168e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4169d763cef2SBarry Smith 
417095452b02SPatrick Sanan    Notes:
417195452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
4172d763cef2SBarry Smith 
4173d763cef2SBarry Smith    Level: intermediate
4174d763cef2SBarry Smith 
417580275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
4176d763cef2SBarry Smith 
4177d763cef2SBarry Smith @*/
4178e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4179d763cef2SBarry Smith {
418024989b8cSPeter Brune   DM             dm;
4181089b2837SJed Brown 
4182d763cef2SBarry Smith   PetscFunctionBegin;
418323a57915SBarry Smith   if (Amat || Pmat) {
418423a57915SBarry Smith     SNES snes;
4185*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetSNES(ts,&snes));
4186*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SNESSetUpMatrices(snes));
4187*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SNESGetJacobian(snes,Amat,Pmat,NULL,NULL));
418823a57915SBarry Smith   }
4189*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
4190*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetRHSJacobian(dm,func,ctx));
4191d763cef2SBarry Smith   PetscFunctionReturn(0);
4192d763cef2SBarry Smith }
4193d763cef2SBarry Smith 
41942eca1d9cSJed Brown /*@C
41952eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
41962eca1d9cSJed Brown 
41972eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
41982eca1d9cSJed Brown 
41992eca1d9cSJed Brown    Input Parameter:
42002eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
42012eca1d9cSJed Brown 
42022eca1d9cSJed Brown    Output Parameters:
4203e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4204e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
42052eca1d9cSJed Brown .  f   - The function to compute the matrices
42062eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
42072eca1d9cSJed Brown 
420895452b02SPatrick Sanan    Notes:
420995452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
42102eca1d9cSJed Brown 
42112eca1d9cSJed Brown    Level: advanced
42122eca1d9cSJed Brown 
421380275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
42142eca1d9cSJed Brown 
42152eca1d9cSJed Brown @*/
4216e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
42172eca1d9cSJed Brown {
421824989b8cSPeter Brune   DM             dm;
42190910c330SBarry Smith 
42202eca1d9cSJed Brown   PetscFunctionBegin;
4221c0aab802Sstefano_zampini   if (Amat || Pmat) {
4222c0aab802Sstefano_zampini     SNES snes;
4223*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetSNES(ts,&snes));
4224*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SNESSetUpMatrices(snes));
4225*5f80ce2aSJacob Faibussowitsch     CHKERRQ(SNESGetJacobian(snes,Amat,Pmat,NULL,NULL));
4226c0aab802Sstefano_zampini   }
4227*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(ts,&dm));
4228*5f80ce2aSJacob Faibussowitsch   CHKERRQ(DMTSGetIJacobian(dm,f,ctx));
42292eca1d9cSJed Brown   PetscFunctionReturn(0);
42302eca1d9cSJed Brown }
42312eca1d9cSJed Brown 
4232af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
42336c699258SBarry Smith /*@
42342a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
42356c699258SBarry Smith 
4236d083f849SBarry Smith    Logically Collective on ts
42376c699258SBarry Smith 
42386c699258SBarry Smith    Input Parameters:
42392a808120SBarry Smith +  ts - the ODE integrator object
42402a808120SBarry Smith -  dm - the dm, cannot be NULL
42416c699258SBarry Smith 
4242e03a659cSJed Brown    Notes:
4243e03a659cSJed Brown    A DM can only be used for solving one problem at a time because information about the problem is stored on the DM,
4244e03a659cSJed Brown    even when not using interfaces like DMTSSetIFunction().  Use DMClone() to get a distinct DM when solving
4245e03a659cSJed Brown    different problems using the same function space.
4246e03a659cSJed Brown 
42476c699258SBarry Smith    Level: intermediate
42486c699258SBarry Smith 
42496c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
42506c699258SBarry Smith @*/
42517087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
42526c699258SBarry Smith {
4253089b2837SJed Brown   SNES           snes;
4254942e3340SBarry Smith   DMTS           tsdm;
42556c699258SBarry Smith 
42566c699258SBarry Smith   PetscFunctionBegin;
42570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
42582a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
4259*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectReference((PetscObject)dm));
4260942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
42612a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4262*5f80ce2aSJacob Faibussowitsch       CHKERRQ(DMCopyDMTS(ts->dm,dm));
4263*5f80ce2aSJacob Faibussowitsch       CHKERRQ(DMGetDMTS(ts->dm,&tsdm));
426424989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
426524989b8cSPeter Brune         tsdm->originaldm = dm;
426624989b8cSPeter Brune       }
426724989b8cSPeter Brune     }
4268*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMDestroy(&ts->dm));
426924989b8cSPeter Brune   }
42706c699258SBarry Smith   ts->dm = dm;
4271bbd56ea5SKarl Rupp 
4272*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
4273*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESSetDM(snes,dm));
42746c699258SBarry Smith   PetscFunctionReturn(0);
42756c699258SBarry Smith }
42766c699258SBarry Smith 
42776c699258SBarry Smith /*@
42786c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
42796c699258SBarry Smith 
42803f9fe445SBarry Smith    Not Collective
42816c699258SBarry Smith 
42826c699258SBarry Smith    Input Parameter:
42836c699258SBarry Smith . ts - the preconditioner context
42846c699258SBarry Smith 
42856c699258SBarry Smith    Output Parameter:
42866c699258SBarry Smith .  dm - the dm
42876c699258SBarry Smith 
42886c699258SBarry Smith    Level: intermediate
42896c699258SBarry Smith 
42906c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
42916c699258SBarry Smith @*/
42927087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
42936c699258SBarry Smith {
42946c699258SBarry Smith   PetscFunctionBegin;
42950700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4296496e6a7aSJed Brown   if (!ts->dm) {
4297*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm));
4298*5f80ce2aSJacob Faibussowitsch     if (ts->snes) CHKERRQ(SNESSetDM(ts->snes,ts->dm));
4299496e6a7aSJed Brown   }
43006c699258SBarry Smith   *dm = ts->dm;
43016c699258SBarry Smith   PetscFunctionReturn(0);
43026c699258SBarry Smith }
43031713a123SBarry Smith 
43040f5c6efeSJed Brown /*@
43050f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
43060f5c6efeSJed Brown 
43073f9fe445SBarry Smith    Logically Collective on SNES
43080f5c6efeSJed Brown 
4309d8d19677SJose E. Roman    Input Parameters:
4310d42a1c89SJed Brown + snes - nonlinear solver
43110910c330SBarry Smith . U - the current state at which to evaluate the residual
4312d42a1c89SJed Brown - ctx - user context, must be a TS
43130f5c6efeSJed Brown 
43140f5c6efeSJed Brown    Output Parameter:
43150f5c6efeSJed Brown . F - the nonlinear residual
43160f5c6efeSJed Brown 
43170f5c6efeSJed Brown    Notes:
43180f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
43190f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
43200f5c6efeSJed Brown 
43210f5c6efeSJed Brown    Level: advanced
43220f5c6efeSJed Brown 
43230f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
43240f5c6efeSJed Brown @*/
43250910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
43260f5c6efeSJed Brown {
43270f5c6efeSJed Brown   TS             ts = (TS)ctx;
43280f5c6efeSJed Brown 
43290f5c6efeSJed Brown   PetscFunctionBegin;
43300f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
43310910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
43320f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
43330f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
4334*5f80ce2aSJacob Faibussowitsch   CHKERRQ((ts->ops->snesfunction)(snes,U,F,ts));
43350f5c6efeSJed Brown   PetscFunctionReturn(0);
43360f5c6efeSJed Brown }
43370f5c6efeSJed Brown 
43380f5c6efeSJed Brown /*@
43390f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
43400f5c6efeSJed Brown 
43410f5c6efeSJed Brown    Collective on SNES
43420f5c6efeSJed Brown 
4343d8d19677SJose E. Roman    Input Parameters:
43440f5c6efeSJed Brown + snes - nonlinear solver
43450910c330SBarry Smith . U - the current state at which to evaluate the residual
43460f5c6efeSJed Brown - ctx - user context, must be a TS
43470f5c6efeSJed Brown 
4348d8d19677SJose E. Roman    Output Parameters:
43490f5c6efeSJed Brown + A - the Jacobian
43506b867d5aSJose E. Roman - B - the preconditioning matrix (may be the same as A)
43510f5c6efeSJed Brown 
43520f5c6efeSJed Brown    Notes:
43530f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
43540f5c6efeSJed Brown 
43550f5c6efeSJed Brown    Level: developer
43560f5c6efeSJed Brown 
43570f5c6efeSJed Brown .seealso: SNESSetJacobian()
43580f5c6efeSJed Brown @*/
4359d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
43600f5c6efeSJed Brown {
43610f5c6efeSJed Brown   TS             ts = (TS)ctx;
43620f5c6efeSJed Brown 
43630f5c6efeSJed Brown   PetscFunctionBegin;
43640f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
43650910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
43660f5c6efeSJed Brown   PetscValidPointer(A,3);
436794ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
43680f5c6efeSJed Brown   PetscValidPointer(B,4);
436994ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
4370064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(ts,TS_CLASSID,5);
4371*5f80ce2aSJacob Faibussowitsch   CHKERRQ((ts->ops->snesjacobian)(snes,U,A,B,ts));
43720f5c6efeSJed Brown   PetscFunctionReturn(0);
43730f5c6efeSJed Brown }
4374325fc9f4SBarry Smith 
43750e4ef248SJed Brown /*@C
43769ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
43770e4ef248SJed Brown 
43780e4ef248SJed Brown    Collective on TS
43790e4ef248SJed Brown 
43804165533cSJose E. Roman    Input Parameters:
43810e4ef248SJed Brown +  ts - time stepping context
43820e4ef248SJed Brown .  t - time at which to evaluate
43830910c330SBarry Smith .  U - state at which to evaluate
43840e4ef248SJed Brown -  ctx - context
43850e4ef248SJed Brown 
43864165533cSJose E. Roman    Output Parameter:
43870e4ef248SJed Brown .  F - right hand side
43880e4ef248SJed Brown 
43890e4ef248SJed Brown    Level: intermediate
43900e4ef248SJed Brown 
43910e4ef248SJed Brown    Notes:
43920e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
43930e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
43940e4ef248SJed Brown 
43950e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
43960e4ef248SJed Brown @*/
43970910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
43980e4ef248SJed Brown {
43990e4ef248SJed Brown   Mat            Arhs,Brhs;
44000e4ef248SJed Brown 
44010e4ef248SJed Brown   PetscFunctionBegin;
4402*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetRHSMats_Private(ts,&Arhs,&Brhs));
44032663174eSHong Zhang   /* undo the damage caused by shifting */
4404*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSRecoverRHSJacobian(ts,Arhs,Brhs));
4405*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSComputeRHSJacobian(ts,t,U,Arhs,Brhs));
4406*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatMult(Arhs,U,F));
44070e4ef248SJed Brown   PetscFunctionReturn(0);
44080e4ef248SJed Brown }
44090e4ef248SJed Brown 
44100e4ef248SJed Brown /*@C
44110e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
44120e4ef248SJed Brown 
44130e4ef248SJed Brown    Collective on TS
44140e4ef248SJed Brown 
44154165533cSJose E. Roman    Input Parameters:
44160e4ef248SJed Brown +  ts - time stepping context
44170e4ef248SJed Brown .  t - time at which to evaluate
44180910c330SBarry Smith .  U - state at which to evaluate
44190e4ef248SJed Brown -  ctx - context
44200e4ef248SJed Brown 
44214165533cSJose E. Roman    Output Parameters:
44220e4ef248SJed Brown +  A - pointer to operator
442397bb3fdcSJose E. Roman -  B - pointer to preconditioning matrix
44240e4ef248SJed Brown 
44250e4ef248SJed Brown    Level: intermediate
44260e4ef248SJed Brown 
44270e4ef248SJed Brown    Notes:
44280e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
44290e4ef248SJed Brown 
44300e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
44310e4ef248SJed Brown @*/
4432d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
44330e4ef248SJed Brown {
44340e4ef248SJed Brown   PetscFunctionBegin;
44350e4ef248SJed Brown   PetscFunctionReturn(0);
44360e4ef248SJed Brown }
44370e4ef248SJed Brown 
44380026cea9SSean Farley /*@C
44390026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
44400026cea9SSean Farley 
44410026cea9SSean Farley    Collective on TS
44420026cea9SSean Farley 
44434165533cSJose E. Roman    Input Parameters:
44440026cea9SSean Farley +  ts - time stepping context
44450026cea9SSean Farley .  t - time at which to evaluate
44460910c330SBarry Smith .  U - state at which to evaluate
44470910c330SBarry Smith .  Udot - time derivative of state vector
44480026cea9SSean Farley -  ctx - context
44490026cea9SSean Farley 
44504165533cSJose E. Roman    Output Parameter:
44510026cea9SSean Farley .  F - left hand side
44520026cea9SSean Farley 
44530026cea9SSean Farley    Level: intermediate
44540026cea9SSean Farley 
44550026cea9SSean Farley    Notes:
44560910c330SBarry 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
44570026cea9SSean Farley    user is required to write their own TSComputeIFunction.
44580026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
44590026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
44600026cea9SSean Farley 
44619ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
44629ae8fd06SBarry Smith 
44639ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
44640026cea9SSean Farley @*/
44650910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
44660026cea9SSean Farley {
44670026cea9SSean Farley   Mat            A,B;
44680026cea9SSean Farley 
44690026cea9SSean Farley   PetscFunctionBegin;
4470*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetIJacobian(ts,&A,&B,NULL,NULL));
4471*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE));
4472*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatMult(A,Udot,F));
44730026cea9SSean Farley   PetscFunctionReturn(0);
44740026cea9SSean Farley }
44750026cea9SSean Farley 
44760026cea9SSean Farley /*@C
4477b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
44780026cea9SSean Farley 
44790026cea9SSean Farley    Collective on TS
44800026cea9SSean Farley 
44814165533cSJose E. Roman    Input Parameters:
44820026cea9SSean Farley +  ts - time stepping context
44830026cea9SSean Farley .  t - time at which to evaluate
44840910c330SBarry Smith .  U - state at which to evaluate
44850910c330SBarry Smith .  Udot - time derivative of state vector
44860026cea9SSean Farley .  shift - shift to apply
44870026cea9SSean Farley -  ctx - context
44880026cea9SSean Farley 
44894165533cSJose E. Roman    Output Parameters:
44900026cea9SSean Farley +  A - pointer to operator
449197bb3fdcSJose E. Roman -  B - pointer to preconditioning matrix
44920026cea9SSean Farley 
4493b41af12eSJed Brown    Level: advanced
44940026cea9SSean Farley 
44950026cea9SSean Farley    Notes:
44960026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
44970026cea9SSean Farley 
4498b41af12eSJed Brown    It is only appropriate for problems of the form
4499b41af12eSJed Brown 
4500b41af12eSJed Brown $     M Udot = F(U,t)
4501b41af12eSJed Brown 
4502b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4503b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4504b41af12eSJed Brown   an implicit operator of the form
4505b41af12eSJed Brown 
4506b41af12eSJed Brown $    shift*M + J
4507b41af12eSJed Brown 
4508b41af12eSJed 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
4509b41af12eSJed Brown   a copy of M or reassemble it when requested.
4510b41af12eSJed Brown 
45110026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
45120026cea9SSean Farley @*/
4513d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
45140026cea9SSean Farley {
45150026cea9SSean Farley   PetscFunctionBegin;
4516*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatScale(A, shift / ts->ijacobian.shift));
4517b41af12eSJed Brown   ts->ijacobian.shift = shift;
45180026cea9SSean Farley   PetscFunctionReturn(0);
45190026cea9SSean Farley }
4520b41af12eSJed Brown 
4521e817cc15SEmil Constantinescu /*@
4522e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4523e817cc15SEmil Constantinescu 
4524e817cc15SEmil Constantinescu    Not Collective
4525e817cc15SEmil Constantinescu 
4526e817cc15SEmil Constantinescu    Input Parameter:
4527e817cc15SEmil Constantinescu .  ts - the TS context
4528e817cc15SEmil Constantinescu 
4529e817cc15SEmil Constantinescu    Output Parameter:
45304e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4531e817cc15SEmil Constantinescu 
4532e817cc15SEmil Constantinescu    Level: beginner
4533e817cc15SEmil Constantinescu 
4534e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4535e817cc15SEmil Constantinescu @*/
4536e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4537e817cc15SEmil Constantinescu {
4538e817cc15SEmil Constantinescu   PetscFunctionBegin;
4539e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4540e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4541e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4542e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4543e817cc15SEmil Constantinescu }
4544e817cc15SEmil Constantinescu 
4545e817cc15SEmil Constantinescu /*@
4546e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4547e817cc15SEmil Constantinescu 
4548e817cc15SEmil Constantinescu    Not Collective
4549e817cc15SEmil Constantinescu 
4550d8d19677SJose E. Roman    Input Parameters:
4551e817cc15SEmil Constantinescu +  ts - the TS context
45521297b224SEmil Constantinescu -  equation_type - see TSEquationType
4553e817cc15SEmil Constantinescu 
4554e817cc15SEmil Constantinescu    Level: advanced
4555e817cc15SEmil Constantinescu 
4556e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4557e817cc15SEmil Constantinescu @*/
4558e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4559e817cc15SEmil Constantinescu {
4560e817cc15SEmil Constantinescu   PetscFunctionBegin;
4561e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4562e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4563e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4564e817cc15SEmil Constantinescu }
45650026cea9SSean Farley 
45664af1b03aSJed Brown /*@
45674af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
45684af1b03aSJed Brown 
45694af1b03aSJed Brown    Not Collective
45704af1b03aSJed Brown 
45714af1b03aSJed Brown    Input Parameter:
45724af1b03aSJed Brown .  ts - the TS context
45734af1b03aSJed Brown 
45744af1b03aSJed Brown    Output Parameter:
45754af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
45764af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
45774af1b03aSJed Brown 
4578487e0bb9SJed Brown    Level: beginner
45794af1b03aSJed Brown 
4580cd652676SJed Brown    Notes:
4581cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
45824af1b03aSJed Brown 
45834af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
45844af1b03aSJed Brown @*/
45854af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
45864af1b03aSJed Brown {
45874af1b03aSJed Brown   PetscFunctionBegin;
45884af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45894af1b03aSJed Brown   PetscValidPointer(reason,2);
45904af1b03aSJed Brown   *reason = ts->reason;
45914af1b03aSJed Brown   PetscFunctionReturn(0);
45924af1b03aSJed Brown }
45934af1b03aSJed Brown 
4594d6ad946cSShri Abhyankar /*@
4595d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4596d6ad946cSShri Abhyankar 
45976b221cbeSPatrick Sanan    Logically Collective; reason must contain common value
4598d6ad946cSShri Abhyankar 
45996b221cbeSPatrick Sanan    Input Parameters:
4600d6ad946cSShri Abhyankar +  ts - the TS context
46016b221cbeSPatrick Sanan -  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4602d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4603d6ad946cSShri Abhyankar 
4604f5abba47SShri Abhyankar    Level: advanced
4605d6ad946cSShri Abhyankar 
4606d6ad946cSShri Abhyankar    Notes:
46076b221cbeSPatrick Sanan    Can only be called while TSSolve() is active.
4608d6ad946cSShri Abhyankar 
4609d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4610d6ad946cSShri Abhyankar @*/
4611d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4612d6ad946cSShri Abhyankar {
4613d6ad946cSShri Abhyankar   PetscFunctionBegin;
4614d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4615d6ad946cSShri Abhyankar   ts->reason = reason;
4616d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4617d6ad946cSShri Abhyankar }
4618d6ad946cSShri Abhyankar 
4619cc708dedSBarry Smith /*@
4620cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4621cc708dedSBarry Smith 
4622cc708dedSBarry Smith    Not Collective
4623cc708dedSBarry Smith 
4624cc708dedSBarry Smith    Input Parameter:
4625cc708dedSBarry Smith .  ts - the TS context
4626cc708dedSBarry Smith 
4627cc708dedSBarry Smith    Output Parameter:
462819eac22cSLisandro Dalcin .  ftime - the final time. This time corresponds to the final time set with TSSetMaxTime()
4629cc708dedSBarry Smith 
4630487e0bb9SJed Brown    Level: beginner
4631cc708dedSBarry Smith 
4632cc708dedSBarry Smith    Notes:
4633cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4634cc708dedSBarry Smith 
4635cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4636cc708dedSBarry Smith @*/
4637cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4638cc708dedSBarry Smith {
4639cc708dedSBarry Smith   PetscFunctionBegin;
4640cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4641cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4642cc708dedSBarry Smith   *ftime = ts->solvetime;
4643cc708dedSBarry Smith   PetscFunctionReturn(0);
4644cc708dedSBarry Smith }
4645cc708dedSBarry Smith 
46462c18e0fdSBarry Smith /*@
46475ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
46489f67acb7SJed Brown    used by the time integrator.
46499f67acb7SJed Brown 
46509f67acb7SJed Brown    Not Collective
46519f67acb7SJed Brown 
46529f67acb7SJed Brown    Input Parameter:
46539f67acb7SJed Brown .  ts - TS context
46549f67acb7SJed Brown 
46559f67acb7SJed Brown    Output Parameter:
46569f67acb7SJed Brown .  nits - number of nonlinear iterations
46579f67acb7SJed Brown 
46589f67acb7SJed Brown    Notes:
46599f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
46609f67acb7SJed Brown 
46619f67acb7SJed Brown    Level: intermediate
46629f67acb7SJed Brown 
46635ef26d82SJed Brown .seealso:  TSGetKSPIterations()
46649f67acb7SJed Brown @*/
46655ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
46669f67acb7SJed Brown {
46679f67acb7SJed Brown   PetscFunctionBegin;
46689f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
46699f67acb7SJed Brown   PetscValidIntPointer(nits,2);
46705ef26d82SJed Brown   *nits = ts->snes_its;
46719f67acb7SJed Brown   PetscFunctionReturn(0);
46729f67acb7SJed Brown }
46739f67acb7SJed Brown 
46749f67acb7SJed Brown /*@
46755ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
46769f67acb7SJed Brown    used by the time integrator.
46779f67acb7SJed Brown 
46789f67acb7SJed Brown    Not Collective
46799f67acb7SJed Brown 
46809f67acb7SJed Brown    Input Parameter:
46819f67acb7SJed Brown .  ts - TS context
46829f67acb7SJed Brown 
46839f67acb7SJed Brown    Output Parameter:
46849f67acb7SJed Brown .  lits - number of linear iterations
46859f67acb7SJed Brown 
46869f67acb7SJed Brown    Notes:
46879f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
46889f67acb7SJed Brown 
46899f67acb7SJed Brown    Level: intermediate
46909f67acb7SJed Brown 
46915ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
46929f67acb7SJed Brown @*/
46935ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
46949f67acb7SJed Brown {
46959f67acb7SJed Brown   PetscFunctionBegin;
46969f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
46979f67acb7SJed Brown   PetscValidIntPointer(lits,2);
46985ef26d82SJed Brown   *lits = ts->ksp_its;
46999f67acb7SJed Brown   PetscFunctionReturn(0);
47009f67acb7SJed Brown }
47019f67acb7SJed Brown 
4702cef5090cSJed Brown /*@
4703cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
4704cef5090cSJed Brown 
4705cef5090cSJed Brown    Not Collective
4706cef5090cSJed Brown 
4707cef5090cSJed Brown    Input Parameter:
4708cef5090cSJed Brown .  ts - TS context
4709cef5090cSJed Brown 
4710cef5090cSJed Brown    Output Parameter:
4711cef5090cSJed Brown .  rejects - number of steps rejected
4712cef5090cSJed Brown 
4713cef5090cSJed Brown    Notes:
4714cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4715cef5090cSJed Brown 
4716cef5090cSJed Brown    Level: intermediate
4717cef5090cSJed Brown 
47185ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4719cef5090cSJed Brown @*/
4720cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4721cef5090cSJed Brown {
4722cef5090cSJed Brown   PetscFunctionBegin;
4723cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4724cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
4725cef5090cSJed Brown   *rejects = ts->reject;
4726cef5090cSJed Brown   PetscFunctionReturn(0);
4727cef5090cSJed Brown }
4728cef5090cSJed Brown 
4729cef5090cSJed Brown /*@
4730cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
4731cef5090cSJed Brown 
4732cef5090cSJed Brown    Not Collective
4733cef5090cSJed Brown 
4734cef5090cSJed Brown    Input Parameter:
4735cef5090cSJed Brown .  ts - TS context
4736cef5090cSJed Brown 
4737cef5090cSJed Brown    Output Parameter:
4738cef5090cSJed Brown .  fails - number of failed nonlinear solves
4739cef5090cSJed Brown 
4740cef5090cSJed Brown    Notes:
4741cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4742cef5090cSJed Brown 
4743cef5090cSJed Brown    Level: intermediate
4744cef5090cSJed Brown 
47455ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4746cef5090cSJed Brown @*/
4747cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4748cef5090cSJed Brown {
4749cef5090cSJed Brown   PetscFunctionBegin;
4750cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4751cef5090cSJed Brown   PetscValidIntPointer(fails,2);
4752cef5090cSJed Brown   *fails = ts->num_snes_failures;
4753cef5090cSJed Brown   PetscFunctionReturn(0);
4754cef5090cSJed Brown }
4755cef5090cSJed Brown 
4756cef5090cSJed Brown /*@
4757cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4758cef5090cSJed Brown 
4759cef5090cSJed Brown    Not Collective
4760cef5090cSJed Brown 
4761d8d19677SJose E. Roman    Input Parameters:
4762cef5090cSJed Brown +  ts - TS context
4763cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4764cef5090cSJed Brown 
4765cef5090cSJed Brown    Notes:
4766cef5090cSJed Brown    The counter is reset to zero for each step
4767cef5090cSJed Brown 
4768cef5090cSJed Brown    Options Database Key:
4769cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4770cef5090cSJed Brown 
4771cef5090cSJed Brown    Level: intermediate
4772cef5090cSJed Brown 
47735ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4774cef5090cSJed Brown @*/
4775cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4776cef5090cSJed Brown {
4777cef5090cSJed Brown   PetscFunctionBegin;
4778cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4779cef5090cSJed Brown   ts->max_reject = rejects;
4780cef5090cSJed Brown   PetscFunctionReturn(0);
4781cef5090cSJed Brown }
4782cef5090cSJed Brown 
4783cef5090cSJed Brown /*@
4784cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4785cef5090cSJed Brown 
4786cef5090cSJed Brown    Not Collective
4787cef5090cSJed Brown 
4788d8d19677SJose E. Roman    Input Parameters:
4789cef5090cSJed Brown +  ts - TS context
4790cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4791cef5090cSJed Brown 
4792cef5090cSJed Brown    Notes:
4793cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
4794cef5090cSJed Brown 
4795cef5090cSJed Brown    Options Database Key:
4796cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4797cef5090cSJed Brown 
4798cef5090cSJed Brown    Level: intermediate
4799cef5090cSJed Brown 
48005ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4801cef5090cSJed Brown @*/
4802cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4803cef5090cSJed Brown {
4804cef5090cSJed Brown   PetscFunctionBegin;
4805cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4806cef5090cSJed Brown   ts->max_snes_failures = fails;
4807cef5090cSJed Brown   PetscFunctionReturn(0);
4808cef5090cSJed Brown }
4809cef5090cSJed Brown 
4810cef5090cSJed Brown /*@
4811cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
4812cef5090cSJed Brown 
4813cef5090cSJed Brown    Not Collective
4814cef5090cSJed Brown 
4815d8d19677SJose E. Roman    Input Parameters:
4816cef5090cSJed Brown +  ts - TS context
4817cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4818cef5090cSJed Brown 
4819cef5090cSJed Brown    Options Database Key:
4820cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
4821cef5090cSJed Brown 
4822cef5090cSJed Brown    Level: intermediate
4823cef5090cSJed Brown 
48245ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4825cef5090cSJed Brown @*/
4826cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4827cef5090cSJed Brown {
4828cef5090cSJed Brown   PetscFunctionBegin;
4829cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4830cef5090cSJed Brown   ts->errorifstepfailed = err;
4831cef5090cSJed Brown   PetscFunctionReturn(0);
4832cef5090cSJed Brown }
4833cef5090cSJed Brown 
483484df9cb4SJed Brown /*@
4835552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
483684df9cb4SJed Brown 
4837ed81e22dSJed Brown    Collective on TS if controller has not been created yet
483884df9cb4SJed Brown 
48394165533cSJose E. Roman    Input Parameter:
4840ed81e22dSJed Brown .  ts - time stepping context
484184df9cb4SJed Brown 
48424165533cSJose E. Roman    Output Parameter:
4843ed81e22dSJed Brown .  adapt - adaptive controller
484484df9cb4SJed Brown 
484584df9cb4SJed Brown    Level: intermediate
484684df9cb4SJed Brown 
4847ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
484884df9cb4SJed Brown @*/
4849552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
485084df9cb4SJed Brown {
485184df9cb4SJed Brown   PetscFunctionBegin;
485284df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4853bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
485484df9cb4SJed Brown   if (!ts->adapt) {
4855*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt));
4856*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt));
4857*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1));
485884df9cb4SJed Brown   }
4859bec58848SLisandro Dalcin   *adapt = ts->adapt;
486084df9cb4SJed Brown   PetscFunctionReturn(0);
486184df9cb4SJed Brown }
4862d6ebe24aSShri Abhyankar 
48631c3436cfSJed Brown /*@
48641c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
48651c3436cfSJed Brown 
48661c3436cfSJed Brown    Logically Collective
48671c3436cfSJed Brown 
48684165533cSJose E. Roman    Input Parameters:
48691c3436cfSJed Brown +  ts - time integration context
48701c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
48710298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
48721c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
48730298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
48741c3436cfSJed Brown 
4875a3cdaa26SBarry Smith    Options Database keys:
4876a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
487767b8a455SSatish Balay -  -ts_atol <atol> - Absolute tolerance for local truncation error
4878a3cdaa26SBarry Smith 
48793ff766beSShri Abhyankar    Notes:
48803ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
48813ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
48823ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
48833ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
48843ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
48853ff766beSShri Abhyankar    differential variables.
48863ff766beSShri Abhyankar 
48871c3436cfSJed Brown    Level: beginner
48881c3436cfSJed Brown 
48895c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSGetTolerances()
48901c3436cfSJed Brown @*/
48911c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
48921c3436cfSJed Brown {
48931c3436cfSJed Brown   PetscFunctionBegin;
4894c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
48951c3436cfSJed Brown   if (vatol) {
4896*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectReference((PetscObject)vatol));
4897*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecDestroy(&ts->vatol));
48981c3436cfSJed Brown     ts->vatol = vatol;
48991c3436cfSJed Brown   }
4900c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
49011c3436cfSJed Brown   if (vrtol) {
4902*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectReference((PetscObject)vrtol));
4903*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecDestroy(&ts->vrtol));
49041c3436cfSJed Brown     ts->vrtol = vrtol;
49051c3436cfSJed Brown   }
49061c3436cfSJed Brown   PetscFunctionReturn(0);
49071c3436cfSJed Brown }
49081c3436cfSJed Brown 
4909c5033834SJed Brown /*@
4910c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
4911c5033834SJed Brown 
4912c5033834SJed Brown    Logically Collective
4913c5033834SJed Brown 
49144165533cSJose E. Roman    Input Parameter:
4915c5033834SJed Brown .  ts - time integration context
4916c5033834SJed Brown 
49174165533cSJose E. Roman    Output Parameters:
49180298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
49190298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
49200298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
49210298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
4922c5033834SJed Brown 
4923c5033834SJed Brown    Level: beginner
4924c5033834SJed Brown 
49255c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSSetTolerances()
4926c5033834SJed Brown @*/
4927c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
4928c5033834SJed Brown {
4929c5033834SJed Brown   PetscFunctionBegin;
4930c5033834SJed Brown   if (atol)  *atol  = ts->atol;
4931c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
4932c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
4933c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
4934c5033834SJed Brown   PetscFunctionReturn(0);
4935c5033834SJed Brown }
4936c5033834SJed Brown 
49379c6b16b5SShri Abhyankar /*@
4938a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
49399c6b16b5SShri Abhyankar 
49409c6b16b5SShri Abhyankar    Collective on TS
49419c6b16b5SShri Abhyankar 
49424165533cSJose E. Roman    Input Parameters:
49439c6b16b5SShri Abhyankar +  ts - time stepping context
4944a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
4945a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
49469c6b16b5SShri Abhyankar 
49474165533cSJose E. Roman    Output Parameters:
4948a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
49497453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
4950a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
49519c6b16b5SShri Abhyankar 
49529c6b16b5SShri Abhyankar    Level: developer
49539c6b16b5SShri Abhyankar 
4954deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
49559c6b16b5SShri Abhyankar @*/
49567453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
49579c6b16b5SShri Abhyankar {
49589c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
49597453f775SEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
49607453f775SEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
49619c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
49627453f775SEmil Constantinescu   PetscReal         sum,suma,sumr,gsum,gsuma,gsumr,diff;
49637453f775SEmil Constantinescu   PetscReal         tol,tola,tolr;
49647453f775SEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
49659c6b16b5SShri Abhyankar 
49669c6b16b5SShri Abhyankar   PetscFunctionBegin;
49679c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4968a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
4969a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
4970a4868fbcSLisandro Dalcin   PetscValidType(U,2);
4971a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
4972a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
4973a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
49748a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
49758a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
49763c633725SBarry Smith   PetscCheck(U != Y,PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
49779c6b16b5SShri Abhyankar 
4978*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetSize(U,&N));
4979*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetLocalSize(U,&n));
4980*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetOwnershipRange(U,&rstart,NULL));
4981*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetArrayRead(U,&u));
4982*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetArrayRead(Y,&y));
49837453f775SEmil Constantinescu   sum  = 0.; n_loc  = 0;
49847453f775SEmil Constantinescu   suma = 0.; na_loc = 0;
49857453f775SEmil Constantinescu   sumr = 0.; nr_loc = 0;
49869c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
49879c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
4988*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vatol,&atol));
4989*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vrtol,&rtol));
49909c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
499176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
49927453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
49937453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
49947453f775SEmil Constantinescu       if (tola>0.) {
49957453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
49967453f775SEmil Constantinescu         na_loc++;
49977453f775SEmil Constantinescu       }
49987453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
49997453f775SEmil Constantinescu       if (tolr>0.) {
50007453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
50017453f775SEmil Constantinescu         nr_loc++;
50027453f775SEmil Constantinescu       }
50037453f775SEmil Constantinescu       tol=tola+tolr;
50047453f775SEmil Constantinescu       if (tol>0.) {
50057453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
50067453f775SEmil Constantinescu         n_loc++;
50077453f775SEmil Constantinescu       }
50089c6b16b5SShri Abhyankar     }
5009*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vatol,&atol));
5010*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vrtol,&rtol));
50119c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
50129c6b16b5SShri Abhyankar     const PetscScalar *atol;
5013*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vatol,&atol));
50149c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
501576cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
50167453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
50177453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
50187453f775SEmil Constantinescu       if (tola>0.) {
50197453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
50207453f775SEmil Constantinescu         na_loc++;
50217453f775SEmil Constantinescu       }
50227453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50237453f775SEmil Constantinescu       if (tolr>0.) {
50247453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
50257453f775SEmil Constantinescu         nr_loc++;
50267453f775SEmil Constantinescu       }
50277453f775SEmil Constantinescu       tol=tola+tolr;
50287453f775SEmil Constantinescu       if (tol>0.) {
50297453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
50307453f775SEmil Constantinescu         n_loc++;
50317453f775SEmil Constantinescu       }
50329c6b16b5SShri Abhyankar     }
5033*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vatol,&atol));
50349c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
50359c6b16b5SShri Abhyankar     const PetscScalar *rtol;
5036*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vrtol,&rtol));
50379c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
503876cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
50397453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
50407453f775SEmil Constantinescu       tola = ts->atol;
50417453f775SEmil Constantinescu       if (tola>0.) {
50427453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
50437453f775SEmil Constantinescu         na_loc++;
50447453f775SEmil Constantinescu       }
50457453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50467453f775SEmil Constantinescu       if (tolr>0.) {
50477453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
50487453f775SEmil Constantinescu         nr_loc++;
50497453f775SEmil Constantinescu       }
50507453f775SEmil Constantinescu       tol=tola+tolr;
50517453f775SEmil Constantinescu       if (tol>0.) {
50527453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
50537453f775SEmil Constantinescu         n_loc++;
50547453f775SEmil Constantinescu       }
50559c6b16b5SShri Abhyankar     }
5056*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vrtol,&rtol));
50579c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
50589c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
505976cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
50607453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
50617453f775SEmil Constantinescu       tola = ts->atol;
50627453f775SEmil Constantinescu       if (tola>0.) {
50637453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
50647453f775SEmil Constantinescu         na_loc++;
50657453f775SEmil Constantinescu       }
50667453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50677453f775SEmil Constantinescu       if (tolr>0.) {
50687453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
50697453f775SEmil Constantinescu         nr_loc++;
50707453f775SEmil Constantinescu       }
50717453f775SEmil Constantinescu       tol=tola+tolr;
50727453f775SEmil Constantinescu       if (tol>0.) {
50737453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
50747453f775SEmil Constantinescu         n_loc++;
50757453f775SEmil Constantinescu       }
50769c6b16b5SShri Abhyankar     }
50779c6b16b5SShri Abhyankar   }
5078*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecRestoreArrayRead(U,&u));
5079*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecRestoreArrayRead(Y,&y));
50809c6b16b5SShri Abhyankar 
50817453f775SEmil Constantinescu   err_loc[0] = sum;
50827453f775SEmil Constantinescu   err_loc[1] = suma;
50837453f775SEmil Constantinescu   err_loc[2] = sumr;
50847453f775SEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
50857453f775SEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
50867453f775SEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
50877453f775SEmil Constantinescu 
5088*5f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts)));
50897453f775SEmil Constantinescu 
50907453f775SEmil Constantinescu   gsum   = err_glb[0];
50917453f775SEmil Constantinescu   gsuma  = err_glb[1];
50927453f775SEmil Constantinescu   gsumr  = err_glb[2];
50937453f775SEmil Constantinescu   n_glb  = err_glb[3];
50947453f775SEmil Constantinescu   na_glb = err_glb[4];
50957453f775SEmil Constantinescu   nr_glb = err_glb[5];
50967453f775SEmil Constantinescu 
5097b1316ef9SEmil Constantinescu   *norm  = 0.;
5098b1316ef9SEmil Constantinescu   if (n_glb>0.) {*norm  = PetscSqrtReal(gsum  / n_glb);}
5099b1316ef9SEmil Constantinescu   *norma = 0.;
5100b1316ef9SEmil Constantinescu   if (na_glb>0.) {*norma = PetscSqrtReal(gsuma / na_glb);}
5101b1316ef9SEmil Constantinescu   *normr = 0.;
5102b1316ef9SEmil Constantinescu   if (nr_glb>0.) {*normr = PetscSqrtReal(gsumr / nr_glb);}
51039c6b16b5SShri Abhyankar 
51043c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*norm),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
51053c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*norma),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
51063c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*normr),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
51079c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
51089c6b16b5SShri Abhyankar }
51099c6b16b5SShri Abhyankar 
51109c6b16b5SShri Abhyankar /*@
5111a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
51129c6b16b5SShri Abhyankar 
51139c6b16b5SShri Abhyankar    Collective on TS
51149c6b16b5SShri Abhyankar 
51154165533cSJose E. Roman    Input Parameters:
51169c6b16b5SShri Abhyankar +  ts - time stepping context
5117a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5118a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
51199c6b16b5SShri Abhyankar 
51204165533cSJose E. Roman    Output Parameters:
5121a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
51227453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5123a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
51249c6b16b5SShri Abhyankar 
51259c6b16b5SShri Abhyankar    Level: developer
51269c6b16b5SShri Abhyankar 
5127deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
51289c6b16b5SShri Abhyankar @*/
51297453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
51309c6b16b5SShri Abhyankar {
51317453f775SEmil Constantinescu   PetscInt          i,n,N,rstart;
51329c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
51337453f775SEmil Constantinescu   PetscReal         max,gmax,maxa,gmaxa,maxr,gmaxr;
51347453f775SEmil Constantinescu   PetscReal         tol,tola,tolr,diff;
51357453f775SEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
51369c6b16b5SShri Abhyankar 
51379c6b16b5SShri Abhyankar   PetscFunctionBegin;
51389c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5139a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5140a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5141a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5142a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5143a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5144a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
51458a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
51468a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
51473c633725SBarry Smith   PetscCheck(U != Y,PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
51489c6b16b5SShri Abhyankar 
5149*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetSize(U,&N));
5150*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetLocalSize(U,&n));
5151*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetOwnershipRange(U,&rstart,NULL));
5152*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetArrayRead(U,&u));
5153*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetArrayRead(Y,&y));
51547453f775SEmil Constantinescu 
51557453f775SEmil Constantinescu   max=0.;
51567453f775SEmil Constantinescu   maxa=0.;
51577453f775SEmil Constantinescu   maxr=0.;
51587453f775SEmil Constantinescu 
51597453f775SEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
51609c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
5161*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vatol,&atol));
5162*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vrtol,&rtol));
51637453f775SEmil Constantinescu 
51647453f775SEmil Constantinescu     for (i=0; i<n; i++) {
516576cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
51667453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
51677453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
51687453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
51697453f775SEmil Constantinescu       tol  = tola+tolr;
51707453f775SEmil Constantinescu       if (tola>0.) {
51717453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
51727453f775SEmil Constantinescu       }
51737453f775SEmil Constantinescu       if (tolr>0.) {
51747453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
51757453f775SEmil Constantinescu       }
51767453f775SEmil Constantinescu       if (tol>0.) {
51777453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
51787453f775SEmil Constantinescu       }
51799c6b16b5SShri Abhyankar     }
5180*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vatol,&atol));
5181*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vrtol,&rtol));
51829c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
51839c6b16b5SShri Abhyankar     const PetscScalar *atol;
5184*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vatol,&atol));
51857453f775SEmil Constantinescu     for (i=0; i<n; i++) {
518676cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
51877453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
51887453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
51897453f775SEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
51907453f775SEmil Constantinescu       tol  = tola+tolr;
51917453f775SEmil Constantinescu       if (tola>0.) {
51927453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
51937453f775SEmil Constantinescu       }
51947453f775SEmil Constantinescu       if (tolr>0.) {
51957453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
51967453f775SEmil Constantinescu       }
51977453f775SEmil Constantinescu       if (tol>0.) {
51987453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
51997453f775SEmil Constantinescu       }
52009c6b16b5SShri Abhyankar     }
5201*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vatol,&atol));
52029c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
52039c6b16b5SShri Abhyankar     const PetscScalar *rtol;
5204*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vrtol,&rtol));
52057453f775SEmil Constantinescu 
52067453f775SEmil Constantinescu     for (i=0; i<n; i++) {
520776cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
52087453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
52097453f775SEmil Constantinescu       tola = ts->atol;
52107453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52117453f775SEmil Constantinescu       tol  = tola+tolr;
52127453f775SEmil Constantinescu       if (tola>0.) {
52137453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
52147453f775SEmil Constantinescu       }
52157453f775SEmil Constantinescu       if (tolr>0.) {
52167453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
52177453f775SEmil Constantinescu       }
52187453f775SEmil Constantinescu       if (tol>0.) {
52197453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
52207453f775SEmil Constantinescu       }
52219c6b16b5SShri Abhyankar     }
5222*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vrtol,&rtol));
52239c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
52247453f775SEmil Constantinescu 
52257453f775SEmil Constantinescu     for (i=0; i<n; i++) {
522676cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
52277453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
52287453f775SEmil Constantinescu       tola = ts->atol;
52297453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52307453f775SEmil Constantinescu       tol  = tola+tolr;
52317453f775SEmil Constantinescu       if (tola>0.) {
52327453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
52337453f775SEmil Constantinescu       }
52347453f775SEmil Constantinescu       if (tolr>0.) {
52357453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
52367453f775SEmil Constantinescu       }
52377453f775SEmil Constantinescu       if (tol>0.) {
52387453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
52397453f775SEmil Constantinescu       }
52409c6b16b5SShri Abhyankar     }
52419c6b16b5SShri Abhyankar   }
5242*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecRestoreArrayRead(U,&u));
5243*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecRestoreArrayRead(Y,&y));
52447453f775SEmil Constantinescu   err_loc[0] = max;
52457453f775SEmil Constantinescu   err_loc[1] = maxa;
52467453f775SEmil Constantinescu   err_loc[2] = maxr;
5247*5f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts)));
52487453f775SEmil Constantinescu   gmax   = err_glb[0];
52497453f775SEmil Constantinescu   gmaxa  = err_glb[1];
52507453f775SEmil Constantinescu   gmaxr  = err_glb[2];
52519c6b16b5SShri Abhyankar 
52529c6b16b5SShri Abhyankar   *norm = gmax;
52537453f775SEmil Constantinescu   *norma = gmaxa;
52547453f775SEmil Constantinescu   *normr = gmaxr;
52553c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*norm),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
52563c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*norma),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
52573c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*normr),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
52589c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
52599c6b16b5SShri Abhyankar }
52609c6b16b5SShri Abhyankar 
52611c3436cfSJed Brown /*@
52628a175baeSEmil Constantinescu    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
52631c3436cfSJed Brown 
52641c3436cfSJed Brown    Collective on TS
52651c3436cfSJed Brown 
52664165533cSJose E. Roman    Input Parameters:
52671c3436cfSJed Brown +  ts - time stepping context
5268a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5269a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
5270a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
52717619abb3SShri 
52724165533cSJose E. Roman    Output Parameters:
5273a2b725a8SWilliam Gropp +  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
52748a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
5275a2b725a8SWilliam Gropp -  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
5276a4868fbcSLisandro Dalcin 
5277a4868fbcSLisandro Dalcin    Options Database Keys:
5278a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5279a4868fbcSLisandro Dalcin 
52801c3436cfSJed Brown    Level: developer
52811c3436cfSJed Brown 
52828a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm
52831c3436cfSJed Brown @*/
52847453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
52851c3436cfSJed Brown {
52861c3436cfSJed Brown   PetscFunctionBegin;
5287a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
5288*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr));
5289a4868fbcSLisandro Dalcin   } else if (wnormtype == NORM_INFINITY) {
5290*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr));
529198921bdaSJacob Faibussowitsch   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
52921c3436cfSJed Brown   PetscFunctionReturn(0);
52931c3436cfSJed Brown }
52941c3436cfSJed Brown 
52958a175baeSEmil Constantinescu /*@
52968a175baeSEmil Constantinescu    TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances
52978a175baeSEmil Constantinescu 
52988a175baeSEmil Constantinescu    Collective on TS
52998a175baeSEmil Constantinescu 
53004165533cSJose E. Roman    Input Parameters:
53018a175baeSEmil Constantinescu +  ts - time stepping context
53028a175baeSEmil Constantinescu .  E - error vector
53038a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
53048a175baeSEmil Constantinescu -  Y - state vector, previous time step
53058a175baeSEmil Constantinescu 
53064165533cSJose E. Roman    Output Parameters:
5307a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
53088a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5309a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
53108a175baeSEmil Constantinescu 
53118a175baeSEmil Constantinescu    Level: developer
53128a175baeSEmil Constantinescu 
53138a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity()
53148a175baeSEmil Constantinescu @*/
53158a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
53168a175baeSEmil Constantinescu {
53178a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
53188a175baeSEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
53198a175baeSEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
53208a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
53218a175baeSEmil Constantinescu   PetscReal         err,sum,suma,sumr,gsum,gsuma,gsumr;
53228a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
53238a175baeSEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
53248a175baeSEmil Constantinescu 
53258a175baeSEmil Constantinescu   PetscFunctionBegin;
53268a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53278a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
53288a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
53298a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
53308a175baeSEmil Constantinescu   PetscValidType(E,2);
53318a175baeSEmil Constantinescu   PetscValidType(U,3);
53328a175baeSEmil Constantinescu   PetscValidType(Y,4);
53338a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
5334064a246eSJacob Faibussowitsch   PetscCheckSameComm(U,3,Y,4);
53358a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
53368a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
53378a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
53388a175baeSEmil Constantinescu 
5339*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetSize(E,&N));
5340*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetLocalSize(E,&n));
5341*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetOwnershipRange(E,&rstart,NULL));
5342*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetArrayRead(E,&e));
5343*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetArrayRead(U,&u));
5344*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetArrayRead(Y,&y));
53458a175baeSEmil Constantinescu   sum  = 0.; n_loc  = 0;
53468a175baeSEmil Constantinescu   suma = 0.; na_loc = 0;
53478a175baeSEmil Constantinescu   sumr = 0.; nr_loc = 0;
53488a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {
53498a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
5350*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vatol,&atol));
5351*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vrtol,&rtol));
53528a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
535376cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
53548a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
53558a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
53568a175baeSEmil Constantinescu       if (tola>0.) {
53578a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
53588a175baeSEmil Constantinescu         na_loc++;
53598a175baeSEmil Constantinescu       }
53608a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53618a175baeSEmil Constantinescu       if (tolr>0.) {
53628a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
53638a175baeSEmil Constantinescu         nr_loc++;
53648a175baeSEmil Constantinescu       }
53658a175baeSEmil Constantinescu       tol=tola+tolr;
53668a175baeSEmil Constantinescu       if (tol>0.) {
53678a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
53688a175baeSEmil Constantinescu         n_loc++;
53698a175baeSEmil Constantinescu       }
53708a175baeSEmil Constantinescu     }
5371*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vatol,&atol));
5372*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vrtol,&rtol));
53738a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
53748a175baeSEmil Constantinescu     const PetscScalar *atol;
5375*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vatol,&atol));
53768a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
537776cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
53788a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
53798a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
53808a175baeSEmil Constantinescu       if (tola>0.) {
53818a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
53828a175baeSEmil Constantinescu         na_loc++;
53838a175baeSEmil Constantinescu       }
53848a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53858a175baeSEmil Constantinescu       if (tolr>0.) {
53868a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
53878a175baeSEmil Constantinescu         nr_loc++;
53888a175baeSEmil Constantinescu       }
53898a175baeSEmil Constantinescu       tol=tola+tolr;
53908a175baeSEmil Constantinescu       if (tol>0.) {
53918a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
53928a175baeSEmil Constantinescu         n_loc++;
53938a175baeSEmil Constantinescu       }
53948a175baeSEmil Constantinescu     }
5395*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vatol,&atol));
53968a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
53978a175baeSEmil Constantinescu     const PetscScalar *rtol;
5398*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vrtol,&rtol));
53998a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
540076cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
54018a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
54028a175baeSEmil Constantinescu       tola = ts->atol;
54038a175baeSEmil Constantinescu       if (tola>0.) {
54048a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
54058a175baeSEmil Constantinescu         na_loc++;
54068a175baeSEmil Constantinescu       }
54078a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54088a175baeSEmil Constantinescu       if (tolr>0.) {
54098a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
54108a175baeSEmil Constantinescu         nr_loc++;
54118a175baeSEmil Constantinescu       }
54128a175baeSEmil Constantinescu       tol=tola+tolr;
54138a175baeSEmil Constantinescu       if (tol>0.) {
54148a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
54158a175baeSEmil Constantinescu         n_loc++;
54168a175baeSEmil Constantinescu       }
54178a175baeSEmil Constantinescu     }
5418*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vrtol,&rtol));
54198a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
54208a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
542176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
54228a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
54238a175baeSEmil Constantinescu       tola = ts->atol;
54248a175baeSEmil Constantinescu       if (tola>0.) {
54258a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
54268a175baeSEmil Constantinescu         na_loc++;
54278a175baeSEmil Constantinescu       }
54288a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54298a175baeSEmil Constantinescu       if (tolr>0.) {
54308a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
54318a175baeSEmil Constantinescu         nr_loc++;
54328a175baeSEmil Constantinescu       }
54338a175baeSEmil Constantinescu       tol=tola+tolr;
54348a175baeSEmil Constantinescu       if (tol>0.) {
54358a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
54368a175baeSEmil Constantinescu         n_loc++;
54378a175baeSEmil Constantinescu       }
54388a175baeSEmil Constantinescu     }
54398a175baeSEmil Constantinescu   }
5440*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecRestoreArrayRead(E,&e));
5441*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecRestoreArrayRead(U,&u));
5442*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecRestoreArrayRead(Y,&y));
54438a175baeSEmil Constantinescu 
54448a175baeSEmil Constantinescu   err_loc[0] = sum;
54458a175baeSEmil Constantinescu   err_loc[1] = suma;
54468a175baeSEmil Constantinescu   err_loc[2] = sumr;
54478a175baeSEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
54488a175baeSEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
54498a175baeSEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
54508a175baeSEmil Constantinescu 
5451*5f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts)));
54528a175baeSEmil Constantinescu 
54538a175baeSEmil Constantinescu   gsum   = err_glb[0];
54548a175baeSEmil Constantinescu   gsuma  = err_glb[1];
54558a175baeSEmil Constantinescu   gsumr  = err_glb[2];
54568a175baeSEmil Constantinescu   n_glb  = err_glb[3];
54578a175baeSEmil Constantinescu   na_glb = err_glb[4];
54588a175baeSEmil Constantinescu   nr_glb = err_glb[5];
54598a175baeSEmil Constantinescu 
54608a175baeSEmil Constantinescu   *norm  = 0.;
54618a175baeSEmil Constantinescu   if (n_glb>0.) {*norm  = PetscSqrtReal(gsum  / n_glb);}
54628a175baeSEmil Constantinescu   *norma = 0.;
54638a175baeSEmil Constantinescu   if (na_glb>0.) {*norma = PetscSqrtReal(gsuma / na_glb);}
54648a175baeSEmil Constantinescu   *normr = 0.;
54658a175baeSEmil Constantinescu   if (nr_glb>0.) {*normr = PetscSqrtReal(gsumr / nr_glb);}
54668a175baeSEmil Constantinescu 
54673c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*norm),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
54683c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*norma),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
54693c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*normr),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
54708a175baeSEmil Constantinescu   PetscFunctionReturn(0);
54718a175baeSEmil Constantinescu }
54728a175baeSEmil Constantinescu 
54738a175baeSEmil Constantinescu /*@
54748a175baeSEmil Constantinescu    TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances
54758a175baeSEmil Constantinescu    Collective on TS
54768a175baeSEmil Constantinescu 
54774165533cSJose E. Roman    Input Parameters:
54788a175baeSEmil Constantinescu +  ts - time stepping context
54798a175baeSEmil Constantinescu .  E - error vector
54808a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
54818a175baeSEmil Constantinescu -  Y - state vector, previous time step
54828a175baeSEmil Constantinescu 
54834165533cSJose E. Roman    Output Parameters:
5484a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
54858a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5486a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
54878a175baeSEmil Constantinescu 
54888a175baeSEmil Constantinescu    Level: developer
54898a175baeSEmil Constantinescu 
54908a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2()
54918a175baeSEmil Constantinescu @*/
54928a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
54938a175baeSEmil Constantinescu {
54948a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
54958a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
54968a175baeSEmil Constantinescu   PetscReal         err,max,gmax,maxa,gmaxa,maxr,gmaxr;
54978a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
54988a175baeSEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
54998a175baeSEmil Constantinescu 
55008a175baeSEmil Constantinescu   PetscFunctionBegin;
55018a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
55028a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
55038a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
55048a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
55058a175baeSEmil Constantinescu   PetscValidType(E,2);
55068a175baeSEmil Constantinescu   PetscValidType(U,3);
55078a175baeSEmil Constantinescu   PetscValidType(Y,4);
55088a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
5509064a246eSJacob Faibussowitsch   PetscCheckSameComm(U,3,Y,4);
55108a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
55118a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
55128a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
55138a175baeSEmil Constantinescu 
5514*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetSize(E,&N));
5515*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetLocalSize(E,&n));
5516*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetOwnershipRange(E,&rstart,NULL));
5517*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetArrayRead(E,&e));
5518*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetArrayRead(U,&u));
5519*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecGetArrayRead(Y,&y));
55208a175baeSEmil Constantinescu 
55218a175baeSEmil Constantinescu   max=0.;
55228a175baeSEmil Constantinescu   maxa=0.;
55238a175baeSEmil Constantinescu   maxr=0.;
55248a175baeSEmil Constantinescu 
55258a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
55268a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
5527*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vatol,&atol));
5528*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vrtol,&rtol));
55298a175baeSEmil Constantinescu 
55308a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
553176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
55328a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
55338a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
55348a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55358a175baeSEmil Constantinescu       tol  = tola+tolr;
55368a175baeSEmil Constantinescu       if (tola>0.) {
55378a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
55388a175baeSEmil Constantinescu       }
55398a175baeSEmil Constantinescu       if (tolr>0.) {
55408a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
55418a175baeSEmil Constantinescu       }
55428a175baeSEmil Constantinescu       if (tol>0.) {
55438a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
55448a175baeSEmil Constantinescu       }
55458a175baeSEmil Constantinescu     }
5546*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vatol,&atol));
5547*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vrtol,&rtol));
55488a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
55498a175baeSEmil Constantinescu     const PetscScalar *atol;
5550*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vatol,&atol));
55518a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
555276cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
55538a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
55548a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
55558a175baeSEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55568a175baeSEmil Constantinescu       tol  = tola+tolr;
55578a175baeSEmil Constantinescu       if (tola>0.) {
55588a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
55598a175baeSEmil Constantinescu       }
55608a175baeSEmil Constantinescu       if (tolr>0.) {
55618a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
55628a175baeSEmil Constantinescu       }
55638a175baeSEmil Constantinescu       if (tol>0.) {
55648a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
55658a175baeSEmil Constantinescu       }
55668a175baeSEmil Constantinescu     }
5567*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vatol,&atol));
55688a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
55698a175baeSEmil Constantinescu     const PetscScalar *rtol;
5570*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecGetArrayRead(ts->vrtol,&rtol));
55718a175baeSEmil Constantinescu 
55728a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
557376cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
55748a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
55758a175baeSEmil Constantinescu       tola = ts->atol;
55768a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55778a175baeSEmil Constantinescu       tol  = tola+tolr;
55788a175baeSEmil Constantinescu       if (tola>0.) {
55798a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
55808a175baeSEmil Constantinescu       }
55818a175baeSEmil Constantinescu       if (tolr>0.) {
55828a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
55838a175baeSEmil Constantinescu       }
55848a175baeSEmil Constantinescu       if (tol>0.) {
55858a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
55868a175baeSEmil Constantinescu       }
55878a175baeSEmil Constantinescu     }
5588*5f80ce2aSJacob Faibussowitsch     CHKERRQ(VecRestoreArrayRead(ts->vrtol,&rtol));
55898a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
55908a175baeSEmil Constantinescu 
55918a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
559276cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
55938a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
55948a175baeSEmil Constantinescu       tola = ts->atol;
55958a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55968a175baeSEmil Constantinescu       tol  = tola+tolr;
55978a175baeSEmil Constantinescu       if (tola>0.) {
55988a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
55998a175baeSEmil Constantinescu       }
56008a175baeSEmil Constantinescu       if (tolr>0.) {
56018a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
56028a175baeSEmil Constantinescu       }
56038a175baeSEmil Constantinescu       if (tol>0.) {
56048a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
56058a175baeSEmil Constantinescu       }
56068a175baeSEmil Constantinescu     }
56078a175baeSEmil Constantinescu   }
5608*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecRestoreArrayRead(E,&e));
5609*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecRestoreArrayRead(U,&u));
5610*5f80ce2aSJacob Faibussowitsch   CHKERRQ(VecRestoreArrayRead(Y,&y));
56118a175baeSEmil Constantinescu   err_loc[0] = max;
56128a175baeSEmil Constantinescu   err_loc[1] = maxa;
56138a175baeSEmil Constantinescu   err_loc[2] = maxr;
5614*5f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts)));
56158a175baeSEmil Constantinescu   gmax   = err_glb[0];
56168a175baeSEmil Constantinescu   gmaxa  = err_glb[1];
56178a175baeSEmil Constantinescu   gmaxr  = err_glb[2];
56188a175baeSEmil Constantinescu 
56198a175baeSEmil Constantinescu   *norm = gmax;
56208a175baeSEmil Constantinescu   *norma = gmaxa;
56218a175baeSEmil Constantinescu   *normr = gmaxr;
56223c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*norm),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
56233c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*norma),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
56243c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*normr),PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
56258a175baeSEmil Constantinescu   PetscFunctionReturn(0);
56268a175baeSEmil Constantinescu }
56278a175baeSEmil Constantinescu 
56288a175baeSEmil Constantinescu /*@
56298a175baeSEmil Constantinescu    TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
56308a175baeSEmil Constantinescu 
56318a175baeSEmil Constantinescu    Collective on TS
56328a175baeSEmil Constantinescu 
56334165533cSJose E. Roman    Input Parameters:
56348a175baeSEmil Constantinescu +  ts - time stepping context
56358a175baeSEmil Constantinescu .  E - error vector
56368a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
56378a175baeSEmil Constantinescu .  Y - state vector, previous time step
56388a175baeSEmil Constantinescu -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
56398a175baeSEmil Constantinescu 
56404165533cSJose E. Roman    Output Parameters:
5641a2b725a8SWilliam Gropp +  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
56428a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
5643a2b725a8SWilliam Gropp -  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
56448a175baeSEmil Constantinescu 
56458a175baeSEmil Constantinescu    Options Database Keys:
56468a175baeSEmil Constantinescu .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
56478a175baeSEmil Constantinescu 
56488a175baeSEmil Constantinescu    Level: developer
56498a175baeSEmil Constantinescu 
56508a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
56518a175baeSEmil Constantinescu @*/
56528a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
56538a175baeSEmil Constantinescu {
56548a175baeSEmil Constantinescu   PetscFunctionBegin;
56558a175baeSEmil Constantinescu   if (wnormtype == NORM_2) {
5656*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr));
56578a175baeSEmil Constantinescu   } else if (wnormtype == NORM_INFINITY) {
5658*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr));
565998921bdaSJacob Faibussowitsch   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
56608a175baeSEmil Constantinescu   PetscFunctionReturn(0);
56618a175baeSEmil Constantinescu }
56628a175baeSEmil Constantinescu 
56638d59e960SJed Brown /*@
56648d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
56658d59e960SJed Brown 
56668d59e960SJed Brown    Logically Collective on TS
56678d59e960SJed Brown 
56684165533cSJose E. Roman    Input Parameters:
56698d59e960SJed Brown +  ts - time stepping context
56708d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
56718d59e960SJed Brown 
56728d59e960SJed Brown    Note:
56738d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
56748d59e960SJed Brown 
56758d59e960SJed Brown    Level: intermediate
56768d59e960SJed Brown 
56778d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
56788d59e960SJed Brown @*/
56798d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
56808d59e960SJed Brown {
56818d59e960SJed Brown   PetscFunctionBegin;
56828d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
56838d59e960SJed Brown   ts->cfltime_local = cfltime;
56848d59e960SJed Brown   ts->cfltime       = -1.;
56858d59e960SJed Brown   PetscFunctionReturn(0);
56868d59e960SJed Brown }
56878d59e960SJed Brown 
56888d59e960SJed Brown /*@
56898d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
56908d59e960SJed Brown 
56918d59e960SJed Brown    Collective on TS
56928d59e960SJed Brown 
56934165533cSJose E. Roman    Input Parameter:
56948d59e960SJed Brown .  ts - time stepping context
56958d59e960SJed Brown 
56964165533cSJose E. Roman    Output Parameter:
56978d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
56988d59e960SJed Brown 
56998d59e960SJed Brown    Level: advanced
57008d59e960SJed Brown 
57018d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
57028d59e960SJed Brown @*/
57038d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
57048d59e960SJed Brown {
57058d59e960SJed Brown   PetscFunctionBegin;
57068d59e960SJed Brown   if (ts->cfltime < 0) {
5707*5f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts)));
57088d59e960SJed Brown   }
57098d59e960SJed Brown   *cfltime = ts->cfltime;
57108d59e960SJed Brown   PetscFunctionReturn(0);
57118d59e960SJed Brown }
57128d59e960SJed Brown 
5713d6ebe24aSShri Abhyankar /*@
5714d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5715d6ebe24aSShri Abhyankar 
5716d6ebe24aSShri Abhyankar    Input Parameters:
5717a2b725a8SWilliam Gropp +  ts   - the TS context.
5718d6ebe24aSShri Abhyankar .  xl   - lower bound.
5719a2b725a8SWilliam Gropp -  xu   - upper bound.
5720d6ebe24aSShri Abhyankar 
5721d6ebe24aSShri Abhyankar    Notes:
5722d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
5723e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
5724d6ebe24aSShri Abhyankar 
57252bd2b0e6SSatish Balay    Level: advanced
57262bd2b0e6SSatish Balay 
5727d6ebe24aSShri Abhyankar @*/
5728d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5729d6ebe24aSShri Abhyankar {
5730d6ebe24aSShri Abhyankar   SNES           snes;
5731d6ebe24aSShri Abhyankar 
5732d6ebe24aSShri Abhyankar   PetscFunctionBegin;
5733*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts,&snes));
5734*5f80ce2aSJacob Faibussowitsch   CHKERRQ(SNESVISetVariableBounds(snes,xl,xu));
5735d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
5736d6ebe24aSShri Abhyankar }
5737d6ebe24aSShri Abhyankar 
5738f9c1d6abSBarry Smith /*@
5739f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
5740f9c1d6abSBarry Smith 
5741d083f849SBarry Smith    Collective on TS
5742f9c1d6abSBarry Smith 
5743f9c1d6abSBarry Smith    Input Parameters:
5744f9c1d6abSBarry Smith +  ts - the TS context
5745f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
5746f9c1d6abSBarry Smith 
5747f9c1d6abSBarry Smith    Output Parameters:
5748f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
5749f9c1d6abSBarry Smith 
5750f9c1d6abSBarry Smith    Level: developer
5751f9c1d6abSBarry Smith 
5752f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
5753f9c1d6abSBarry Smith @*/
5754f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
5755f9c1d6abSBarry Smith {
5756f9c1d6abSBarry Smith   PetscFunctionBegin;
5757f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
57583c633725SBarry Smith   PetscCheck(ts->ops->linearstability,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
5759*5f80ce2aSJacob Faibussowitsch   CHKERRQ((*ts->ops->linearstability)(ts,xr,xi,yr,yi));
5760f9c1d6abSBarry Smith   PetscFunctionReturn(0);
5761f9c1d6abSBarry Smith }
576224655328SShri 
576324655328SShri /*@
5764dcb233daSLisandro Dalcin    TSRestartStep - Flags the solver to restart the next step
5765dcb233daSLisandro Dalcin 
5766dcb233daSLisandro Dalcin    Collective on TS
5767dcb233daSLisandro Dalcin 
5768dcb233daSLisandro Dalcin    Input Parameter:
5769dcb233daSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
5770dcb233daSLisandro Dalcin 
5771dcb233daSLisandro Dalcin    Level: advanced
5772dcb233daSLisandro Dalcin 
5773dcb233daSLisandro Dalcin    Notes:
5774dcb233daSLisandro Dalcin    Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of
5775dcb233daSLisandro Dalcin    discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution
5776dcb233daSLisandro Dalcin    vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For
5777dcb233daSLisandro Dalcin    the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce
5778dcb233daSLisandro Dalcin    discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with
5779dcb233daSLisandro Dalcin    discontinuous source terms).
5780dcb233daSLisandro Dalcin 
5781dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep()
5782dcb233daSLisandro Dalcin @*/
5783dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts)
5784dcb233daSLisandro Dalcin {
5785dcb233daSLisandro Dalcin   PetscFunctionBegin;
5786dcb233daSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5787dcb233daSLisandro Dalcin   ts->steprestart = PETSC_TRUE;
5788dcb233daSLisandro Dalcin   PetscFunctionReturn(0);
5789dcb233daSLisandro Dalcin }
5790dcb233daSLisandro Dalcin 
5791dcb233daSLisandro Dalcin /*@
579224655328SShri    TSRollBack - Rolls back one time step
579324655328SShri 
579424655328SShri    Collective on TS
579524655328SShri 
579624655328SShri    Input Parameter:
579724655328SShri .  ts - the TS context obtained from TSCreate()
579824655328SShri 
579924655328SShri    Level: advanced
580024655328SShri 
580124655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
580224655328SShri @*/
580324655328SShri PetscErrorCode  TSRollBack(TS ts)
580424655328SShri {
580524655328SShri   PetscFunctionBegin;
580624655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
58073c633725SBarry Smith   PetscCheck(!ts->steprollback,PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
58083c633725SBarry Smith   PetscCheck(ts->ops->rollback,PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
5809*5f80ce2aSJacob Faibussowitsch   CHKERRQ((*ts->ops->rollback)(ts));
581024655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
581124655328SShri   ts->ptime = ts->ptime_prev;
5812be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
58132808aa04SLisandro Dalcin   ts->steps--;
5814b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
581524655328SShri   PetscFunctionReturn(0);
581624655328SShri }
5817aeb4809dSShri Abhyankar 
5818ff22ae23SHong Zhang /*@
5819ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
5820ff22ae23SHong Zhang 
5821ff22ae23SHong Zhang    Input Parameter:
5822ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
5823ff22ae23SHong Zhang 
58240429704eSStefano Zampini    Output Parameters:
58250429704eSStefano Zampini +  ns - the number of stages
58260429704eSStefano Zampini -  Y - the current stage vectors
58270429704eSStefano Zampini 
5828ff22ae23SHong Zhang    Level: advanced
5829ff22ae23SHong Zhang 
58300429704eSStefano Zampini    Notes: Both ns and Y can be NULL.
58310429704eSStefano Zampini 
5832ff22ae23SHong Zhang .seealso: TSCreate()
5833ff22ae23SHong Zhang @*/
5834ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
5835ff22ae23SHong Zhang {
5836ff22ae23SHong Zhang   PetscFunctionBegin;
5837ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
58380429704eSStefano Zampini   if (ns) PetscValidPointer(ns,2);
58390429704eSStefano Zampini   if (Y) PetscValidPointer(Y,3);
58400429704eSStefano Zampini   if (!ts->ops->getstages) {
58410429704eSStefano Zampini     if (ns) *ns = 0;
58420429704eSStefano Zampini     if (Y) *Y = NULL;
58430429704eSStefano Zampini   } else {
5844*5f80ce2aSJacob Faibussowitsch     CHKERRQ((*ts->ops->getstages)(ts,ns,Y));
5845ff22ae23SHong Zhang   }
5846ff22ae23SHong Zhang   PetscFunctionReturn(0);
5847ff22ae23SHong Zhang }
5848ff22ae23SHong Zhang 
5849847ff0e1SMatthew G. Knepley /*@C
5850847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
5851847ff0e1SMatthew G. Knepley 
5852847ff0e1SMatthew G. Knepley   Collective on SNES
5853847ff0e1SMatthew G. Knepley 
5854847ff0e1SMatthew G. Knepley   Input Parameters:
5855847ff0e1SMatthew G. Knepley + ts - the TS context
5856847ff0e1SMatthew G. Knepley . t - current timestep
5857847ff0e1SMatthew G. Knepley . U - state vector
5858847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
5859847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
5860847ff0e1SMatthew G. Knepley - ctx - an optional user context
5861847ff0e1SMatthew G. Knepley 
5862847ff0e1SMatthew G. Knepley   Output Parameters:
5863847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
5864847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
5865847ff0e1SMatthew G. Knepley 
5866847ff0e1SMatthew G. Knepley   Level: intermediate
5867847ff0e1SMatthew G. Knepley 
5868847ff0e1SMatthew G. Knepley   Notes:
5869847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
5870847ff0e1SMatthew G. Knepley 
5871847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
5872847ff0e1SMatthew G. Knepley 
5873847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
5874847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
5875847ff0e1SMatthew G. Knepley 
5876847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
5877847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
5878847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
5879847ff0e1SMatthew G. Knepley 
5880847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
5881847ff0e1SMatthew G. Knepley @*/
5882847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
5883847ff0e1SMatthew G. Knepley {
5884847ff0e1SMatthew G. Knepley   SNES           snes;
5885847ff0e1SMatthew G. Knepley   MatFDColoring  color;
5886847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
5887847ff0e1SMatthew G. Knepley 
5888847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
5889*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL));
5890*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color));
5891847ff0e1SMatthew G. Knepley   if (!color) {
5892847ff0e1SMatthew G. Knepley     DM         dm;
5893847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
5894847ff0e1SMatthew G. Knepley 
5895*5f80ce2aSJacob Faibussowitsch     CHKERRQ(TSGetDM(ts, &dm));
5896*5f80ce2aSJacob Faibussowitsch     CHKERRQ(DMHasColoring(dm, &hascolor));
5897847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
5898*5f80ce2aSJacob Faibussowitsch       CHKERRQ(DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring));
5899*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatFDColoringCreate(B, iscoloring, &color));
5900*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts));
5901*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatFDColoringSetFromOptions(color));
5902*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatFDColoringSetUp(B, iscoloring, color));
5903*5f80ce2aSJacob Faibussowitsch       CHKERRQ(ISColoringDestroy(&iscoloring));
5904847ff0e1SMatthew G. Knepley     } else {
5905847ff0e1SMatthew G. Knepley       MatColoring mc;
5906847ff0e1SMatthew G. Knepley 
5907*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatColoringCreate(B, &mc));
5908*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatColoringSetDistance(mc, 2));
5909*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatColoringSetType(mc, MATCOLORINGSL));
5910*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatColoringSetFromOptions(mc));
5911*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatColoringApply(mc, &iscoloring));
5912*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatColoringDestroy(&mc));
5913*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatFDColoringCreate(B, iscoloring, &color));
5914*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts));
5915*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatFDColoringSetFromOptions(color));
5916*5f80ce2aSJacob Faibussowitsch       CHKERRQ(MatFDColoringSetUp(B, iscoloring, color));
5917*5f80ce2aSJacob Faibussowitsch       CHKERRQ(ISColoringDestroy(&iscoloring));
5918847ff0e1SMatthew G. Knepley     }
5919*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color));
5920*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscObjectDereference((PetscObject) color));
5921847ff0e1SMatthew G. Knepley   }
5922*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(ts, &snes));
5923*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatFDColoringApply(B, color, U, snes));
5924847ff0e1SMatthew G. Knepley   if (J != B) {
5925*5f80ce2aSJacob Faibussowitsch     CHKERRQ(MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY));
5926*5f80ce2aSJacob Faibussowitsch     CHKERRQ(MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY));
5927847ff0e1SMatthew G. Knepley   }
5928847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
5929847ff0e1SMatthew G. Knepley }
593093b34091SDebojyoti Ghosh 
5931cb9d8021SPierre Barbier de Reuille /*@
59326bc98fa9SBarry Smith     TSSetFunctionDomainError - Set a function that tests if the current state vector is valid
5933cb9d8021SPierre Barbier de Reuille 
5934cb9d8021SPierre Barbier de Reuille     Input Parameters:
59356bc98fa9SBarry Smith +    ts - the TS context
59366bc98fa9SBarry Smith -    func - function called within TSFunctionDomainError
59376bc98fa9SBarry Smith 
59386bc98fa9SBarry Smith     Calling sequence of func:
59396bc98fa9SBarry Smith $     PetscErrorCode func(TS ts,PetscReal time,Vec state,PetscBool reject)
59406bc98fa9SBarry Smith 
59416bc98fa9SBarry Smith +   ts - the TS context
59426bc98fa9SBarry Smith .   time - the current time (of the stage)
59436bc98fa9SBarry Smith .   state - the state to check if it is valid
59446bc98fa9SBarry Smith -   reject - (output parameter) PETSC_FALSE if the state is acceptable, PETSC_TRUE if not acceptable
5945cb9d8021SPierre Barbier de Reuille 
5946cb9d8021SPierre Barbier de Reuille     Level: intermediate
5947cb9d8021SPierre Barbier de Reuille 
59486bc98fa9SBarry Smith     Notes:
59496bc98fa9SBarry Smith       If an implicit ODE solver is being used then, in addition to providing this routine, the
59506bc98fa9SBarry Smith       user's code should call SNESSetFunctionDomainError() when domain errors occur during
59516bc98fa9SBarry Smith       function evaluations where the functions are provided by TSSetIFunction() or TSSetRHSFunction().
59526bc98fa9SBarry Smith       Use TSGetSNES() to obtain the SNES object
59536bc98fa9SBarry Smith 
59546bc98fa9SBarry Smith     Developer Notes:
59556bc98fa9SBarry Smith       The naming of this function is inconsistent with the SNESSetFunctionDomainError()
59566bc98fa9SBarry Smith       since one takes a function pointer and the other does not.
59576bc98fa9SBarry Smith 
59586bc98fa9SBarry Smith .seealso: TSAdaptCheckStage(), TSFunctionDomainError(), SNESSetFunctionDomainError(), TSGetSNES()
5959cb9d8021SPierre Barbier de Reuille @*/
5960cb9d8021SPierre Barbier de Reuille 
5961d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
5962cb9d8021SPierre Barbier de Reuille {
5963cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
5964cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
5965cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
5966cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
5967cb9d8021SPierre Barbier de Reuille }
5968cb9d8021SPierre Barbier de Reuille 
5969cb9d8021SPierre Barbier de Reuille /*@
59706bc98fa9SBarry Smith     TSFunctionDomainError - Checks if the current state is valid
5971cb9d8021SPierre Barbier de Reuille 
5972cb9d8021SPierre Barbier de Reuille     Input Parameters:
59736bc98fa9SBarry Smith +    ts - the TS context
59746bc98fa9SBarry Smith .    stagetime - time of the simulation
59756bc98fa9SBarry Smith -    Y - state vector to check.
5976cb9d8021SPierre Barbier de Reuille 
5977cb9d8021SPierre Barbier de Reuille     Output Parameter:
59786bc98fa9SBarry Smith .    accept - Set to PETSC_FALSE if the current state vector is valid.
5979cb9d8021SPierre Barbier de Reuille 
5980cb9d8021SPierre Barbier de Reuille     Note:
59816bc98fa9SBarry Smith     This function is called by the TS integration routines and calls the user provided function (set with TSSetFunctionDomainError())
59826bc98fa9SBarry Smith     to check if the current state is valid.
598396a0c994SBarry Smith 
59846bc98fa9SBarry Smith     Level: developer
59856bc98fa9SBarry Smith 
59866bc98fa9SBarry Smith .seealso: TSSetFunctionDomainError()
5987cb9d8021SPierre Barbier de Reuille @*/
5988d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
5989cb9d8021SPierre Barbier de Reuille {
5990cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
5991cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5992cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
5993cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
5994a74df02fSJacob Faibussowitsch     PetscStackCallStandard((*ts->functiondomainerror),ts,stagetime,Y,accept);
5995cb9d8021SPierre Barbier de Reuille   }
5996cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
5997cb9d8021SPierre Barbier de Reuille }
59981ceb14c0SBarry Smith 
599993b34091SDebojyoti Ghosh /*@C
6000e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
600193b34091SDebojyoti Ghosh 
6002d083f849SBarry Smith   Collective
600393b34091SDebojyoti Ghosh 
600493b34091SDebojyoti Ghosh   Input Parameter:
600593b34091SDebojyoti Ghosh . tsin    - The input TS
600693b34091SDebojyoti Ghosh 
600793b34091SDebojyoti Ghosh   Output Parameter:
6008e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
600993b34091SDebojyoti Ghosh 
60105eca1a21SEmil Constantinescu   Notes:
60115eca1a21SEmil 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.
60125eca1a21SEmil Constantinescu 
6013928bb9adSStefano 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);
60145eca1a21SEmil Constantinescu 
60155eca1a21SEmil Constantinescu   Level: developer
601693b34091SDebojyoti Ghosh 
6017e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
601893b34091SDebojyoti Ghosh @*/
6019baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
602093b34091SDebojyoti Ghosh {
602193b34091SDebojyoti Ghosh   TS             t;
6022dc846ba4SSatish Balay   SNES           snes_start;
6023dc846ba4SSatish Balay   DM             dm;
6024dc846ba4SSatish Balay   TSType         type;
602593b34091SDebojyoti Ghosh 
602693b34091SDebojyoti Ghosh   PetscFunctionBegin;
602793b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
602893b34091SDebojyoti Ghosh   *tsout = NULL;
602993b34091SDebojyoti Ghosh 
6030*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView));
603193b34091SDebojyoti Ghosh 
603293b34091SDebojyoti Ghosh   /* General TS description */
603393b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
6034d0c080abSJoseph Pusztay   t->monitorFrequency  = 1;
603593b34091SDebojyoti Ghosh   t->setupcalled       = 0;
603693b34091SDebojyoti Ghosh   t->ksp_its           = 0;
603793b34091SDebojyoti Ghosh   t->snes_its          = 0;
603893b34091SDebojyoti Ghosh   t->nwork             = 0;
60397d51462cSStefano Zampini   t->rhsjacobian.time  = PETSC_MIN_REAL;
604093b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
604193b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
604293b34091SDebojyoti Ghosh 
6043*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetSNES(tsin,&snes_start));
6044*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetSNES(t,snes_start));
6045d15a3a53SEmil Constantinescu 
6046*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetDM(tsin,&dm));
6047*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetDM(t,dm));
604893b34091SDebojyoti Ghosh 
604993b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
6050*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectReference((PetscObject)t->adapt));
605193b34091SDebojyoti Ghosh 
6052e7069c78SShri   t->trajectory = tsin->trajectory;
6053*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectReference((PetscObject)t->trajectory));
6054e7069c78SShri 
6055e7069c78SShri   t->event = tsin->event;
60566b10a48eSSatish Balay   if (t->event) t->event->refct++;
6057e7069c78SShri 
605893b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
605993b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
6060e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
606193b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
606293b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
606393b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
606493b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
606593b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
606693b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
606793b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
606893b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
606993b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
607093b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
607193b34091SDebojyoti Ghosh 
6072*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetType(tsin,&type));
6073*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSSetType(t,type));
607493b34091SDebojyoti Ghosh 
607593b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
607693b34091SDebojyoti Ghosh 
607793b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
607893b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
607993b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
608093b34091SDebojyoti Ghosh 
6081*5f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps)));
608293b34091SDebojyoti Ghosh 
60830d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
60840d4fed19SBarry Smith     PetscInt i;
6085*5f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers));
60860d4fed19SBarry Smith     for (i=0; i<10; i++) {
60870d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
60880d4fed19SBarry Smith     }
60890d4fed19SBarry Smith   }
609093b34091SDebojyoti Ghosh   *tsout = t;
609193b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
609293b34091SDebojyoti Ghosh }
6093f3b1f45cSBarry Smith 
6094f3b1f45cSBarry Smith static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void* ctx,Vec x,Vec y)
6095f3b1f45cSBarry Smith {
6096f3b1f45cSBarry Smith   TS             ts = (TS) ctx;
6097f3b1f45cSBarry Smith 
6098f3b1f45cSBarry Smith   PetscFunctionBegin;
6099*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSComputeRHSFunction(ts,0,x,y));
6100f3b1f45cSBarry Smith   PetscFunctionReturn(0);
6101f3b1f45cSBarry Smith }
6102f3b1f45cSBarry Smith 
6103f3b1f45cSBarry Smith /*@
6104f3b1f45cSBarry Smith     TSRHSJacobianTest - Compares the multiply routine provided to the MATSHELL with differencing on the TS given RHS function.
6105f3b1f45cSBarry Smith 
6106d083f849SBarry Smith    Logically Collective on TS
6107f3b1f45cSBarry Smith 
6108f3b1f45cSBarry Smith     Input Parameters:
6109f3b1f45cSBarry Smith     TS - the time stepping routine
6110f3b1f45cSBarry Smith 
6111f3b1f45cSBarry Smith    Output Parameter:
6112f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
6113f3b1f45cSBarry Smith 
6114f3b1f45cSBarry Smith    Options Database:
6115f3b1f45cSBarry Smith  .   -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator
6116f3b1f45cSBarry Smith 
6117f3b1f45cSBarry Smith    Level: advanced
6118f3b1f45cSBarry Smith 
611995452b02SPatrick Sanan    Notes:
612095452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
6121f3b1f45cSBarry Smith 
6122f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTestTranspose()
6123f3b1f45cSBarry Smith @*/
6124f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTest(TS ts,PetscBool *flg)
6125f3b1f45cSBarry Smith {
6126f3b1f45cSBarry Smith   Mat            J,B;
6127f3b1f45cSBarry Smith   TSRHSJacobian  func;
6128f3b1f45cSBarry Smith   void*          ctx;
6129f3b1f45cSBarry Smith 
6130f3b1f45cSBarry Smith   PetscFunctionBegin;
6131*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetRHSJacobian(ts,&J,&B,&func,&ctx));
6132*5f80ce2aSJacob Faibussowitsch   CHKERRQ((*func)(ts,0.0,ts->vec_sol,J,B,ctx));
6133*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatShellTestMult(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg));
6134f3b1f45cSBarry Smith   PetscFunctionReturn(0);
6135f3b1f45cSBarry Smith }
6136f3b1f45cSBarry Smith 
6137f3b1f45cSBarry Smith /*@C
6138f3b1f45cSBarry Smith     TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the MATSHELL with differencing on the TS given RHS function.
6139f3b1f45cSBarry Smith 
6140d083f849SBarry Smith    Logically Collective on TS
6141f3b1f45cSBarry Smith 
6142f3b1f45cSBarry Smith     Input Parameters:
6143f3b1f45cSBarry Smith     TS - the time stepping routine
6144f3b1f45cSBarry Smith 
6145f3b1f45cSBarry Smith    Output Parameter:
6146f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
6147f3b1f45cSBarry Smith 
6148f3b1f45cSBarry Smith    Options Database:
6149f3b1f45cSBarry Smith .   -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator
6150f3b1f45cSBarry Smith 
615195452b02SPatrick Sanan    Notes:
615295452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
6153f3b1f45cSBarry Smith 
6154f3b1f45cSBarry Smith    Level: advanced
6155f3b1f45cSBarry Smith 
6156f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTest()
6157f3b1f45cSBarry Smith @*/
6158f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTestTranspose(TS ts,PetscBool *flg)
6159f3b1f45cSBarry Smith {
6160f3b1f45cSBarry Smith   Mat            J,B;
6161f3b1f45cSBarry Smith   void           *ctx;
6162f3b1f45cSBarry Smith   TSRHSJacobian  func;
6163f3b1f45cSBarry Smith 
6164f3b1f45cSBarry Smith   PetscFunctionBegin;
6165*5f80ce2aSJacob Faibussowitsch   CHKERRQ(TSGetRHSJacobian(ts,&J,&B,&func,&ctx));
6166*5f80ce2aSJacob Faibussowitsch   CHKERRQ((*func)(ts,0.0,ts->vec_sol,J,B,ctx));
6167*5f80ce2aSJacob Faibussowitsch   CHKERRQ(MatShellTestMultTranspose(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg));
6168f3b1f45cSBarry Smith   PetscFunctionReturn(0);
6169f3b1f45cSBarry Smith }
61700fe4d17eSHong Zhang 
61710fe4d17eSHong Zhang /*@
61720fe4d17eSHong Zhang   TSSetUseSplitRHSFunction - Use the split RHSFunction when a multirate method is used.
61730fe4d17eSHong Zhang 
61740fe4d17eSHong Zhang   Logically collective
61750fe4d17eSHong Zhang 
6176d8d19677SJose E. Roman   Input Parameters:
61770fe4d17eSHong Zhang +  ts - timestepping context
61780fe4d17eSHong Zhang -  use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used
61790fe4d17eSHong Zhang 
61800fe4d17eSHong Zhang   Options Database:
61810fe4d17eSHong Zhang .   -ts_use_splitrhsfunction - <true,false>
61820fe4d17eSHong Zhang 
61830fe4d17eSHong Zhang   Notes:
61840fe4d17eSHong Zhang     This is only useful for multirate methods
61850fe4d17eSHong Zhang 
61860fe4d17eSHong Zhang   Level: intermediate
61870fe4d17eSHong Zhang 
61880fe4d17eSHong Zhang .seealso: TSGetUseSplitRHSFunction()
61890fe4d17eSHong Zhang @*/
61900fe4d17eSHong Zhang PetscErrorCode TSSetUseSplitRHSFunction(TS ts, PetscBool use_splitrhsfunction)
61910fe4d17eSHong Zhang {
61920fe4d17eSHong Zhang   PetscFunctionBegin;
61930fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
61940fe4d17eSHong Zhang   ts->use_splitrhsfunction = use_splitrhsfunction;
61950fe4d17eSHong Zhang   PetscFunctionReturn(0);
61960fe4d17eSHong Zhang }
61970fe4d17eSHong Zhang 
61980fe4d17eSHong Zhang /*@
61990fe4d17eSHong Zhang   TSGetUseSplitRHSFunction - Gets whether to use the split RHSFunction when a multirate method is used.
62000fe4d17eSHong Zhang 
62010fe4d17eSHong Zhang   Not collective
62020fe4d17eSHong Zhang 
62030fe4d17eSHong Zhang   Input Parameter:
62040fe4d17eSHong Zhang .  ts - timestepping context
62050fe4d17eSHong Zhang 
62060fe4d17eSHong Zhang   Output Parameter:
62070fe4d17eSHong Zhang .  use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used
62080fe4d17eSHong Zhang 
62090fe4d17eSHong Zhang   Level: intermediate
62100fe4d17eSHong Zhang 
62110fe4d17eSHong Zhang .seealso: TSSetUseSplitRHSFunction()
62120fe4d17eSHong Zhang @*/
62130fe4d17eSHong Zhang PetscErrorCode TSGetUseSplitRHSFunction(TS ts, PetscBool *use_splitrhsfunction)
62140fe4d17eSHong Zhang {
62150fe4d17eSHong Zhang   PetscFunctionBegin;
62160fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
62170fe4d17eSHong Zhang   *use_splitrhsfunction = ts->use_splitrhsfunction;
62180fe4d17eSHong Zhang   PetscFunctionReturn(0);
62190fe4d17eSHong Zhang }
6220d60b7d5cSBarry Smith 
6221d60b7d5cSBarry Smith /*@
6222d60b7d5cSBarry Smith     TSSetMatStructure - sets the relationship between the nonzero structure of the RHS Jacobian matrix to the IJacobian matrix.
6223d60b7d5cSBarry Smith 
6224d60b7d5cSBarry Smith    Logically  Collective on ts
6225d60b7d5cSBarry Smith 
6226d60b7d5cSBarry Smith    Input Parameters:
6227d60b7d5cSBarry Smith +  ts - the time-stepper
6228d60b7d5cSBarry Smith -  str - the structure (the default is UNKNOWN_NONZERO_PATTERN)
6229d60b7d5cSBarry Smith 
6230d60b7d5cSBarry Smith    Level: intermediate
6231d60b7d5cSBarry Smith 
6232d60b7d5cSBarry Smith    Notes:
6233d60b7d5cSBarry Smith      When the relationship between the nonzero structures is known and supplied the solution process can be much faster
6234d60b7d5cSBarry Smith 
6235d60b7d5cSBarry Smith .seealso: MatAXPY(), MatStructure
6236d60b7d5cSBarry Smith  @*/
6237d60b7d5cSBarry Smith PetscErrorCode TSSetMatStructure(TS ts,MatStructure str)
6238d60b7d5cSBarry Smith {
6239d60b7d5cSBarry Smith   PetscFunctionBegin;
6240d60b7d5cSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6241d60b7d5cSBarry Smith   ts->axpy_pattern = str;
6242d60b7d5cSBarry Smith   PetscFunctionReturn(0);
6243d60b7d5cSBarry Smith }
6244