xref: /petsc/src/ts/interface/ts.c (revision 589a23caa660d2a5f330cc8d1ed213e9cfaf51a7)
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 
161c167fc2SEmil Constantinescu 
17fde5950dSBarry Smith /*@C
18fde5950dSBarry Smith    TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
19fde5950dSBarry Smith 
20fde5950dSBarry Smith    Collective on TS
21fde5950dSBarry Smith 
22fde5950dSBarry Smith    Input Parameters:
23fde5950dSBarry Smith +  ts - TS object you wish to monitor
24fde5950dSBarry Smith .  name - the monitor type one is seeking
25fde5950dSBarry Smith .  help - message indicating what monitoring is done
26fde5950dSBarry Smith .  manual - manual page for the monitor
27fde5950dSBarry Smith .  monitor - the monitor function
28fde5950dSBarry Smith -  monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects
29fde5950dSBarry Smith 
30fde5950dSBarry Smith    Level: developer
31fde5950dSBarry Smith 
32fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
33fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
34fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
35fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
36fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
37fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
38fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
39fde5950dSBarry Smith @*/
40721cd6eeSBarry Smith PetscErrorCode  TSMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*))
41fde5950dSBarry Smith {
42fde5950dSBarry Smith   PetscErrorCode    ierr;
43fde5950dSBarry Smith   PetscViewer       viewer;
44fde5950dSBarry Smith   PetscViewerFormat format;
45fde5950dSBarry Smith   PetscBool         flg;
46fde5950dSBarry Smith 
47fde5950dSBarry Smith   PetscFunctionBegin;
4816413a6aSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject) ts)->options,((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
49fde5950dSBarry Smith   if (flg) {
50721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
51721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
52721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
53fde5950dSBarry Smith     if (monitorsetup) {
54721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
55fde5950dSBarry Smith     }
56721cd6eeSBarry Smith     ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr);
57fde5950dSBarry Smith   }
58fde5950dSBarry Smith   PetscFunctionReturn(0);
59fde5950dSBarry Smith }
60fde5950dSBarry Smith 
612ffb9264SLisandro Dalcin static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt,TSAdaptType default_type)
622ffb9264SLisandro Dalcin {
632ffb9264SLisandro Dalcin   PetscErrorCode ierr;
642ffb9264SLisandro Dalcin 
652ffb9264SLisandro Dalcin   PetscFunctionBegin;
66b92453a8SLisandro Dalcin   PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1);
67b92453a8SLisandro Dalcin   PetscValidCharPointer(default_type,2);
682ffb9264SLisandro Dalcin   if (!((PetscObject)adapt)->type_name) {
692ffb9264SLisandro Dalcin     ierr = TSAdaptSetType(adapt,default_type);CHKERRQ(ierr);
702ffb9264SLisandro Dalcin   }
712ffb9264SLisandro Dalcin   PetscFunctionReturn(0);
722ffb9264SLisandro Dalcin }
732ffb9264SLisandro Dalcin 
74bdad233fSMatthew Knepley /*@
75bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
76bdad233fSMatthew Knepley 
77bdad233fSMatthew Knepley    Collective on TS
78bdad233fSMatthew Knepley 
79bdad233fSMatthew Knepley    Input Parameter:
80bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
81bdad233fSMatthew Knepley 
82bdad233fSMatthew Knepley    Options Database Keys:
83e49d4f37SHong Zhang +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE, TSBSYMP
84ef222394SBarry Smith .  -ts_save_trajectory - checkpoint the solution at each time-step
85ef85077eSLisandro Dalcin .  -ts_max_time <time> - maximum time to compute to
86ef85077eSLisandro Dalcin .  -ts_max_steps <steps> - maximum number of time-steps to take
87ef85077eSLisandro Dalcin .  -ts_init_time <time> - initial time to start computation
884dc72f7fSBarry Smith .  -ts_final_time <time> - final time to compute to (deprecated: use -ts_max_time)
893e4cdcaaSBarry Smith .  -ts_dt <dt> - initial time step
906c51df0eSBarry Smith .  -ts_exact_final_time <stepover,interpolate,matchstep> - whether to stop at the exact given final time and how to compute the solution at that ti,e
91a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
92a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
93a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
94a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
95a3cdaa26SBarry Smith .  -ts_atol <atol> Absolute tolerance for local truncation error
96f3b1f45cSBarry Smith .  -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - test the Jacobian at each iteration against finite difference with RHS function
97f3b1f45cSBarry 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
98ef222394SBarry Smith .  -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
99847ff0e1SMatthew G. Knepley .  -ts_fd_color - Use finite differences with coloring to compute IJacobian
100bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
101de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
102de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
1037cf37e64SBarry Smith .  -ts_monitor_error - Monitors norm of error
1046934998bSLisandro Dalcin .  -ts_monitor_lg_timestep - Monitor timestep size graphically
1058b668821SLisandro Dalcin .  -ts_monitor_lg_timestep_log - Monitor log timestep size graphically
106de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
107de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
108de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
109de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
1103e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
1113e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
112fde5950dSBarry Smith .  -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep
113e4160dc7SJulian Andrej .  -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu)
1149e336e28SPatrick Sanan -  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
11553ea634cSHong Zhang 
1169e336e28SPatrick Sanan    Developer Note:
1179e336e28SPatrick Sanan    We should unify all the -ts_monitor options in the way that -xxx_view has been unified
118bdad233fSMatthew Knepley 
119bdad233fSMatthew Knepley    Level: beginner
120bdad233fSMatthew Knepley 
121a313700dSBarry Smith .seealso: TSGetType()
122bdad233fSMatthew Knepley @*/
1237087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
124bdad233fSMatthew Knepley {
125bc952696SBarry Smith   PetscBool              opt,flg,tflg;
126dfbe8321SBarry Smith   PetscErrorCode         ierr;
127eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
12831748224SBarry Smith   PetscReal              time_step;
12949354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
130d1212d36SBarry Smith   char                   dir[16];
131cd11d68dSLisandro Dalcin   TSIFunction            ifun;
1326991f827SBarry Smith   const char             *defaultType;
1336991f827SBarry Smith   char                   typeName[256];
134bdad233fSMatthew Knepley 
135bdad233fSMatthew Knepley   PetscFunctionBegin;
1360700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1376991f827SBarry Smith 
1386991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
139cd11d68dSLisandro Dalcin   ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
140cd11d68dSLisandro Dalcin 
141cd11d68dSLisandro Dalcin   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
1421ef27442SStefano Zampini   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
1431ef27442SStefano Zampini   else defaultType = ifun ? TSBEULER : TSEULER;
1446991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr);
1456991f827SBarry Smith   if (opt) {
1466991f827SBarry Smith     ierr = TSSetType(ts,typeName);CHKERRQ(ierr);
1476991f827SBarry Smith   } else {
1486991f827SBarry Smith     ierr = TSSetType(ts,defaultType);CHKERRQ(ierr);
1496991f827SBarry Smith   }
150bdad233fSMatthew Knepley 
151bdad233fSMatthew Knepley   /* Handle generic TS options */
1524dc72f7fSBarry Smith   ierr = PetscOptionsDeprecated("-ts_final_time","-ts_max_time","3.10",NULL);CHKERRQ(ierr);
153ef85077eSLisandro Dalcin   ierr = PetscOptionsReal("-ts_max_time","Maximum time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
15419eac22cSLisandro Dalcin   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetMaxSteps",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1550298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
15631748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
157cd11d68dSLisandro Dalcin   if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);}
15849354f04SShri Abhyankar   ierr = PetscOptionsEnum("-ts_exact_final_time","Option for handling of final time step","TSSetExactFinalTime",TSExactFinalTimeOptions,(PetscEnum)ts->exact_final_time,(PetscEnum*)&eftopt,&flg);CHKERRQ(ierr);
15949354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
1600298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL);CHKERRQ(ierr);
1610298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
1620298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
1630298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
1640298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
165bdad233fSMatthew Knepley 
166f3b1f45cSBarry Smith   ierr = PetscOptionsBool("-ts_rhs_jacobian_test_mult","Test the RHS Jacobian for consistency with RHS at each solve ","None",ts->testjacobian,&ts->testjacobian,NULL);CHKERRQ(ierr);
167f3b1f45cSBarry Smith   ierr = PetscOptionsBool("-ts_rhs_jacobian_test_mult_transpose","Test the RHS Jacobian transpose for consistency with RHS at each solve ","None",ts->testjacobiantranspose,&ts->testjacobiantranspose,NULL);CHKERRQ(ierr);
1680fe4d17eSHong Zhang   ierr = PetscOptionsBool("-ts_use_splitrhsfunction","Use the split RHS function for multirate solvers ","TSSetUseSplitRHSFunction",ts->use_splitrhsfunction,&ts->use_splitrhsfunction,NULL);CHKERRQ(ierr);
16956f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
17056f85f32SBarry Smith   {
17156f85f32SBarry Smith     PetscBool set;
17256f85f32SBarry Smith     flg  = PETSC_FALSE;
17356f85f32SBarry Smith     ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
17456f85f32SBarry Smith     if (set) {
17556f85f32SBarry Smith       ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
17656f85f32SBarry Smith     }
17756f85f32SBarry Smith   }
17856f85f32SBarry Smith #endif
17956f85f32SBarry Smith 
180bdad233fSMatthew Knepley   /* Monitor options */
181cd11d68dSLisandro Dalcin   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr);
182cc9c3a59SBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_extreme","Monitor extreme values of the solution","TSMonitorExtreme",TSMonitorExtreme,NULL);CHKERRQ(ierr);
183fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr);
184fde5950dSBarry Smith 
185*589a23caSBarry Smith   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",NULL,monfilename,sizeof(monfilename),&flg);CHKERRQ(ierr);
1865180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1875180491cSLisandro Dalcin 
1884f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
189b3603a34SBarry Smith   if (opt) {
1900b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1913923b477SBarry Smith     PetscInt       howoften = 1;
192b3603a34SBarry Smith 
1930298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
194c793f718SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
1954f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
196bdad233fSMatthew Knepley   }
1976ba87a44SLisandro Dalcin 
1984f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
199ef20d060SBarry Smith   if (opt) {
2000b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2013923b477SBarry Smith     PetscInt       howoften = 1;
202ef20d060SBarry Smith 
2030298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
204c793f718SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2054f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
206ef20d060SBarry Smith   }
207edbaebb3SBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_error","View the error at each timestep","TSMonitorError",TSMonitorError,NULL);CHKERRQ(ierr);
2087cf37e64SBarry Smith 
2096934998bSLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2106934998bSLisandro Dalcin   if (opt) {
2116934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
2126934998bSLisandro Dalcin     PetscInt       howoften = 1;
2136934998bSLisandro Dalcin 
2146934998bSLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2156ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2166934998bSLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2176934998bSLisandro Dalcin   }
2188b668821SLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2198b668821SLisandro Dalcin   if (opt) {
2208b668821SLisandro Dalcin     TSMonitorLGCtx ctx;
2218b668821SLisandro Dalcin     PetscInt       howoften = 1;
2228b668821SLisandro Dalcin 
2238b668821SLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2248b668821SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2258b668821SLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2268b668821SLisandro Dalcin     ctx->semilogy = PETSC_TRUE;
2278b668821SLisandro Dalcin   }
2288b668821SLisandro Dalcin 
229201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
230201da799SBarry Smith   if (opt) {
231201da799SBarry Smith     TSMonitorLGCtx ctx;
232201da799SBarry Smith     PetscInt       howoften = 1;
233201da799SBarry Smith 
2340298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2356ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
236201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
237201da799SBarry Smith   }
238201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
239201da799SBarry Smith   if (opt) {
240201da799SBarry Smith     TSMonitorLGCtx ctx;
241201da799SBarry Smith     PetscInt       howoften = 1;
242201da799SBarry Smith 
2430298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2446ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
245201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
246201da799SBarry Smith   }
2478189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
2488189c53fSBarry Smith   if (opt) {
2498189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2508189c53fSBarry Smith     PetscInt          howoften = 1;
2518189c53fSBarry Smith 
2520298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
253c793f718SLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2548189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
2558189c53fSBarry Smith   }
2560ec8ee2bSJoseph Pusztay   ierr = PetscOptionsName("-ts_monitor_sp_swarm","Display particle phase from the DMSwarm","TSMonitorSPSwarm",&opt);CHKERRQ(ierr);
2571b575b74SJoseph Pusztay   if (opt) {
2581b575b74SJoseph Pusztay     TSMonitorSPCtx  ctx;
2591b575b74SJoseph Pusztay     PetscInt        howoften = 1;
2600ec8ee2bSJoseph Pusztay     ierr = PetscOptionsInt("-ts_monitor_sp_swarm","Display particles phase from the DMSwarm","TSMonitorSPSwarm",howoften,&howoften,NULL);CHKERRQ(ierr);
2611b575b74SJoseph Pusztay     ierr = TSMonitorSPCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx);CHKERRQ(ierr);
2620ec8ee2bSJoseph Pusztay     ierr = TSMonitorSet(ts, TSMonitorSPSwarmSolution, ctx, (PetscErrorCode (*)(void**))TSMonitorSPCtxDestroy);CHKERRQ(ierr);
2631b575b74SJoseph Pusztay   }
264ef20d060SBarry Smith   opt  = PETSC_FALSE;
2650dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
266a7cc72afSBarry Smith   if (opt) {
26783a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
26883a4ac43SBarry Smith     PetscInt         howoften = 1;
269a80ad3e0SBarry Smith 
2700298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
271c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
27283a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
273bdad233fSMatthew Knepley   }
274fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2752d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
2762d5ee99bSBarry Smith   if (opt) {
2772d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2782d5ee99bSBarry Smith     PetscReal        bounds[4];
2792d5ee99bSBarry Smith     PetscInt         n = 4;
2802d5ee99bSBarry Smith     PetscDraw        draw;
2816934998bSLisandro Dalcin     PetscDrawAxis    axis;
2822d5ee99bSBarry Smith 
2832d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
2842d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
285c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr);
2862d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
2876934998bSLisandro Dalcin     ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr);
2886934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
2896934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
2902d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2912d5ee99bSBarry Smith   }
2922d5ee99bSBarry Smith   opt  = PETSC_FALSE;
2930dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
2943a471f94SBarry Smith   if (opt) {
29583a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
29683a4ac43SBarry Smith     PetscInt         howoften = 1;
2973a471f94SBarry Smith 
2980298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
299c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
30083a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3013a471f94SBarry Smith   }
3020ed3bfb6SBarry Smith   opt  = PETSC_FALSE;
3030ed3bfb6SBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt);CHKERRQ(ierr);
3040ed3bfb6SBarry Smith   if (opt) {
3050ed3bfb6SBarry Smith     TSMonitorDrawCtx ctx;
3060ed3bfb6SBarry Smith     PetscInt         howoften = 1;
3070ed3bfb6SBarry Smith 
3080ed3bfb6SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL);CHKERRQ(ierr);
309c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3100ed3bfb6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3110ed3bfb6SBarry Smith   }
312fde5950dSBarry Smith 
313ed81e22dSJed Brown   opt  = PETSC_FALSE;
314*589a23caSBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",NULL,monfilename,sizeof(monfilename),&flg);CHKERRQ(ierr);
315ed81e22dSJed Brown   if (flg) {
316ed81e22dSJed Brown     const char *ptr,*ptr2;
317ed81e22dSJed Brown     char       *filetemplate;
318ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
319ed81e22dSJed Brown     /* Do some cursory validation of the input. */
320ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
321ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
322ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
323ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
324ce94432eSBarry Smith       if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03D.vts");
325ed81e22dSJed Brown       if (ptr2) break;
326ed81e22dSJed Brown     }
327ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
328ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
329ed81e22dSJed Brown   }
330bdad233fSMatthew Knepley 
331*589a23caSBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,sizeof(dir),&flg);CHKERRQ(ierr);
332d1212d36SBarry Smith   if (flg) {
333d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
334d1212d36SBarry Smith     int                  ray = 0;
3353ee9839eSMatthew G. Knepley     DMDirection          ddir;
336d1212d36SBarry Smith     DM                   da;
337d1212d36SBarry Smith     PetscMPIInt          rank;
338d1212d36SBarry Smith 
339ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
3403ee9839eSMatthew G. Knepley     if (dir[0] == 'x') ddir = DM_X;
3413ee9839eSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DM_Y;
342ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
343d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
344d1212d36SBarry Smith 
3455bd1e576SStefano Zampini     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %d\n",dir[0],ray);CHKERRQ(ierr);
346b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
347d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
348d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
349ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
350d1212d36SBarry Smith     if (!rank) {
351c793f718SLisandro Dalcin       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,NULL,NULL,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
352d1212d36SBarry Smith     }
35351b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
354d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
355d1212d36SBarry Smith   }
356*589a23caSBarry Smith   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,sizeof(dir),&flg);CHKERRQ(ierr);
35751b4a12fSMatthew G. Knepley   if (flg) {
35851b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
35951b4a12fSMatthew G. Knepley     int                 ray = 0;
3603ee9839eSMatthew G. Knepley     DMDirection         ddir;
36151b4a12fSMatthew G. Knepley     DM                  da;
36251b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
363d1212d36SBarry Smith 
36451b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
3653ee9839eSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DM_X;
3663ee9839eSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DM_Y;
36751b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
36851b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3691c3436cfSJed Brown 
3705bd1e576SStefano Zampini     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %d\n", dir[0], ray);CHKERRQ(ierr);
371b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
37251b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
37351b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
374c793f718SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
37551b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
37651b4a12fSMatthew G. Knepley   }
377a7a1495cSBarry Smith 
378b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
379b3d3934dSBarry Smith   if (opt) {
380b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
381b3d3934dSBarry Smith 
382b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
383b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
384b3d3934dSBarry Smith   }
385b3d3934dSBarry Smith 
386847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
387847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
388847ff0e1SMatthew G. Knepley   if (flg) {
389847ff0e1SMatthew G. Knepley     DM   dm;
390847ff0e1SMatthew G. Knepley     DMTS tdm;
391847ff0e1SMatthew G. Knepley 
392847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
393847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
394847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
395c793f718SLisandro Dalcin     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, NULL);CHKERRQ(ierr);
396847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
397847ff0e1SMatthew G. Knepley   }
398847ff0e1SMatthew G. Knepley 
399d763cef2SBarry Smith   /* Handle specific TS options */
400d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
4016991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
402d763cef2SBarry Smith   }
403fbc52257SHong Zhang 
404a7bdc993SLisandro Dalcin   /* Handle TSAdapt options */
405a7bdc993SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
406a7bdc993SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
407a7bdc993SLisandro Dalcin   ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr);
408a7bdc993SLisandro Dalcin 
40968bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
4104f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
41168bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
41268bece0bSHong Zhang   if (tflg) {
41368bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
41468bece0bSHong Zhang   }
415a05bf03eSHong Zhang 
416a05bf03eSHong Zhang   ierr = TSAdjointSetFromOptions(PetscOptionsObject,ts);CHKERRQ(ierr);
417d763cef2SBarry Smith 
418d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
4190633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
420fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
421d763cef2SBarry Smith 
4224f122a70SLisandro Dalcin   if (ts->trajectory) {
4234f122a70SLisandro Dalcin     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
424d763cef2SBarry Smith   }
42568bece0bSHong Zhang 
4261ef27442SStefano Zampini   /* why do we have to do this here and not during TSSetUp? */
4274f122a70SLisandro Dalcin   ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr);
4281ef27442SStefano Zampini   if (ts->problem_type == TS_LINEAR) {
4291ef27442SStefano Zampini     ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&flg,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr);
4301ef27442SStefano Zampini     if (!flg) { ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); }
4311ef27442SStefano Zampini   }
4324f122a70SLisandro Dalcin   ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
433d763cef2SBarry Smith   PetscFunctionReturn(0);
434d763cef2SBarry Smith }
435d763cef2SBarry Smith 
436d2daff3dSHong Zhang /*@
43778fbdcc8SBarry Smith    TSGetTrajectory - Gets the trajectory from a TS if it exists
43878fbdcc8SBarry Smith 
43978fbdcc8SBarry Smith    Collective on TS
44078fbdcc8SBarry Smith 
44178fbdcc8SBarry Smith    Input Parameters:
44278fbdcc8SBarry Smith .  ts - the TS context obtained from TSCreate()
44378fbdcc8SBarry Smith 
4447a7aea1fSJed Brown    Output Parameters:
44578fbdcc8SBarry Smith .  tr - the TSTrajectory object, if it exists
44678fbdcc8SBarry Smith 
44778fbdcc8SBarry Smith    Note: This routine should be called after all TS options have been set
44878fbdcc8SBarry Smith 
44978fbdcc8SBarry Smith    Level: advanced
45078fbdcc8SBarry Smith 
45178fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate()
45278fbdcc8SBarry Smith 
45378fbdcc8SBarry Smith @*/
45478fbdcc8SBarry Smith PetscErrorCode  TSGetTrajectory(TS ts,TSTrajectory *tr)
45578fbdcc8SBarry Smith {
45678fbdcc8SBarry Smith   PetscFunctionBegin;
45778fbdcc8SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45878fbdcc8SBarry Smith   *tr = ts->trajectory;
45978fbdcc8SBarry Smith   PetscFunctionReturn(0);
46078fbdcc8SBarry Smith }
46178fbdcc8SBarry Smith 
46278fbdcc8SBarry Smith /*@
463bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
464d2daff3dSHong Zhang 
465d2daff3dSHong Zhang    Collective on TS
466d2daff3dSHong Zhang 
467d2daff3dSHong Zhang    Input Parameters:
468bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
469bc952696SBarry Smith 
47078fbdcc8SBarry Smith    Options Database:
47178fbdcc8SBarry Smith +  -ts_save_trajectory - saves the trajectory to a file
47278fbdcc8SBarry Smith -  -ts_trajectory_type type
47378fbdcc8SBarry Smith 
47468bece0bSHong Zhang Note: This routine should be called after all TS options have been set
475d2daff3dSHong Zhang 
476c3a89c15SBarry Smith     The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/lib/petsc/bin/PetscBinaryIOTrajectory.py and
47778fbdcc8SBarry Smith    MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m
47878fbdcc8SBarry Smith 
479d2daff3dSHong Zhang    Level: intermediate
480d2daff3dSHong Zhang 
4812d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve()
482d2daff3dSHong Zhang 
483d2daff3dSHong Zhang @*/
484bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
485d2daff3dSHong Zhang {
486bc952696SBarry Smith   PetscErrorCode ierr;
487bc952696SBarry Smith 
488d2daff3dSHong Zhang   PetscFunctionBegin;
489d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
490bc952696SBarry Smith   if (!ts->trajectory) {
491bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
492bc952696SBarry Smith   }
493d2daff3dSHong Zhang   PetscFunctionReturn(0);
494d2daff3dSHong Zhang }
495d2daff3dSHong Zhang 
496a7a1495cSBarry Smith /*@
4972d29f1f2SStefano Zampini    TSResetTrajectory - Destroys and recreates the internal TSTrajectory object
4982d29f1f2SStefano Zampini 
4992d29f1f2SStefano Zampini    Collective on TS
5002d29f1f2SStefano Zampini 
5012d29f1f2SStefano Zampini    Input Parameters:
5022d29f1f2SStefano Zampini .  ts - the TS context obtained from TSCreate()
5032d29f1f2SStefano Zampini 
5042d29f1f2SStefano Zampini    Level: intermediate
5052d29f1f2SStefano Zampini 
5062d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve()
5072d29f1f2SStefano Zampini 
5082d29f1f2SStefano Zampini @*/
5092d29f1f2SStefano Zampini PetscErrorCode  TSResetTrajectory(TS ts)
5102d29f1f2SStefano Zampini {
5112d29f1f2SStefano Zampini   PetscErrorCode ierr;
5122d29f1f2SStefano Zampini 
5132d29f1f2SStefano Zampini   PetscFunctionBegin;
5142d29f1f2SStefano Zampini   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5152d29f1f2SStefano Zampini   if (ts->trajectory) {
5162d29f1f2SStefano Zampini     ierr = TSTrajectoryDestroy(&ts->trajectory);CHKERRQ(ierr);
5172d29f1f2SStefano Zampini     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
5182d29f1f2SStefano Zampini   }
5192d29f1f2SStefano Zampini   PetscFunctionReturn(0);
5202d29f1f2SStefano Zampini }
5212d29f1f2SStefano Zampini 
5222d29f1f2SStefano Zampini /*@
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
535a7a1495cSBarry Smith .  B - optional preconditioning matrix
536a7a1495cSBarry Smith -  flag - flag indicating matrix structure
537a7a1495cSBarry Smith 
538a7a1495cSBarry Smith    Notes:
539a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
540a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
541a7a1495cSBarry Smith 
54294b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
543a7a1495cSBarry Smith    flag parameter.
544a7a1495cSBarry Smith 
545a7a1495cSBarry Smith    Level: developer
546a7a1495cSBarry Smith 
54794b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
548a7a1495cSBarry Smith @*/
549d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
550a7a1495cSBarry Smith {
551dfbe8321SBarry Smith   PetscErrorCode   ierr;
552270bf2e7SJed Brown   PetscObjectState Ustate;
5536c1e1eecSBarry Smith   PetscObjectId    Uid;
55424989b8cSPeter Brune   DM               dm;
555942e3340SBarry Smith   DMTS             tsdm;
55624989b8cSPeter Brune   TSRHSJacobian    rhsjacobianfunc;
55724989b8cSPeter Brune   void             *ctx;
55824989b8cSPeter Brune   TSIJacobian      ijacobianfunc;
559b2df71adSDebojyoti Ghosh   TSRHSFunction    rhsfunction;
560a7a1495cSBarry Smith 
561a7a1495cSBarry Smith   PetscFunctionBegin;
5620700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5630910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5640910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
56524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
566942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
56724989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
5680298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
569b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
57059e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
5716c1e1eecSBarry Smith   ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr);
572971015bcSStefano Zampini 
5736c1e1eecSBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
574971015bcSStefano Zampini     /* restore back RHS Jacobian matrices if they have been shifted/scaled */
575971015bcSStefano Zampini     if (A == ts->Arhs) {
576971015bcSStefano Zampini       if (ts->rhsjacobian.shift != 0) {
577971015bcSStefano Zampini         ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
578971015bcSStefano Zampini       }
579971015bcSStefano Zampini       if (ts->rhsjacobian.scale != 1.) {
580971015bcSStefano Zampini         ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
581971015bcSStefano Zampini       }
582971015bcSStefano Zampini     }
583971015bcSStefano Zampini     if (B && B == ts->Brhs && A != B) {
584971015bcSStefano Zampini       if (ts->rhsjacobian.shift != 0) {
585971015bcSStefano Zampini         ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
586971015bcSStefano Zampini       }
587971015bcSStefano Zampini       if (ts->rhsjacobian.scale != 1.) {
588971015bcSStefano Zampini         ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
589971015bcSStefano Zampini       }
590971015bcSStefano Zampini     }
591971015bcSStefano Zampini     ts->rhsjacobian.shift = 0;
592971015bcSStefano Zampini     ts->rhsjacobian.scale = 1.;
5930e4ef248SJed Brown     PetscFunctionReturn(0);
594f8ede8e7SJed Brown   }
595d90be118SSean Farley 
596ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
597d90be118SSean Farley 
598e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
599971015bcSStefano Zampini     if (A == ts->Arhs) {
600971015bcSStefano Zampini       /* MatScale has a short path for this case.
601971015bcSStefano Zampini          However, this code path is taken the first time TSComputeRHSJacobian is called
602971015bcSStefano Zampini          and the matrices have not assembled yet */
603971015bcSStefano Zampini       if (ts->rhsjacobian.shift != 0) {
60494ab13aaSBarry Smith         ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
605971015bcSStefano Zampini       }
606971015bcSStefano Zampini       if (ts->rhsjacobian.scale != 1.) {
60794ab13aaSBarry Smith         ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
608971015bcSStefano Zampini       }
609971015bcSStefano Zampini     }
610971015bcSStefano Zampini     if (B && B == ts->Brhs && A != B) {
611971015bcSStefano Zampini       if (ts->rhsjacobian.shift != 0) {
61294ab13aaSBarry Smith         ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
613971015bcSStefano Zampini       }
614971015bcSStefano Zampini       if (ts->rhsjacobian.scale != 1.) {
61594ab13aaSBarry Smith         ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
616e1244c69SJed Brown       }
617971015bcSStefano Zampini     }
618e1244c69SJed Brown   }
619e1244c69SJed Brown 
62024989b8cSPeter Brune   if (rhsjacobianfunc) {
6216cd88445SBarry Smith     PetscBool missing;
62294ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
623a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
624d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
625a7a1495cSBarry Smith     PetscStackPop;
62694ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
6276cd88445SBarry Smith     if (A) {
6286cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
6296cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
6306cd88445SBarry Smith     }
6316cd88445SBarry Smith     if (B && B != A) {
6326cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
6336cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
6346cd88445SBarry Smith     }
635ef66eb69SBarry Smith   } else {
63694ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
637971015bcSStefano Zampini     if (B && A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
638ef66eb69SBarry Smith   }
6390e4ef248SJed Brown   ts->rhsjacobian.time  = t;
640971015bcSStefano Zampini   ts->rhsjacobian.shift = 0;
641971015bcSStefano Zampini   ts->rhsjacobian.scale = 1.;
6427f79407eSBarry Smith   ierr                  = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr);
64359e4f3c8SBarry Smith   ierr                  = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
644a7a1495cSBarry Smith   PetscFunctionReturn(0);
645a7a1495cSBarry Smith }
646a7a1495cSBarry Smith 
647316643e7SJed Brown /*@
648d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
649d763cef2SBarry Smith 
650d083f849SBarry Smith    Collective on TS
651316643e7SJed Brown 
652316643e7SJed Brown    Input Parameters:
653316643e7SJed Brown +  ts - the TS context
654316643e7SJed Brown .  t - current time
6550910c330SBarry Smith -  U - state vector
656316643e7SJed Brown 
657316643e7SJed Brown    Output Parameter:
658316643e7SJed Brown .  y - right hand side
659316643e7SJed Brown 
660316643e7SJed Brown    Note:
661316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
662316643e7SJed Brown    is used internally within the nonlinear solvers.
663316643e7SJed Brown 
664316643e7SJed Brown    Level: developer
665316643e7SJed Brown 
666316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
667316643e7SJed Brown @*/
6680910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
669d763cef2SBarry Smith {
670dfbe8321SBarry Smith   PetscErrorCode ierr;
67124989b8cSPeter Brune   TSRHSFunction  rhsfunction;
67224989b8cSPeter Brune   TSIFunction    ifunction;
67324989b8cSPeter Brune   void           *ctx;
67424989b8cSPeter Brune   DM             dm;
67524989b8cSPeter Brune 
676d763cef2SBarry Smith   PetscFunctionBegin;
6770700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6780910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6790700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
68024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
68124989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
6820298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
683d763cef2SBarry Smith 
684ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
685d763cef2SBarry Smith 
6860910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
68724989b8cSPeter Brune   if (rhsfunction) {
6881be370b1SHong Zhang     ierr = VecLockReadPush(U);CHKERRQ(ierr);
689d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
6900910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
691d763cef2SBarry Smith     PetscStackPop;
6921be370b1SHong Zhang     ierr = VecLockReadPop(U);CHKERRQ(ierr);
693214bc6a2SJed Brown   } else {
694214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
695b2cd27e8SJed Brown   }
69644a41b28SSean Farley 
6970910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
698d763cef2SBarry Smith   PetscFunctionReturn(0);
699d763cef2SBarry Smith }
700d763cef2SBarry Smith 
701ef20d060SBarry Smith /*@
702ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
703ef20d060SBarry Smith 
704d083f849SBarry Smith    Collective on TS
705ef20d060SBarry Smith 
706ef20d060SBarry Smith    Input Parameters:
707ef20d060SBarry Smith +  ts - the TS context
708ef20d060SBarry Smith -  t - current time
709ef20d060SBarry Smith 
710ef20d060SBarry Smith    Output Parameter:
7110910c330SBarry Smith .  U - the solution
712ef20d060SBarry Smith 
713ef20d060SBarry Smith    Note:
714ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
715ef20d060SBarry Smith    is used internally within the nonlinear solvers.
716ef20d060SBarry Smith 
717ef20d060SBarry Smith    Level: developer
718ef20d060SBarry Smith 
719abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
720ef20d060SBarry Smith @*/
7210910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
722ef20d060SBarry Smith {
723ef20d060SBarry Smith   PetscErrorCode     ierr;
724ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
725ef20d060SBarry Smith   void               *ctx;
726ef20d060SBarry Smith   DM                 dm;
727ef20d060SBarry Smith 
728ef20d060SBarry Smith   PetscFunctionBegin;
729ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7300910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
731ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
732ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
733ef20d060SBarry Smith 
734ef20d060SBarry Smith   if (solutionfunction) {
7359b7cd975SBarry Smith     PetscStackPush("TS user solution function");
7360910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
737ef20d060SBarry Smith     PetscStackPop;
738ef20d060SBarry Smith   }
739ef20d060SBarry Smith   PetscFunctionReturn(0);
740ef20d060SBarry Smith }
7419b7cd975SBarry Smith /*@
7429b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
7439b7cd975SBarry Smith 
744d083f849SBarry Smith    Collective on TS
7459b7cd975SBarry Smith 
7469b7cd975SBarry Smith    Input Parameters:
7479b7cd975SBarry Smith +  ts - the TS context
7489b7cd975SBarry Smith -  t - current time
7499b7cd975SBarry Smith 
7509b7cd975SBarry Smith    Output Parameter:
7519b7cd975SBarry Smith .  U - the function value
7529b7cd975SBarry Smith 
7539b7cd975SBarry Smith    Note:
7549b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
7559b7cd975SBarry Smith    is used internally within the nonlinear solvers.
7569b7cd975SBarry Smith 
7579b7cd975SBarry Smith    Level: developer
7589b7cd975SBarry Smith 
7599b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7609b7cd975SBarry Smith @*/
7619b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7629b7cd975SBarry Smith {
7639b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7649b7cd975SBarry Smith   void               *ctx;
7659b7cd975SBarry Smith   DM                 dm;
7669b7cd975SBarry Smith 
7679b7cd975SBarry Smith   PetscFunctionBegin;
7689b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7699b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7709b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7719b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7729b7cd975SBarry Smith 
7739b7cd975SBarry Smith   if (forcing) {
7749b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
7759b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
7769b7cd975SBarry Smith     PetscStackPop;
7779b7cd975SBarry Smith   }
7789b7cd975SBarry Smith   PetscFunctionReturn(0);
7799b7cd975SBarry Smith }
780ef20d060SBarry Smith 
781214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
782214bc6a2SJed Brown {
7832dd45cf8SJed Brown   Vec            F;
784214bc6a2SJed Brown   PetscErrorCode ierr;
785214bc6a2SJed Brown 
786214bc6a2SJed Brown   PetscFunctionBegin;
7870298fd71SBarry Smith   *Frhs = NULL;
7880298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
789214bc6a2SJed Brown   if (!ts->Frhs) {
7902dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
791214bc6a2SJed Brown   }
792214bc6a2SJed Brown   *Frhs = ts->Frhs;
793214bc6a2SJed Brown   PetscFunctionReturn(0);
794214bc6a2SJed Brown }
795214bc6a2SJed Brown 
796971015bcSStefano Zampini PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
797214bc6a2SJed Brown {
798214bc6a2SJed Brown   Mat            A,B;
7992dd45cf8SJed Brown   PetscErrorCode ierr;
80041a1d4d2SBarry Smith   TSIJacobian    ijacobian;
801214bc6a2SJed Brown 
802214bc6a2SJed Brown   PetscFunctionBegin;
803c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
804c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
80541a1d4d2SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr);
806214bc6a2SJed Brown   if (Arhs) {
807214bc6a2SJed Brown     if (!ts->Arhs) {
80841a1d4d2SBarry Smith       if (ijacobian) {
809214bc6a2SJed Brown         ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
81041a1d4d2SBarry Smith       } else {
81141a1d4d2SBarry Smith         ts->Arhs = A;
81241a1d4d2SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
81341a1d4d2SBarry Smith       }
8143565c898SBarry Smith     } else {
8153565c898SBarry Smith       PetscBool flg;
8163565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
8173565c898SBarry Smith       /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */
8183565c898SBarry Smith       if (flg && !ijacobian && ts->Arhs == ts->Brhs){
8193565c898SBarry Smith         ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr);
8203565c898SBarry Smith         ts->Arhs = A;
8213565c898SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
8223565c898SBarry Smith       }
823214bc6a2SJed Brown     }
824214bc6a2SJed Brown     *Arhs = ts->Arhs;
825214bc6a2SJed Brown   }
826214bc6a2SJed Brown   if (Brhs) {
827214bc6a2SJed Brown     if (!ts->Brhs) {
828bdb70873SJed Brown       if (A != B) {
82941a1d4d2SBarry Smith         if (ijacobian) {
830214bc6a2SJed Brown           ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
831bdb70873SJed Brown         } else {
83241a1d4d2SBarry Smith           ts->Brhs = B;
83341a1d4d2SBarry Smith           ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
83441a1d4d2SBarry Smith         }
83541a1d4d2SBarry Smith       } else {
836bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
83751699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
838bdb70873SJed Brown       }
839214bc6a2SJed Brown     }
840214bc6a2SJed Brown     *Brhs = ts->Brhs;
841214bc6a2SJed Brown   }
842214bc6a2SJed Brown   PetscFunctionReturn(0);
843214bc6a2SJed Brown }
844214bc6a2SJed Brown 
845316643e7SJed Brown /*@
8460910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
847316643e7SJed Brown 
848d083f849SBarry Smith    Collective on TS
849316643e7SJed Brown 
850316643e7SJed Brown    Input Parameters:
851316643e7SJed Brown +  ts - the TS context
852316643e7SJed Brown .  t - current time
8530910c330SBarry Smith .  U - state vector
8540910c330SBarry Smith .  Udot - time derivative of state vector
855214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
856316643e7SJed Brown 
857316643e7SJed Brown    Output Parameter:
858316643e7SJed Brown .  Y - right hand side
859316643e7SJed Brown 
860316643e7SJed Brown    Note:
861316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
862316643e7SJed Brown    is used internally within the nonlinear solvers.
863316643e7SJed Brown 
864316643e7SJed Brown    If the user did did not write their equations in implicit form, this
865316643e7SJed Brown    function recasts them in implicit form.
866316643e7SJed Brown 
867316643e7SJed Brown    Level: developer
868316643e7SJed Brown 
869316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
870316643e7SJed Brown @*/
8710910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
872316643e7SJed Brown {
873316643e7SJed Brown   PetscErrorCode ierr;
87424989b8cSPeter Brune   TSIFunction    ifunction;
87524989b8cSPeter Brune   TSRHSFunction  rhsfunction;
87624989b8cSPeter Brune   void           *ctx;
87724989b8cSPeter Brune   DM             dm;
878316643e7SJed Brown 
879316643e7SJed Brown   PetscFunctionBegin;
8800700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8810910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8820910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
8830700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
884316643e7SJed Brown 
88524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
88624989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
8870298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
88824989b8cSPeter Brune 
889ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
890d90be118SSean Farley 
8910910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
89224989b8cSPeter Brune   if (ifunction) {
893316643e7SJed Brown     PetscStackPush("TS user implicit function");
8940910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
895316643e7SJed Brown     PetscStackPop;
896214bc6a2SJed Brown   }
897214bc6a2SJed Brown   if (imex) {
89824989b8cSPeter Brune     if (!ifunction) {
8990910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
9002dd45cf8SJed Brown     }
90124989b8cSPeter Brune   } else if (rhsfunction) {
90224989b8cSPeter Brune     if (ifunction) {
903214bc6a2SJed Brown       Vec Frhs;
904214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
9050910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
906214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
9072dd45cf8SJed Brown     } else {
9080910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
9090910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
910316643e7SJed Brown     }
9114a6899ffSJed Brown   }
9120910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
913316643e7SJed Brown   PetscFunctionReturn(0);
914316643e7SJed Brown }
915316643e7SJed Brown 
916316643e7SJed Brown /*@
917316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
918316643e7SJed Brown 
919d083f849SBarry Smith    Collective on TS
920316643e7SJed Brown 
921316643e7SJed Brown    Input
922316643e7SJed Brown       Input Parameters:
923316643e7SJed Brown +  ts - the TS context
924316643e7SJed Brown .  t - current timestep
9250910c330SBarry Smith .  U - state vector
9260910c330SBarry Smith .  Udot - time derivative of state vector
927214bc6a2SJed Brown .  shift - shift to apply, see note below
928214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
929316643e7SJed Brown 
930316643e7SJed Brown    Output Parameters:
931316643e7SJed Brown +  A - Jacobian matrix
9323565c898SBarry Smith -  B - matrix from which the preconditioner is constructed; often the same as A
933316643e7SJed Brown 
934316643e7SJed Brown    Notes:
9350910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
936316643e7SJed Brown 
9370910c330SBarry Smith    dF/dU + shift*dF/dUdot
938316643e7SJed Brown 
939316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
940316643e7SJed Brown    is used internally within the nonlinear solvers.
941316643e7SJed Brown 
942316643e7SJed Brown    Level: developer
943316643e7SJed Brown 
944316643e7SJed Brown .seealso:  TSSetIJacobian()
94563495f91SJed Brown @*/
946d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
947316643e7SJed Brown {
948316643e7SJed Brown   PetscErrorCode ierr;
94924989b8cSPeter Brune   TSIJacobian    ijacobian;
95024989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
95124989b8cSPeter Brune   DM             dm;
95224989b8cSPeter Brune   void           *ctx;
953316643e7SJed Brown 
954316643e7SJed Brown   PetscFunctionBegin;
9550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9560910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9570910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
958316643e7SJed Brown   PetscValidPointer(A,6);
95994ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
960316643e7SJed Brown   PetscValidPointer(B,7);
96194ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
96224989b8cSPeter Brune 
96324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
96424989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
9650298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
96624989b8cSPeter Brune 
967ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
968316643e7SJed Brown 
96994ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
97024989b8cSPeter Brune   if (ijacobian) {
9716cd88445SBarry Smith     PetscBool missing;
972316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
973d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
974316643e7SJed Brown     PetscStackPop;
9756cd88445SBarry Smith     ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
9766cd88445SBarry Smith     if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
9773565c898SBarry Smith     if (B != A) {
9786cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
9796cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
9806cd88445SBarry Smith     }
9814a6899ffSJed Brown   }
982214bc6a2SJed Brown   if (imex) {
983b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
9844c26be97Sstefano_zampini       PetscBool assembled;
985971015bcSStefano Zampini       if (rhsjacobian) {
986971015bcSStefano Zampini         Mat Arhs = NULL;
987971015bcSStefano Zampini         ierr = TSGetRHSMats_Private(ts,&Arhs,NULL);CHKERRQ(ierr);
988971015bcSStefano Zampini         if (A == Arhs) {
989971015bcSStefano Zampini           if (rhsjacobian == TSComputeRHSJacobianConstant) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Unsupported operation! cannot use TSComputeRHSJacobianConstant");
990971015bcSStefano Zampini           ts->rhsjacobian.time = PETSC_MIN_REAL;
991971015bcSStefano Zampini         }
992971015bcSStefano Zampini       }
99394ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
9944c26be97Sstefano_zampini       ierr = MatAssembled(A,&assembled);CHKERRQ(ierr);
9954c26be97Sstefano_zampini       if (!assembled) {
9964c26be97Sstefano_zampini         ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9974c26be97Sstefano_zampini         ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9984c26be97Sstefano_zampini       }
99994ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
100094ab13aaSBarry Smith       if (A != B) {
100194ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
10024c26be97Sstefano_zampini         ierr = MatAssembled(B,&assembled);CHKERRQ(ierr);
10034c26be97Sstefano_zampini         if (!assembled) {
10044c26be97Sstefano_zampini           ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10054c26be97Sstefano_zampini           ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10064c26be97Sstefano_zampini         }
100794ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
1008214bc6a2SJed Brown       }
1009214bc6a2SJed Brown     }
1010214bc6a2SJed Brown   } else {
1011e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
1012e1244c69SJed Brown     if (rhsjacobian) {
1013214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
1014d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
1015e1244c69SJed Brown     }
101694ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
10173565c898SBarry Smith       PetscBool flg;
1018e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
1019e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
10203565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
10213565c898SBarry Smith       /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */
10223565c898SBarry Smith       if (!flg) {
102394ab13aaSBarry Smith         ierr = MatScale(A,-1);CHKERRQ(ierr);
102494ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
10253565c898SBarry Smith       }
102694ab13aaSBarry Smith       if (A != B) {
102794ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
102894ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
1029316643e7SJed Brown       }
1030e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
1031e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1032e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
103394ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
103494ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
103594ab13aaSBarry Smith         if (A != B) {
103694ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
103794ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
1038214bc6a2SJed Brown         }
1039316643e7SJed Brown       }
104094ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
104194ab13aaSBarry Smith       if (A != B) {
104294ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
1043316643e7SJed Brown       }
1044316643e7SJed Brown     }
1045316643e7SJed Brown   }
104694ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
1047316643e7SJed Brown   PetscFunctionReturn(0);
1048316643e7SJed Brown }
1049316643e7SJed Brown 
1050d763cef2SBarry Smith /*@C
1051d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
1052b5abc632SBarry Smith     where U_t = G(t,u).
1053d763cef2SBarry Smith 
10543f9fe445SBarry Smith     Logically Collective on TS
1055d763cef2SBarry Smith 
1056d763cef2SBarry Smith     Input Parameters:
1057d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
10580298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
1059d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
1060d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
10610298fd71SBarry Smith           function evaluation routine (may be NULL)
1062d763cef2SBarry Smith 
1063d763cef2SBarry Smith     Calling sequence of func:
10646bc98fa9SBarry Smith $     PetscErrorCode func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
1065d763cef2SBarry Smith 
1066d763cef2SBarry Smith +   t - current timestep
1067d763cef2SBarry Smith .   u - input vector
1068d763cef2SBarry Smith .   F - function vector
1069d763cef2SBarry Smith -   ctx - [optional] user-defined function context
1070d763cef2SBarry Smith 
1071d763cef2SBarry Smith     Level: beginner
1072d763cef2SBarry Smith 
107395452b02SPatrick Sanan     Notes:
107495452b02SPatrick Sanan     You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
10752bbac0d3SBarry Smith 
1076ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
1077d763cef2SBarry Smith @*/
1078089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
1079d763cef2SBarry Smith {
1080089b2837SJed Brown   PetscErrorCode ierr;
1081089b2837SJed Brown   SNES           snes;
10820298fd71SBarry Smith   Vec            ralloc = NULL;
108324989b8cSPeter Brune   DM             dm;
1084d763cef2SBarry Smith 
1085089b2837SJed Brown   PetscFunctionBegin;
10860700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1087ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
108824989b8cSPeter Brune 
108924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
109024989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1091089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1092e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1093e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1094e856ceecSJed Brown     r = ralloc;
1095e856ceecSJed Brown   }
1096089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1097e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1098d763cef2SBarry Smith   PetscFunctionReturn(0);
1099d763cef2SBarry Smith }
1100d763cef2SBarry Smith 
1101ef20d060SBarry Smith /*@C
1102abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1103ef20d060SBarry Smith 
1104ef20d060SBarry Smith     Logically Collective on TS
1105ef20d060SBarry Smith 
1106ef20d060SBarry Smith     Input Parameters:
1107ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1108ef20d060SBarry Smith .   f - routine for evaluating the solution
1109ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
11100298fd71SBarry Smith           function evaluation routine (may be NULL)
1111ef20d060SBarry Smith 
1112ef20d060SBarry Smith     Calling sequence of func:
11136bc98fa9SBarry Smith $     PetscErrorCode func (TS ts,PetscReal t,Vec u,void *ctx);
1114ef20d060SBarry Smith 
1115ef20d060SBarry Smith +   t - current timestep
1116ef20d060SBarry Smith .   u - output vector
1117ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1118ef20d060SBarry Smith 
11190ed3bfb6SBarry Smith     Options Database:
11200ed3bfb6SBarry Smith +  -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction()
11210ed3bfb6SBarry Smith -  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
11220ed3bfb6SBarry Smith 
1123abd5a294SJed Brown     Notes:
1124abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1125abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1126abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1127abd5a294SJed Brown 
11284f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1129abd5a294SJed Brown 
1130ef20d060SBarry Smith     Level: beginner
1131ef20d060SBarry Smith 
11320ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError()
1133ef20d060SBarry Smith @*/
1134ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1135ef20d060SBarry Smith {
1136ef20d060SBarry Smith   PetscErrorCode ierr;
1137ef20d060SBarry Smith   DM             dm;
1138ef20d060SBarry Smith 
1139ef20d060SBarry Smith   PetscFunctionBegin;
1140ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1141ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1142ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1143ef20d060SBarry Smith   PetscFunctionReturn(0);
1144ef20d060SBarry Smith }
1145ef20d060SBarry Smith 
11469b7cd975SBarry Smith /*@C
11479b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
11489b7cd975SBarry Smith 
11499b7cd975SBarry Smith     Logically Collective on TS
11509b7cd975SBarry Smith 
11519b7cd975SBarry Smith     Input Parameters:
11529b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
1153e162b725SBarry Smith .   func - routine for evaluating the forcing function
11549b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
11550298fd71SBarry Smith           function evaluation routine (may be NULL)
11569b7cd975SBarry Smith 
11579b7cd975SBarry Smith     Calling sequence of func:
11586bc98fa9SBarry Smith $     PetscErrorCode func (TS ts,PetscReal t,Vec f,void *ctx);
11599b7cd975SBarry Smith 
11609b7cd975SBarry Smith +   t - current timestep
1161e162b725SBarry Smith .   f - output vector
11629b7cd975SBarry Smith -   ctx - [optional] user-defined function context
11639b7cd975SBarry Smith 
11649b7cd975SBarry Smith     Notes:
11659b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
1166e162b725SBarry 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
1167e162b725SBarry Smith     definition of the problem you are solving and hence possibly introducing bugs.
1168e162b725SBarry Smith 
1169e162b725SBarry Smith     This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0
1170e162b725SBarry Smith 
1171e162b725SBarry 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
1172e162b725SBarry Smith     parameters can be passed in the ctx variable.
11739b7cd975SBarry Smith 
11749b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
11759b7cd975SBarry Smith 
11769b7cd975SBarry Smith     Level: beginner
11779b7cd975SBarry Smith 
11789b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
11799b7cd975SBarry Smith @*/
1180e162b725SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx)
11819b7cd975SBarry Smith {
11829b7cd975SBarry Smith   PetscErrorCode ierr;
11839b7cd975SBarry Smith   DM             dm;
11849b7cd975SBarry Smith 
11859b7cd975SBarry Smith   PetscFunctionBegin;
11869b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
11879b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1188e162b725SBarry Smith   ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr);
11899b7cd975SBarry Smith   PetscFunctionReturn(0);
11909b7cd975SBarry Smith }
11919b7cd975SBarry Smith 
1192d763cef2SBarry Smith /*@C
1193f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1194b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1195d763cef2SBarry Smith 
11963f9fe445SBarry Smith    Logically Collective on TS
1197d763cef2SBarry Smith 
1198d763cef2SBarry Smith    Input Parameters:
1199d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1200e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1201e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1202d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1203d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
12040298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1205d763cef2SBarry Smith 
1206f7ab8db6SBarry Smith    Calling sequence of f:
12076bc98fa9SBarry Smith $     PetscErrorCode func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1208d763cef2SBarry Smith 
1209d763cef2SBarry Smith +  t - current timestep
1210d763cef2SBarry Smith .  u - input vector
1211e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1212e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1213d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1214d763cef2SBarry Smith 
12156cd88445SBarry Smith    Notes:
12166cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
12176cd88445SBarry Smith 
12186cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1219ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1220d763cef2SBarry Smith 
1221d763cef2SBarry Smith    Level: beginner
1222d763cef2SBarry Smith 
1223ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1224d763cef2SBarry Smith 
1225d763cef2SBarry Smith @*/
1226e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1227d763cef2SBarry Smith {
1228277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1229089b2837SJed Brown   SNES           snes;
123024989b8cSPeter Brune   DM             dm;
123124989b8cSPeter Brune   TSIJacobian    ijacobian;
1232277b19d0SLisandro Dalcin 
1233d763cef2SBarry Smith   PetscFunctionBegin;
12340700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1235e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1236e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1237e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1238e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1239d763cef2SBarry Smith 
124024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
124124989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1242e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1243e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1244e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1245e1244c69SJed Brown   }
12460298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1247089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12485f659677SPeter Brune   if (!ijacobian) {
1249e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
12500e4ef248SJed Brown   }
1251e5d3d808SBarry Smith   if (Amat) {
1252e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
12530e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1254e5d3d808SBarry Smith     ts->Arhs = Amat;
12550e4ef248SJed Brown   }
1256e5d3d808SBarry Smith   if (Pmat) {
1257e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
12580e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1259e5d3d808SBarry Smith     ts->Brhs = Pmat;
12600e4ef248SJed Brown   }
1261d763cef2SBarry Smith   PetscFunctionReturn(0);
1262d763cef2SBarry Smith }
1263d763cef2SBarry Smith 
1264316643e7SJed Brown /*@C
1265b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1266316643e7SJed Brown 
12673f9fe445SBarry Smith    Logically Collective on TS
1268316643e7SJed Brown 
1269316643e7SJed Brown    Input Parameters:
1270316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
12710298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1272316643e7SJed Brown .  f   - the function evaluation routine
12730298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1274316643e7SJed Brown 
1275316643e7SJed Brown    Calling sequence of f:
12766bc98fa9SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1277316643e7SJed Brown 
1278316643e7SJed Brown +  t   - time at step/stage being solved
1279316643e7SJed Brown .  u   - state vector
1280316643e7SJed Brown .  u_t - time derivative of state vector
1281316643e7SJed Brown .  F   - function vector
1282316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1283316643e7SJed Brown 
1284316643e7SJed Brown    Important:
12852bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1286316643e7SJed Brown 
1287316643e7SJed Brown    Level: beginner
1288316643e7SJed Brown 
1289d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1290316643e7SJed Brown @*/
129151699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1292316643e7SJed Brown {
1293089b2837SJed Brown   PetscErrorCode ierr;
1294089b2837SJed Brown   SNES           snes;
129551699248SLisandro Dalcin   Vec            ralloc = NULL;
129624989b8cSPeter Brune   DM             dm;
1297316643e7SJed Brown 
1298316643e7SJed Brown   PetscFunctionBegin;
12990700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
130051699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
130124989b8cSPeter Brune 
130224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
130324989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
130424989b8cSPeter Brune 
1305089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
130651699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
130751699248SLisandro Dalcin     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
130851699248SLisandro Dalcin     r  = ralloc;
1309e856ceecSJed Brown   }
131051699248SLisandro Dalcin   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
131151699248SLisandro Dalcin   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1312089b2837SJed Brown   PetscFunctionReturn(0);
1313089b2837SJed Brown }
1314089b2837SJed Brown 
1315089b2837SJed Brown /*@C
1316089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1317089b2837SJed Brown 
1318089b2837SJed Brown    Not Collective
1319089b2837SJed Brown 
1320089b2837SJed Brown    Input Parameter:
1321089b2837SJed Brown .  ts - the TS context
1322089b2837SJed Brown 
1323089b2837SJed Brown    Output Parameter:
13240298fd71SBarry Smith +  r - vector to hold residual (or NULL)
13250298fd71SBarry Smith .  func - the function to compute residual (or NULL)
13260298fd71SBarry Smith -  ctx - the function context (or NULL)
1327089b2837SJed Brown 
1328089b2837SJed Brown    Level: advanced
1329089b2837SJed Brown 
1330089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1331089b2837SJed Brown @*/
1332089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1333089b2837SJed Brown {
1334089b2837SJed Brown   PetscErrorCode ierr;
1335089b2837SJed Brown   SNES           snes;
133624989b8cSPeter Brune   DM             dm;
1337089b2837SJed Brown 
1338089b2837SJed Brown   PetscFunctionBegin;
1339089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1340089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13410298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
134224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
134324989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1344089b2837SJed Brown   PetscFunctionReturn(0);
1345089b2837SJed Brown }
1346089b2837SJed Brown 
1347089b2837SJed Brown /*@C
1348089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1349089b2837SJed Brown 
1350089b2837SJed Brown    Not Collective
1351089b2837SJed Brown 
1352089b2837SJed Brown    Input Parameter:
1353089b2837SJed Brown .  ts - the TS context
1354089b2837SJed Brown 
1355089b2837SJed Brown    Output Parameter:
13560298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
13570298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
13580298fd71SBarry Smith -  ctx - the function context (or NULL)
1359089b2837SJed Brown 
1360089b2837SJed Brown    Level: advanced
1361089b2837SJed Brown 
13622bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1363089b2837SJed Brown @*/
1364089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1365089b2837SJed Brown {
1366089b2837SJed Brown   PetscErrorCode ierr;
1367089b2837SJed Brown   SNES           snes;
136824989b8cSPeter Brune   DM             dm;
1369089b2837SJed Brown 
1370089b2837SJed Brown   PetscFunctionBegin;
1371089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1372089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13730298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
137424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
137524989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1376316643e7SJed Brown   PetscFunctionReturn(0);
1377316643e7SJed Brown }
1378316643e7SJed Brown 
1379316643e7SJed Brown /*@C
1380a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1381ae8867d6SBarry Smith         provided with TSSetIFunction().
1382316643e7SJed Brown 
13833f9fe445SBarry Smith    Logically Collective on TS
1384316643e7SJed Brown 
1385316643e7SJed Brown    Input Parameters:
1386316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1387e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1388e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1389316643e7SJed Brown .  f   - the Jacobian evaluation routine
13900298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1391316643e7SJed Brown 
1392316643e7SJed Brown    Calling sequence of f:
13936bc98fa9SBarry Smith $    PetscErrorCode f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1394316643e7SJed Brown 
1395316643e7SJed Brown +  t    - time at step/stage being solved
13961b4a444bSJed Brown .  U    - state vector
13971b4a444bSJed Brown .  U_t  - time derivative of state vector
1398316643e7SJed Brown .  a    - shift
1399e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1400e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1401316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1402316643e7SJed Brown 
1403316643e7SJed Brown    Notes:
1404e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1405316643e7SJed Brown 
1406895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1407895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1408895c21f2SBarry Smith 
1409a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1410b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1411a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1412a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1413a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1414a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1415a4f0a591SBarry Smith 
14166cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
14176cd88445SBarry Smith 
14186cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1419ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1420ca5f011dSBarry Smith 
1421316643e7SJed Brown    Level: beginner
1422316643e7SJed Brown 
1423ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1424316643e7SJed Brown 
1425316643e7SJed Brown @*/
1426e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1427316643e7SJed Brown {
1428316643e7SJed Brown   PetscErrorCode ierr;
1429089b2837SJed Brown   SNES           snes;
143024989b8cSPeter Brune   DM             dm;
1431316643e7SJed Brown 
1432316643e7SJed Brown   PetscFunctionBegin;
14330700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1434e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1435e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1436e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1437e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
143824989b8cSPeter Brune 
143924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
144024989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
144124989b8cSPeter Brune 
1442089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1443e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1444316643e7SJed Brown   PetscFunctionReturn(0);
1445316643e7SJed Brown }
1446316643e7SJed Brown 
1447e1244c69SJed Brown /*@
1448e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1449e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1450e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1451e1244c69SJed Brown    not been changed by the TS.
1452e1244c69SJed Brown 
1453e1244c69SJed Brown    Logically Collective
1454e1244c69SJed Brown 
1455e1244c69SJed Brown    Input Arguments:
1456e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1457e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1458e1244c69SJed Brown 
1459e1244c69SJed Brown    Level: intermediate
1460e1244c69SJed Brown 
1461e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1462e1244c69SJed Brown @*/
1463e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1464e1244c69SJed Brown {
1465e1244c69SJed Brown   PetscFunctionBegin;
1466e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1467e1244c69SJed Brown   PetscFunctionReturn(0);
1468e1244c69SJed Brown }
1469e1244c69SJed Brown 
1470efe9872eSLisandro Dalcin /*@C
1471efe9872eSLisandro Dalcin    TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1472efe9872eSLisandro Dalcin 
1473efe9872eSLisandro Dalcin    Logically Collective on TS
1474efe9872eSLisandro Dalcin 
1475efe9872eSLisandro Dalcin    Input Parameters:
1476efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1477efe9872eSLisandro Dalcin .  F   - vector to hold the residual (or NULL to have it created internally)
1478efe9872eSLisandro Dalcin .  fun - the function evaluation routine
1479efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1480efe9872eSLisandro Dalcin 
1481efe9872eSLisandro Dalcin    Calling sequence of fun:
14826bc98fa9SBarry Smith $     PetscErrorCode fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx);
1483efe9872eSLisandro Dalcin 
1484efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1485efe9872eSLisandro Dalcin .  U    - state vector
1486efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1487efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1488efe9872eSLisandro Dalcin .  F    - function vector
1489efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine (may be NULL)
1490efe9872eSLisandro Dalcin 
1491efe9872eSLisandro Dalcin    Level: beginner
1492efe9872eSLisandro Dalcin 
1493efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian()
1494efe9872eSLisandro Dalcin @*/
1495efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx)
1496efe9872eSLisandro Dalcin {
1497efe9872eSLisandro Dalcin   DM             dm;
1498efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1499efe9872eSLisandro Dalcin 
1500efe9872eSLisandro Dalcin   PetscFunctionBegin;
1501efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1502efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2);
1503efe9872eSLisandro Dalcin   ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr);
1504efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1505efe9872eSLisandro Dalcin   ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1506efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1507efe9872eSLisandro Dalcin }
1508efe9872eSLisandro Dalcin 
1509efe9872eSLisandro Dalcin /*@C
1510efe9872eSLisandro Dalcin   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1511efe9872eSLisandro Dalcin 
1512efe9872eSLisandro Dalcin   Not Collective
1513efe9872eSLisandro Dalcin 
1514efe9872eSLisandro Dalcin   Input Parameter:
1515efe9872eSLisandro Dalcin . ts - the TS context
1516efe9872eSLisandro Dalcin 
1517efe9872eSLisandro Dalcin   Output Parameter:
1518efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL)
1519efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL)
1520efe9872eSLisandro Dalcin - ctx - the function context (or NULL)
1521efe9872eSLisandro Dalcin 
1522efe9872eSLisandro Dalcin   Level: advanced
1523efe9872eSLisandro Dalcin 
1524efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction()
1525efe9872eSLisandro Dalcin @*/
1526efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1527efe9872eSLisandro Dalcin {
1528efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1529efe9872eSLisandro Dalcin   SNES           snes;
1530efe9872eSLisandro Dalcin   DM             dm;
1531efe9872eSLisandro Dalcin 
1532efe9872eSLisandro Dalcin   PetscFunctionBegin;
1533efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1534efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1535efe9872eSLisandro Dalcin   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1536efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1537efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1538efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1539efe9872eSLisandro Dalcin }
1540efe9872eSLisandro Dalcin 
1541efe9872eSLisandro Dalcin /*@C
1542bc77d74cSLisandro Dalcin    TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1543efe9872eSLisandro Dalcin         where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1544efe9872eSLisandro Dalcin 
1545efe9872eSLisandro Dalcin    Logically Collective on TS
1546efe9872eSLisandro Dalcin 
1547efe9872eSLisandro Dalcin    Input Parameters:
1548efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1549efe9872eSLisandro Dalcin .  J   - Jacobian matrix
1550efe9872eSLisandro Dalcin .  P   - preconditioning matrix for J (may be same as J)
1551efe9872eSLisandro Dalcin .  jac - the Jacobian evaluation routine
1552efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1553efe9872eSLisandro Dalcin 
1554efe9872eSLisandro Dalcin    Calling sequence of jac:
15556bc98fa9SBarry 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);
1556efe9872eSLisandro Dalcin 
1557efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1558efe9872eSLisandro Dalcin .  U    - state vector
1559efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1560efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1561efe9872eSLisandro Dalcin .  v    - shift for U_t
1562efe9872eSLisandro Dalcin .  a    - shift for U_tt
1563efe9872eSLisandro 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
1564efe9872eSLisandro Dalcin .  P    - preconditioning matrix for J, may be same as J
1565efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine
1566efe9872eSLisandro Dalcin 
1567efe9872eSLisandro Dalcin    Notes:
1568efe9872eSLisandro Dalcin    The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1569efe9872eSLisandro Dalcin 
1570efe9872eSLisandro Dalcin    The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1571efe9872eSLisandro 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.
1572efe9872eSLisandro Dalcin    The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1573bc77d74cSLisandro Dalcin    parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1574efe9872eSLisandro Dalcin 
1575efe9872eSLisandro Dalcin    Level: beginner
1576efe9872eSLisandro Dalcin 
1577efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1578efe9872eSLisandro Dalcin @*/
1579efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1580efe9872eSLisandro Dalcin {
1581efe9872eSLisandro Dalcin   DM             dm;
1582efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1583efe9872eSLisandro Dalcin 
1584efe9872eSLisandro Dalcin   PetscFunctionBegin;
1585efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1586efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2);
1587efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3);
1588efe9872eSLisandro Dalcin   ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr);
1589efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1590efe9872eSLisandro Dalcin   ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1591efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1592efe9872eSLisandro Dalcin }
1593efe9872eSLisandro Dalcin 
1594efe9872eSLisandro Dalcin /*@C
1595efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1596efe9872eSLisandro Dalcin 
1597efe9872eSLisandro Dalcin   Not Collective, but parallel objects are returned if TS is parallel
1598efe9872eSLisandro Dalcin 
1599efe9872eSLisandro Dalcin   Input Parameter:
1600efe9872eSLisandro Dalcin . ts  - The TS context obtained from TSCreate()
1601efe9872eSLisandro Dalcin 
1602efe9872eSLisandro Dalcin   Output Parameters:
1603efe9872eSLisandro Dalcin + J  - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1604efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J
1605efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1606efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1607efe9872eSLisandro Dalcin 
160895452b02SPatrick Sanan   Notes:
160995452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
1610efe9872eSLisandro Dalcin 
1611efe9872eSLisandro Dalcin   Level: advanced
1612efe9872eSLisandro Dalcin 
161380275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
1614efe9872eSLisandro Dalcin 
1615efe9872eSLisandro Dalcin @*/
1616efe9872eSLisandro Dalcin PetscErrorCode  TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1617efe9872eSLisandro Dalcin {
1618efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1619efe9872eSLisandro Dalcin   SNES           snes;
1620efe9872eSLisandro Dalcin   DM             dm;
1621efe9872eSLisandro Dalcin 
1622efe9872eSLisandro Dalcin   PetscFunctionBegin;
1623efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1624efe9872eSLisandro Dalcin   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
1625efe9872eSLisandro Dalcin   ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr);
1626efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1627efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1628efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1629efe9872eSLisandro Dalcin }
1630efe9872eSLisandro Dalcin 
1631efe9872eSLisandro Dalcin /*@
1632efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1633efe9872eSLisandro Dalcin 
1634d083f849SBarry Smith   Collective on TS
1635efe9872eSLisandro Dalcin 
1636efe9872eSLisandro Dalcin   Input Parameters:
1637efe9872eSLisandro Dalcin + ts - the TS context
1638efe9872eSLisandro Dalcin . t - current time
1639efe9872eSLisandro Dalcin . U - state vector
1640efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t)
1641efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt)
1642efe9872eSLisandro Dalcin 
1643efe9872eSLisandro Dalcin   Output Parameter:
1644efe9872eSLisandro Dalcin . F - the residual vector
1645efe9872eSLisandro Dalcin 
1646efe9872eSLisandro Dalcin   Note:
1647efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1648efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1649efe9872eSLisandro Dalcin 
1650efe9872eSLisandro Dalcin   Level: developer
1651efe9872eSLisandro Dalcin 
1652efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1653efe9872eSLisandro Dalcin @*/
1654efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1655efe9872eSLisandro Dalcin {
1656efe9872eSLisandro Dalcin   DM             dm;
1657efe9872eSLisandro Dalcin   TSI2Function   I2Function;
1658efe9872eSLisandro Dalcin   void           *ctx;
1659efe9872eSLisandro Dalcin   TSRHSFunction  rhsfunction;
1660efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1661efe9872eSLisandro Dalcin 
1662efe9872eSLisandro Dalcin   PetscFunctionBegin;
1663efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1664efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1665efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1666efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1667efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F,VEC_CLASSID,6);
1668efe9872eSLisandro Dalcin 
1669efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1670efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr);
1671efe9872eSLisandro Dalcin   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
1672efe9872eSLisandro Dalcin 
1673efe9872eSLisandro Dalcin   if (!I2Function) {
1674efe9872eSLisandro Dalcin     ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr);
1675efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1676efe9872eSLisandro Dalcin   }
1677efe9872eSLisandro Dalcin 
1678efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1679efe9872eSLisandro Dalcin 
1680efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit function");
1681efe9872eSLisandro Dalcin   ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr);
1682efe9872eSLisandro Dalcin   PetscStackPop;
1683efe9872eSLisandro Dalcin 
1684efe9872eSLisandro Dalcin   if (rhsfunction) {
1685efe9872eSLisandro Dalcin     Vec Frhs;
1686efe9872eSLisandro Dalcin     ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
1687efe9872eSLisandro Dalcin     ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
1688efe9872eSLisandro Dalcin     ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr);
1689efe9872eSLisandro Dalcin   }
1690efe9872eSLisandro Dalcin 
1691efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1692efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1693efe9872eSLisandro Dalcin }
1694efe9872eSLisandro Dalcin 
1695efe9872eSLisandro Dalcin /*@
1696efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1697efe9872eSLisandro Dalcin 
1698d083f849SBarry Smith   Collective on TS
1699efe9872eSLisandro Dalcin 
1700efe9872eSLisandro Dalcin   Input Parameters:
1701efe9872eSLisandro Dalcin + ts - the TS context
1702efe9872eSLisandro Dalcin . t - current timestep
1703efe9872eSLisandro Dalcin . U - state vector
1704efe9872eSLisandro Dalcin . V - time derivative of state vector
1705efe9872eSLisandro Dalcin . A - second time derivative of state vector
1706efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1707efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1708efe9872eSLisandro Dalcin 
1709efe9872eSLisandro Dalcin   Output Parameters:
1710efe9872eSLisandro Dalcin + J - Jacobian matrix
1711efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1712efe9872eSLisandro Dalcin 
1713efe9872eSLisandro Dalcin   Notes:
1714efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1715efe9872eSLisandro Dalcin 
1716efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1717efe9872eSLisandro Dalcin 
1718efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1719efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1720efe9872eSLisandro Dalcin 
1721efe9872eSLisandro Dalcin   Level: developer
1722efe9872eSLisandro Dalcin 
1723efe9872eSLisandro Dalcin .seealso:  TSSetI2Jacobian()
1724efe9872eSLisandro Dalcin @*/
1725efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1726efe9872eSLisandro Dalcin {
1727efe9872eSLisandro Dalcin   DM             dm;
1728efe9872eSLisandro Dalcin   TSI2Jacobian   I2Jacobian;
1729efe9872eSLisandro Dalcin   void           *ctx;
1730efe9872eSLisandro Dalcin   TSRHSJacobian  rhsjacobian;
1731efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1732efe9872eSLisandro Dalcin 
1733efe9872eSLisandro Dalcin   PetscFunctionBegin;
1734efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1735efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1736efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1737efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1738efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J,MAT_CLASSID,8);
1739efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P,MAT_CLASSID,9);
1740efe9872eSLisandro Dalcin 
1741efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1742efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr);
1743efe9872eSLisandro Dalcin   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
1744efe9872eSLisandro Dalcin 
1745efe9872eSLisandro Dalcin   if (!I2Jacobian) {
1746efe9872eSLisandro Dalcin     ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr);
1747efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1748efe9872eSLisandro Dalcin   }
1749efe9872eSLisandro Dalcin 
1750efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1751efe9872eSLisandro Dalcin 
1752efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit Jacobian");
1753efe9872eSLisandro Dalcin   ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr);
1754efe9872eSLisandro Dalcin   PetscStackPop;
1755efe9872eSLisandro Dalcin 
1756efe9872eSLisandro Dalcin   if (rhsjacobian) {
1757efe9872eSLisandro Dalcin     Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1758efe9872eSLisandro Dalcin     ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr);
1759efe9872eSLisandro Dalcin     ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr);
1760efe9872eSLisandro Dalcin     ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr);
1761efe9872eSLisandro Dalcin     if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);}
1762efe9872eSLisandro Dalcin   }
1763efe9872eSLisandro Dalcin 
1764efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1765efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1766efe9872eSLisandro Dalcin }
1767efe9872eSLisandro Dalcin 
1768438f35afSJed Brown /*@C
1769438f35afSJed Brown    TSSetTransientVariable - sets function to transform from state to transient variables
1770438f35afSJed Brown 
1771438f35afSJed Brown    Logically Collective
1772438f35afSJed Brown 
1773438f35afSJed Brown    Input Arguments:
1774438f35afSJed Brown +  ts - time stepping context on which to change the transient variable
1775438f35afSJed Brown .  tvar - a function that transforms in-place to transient variables
1776438f35afSJed Brown -  ctx - a context for tvar
1777438f35afSJed Brown 
1778438f35afSJed Brown    Level: advanced
1779438f35afSJed Brown 
1780438f35afSJed Brown    Notes:
1781438f35afSJed Brown    This is typically used to transform from primitive to conservative variables so that a time integrator (e.g., TSBDF)
1782438f35afSJed Brown    can be conservative.  In this context, primitive variables P are used to model the state (e.g., because they lead to
1783438f35afSJed Brown    well-conditioned formulations even in limiting cases such as low-Mach or zero porosity).  The transient variable is
1784438f35afSJed Brown    C(P), specified by calling this function.  An IFunction thus receives arguments (P, Cdot) and the IJacobian must be
1785438f35afSJed Brown    evaluated via the chain rule, as in
1786438f35afSJed Brown 
1787438f35afSJed Brown      dF/dP + shift * dF/dCdot dC/dP.
1788438f35afSJed Brown 
1789438f35afSJed Brown .seealso: DMTSSetTransientVariable(), DMTSGetTransientVariable(), TSSetIFunction(), TSSetIJacobian()
1790438f35afSJed Brown @*/
1791438f35afSJed Brown PetscErrorCode TSSetTransientVariable(TS ts,TSTransientVariable tvar,void *ctx)
1792438f35afSJed Brown {
1793438f35afSJed Brown   PetscErrorCode ierr;
1794438f35afSJed Brown   DM             dm;
1795438f35afSJed Brown 
1796438f35afSJed Brown   PetscFunctionBegin;
1797438f35afSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1798438f35afSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1799438f35afSJed Brown   ierr = DMTSSetTransientVariable(dm,tvar,ctx);CHKERRQ(ierr);
1800438f35afSJed Brown   PetscFunctionReturn(0);
1801438f35afSJed Brown }
1802438f35afSJed Brown 
1803efe9872eSLisandro Dalcin /*@
1804e3c11fc1SJed Brown    TSComputeTransientVariable - transforms state (primitive) variables to transient (conservative) variables
1805e3c11fc1SJed Brown 
1806e3c11fc1SJed Brown    Logically Collective
1807e3c11fc1SJed Brown 
1808e3c11fc1SJed Brown    Input Parameters:
1809e3c11fc1SJed Brown +  ts - TS on which to compute
1810e3c11fc1SJed Brown -  U - state vector to be transformed to transient variables
1811e3c11fc1SJed Brown 
1812e3c11fc1SJed Brown    Output Parameters:
1813e3c11fc1SJed Brown .  C - transient (conservative) variable
1814e3c11fc1SJed Brown 
1815e3c11fc1SJed Brown    Developer Notes:
1816e3c11fc1SJed Brown    If DMTSSetTransientVariable() has not been called, then C is not modified in this routine and C=NULL is allowed.
1817e3c11fc1SJed Brown    This makes it safe to call without a guard.  One can use TSHasTransientVariable() to check if transient variables are
1818e3c11fc1SJed Brown    being used.
1819e3c11fc1SJed Brown 
1820e3c11fc1SJed Brown    Level: developer
1821e3c11fc1SJed Brown 
1822e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeIFunction(), TSComputeIJacobian()
1823e3c11fc1SJed Brown @*/
1824e3c11fc1SJed Brown PetscErrorCode TSComputeTransientVariable(TS ts,Vec U,Vec C)
1825e3c11fc1SJed Brown {
1826e3c11fc1SJed Brown   PetscErrorCode ierr;
1827e3c11fc1SJed Brown   DM             dm;
1828e3c11fc1SJed Brown   DMTS           dmts;
1829e3c11fc1SJed Brown 
1830e3c11fc1SJed Brown   PetscFunctionBegin;
1831e3c11fc1SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1832e3c11fc1SJed Brown   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
1833e3c11fc1SJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1834e3c11fc1SJed Brown   ierr = DMGetDMTS(dm,&dmts);CHKERRQ(ierr);
1835e3c11fc1SJed Brown   if (dmts->ops->transientvar) {
1836e3c11fc1SJed Brown     PetscValidHeaderSpecific(C,VEC_CLASSID,3);
1837e3c11fc1SJed Brown     ierr = (*dmts->ops->transientvar)(ts,U,C,dmts->transientvarctx);CHKERRQ(ierr);
1838e3c11fc1SJed Brown   }
1839e3c11fc1SJed Brown   PetscFunctionReturn(0);
1840e3c11fc1SJed Brown }
1841e3c11fc1SJed Brown 
1842e3c11fc1SJed Brown /*@
1843e3c11fc1SJed Brown    TSHasTransientVariable - determine whether transient variables have been set
1844e3c11fc1SJed Brown 
1845e3c11fc1SJed Brown    Logically Collective
1846e3c11fc1SJed Brown 
1847e3c11fc1SJed Brown    Input Parameters:
1848e3c11fc1SJed Brown .  ts - TS on which to compute
1849e3c11fc1SJed Brown 
1850e3c11fc1SJed Brown    Output Parameters:
1851e3c11fc1SJed Brown .  has - PETSC_TRUE if transient variables have been set
1852e3c11fc1SJed Brown 
1853e3c11fc1SJed Brown    Level: developer
1854e3c11fc1SJed Brown 
1855e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeTransientVariable()
1856e3c11fc1SJed Brown @*/
1857e3c11fc1SJed Brown PetscErrorCode TSHasTransientVariable(TS ts,PetscBool *has)
1858e3c11fc1SJed Brown {
1859e3c11fc1SJed Brown   PetscErrorCode ierr;
1860e3c11fc1SJed Brown   DM             dm;
1861e3c11fc1SJed Brown   DMTS           dmts;
1862e3c11fc1SJed Brown 
1863e3c11fc1SJed Brown   PetscFunctionBegin;
1864e3c11fc1SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1865e3c11fc1SJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1866e3c11fc1SJed Brown   ierr = DMGetDMTS(dm,&dmts);CHKERRQ(ierr);
1867e3c11fc1SJed Brown   *has = dmts->ops->transientvar ? PETSC_TRUE : PETSC_FALSE;
1868e3c11fc1SJed Brown   PetscFunctionReturn(0);
1869e3c11fc1SJed Brown }
1870e3c11fc1SJed Brown 
1871e3c11fc1SJed Brown /*@
1872efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1873efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1874efe9872eSLisandro Dalcin 
1875d083f849SBarry Smith    Logically Collective on TS
1876efe9872eSLisandro Dalcin 
1877efe9872eSLisandro Dalcin    Input Parameters:
1878efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1879efe9872eSLisandro Dalcin .  u - the solution vector
1880efe9872eSLisandro Dalcin -  v - the time derivative vector
1881efe9872eSLisandro Dalcin 
1882efe9872eSLisandro Dalcin    Level: beginner
1883efe9872eSLisandro Dalcin 
1884efe9872eSLisandro Dalcin @*/
1885efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1886efe9872eSLisandro Dalcin {
1887efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1888efe9872eSLisandro Dalcin 
1889efe9872eSLisandro Dalcin   PetscFunctionBegin;
1890efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1891efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1892efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1893efe9872eSLisandro Dalcin   ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
1894efe9872eSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr);
1895efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
1896efe9872eSLisandro Dalcin   ts->vec_dot = v;
1897efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1898efe9872eSLisandro Dalcin }
1899efe9872eSLisandro Dalcin 
1900efe9872eSLisandro Dalcin /*@
1901efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1902efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1903efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1904efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1905efe9872eSLisandro Dalcin 
1906efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1907efe9872eSLisandro Dalcin 
1908efe9872eSLisandro Dalcin    Input Parameter:
1909efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1910efe9872eSLisandro Dalcin 
1911efe9872eSLisandro Dalcin    Output Parameter:
1912efe9872eSLisandro Dalcin +  u - the vector containing the solution
1913efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1914efe9872eSLisandro Dalcin 
1915efe9872eSLisandro Dalcin    Level: intermediate
1916efe9872eSLisandro Dalcin 
1917efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1918efe9872eSLisandro Dalcin 
1919efe9872eSLisandro Dalcin @*/
1920efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1921efe9872eSLisandro Dalcin {
1922efe9872eSLisandro Dalcin   PetscFunctionBegin;
1923efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1924efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1925efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1926efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1927efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1928efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1929efe9872eSLisandro Dalcin }
1930efe9872eSLisandro Dalcin 
193155849f57SBarry Smith /*@C
193255849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
193355849f57SBarry Smith 
193455849f57SBarry Smith   Collective on PetscViewer
193555849f57SBarry Smith 
193655849f57SBarry Smith   Input Parameters:
193755849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
193855849f57SBarry Smith            some related function before a call to TSLoad().
193955849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
194055849f57SBarry Smith 
194155849f57SBarry Smith    Level: intermediate
194255849f57SBarry Smith 
194355849f57SBarry Smith   Notes:
194455849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
194555849f57SBarry Smith 
194655849f57SBarry Smith   Notes for advanced users:
194755849f57SBarry Smith   Most users should not need to know the details of the binary storage
194855849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
194955849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
195055849f57SBarry Smith   format is
195155849f57SBarry Smith .vb
195255849f57SBarry Smith      has not yet been determined
195355849f57SBarry Smith .ve
195455849f57SBarry Smith 
195555849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
195655849f57SBarry Smith @*/
1957f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
195855849f57SBarry Smith {
195955849f57SBarry Smith   PetscErrorCode ierr;
196055849f57SBarry Smith   PetscBool      isbinary;
196155849f57SBarry Smith   PetscInt       classid;
196255849f57SBarry Smith   char           type[256];
19632d53ad75SBarry Smith   DMTS           sdm;
1964ad6bc421SBarry Smith   DM             dm;
196555849f57SBarry Smith 
196655849f57SBarry Smith   PetscFunctionBegin;
1967f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
196855849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
196955849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
197055849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
197155849f57SBarry Smith 
1972060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1973ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1974060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1975f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1976f2c2a1b9SBarry Smith   if (ts->ops->load) {
1977f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1978f2c2a1b9SBarry Smith   }
1979ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1980ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1981ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1982f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1983f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
19842d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19852d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
198655849f57SBarry Smith   PetscFunctionReturn(0);
198755849f57SBarry Smith }
198855849f57SBarry Smith 
19899804daf3SBarry Smith #include <petscdraw.h>
1990e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1991e04113cfSBarry Smith #include <petscviewersaws.h>
1992f05ece33SBarry Smith #endif
1993fe2efc57SMark 
1994fe2efc57SMark /*@C
1995fe2efc57SMark    TSViewFromOptions - View from Options
1996fe2efc57SMark 
1997fe2efc57SMark    Collective on TS
1998fe2efc57SMark 
1999fe2efc57SMark    Input Parameters:
2000fe2efc57SMark +  A - the application ordering context
2001736c3998SJose E. Roman .  obj - Optional object
2002736c3998SJose E. Roman -  name - command line option
2003fe2efc57SMark 
2004fe2efc57SMark    Level: intermediate
2005fe2efc57SMark .seealso:  TS, TSView, PetscObjectViewFromOptions(), TSCreate()
2006fe2efc57SMark @*/
2007fe2efc57SMark PetscErrorCode  TSViewFromOptions(TS A,PetscObject obj,const char name[])
2008fe2efc57SMark {
2009fe2efc57SMark   PetscErrorCode ierr;
2010fe2efc57SMark 
2011fe2efc57SMark   PetscFunctionBegin;
2012fe2efc57SMark   PetscValidHeaderSpecific(A,TS_CLASSID,1);
2013fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)A,obj,name);CHKERRQ(ierr);
2014fe2efc57SMark   PetscFunctionReturn(0);
2015fe2efc57SMark }
2016fe2efc57SMark 
20177e2c5f70SBarry Smith /*@C
2018d763cef2SBarry Smith     TSView - Prints the TS data structure.
2019d763cef2SBarry Smith 
20204c49b128SBarry Smith     Collective on TS
2021d763cef2SBarry Smith 
2022d763cef2SBarry Smith     Input Parameters:
2023d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
2024d763cef2SBarry Smith -   viewer - visualization context
2025d763cef2SBarry Smith 
2026d763cef2SBarry Smith     Options Database Key:
2027d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
2028d763cef2SBarry Smith 
2029d763cef2SBarry Smith     Notes:
2030d763cef2SBarry Smith     The available visualization contexts include
2031b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
2032b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
2033d763cef2SBarry Smith          output where only the first processor opens
2034d763cef2SBarry Smith          the file.  All other processors send their
2035d763cef2SBarry Smith          data to the first processor to print.
2036d763cef2SBarry Smith 
2037d763cef2SBarry Smith     The user can open an alternative visualization context with
2038b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
2039d763cef2SBarry Smith 
2040d763cef2SBarry Smith     Level: beginner
2041d763cef2SBarry Smith 
2042b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
2043d763cef2SBarry Smith @*/
20447087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
2045d763cef2SBarry Smith {
2046dfbe8321SBarry Smith   PetscErrorCode ierr;
204719fd82e9SBarry Smith   TSType         type;
20482b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
20492d53ad75SBarry Smith   DMTS           sdm;
2050e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2051536b137fSBarry Smith   PetscBool      issaws;
2052f05ece33SBarry Smith #endif
2053d763cef2SBarry Smith 
2054d763cef2SBarry Smith   PetscFunctionBegin;
20550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20563050cee2SBarry Smith   if (!viewer) {
2057ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
20583050cee2SBarry Smith   }
20590700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
2060c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
2061fd16b177SBarry Smith 
2062251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
2063251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
206455849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
20652b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
2066e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2067536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
2068f05ece33SBarry Smith #endif
206932077d6dSBarry Smith   if (iascii) {
2070dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
2071efd4aadfSBarry Smith     if (ts->ops->view) {
2072efd4aadfSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2073efd4aadfSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
2074efd4aadfSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2075efd4aadfSBarry Smith     }
2076ef85077eSLisandro Dalcin     if (ts->max_steps < PETSC_MAX_INT) {
207777431f27SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
2078ef85077eSLisandro Dalcin     }
2079ef85077eSLisandro Dalcin     if (ts->max_time < PETSC_MAX_REAL) {
20807c8652ddSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
2081ef85077eSLisandro Dalcin     }
2082efd4aadfSBarry Smith     if (ts->usessnes) {
2083efd4aadfSBarry Smith       PetscBool lin;
2084d763cef2SBarry Smith       if (ts->problem_type == TS_NONLINEAR) {
20855ef26d82SJed Brown         ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
2086d763cef2SBarry Smith       }
20875ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
20881ef27442SStefano Zampini       ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&lin,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr);
2089efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr);
2090efd4aadfSBarry Smith     }
2091193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
2092a0af407cSBarry Smith     if (ts->vrtol) {
2093a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of relative error tolerances, ");CHKERRQ(ierr);
2094a0af407cSBarry Smith     } else {
2095a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr);
2096a0af407cSBarry Smith     }
2097a0af407cSBarry Smith     if (ts->vatol) {
2098a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of absolute error tolerances\n");CHKERRQ(ierr);
2099a0af407cSBarry Smith     } else {
2100a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr);
2101a0af407cSBarry Smith     }
2102825ab935SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2103efd4aadfSBarry Smith     ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);
2104825ab935SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21050f5bd95cSBarry Smith   } else if (isstring) {
2106a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
210736a9e3b9SBarry Smith     ierr = PetscViewerStringSPrintf(viewer," TSType: %-7.7s",type);CHKERRQ(ierr);
210836a9e3b9SBarry Smith     if (ts->ops->view) {ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);}
210955849f57SBarry Smith   } else if (isbinary) {
211055849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
211155849f57SBarry Smith     MPI_Comm    comm;
211255849f57SBarry Smith     PetscMPIInt rank;
211355849f57SBarry Smith     char        type[256];
211455849f57SBarry Smith 
211555849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
211655849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
211755849f57SBarry Smith     if (!rank) {
2118f253e43cSLisandro Dalcin       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
211955849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
2120f253e43cSLisandro Dalcin       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
212155849f57SBarry Smith     }
212255849f57SBarry Smith     if (ts->ops->view) {
212355849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
212455849f57SBarry Smith     }
2125efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2126f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
2127f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
21282d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
21292d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
21302b0a91c0SBarry Smith   } else if (isdraw) {
21312b0a91c0SBarry Smith     PetscDraw draw;
21322b0a91c0SBarry Smith     char      str[36];
213389fd9fafSBarry Smith     PetscReal x,y,bottom,h;
21342b0a91c0SBarry Smith 
21352b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
21362b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
21372b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
21382b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
213951fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
214089fd9fafSBarry Smith     bottom = y - h;
21412b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
21422b0a91c0SBarry Smith     if (ts->ops->view) {
21432b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
21442b0a91c0SBarry Smith     }
2145efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2146efd4aadfSBarry Smith     if (ts->snes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
21472b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2148e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2149536b137fSBarry Smith   } else if (issaws) {
2150d45a07a7SBarry Smith     PetscMPIInt rank;
21512657e9d9SBarry Smith     const char  *name;
21522657e9d9SBarry Smith 
21532657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
2154d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
2155d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
2156d45a07a7SBarry Smith       char       dir[1024];
2157d45a07a7SBarry Smith 
2158e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
2159a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
21602657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
21612657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
21622657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
2163d763cef2SBarry Smith     }
21640acecf5bSBarry Smith     if (ts->ops->view) {
21650acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
21660acecf5bSBarry Smith     }
2167f05ece33SBarry Smith #endif
2168f05ece33SBarry Smith   }
216936a9e3b9SBarry Smith   if (ts->snes && ts->usessnes)  {
217036a9e3b9SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
217136a9e3b9SBarry Smith     ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);
217236a9e3b9SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
217336a9e3b9SBarry Smith   }
217436a9e3b9SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
217536a9e3b9SBarry Smith   ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
2176f05ece33SBarry Smith 
2177b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2178251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
2179b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2180d763cef2SBarry Smith   PetscFunctionReturn(0);
2181d763cef2SBarry Smith }
2182d763cef2SBarry Smith 
2183b07ff414SBarry Smith /*@
2184d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2185d763cef2SBarry Smith    the timesteppers.
2186d763cef2SBarry Smith 
21873f9fe445SBarry Smith    Logically Collective on TS
2188d763cef2SBarry Smith 
2189d763cef2SBarry Smith    Input Parameters:
2190d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2191d763cef2SBarry Smith -  usrP - optional user context
2192d763cef2SBarry Smith 
219395452b02SPatrick Sanan    Fortran Notes:
219495452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2195daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2196daf670e6SBarry Smith 
2197d763cef2SBarry Smith    Level: intermediate
2198d763cef2SBarry Smith 
2199d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2200d763cef2SBarry Smith @*/
22017087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2202d763cef2SBarry Smith {
2203d763cef2SBarry Smith   PetscFunctionBegin;
22040700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2205d763cef2SBarry Smith   ts->user = usrP;
2206d763cef2SBarry Smith   PetscFunctionReturn(0);
2207d763cef2SBarry Smith }
2208d763cef2SBarry Smith 
2209b07ff414SBarry Smith /*@
2210d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2211d763cef2SBarry Smith     timestepper.
2212d763cef2SBarry Smith 
2213d763cef2SBarry Smith     Not Collective
2214d763cef2SBarry Smith 
2215d763cef2SBarry Smith     Input Parameter:
2216d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2217d763cef2SBarry Smith 
2218d763cef2SBarry Smith     Output Parameter:
2219d763cef2SBarry Smith .   usrP - user context
2220d763cef2SBarry Smith 
222195452b02SPatrick Sanan    Fortran Notes:
222295452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2223daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2224daf670e6SBarry Smith 
2225d763cef2SBarry Smith     Level: intermediate
2226d763cef2SBarry Smith 
2227d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2228d763cef2SBarry Smith @*/
2229e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2230d763cef2SBarry Smith {
2231d763cef2SBarry Smith   PetscFunctionBegin;
22320700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2233e71120c6SJed Brown   *(void**)usrP = ts->user;
2234d763cef2SBarry Smith   PetscFunctionReturn(0);
2235d763cef2SBarry Smith }
2236d763cef2SBarry Smith 
2237d763cef2SBarry Smith /*@
223880275a0aSLisandro Dalcin    TSGetStepNumber - Gets the number of steps completed.
2239d763cef2SBarry Smith 
2240d763cef2SBarry Smith    Not Collective
2241d763cef2SBarry Smith 
2242d763cef2SBarry Smith    Input Parameter:
2243d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2244d763cef2SBarry Smith 
2245d763cef2SBarry Smith    Output Parameter:
224680275a0aSLisandro Dalcin .  steps - number of steps completed so far
2247d763cef2SBarry Smith 
2248d763cef2SBarry Smith    Level: intermediate
2249d763cef2SBarry Smith 
22509be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2251d763cef2SBarry Smith @*/
225280275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps)
2253d763cef2SBarry Smith {
2254d763cef2SBarry Smith   PetscFunctionBegin;
22550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
225680275a0aSLisandro Dalcin   PetscValidIntPointer(steps,2);
225780275a0aSLisandro Dalcin   *steps = ts->steps;
225880275a0aSLisandro Dalcin   PetscFunctionReturn(0);
225980275a0aSLisandro Dalcin }
226080275a0aSLisandro Dalcin 
226180275a0aSLisandro Dalcin /*@
226280275a0aSLisandro Dalcin    TSSetStepNumber - Sets the number of steps completed.
226380275a0aSLisandro Dalcin 
226480275a0aSLisandro Dalcin    Logically Collective on TS
226580275a0aSLisandro Dalcin 
226680275a0aSLisandro Dalcin    Input Parameters:
226780275a0aSLisandro Dalcin +  ts - the TS context
226880275a0aSLisandro Dalcin -  steps - number of steps completed so far
226980275a0aSLisandro Dalcin 
227080275a0aSLisandro Dalcin    Notes:
227180275a0aSLisandro Dalcin    For most uses of the TS solvers the user need not explicitly call
227280275a0aSLisandro Dalcin    TSSetStepNumber(), as the step counter is appropriately updated in
227380275a0aSLisandro Dalcin    TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to
227480275a0aSLisandro Dalcin    reinitialize timestepping by setting the step counter to zero (and time
227580275a0aSLisandro Dalcin    to the initial time) to solve a similar problem with different initial
227680275a0aSLisandro Dalcin    conditions or parameters. Other possible use case is to continue
227780275a0aSLisandro Dalcin    timestepping from a previously interrupted run in such a way that TS
227880275a0aSLisandro Dalcin    monitors will be called with a initial nonzero step counter.
227980275a0aSLisandro Dalcin 
228080275a0aSLisandro Dalcin    Level: advanced
228180275a0aSLisandro Dalcin 
228280275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution()
228380275a0aSLisandro Dalcin @*/
228480275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps)
228580275a0aSLisandro Dalcin {
228680275a0aSLisandro Dalcin   PetscFunctionBegin;
228780275a0aSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
228880275a0aSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,steps,2);
228980275a0aSLisandro Dalcin   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative");
229080275a0aSLisandro Dalcin   ts->steps = steps;
2291d763cef2SBarry Smith   PetscFunctionReturn(0);
2292d763cef2SBarry Smith }
2293d763cef2SBarry Smith 
2294d763cef2SBarry Smith /*@
2295d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2296d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2297d763cef2SBarry Smith 
22983f9fe445SBarry Smith    Logically Collective on TS
2299d763cef2SBarry Smith 
2300d763cef2SBarry Smith    Input Parameters:
2301d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2302d763cef2SBarry Smith -  time_step - the size of the timestep
2303d763cef2SBarry Smith 
2304d763cef2SBarry Smith    Level: intermediate
2305d763cef2SBarry Smith 
2306aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime()
2307d763cef2SBarry Smith 
2308d763cef2SBarry Smith @*/
23097087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2310d763cef2SBarry Smith {
2311d763cef2SBarry Smith   PetscFunctionBegin;
23120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2313c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2314d763cef2SBarry Smith   ts->time_step = time_step;
2315d763cef2SBarry Smith   PetscFunctionReturn(0);
2316d763cef2SBarry Smith }
2317d763cef2SBarry Smith 
2318a43b19c4SJed Brown /*@
231949354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
232049354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
232149354f04SShri Abhyankar      or just return at the final time TS computed.
2322a43b19c4SJed Brown 
2323a43b19c4SJed Brown   Logically Collective on TS
2324a43b19c4SJed Brown 
2325a43b19c4SJed Brown    Input Parameter:
2326a43b19c4SJed Brown +   ts - the time-step context
232749354f04SShri Abhyankar -   eftopt - exact final time option
2328a43b19c4SJed Brown 
2329feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2330feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2331feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2332feed9e9dSBarry Smith 
2333feed9e9dSBarry Smith    Options Database:
2334feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2335feed9e9dSBarry Smith 
2336ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2337ee346746SBarry Smith     then the final time you selected.
2338ee346746SBarry Smith 
2339a43b19c4SJed Brown    Level: beginner
2340a43b19c4SJed Brown 
2341f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime()
2342a43b19c4SJed Brown @*/
234349354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2344a43b19c4SJed Brown {
2345a43b19c4SJed Brown   PetscFunctionBegin;
2346a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
234749354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
234849354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2349a43b19c4SJed Brown   PetscFunctionReturn(0);
2350a43b19c4SJed Brown }
2351a43b19c4SJed Brown 
2352d763cef2SBarry Smith /*@
2353f6953c82SLisandro Dalcin    TSGetExactFinalTime - Gets the exact final time option.
2354f6953c82SLisandro Dalcin 
2355f6953c82SLisandro Dalcin    Not Collective
2356f6953c82SLisandro Dalcin 
2357f6953c82SLisandro Dalcin    Input Parameter:
2358f6953c82SLisandro Dalcin .  ts - the TS context
2359f6953c82SLisandro Dalcin 
2360f6953c82SLisandro Dalcin    Output Parameter:
2361f6953c82SLisandro Dalcin .  eftopt - exact final time option
2362f6953c82SLisandro Dalcin 
2363f6953c82SLisandro Dalcin    Level: beginner
2364f6953c82SLisandro Dalcin 
2365f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime()
2366f6953c82SLisandro Dalcin @*/
2367f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt)
2368f6953c82SLisandro Dalcin {
2369f6953c82SLisandro Dalcin   PetscFunctionBegin;
2370f6953c82SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2371f6953c82SLisandro Dalcin   PetscValidPointer(eftopt,2);
2372f6953c82SLisandro Dalcin   *eftopt = ts->exact_final_time;
2373f6953c82SLisandro Dalcin   PetscFunctionReturn(0);
2374f6953c82SLisandro Dalcin }
2375f6953c82SLisandro Dalcin 
2376f6953c82SLisandro Dalcin /*@
2377d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2378d763cef2SBarry Smith 
2379d763cef2SBarry Smith    Not Collective
2380d763cef2SBarry Smith 
2381d763cef2SBarry Smith    Input Parameter:
2382d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2383d763cef2SBarry Smith 
2384d763cef2SBarry Smith    Output Parameter:
2385d763cef2SBarry Smith .  dt - the current timestep size
2386d763cef2SBarry Smith 
2387d763cef2SBarry Smith    Level: intermediate
2388d763cef2SBarry Smith 
2389aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime()
2390d763cef2SBarry Smith 
2391d763cef2SBarry Smith @*/
23927087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2393d763cef2SBarry Smith {
2394d763cef2SBarry Smith   PetscFunctionBegin;
23950700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2396f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2397d763cef2SBarry Smith   *dt = ts->time_step;
2398d763cef2SBarry Smith   PetscFunctionReturn(0);
2399d763cef2SBarry Smith }
2400d763cef2SBarry Smith 
2401d8e5e3e6SSatish Balay /*@
2402d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2403d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2404d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2405d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2406d763cef2SBarry Smith 
2407d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2408d763cef2SBarry Smith 
2409d763cef2SBarry Smith    Input Parameter:
2410d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2411d763cef2SBarry Smith 
2412d763cef2SBarry Smith    Output Parameter:
2413d763cef2SBarry Smith .  v - the vector containing the solution
2414d763cef2SBarry Smith 
241563e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
241663e21af5SBarry Smith    final time. It returns the solution at the next timestep.
241763e21af5SBarry Smith 
2418d763cef2SBarry Smith    Level: intermediate
2419d763cef2SBarry Smith 
24200ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction()
2421d763cef2SBarry Smith 
2422d763cef2SBarry Smith @*/
24237087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2424d763cef2SBarry Smith {
2425d763cef2SBarry Smith   PetscFunctionBegin;
24260700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24274482741eSBarry Smith   PetscValidPointer(v,2);
24288737fe31SLisandro Dalcin   *v = ts->vec_sol;
2429d763cef2SBarry Smith   PetscFunctionReturn(0);
2430d763cef2SBarry Smith }
2431d763cef2SBarry Smith 
243203fe5f5eSDebojyoti Ghosh /*@
2433b2bf4f3aSDebojyoti Ghosh    TSGetSolutionComponents - Returns any solution components at the present
243403fe5f5eSDebojyoti Ghosh    timestep, if available for the time integration method being used.
2435b2bf4f3aSDebojyoti Ghosh    Solution components are quantities that share the same size and
243603fe5f5eSDebojyoti Ghosh    structure as the solution vector.
243703fe5f5eSDebojyoti Ghosh 
243803fe5f5eSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
243903fe5f5eSDebojyoti Ghosh 
244003fe5f5eSDebojyoti Ghosh    Parameters :
2441a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2442b2bf4f3aSDebojyoti Ghosh .  n - If v is PETSC_NULL, then the number of solution components is
2443b2bf4f3aSDebojyoti Ghosh        returned through n, else the n-th solution component is
244403fe5f5eSDebojyoti Ghosh        returned in v.
2445a2b725a8SWilliam Gropp -  v - the vector containing the n-th solution component
244603fe5f5eSDebojyoti Ghosh        (may be PETSC_NULL to use this function to find out
2447b2bf4f3aSDebojyoti Ghosh         the number of solutions components).
244803fe5f5eSDebojyoti Ghosh 
24494cdd57e5SDebojyoti Ghosh    Level: advanced
245003fe5f5eSDebojyoti Ghosh 
245103fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution()
245203fe5f5eSDebojyoti Ghosh 
245303fe5f5eSDebojyoti Ghosh @*/
2454b2bf4f3aSDebojyoti Ghosh PetscErrorCode  TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v)
245503fe5f5eSDebojyoti Ghosh {
245603fe5f5eSDebojyoti Ghosh   PetscErrorCode ierr;
245703fe5f5eSDebojyoti Ghosh 
245803fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
245903fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2460b2bf4f3aSDebojyoti Ghosh   if (!ts->ops->getsolutioncomponents) *n = 0;
246103fe5f5eSDebojyoti Ghosh   else {
2462b2bf4f3aSDebojyoti Ghosh     ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr);
246303fe5f5eSDebojyoti Ghosh   }
246403fe5f5eSDebojyoti Ghosh   PetscFunctionReturn(0);
246503fe5f5eSDebojyoti Ghosh }
246603fe5f5eSDebojyoti Ghosh 
24674cdd57e5SDebojyoti Ghosh /*@
24684cdd57e5SDebojyoti Ghosh    TSGetAuxSolution - Returns an auxiliary solution at the present
24694cdd57e5SDebojyoti Ghosh    timestep, if available for the time integration method being used.
24704cdd57e5SDebojyoti Ghosh 
24714cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
24724cdd57e5SDebojyoti Ghosh 
24734cdd57e5SDebojyoti Ghosh    Parameters :
2474a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2475a2b725a8SWilliam Gropp -  v - the vector containing the auxiliary solution
24764cdd57e5SDebojyoti Ghosh 
24774cdd57e5SDebojyoti Ghosh    Level: intermediate
24784cdd57e5SDebojyoti Ghosh 
24794cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution()
24804cdd57e5SDebojyoti Ghosh 
24814cdd57e5SDebojyoti Ghosh @*/
24824cdd57e5SDebojyoti Ghosh PetscErrorCode  TSGetAuxSolution(TS ts,Vec *v)
24834cdd57e5SDebojyoti Ghosh {
24844cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
24854cdd57e5SDebojyoti Ghosh 
24864cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
24874cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2488f6356ec7SDebojyoti Ghosh   if (ts->ops->getauxsolution) {
24894cdd57e5SDebojyoti Ghosh     ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr);
2490f6356ec7SDebojyoti Ghosh   } else {
2491f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v); CHKERRQ(ierr);
2492f6356ec7SDebojyoti Ghosh   }
24934cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
24944cdd57e5SDebojyoti Ghosh }
24954cdd57e5SDebojyoti Ghosh 
24964cdd57e5SDebojyoti Ghosh /*@
24974cdd57e5SDebojyoti Ghosh    TSGetTimeError - Returns the estimated error vector, if the chosen
24984cdd57e5SDebojyoti Ghosh    TSType has an error estimation functionality.
24994cdd57e5SDebojyoti Ghosh 
25004cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
25014cdd57e5SDebojyoti Ghosh 
25029657682dSDebojyoti Ghosh    Note: MUST call after TSSetUp()
25039657682dSDebojyoti Ghosh 
25044cdd57e5SDebojyoti Ghosh    Parameters :
2505a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2506657c1e31SEmil Constantinescu .  n - current estimate (n=0) or previous one (n=-1)
2507a2b725a8SWilliam Gropp -  v - the vector containing the error (same size as the solution).
25084cdd57e5SDebojyoti Ghosh 
25094cdd57e5SDebojyoti Ghosh    Level: intermediate
25104cdd57e5SDebojyoti Ghosh 
251157df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError()
25124cdd57e5SDebojyoti Ghosh 
25134cdd57e5SDebojyoti Ghosh @*/
25140a01e1b2SEmil Constantinescu PetscErrorCode  TSGetTimeError(TS ts,PetscInt n,Vec *v)
25154cdd57e5SDebojyoti Ghosh {
25164cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
25174cdd57e5SDebojyoti Ghosh 
25184cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
25194cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2520f6356ec7SDebojyoti Ghosh   if (ts->ops->gettimeerror) {
25210a01e1b2SEmil Constantinescu     ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr);
2522f6356ec7SDebojyoti Ghosh   } else {
2523f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v);CHKERRQ(ierr);
2524f6356ec7SDebojyoti Ghosh   }
25254cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
25264cdd57e5SDebojyoti Ghosh }
25274cdd57e5SDebojyoti Ghosh 
252857df6a1bSDebojyoti Ghosh /*@
252957df6a1bSDebojyoti Ghosh    TSSetTimeError - Sets the estimated error vector, if the chosen
253057df6a1bSDebojyoti Ghosh    TSType has an error estimation functionality. This can be used
253157df6a1bSDebojyoti Ghosh    to restart such a time integrator with a given error vector.
253257df6a1bSDebojyoti Ghosh 
253357df6a1bSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
253457df6a1bSDebojyoti Ghosh 
253557df6a1bSDebojyoti Ghosh    Parameters :
2536a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2537a2b725a8SWilliam Gropp -  v - the vector containing the error (same size as the solution).
253857df6a1bSDebojyoti Ghosh 
253957df6a1bSDebojyoti Ghosh    Level: intermediate
254057df6a1bSDebojyoti Ghosh 
254157df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError)
254257df6a1bSDebojyoti Ghosh 
254357df6a1bSDebojyoti Ghosh @*/
254457df6a1bSDebojyoti Ghosh PetscErrorCode  TSSetTimeError(TS ts,Vec v)
254557df6a1bSDebojyoti Ghosh {
254657df6a1bSDebojyoti Ghosh   PetscErrorCode ierr;
254757df6a1bSDebojyoti Ghosh 
254857df6a1bSDebojyoti Ghosh   PetscFunctionBegin;
254957df6a1bSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25509657682dSDebojyoti Ghosh   if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first");
255157df6a1bSDebojyoti Ghosh   if (ts->ops->settimeerror) {
255257df6a1bSDebojyoti Ghosh     ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr);
255357df6a1bSDebojyoti Ghosh   }
255457df6a1bSDebojyoti Ghosh   PetscFunctionReturn(0);
255557df6a1bSDebojyoti Ghosh }
255657df6a1bSDebojyoti Ghosh 
2557bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
2558d8e5e3e6SSatish Balay /*@
2559bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2560d763cef2SBarry Smith 
2561bdad233fSMatthew Knepley   Not collective
2562d763cef2SBarry Smith 
2563bdad233fSMatthew Knepley   Input Parameters:
2564bdad233fSMatthew Knepley + ts   - The TS
2565bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2566d763cef2SBarry Smith .vb
25670910c330SBarry Smith          U_t - A U = 0      (linear)
25680910c330SBarry Smith          U_t - A(t) U = 0   (linear)
25690910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2570d763cef2SBarry Smith .ve
2571d763cef2SBarry Smith 
2572d763cef2SBarry Smith    Level: beginner
2573d763cef2SBarry Smith 
2574bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2575d763cef2SBarry Smith @*/
25767087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2577a7cc72afSBarry Smith {
25789e2a6581SJed Brown   PetscErrorCode ierr;
25799e2a6581SJed Brown 
2580d763cef2SBarry Smith   PetscFunctionBegin;
25810700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2582bdad233fSMatthew Knepley   ts->problem_type = type;
25839e2a6581SJed Brown   if (type == TS_LINEAR) {
25849e2a6581SJed Brown     SNES snes;
25859e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
25869e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
25879e2a6581SJed Brown   }
2588d763cef2SBarry Smith   PetscFunctionReturn(0);
2589d763cef2SBarry Smith }
2590d763cef2SBarry Smith 
2591bdad233fSMatthew Knepley /*@C
2592bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2593bdad233fSMatthew Knepley 
2594bdad233fSMatthew Knepley   Not collective
2595bdad233fSMatthew Knepley 
2596bdad233fSMatthew Knepley   Input Parameter:
2597bdad233fSMatthew Knepley . ts   - The TS
2598bdad233fSMatthew Knepley 
2599bdad233fSMatthew Knepley   Output Parameter:
2600bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2601bdad233fSMatthew Knepley .vb
2602089b2837SJed Brown          M U_t = A U
2603089b2837SJed Brown          M(t) U_t = A(t) U
2604b5abc632SBarry Smith          F(t,U,U_t)
2605bdad233fSMatthew Knepley .ve
2606bdad233fSMatthew Knepley 
2607bdad233fSMatthew Knepley    Level: beginner
2608bdad233fSMatthew Knepley 
2609bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2610bdad233fSMatthew Knepley @*/
26117087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2612a7cc72afSBarry Smith {
2613bdad233fSMatthew Knepley   PetscFunctionBegin;
26140700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
26154482741eSBarry Smith   PetscValidIntPointer(type,2);
2616bdad233fSMatthew Knepley   *type = ts->problem_type;
2617bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2618bdad233fSMatthew Knepley }
2619d763cef2SBarry Smith 
2620d763cef2SBarry Smith /*@
2621d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
2622d763cef2SBarry Smith    of a timestepper.
2623d763cef2SBarry Smith 
2624d763cef2SBarry Smith    Collective on TS
2625d763cef2SBarry Smith 
2626d763cef2SBarry Smith    Input Parameter:
2627d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2628d763cef2SBarry Smith 
2629d763cef2SBarry Smith    Notes:
2630d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2631d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2632141bd67dSStefano Zampini    the call to TSStep() or TSSolve().  However, if one wishes to control this
2633d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2634141bd67dSStefano Zampini    and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve().
2635d763cef2SBarry Smith 
2636d763cef2SBarry Smith    Level: advanced
2637d763cef2SBarry Smith 
2638141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve()
2639d763cef2SBarry Smith @*/
26407087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2641d763cef2SBarry Smith {
2642dfbe8321SBarry Smith   PetscErrorCode ierr;
26436c6b9e74SPeter Brune   DM             dm;
26446c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2645d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2646cd11d68dSLisandro Dalcin   TSIFunction    ifun;
26476c6b9e74SPeter Brune   TSIJacobian    ijac;
2648efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
26496c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
26502ffb9264SLisandro Dalcin   PetscBool      isnone;
2651d763cef2SBarry Smith 
2652d763cef2SBarry Smith   PetscFunctionBegin;
26530700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2654277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2655277b19d0SLisandro Dalcin 
26567adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2657cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
2658cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
2659d763cef2SBarry Smith   }
2660277b19d0SLisandro Dalcin 
26611a638600SStefano Zampini   if (!ts->vec_sol) {
26621a638600SStefano Zampini     if (ts->dm) {
26631a638600SStefano Zampini       ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
26641a638600SStefano Zampini     } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
26651a638600SStefano Zampini   }
2666277b19d0SLisandro Dalcin 
2667298bade4SHong Zhang   if (!ts->Jacp && ts->Jacprhs) { /* IJacobianP shares the same matrix with RHSJacobianP if only RHSJacobianP is provided */
2668298bade4SHong Zhang     ierr = PetscObjectReference((PetscObject)ts->Jacprhs);CHKERRQ(ierr);
2669298bade4SHong Zhang     ts->Jacp = ts->Jacprhs;
2670298bade4SHong Zhang   }
2671298bade4SHong Zhang 
2672cd4cee2dSHong Zhang   if (ts->quadraturets) {
2673cd4cee2dSHong Zhang     ierr = TSSetUp(ts->quadraturets);CHKERRQ(ierr);
2674ecf68647SHong Zhang     ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2675cd4cee2dSHong Zhang     ierr = VecDuplicate(ts->quadraturets->vec_sol,&ts->vec_costintegrand);CHKERRQ(ierr);
2676cd4cee2dSHong Zhang   }
2677cd4cee2dSHong Zhang 
2678971015bcSStefano Zampini   ierr = TSGetRHSJacobian(ts,NULL,NULL,&rhsjac,NULL);CHKERRQ(ierr);
2679971015bcSStefano Zampini   if (ts->rhsjacobian.reuse && rhsjac == TSComputeRHSJacobianConstant) {
2680e1244c69SJed Brown     Mat Amat,Pmat;
2681e1244c69SJed Brown     SNES snes;
2682e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2683e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2684e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2685e1244c69SJed Brown      * have displaced the RHS matrix */
2686971015bcSStefano Zampini     if (Amat && Amat == ts->Arhs) {
2687abc0d4abSBarry 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 */
2688abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2689e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2690e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2691e1244c69SJed Brown     }
2692971015bcSStefano Zampini     if (Pmat && Pmat == ts->Brhs) {
2693abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2694e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2695e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2696e1244c69SJed Brown     }
2697e1244c69SJed Brown   }
26982ffb9264SLisandro Dalcin 
26992ffb9264SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
27002ffb9264SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
27012ffb9264SLisandro Dalcin 
2702277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2703000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2704277b19d0SLisandro Dalcin   }
2705277b19d0SLisandro Dalcin 
27062ffb9264SLisandro Dalcin   /* Attempt to check/preset a default value for the exact final time option */
27072ffb9264SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr);
27082ffb9264SLisandro Dalcin   if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED)
27092ffb9264SLisandro Dalcin     ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP;
27102ffb9264SLisandro Dalcin 
2711a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
27126c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
27136c6b9e74SPeter Brune    */
27146c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
27150298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
27166c6b9e74SPeter Brune   if (!func) {
27176c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
27186c6b9e74SPeter Brune   }
2719a6772fa2SLisandro 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.
27206c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
27216c6b9e74SPeter Brune    */
27220298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
27230298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
2724efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr);
27250298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
2726efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
27276c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
27286c6b9e74SPeter Brune   }
2729c0517034SDebojyoti Ghosh 
2730c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2731c0517034SDebojyoti Ghosh   if (ts->ops->startingmethod) {
2732c0517034SDebojyoti Ghosh     ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr);
2733c0517034SDebojyoti Ghosh   }
2734c0517034SDebojyoti Ghosh 
2735277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2736277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2737277b19d0SLisandro Dalcin }
2738277b19d0SLisandro Dalcin 
2739f6a906c0SBarry Smith /*@
2740277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2741277b19d0SLisandro Dalcin 
2742277b19d0SLisandro Dalcin    Collective on TS
2743277b19d0SLisandro Dalcin 
2744277b19d0SLisandro Dalcin    Input Parameter:
2745277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2746277b19d0SLisandro Dalcin 
2747277b19d0SLisandro Dalcin    Level: beginner
2748277b19d0SLisandro Dalcin 
2749277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2750277b19d0SLisandro Dalcin @*/
2751277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2752277b19d0SLisandro Dalcin {
27531d06f6b3SHong Zhang   TS_RHSSplitLink ilink = ts->tsrhssplit,next;
2754277b19d0SLisandro Dalcin   PetscErrorCode  ierr;
2755277b19d0SLisandro Dalcin 
2756277b19d0SLisandro Dalcin   PetscFunctionBegin;
2757277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2758b18ea86cSHong Zhang 
2759277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2760277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2761277b19d0SLisandro Dalcin   }
2762277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2763e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2764bbd56ea5SKarl Rupp 
27654e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
27664e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2767214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
27686bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2769efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
2770e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2771e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
277238637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2773bbd56ea5SKarl Rupp 
2774cd4cee2dSHong Zhang   ierr = MatDestroy(&ts->Jacprhs);CHKERRQ(ierr);
2775ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2776ecf68647SHong Zhang   if (ts->forward_solve) {
2777ecf68647SHong Zhang     ierr = TSForwardReset(ts);CHKERRQ(ierr);
2778ecf68647SHong Zhang   }
2779cd4cee2dSHong Zhang   if (ts->quadraturets) {
2780cd4cee2dSHong Zhang     ierr = TSReset(ts->quadraturets);CHKERRQ(ierr);
278136eaed60SHong Zhang     ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2782cd4cee2dSHong Zhang   }
27831d06f6b3SHong Zhang   while (ilink) {
27841d06f6b3SHong Zhang     next = ilink->next;
27851d06f6b3SHong Zhang     ierr = TSDestroy(&ilink->ts);CHKERRQ(ierr);
27861d06f6b3SHong Zhang     ierr = PetscFree(ilink->splitname);CHKERRQ(ierr);
27871d06f6b3SHong Zhang     ierr = ISDestroy(&ilink->is);CHKERRQ(ierr);
27881d06f6b3SHong Zhang     ierr = PetscFree(ilink);CHKERRQ(ierr);
27891d06f6b3SHong Zhang     ilink = next;
279087f4e208SHong Zhang   }
2791545aaa6fSHong Zhang   ts->num_rhs_splits = 0;
2792277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2793d763cef2SBarry Smith   PetscFunctionReturn(0);
2794d763cef2SBarry Smith }
2795d763cef2SBarry Smith 
2796d8e5e3e6SSatish Balay /*@
2797d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2798d763cef2SBarry Smith    with TSCreate().
2799d763cef2SBarry Smith 
2800d763cef2SBarry Smith    Collective on TS
2801d763cef2SBarry Smith 
2802d763cef2SBarry Smith    Input Parameter:
2803d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2804d763cef2SBarry Smith 
2805d763cef2SBarry Smith    Level: beginner
2806d763cef2SBarry Smith 
2807d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2808d763cef2SBarry Smith @*/
28096bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2810d763cef2SBarry Smith {
28116849ba73SBarry Smith   PetscErrorCode ierr;
2812d763cef2SBarry Smith 
2813d763cef2SBarry Smith   PetscFunctionBegin;
28146bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
2815ecf68647SHong Zhang   PetscValidHeaderSpecific(*ts,TS_CLASSID,1);
2816c793f718SLisandro Dalcin   if (--((PetscObject)(*ts))->refct > 0) {*ts = NULL; PetscFunctionReturn(0);}
2817d763cef2SBarry Smith 
2818ecf68647SHong Zhang   ierr = TSReset(*ts);CHKERRQ(ierr);
2819ecf68647SHong Zhang   ierr = TSAdjointReset(*ts);CHKERRQ(ierr);
2820ecf68647SHong Zhang   if ((*ts)->forward_solve) {
2821ecf68647SHong Zhang     ierr = TSForwardReset(*ts);CHKERRQ(ierr);
2822ecf68647SHong Zhang   }
2823e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2824e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
28256bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
28266d4c513bSLisandro Dalcin 
2827bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2828bc952696SBarry Smith 
282984df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
28306427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
28316427ac75SLisandro Dalcin 
28326bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
28336bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
28346bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
28350dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
28366d4c513bSLisandro Dalcin 
2837cd4cee2dSHong Zhang   ierr = TSDestroy(&(*ts)->quadraturets);CHKERRQ(ierr);
2838a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2839d763cef2SBarry Smith   PetscFunctionReturn(0);
2840d763cef2SBarry Smith }
2841d763cef2SBarry Smith 
2842d8e5e3e6SSatish Balay /*@
2843d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2844d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2845d763cef2SBarry Smith 
2846d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2847d763cef2SBarry Smith 
2848d763cef2SBarry Smith    Input Parameter:
2849d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2850d763cef2SBarry Smith 
2851d763cef2SBarry Smith    Output Parameter:
2852d763cef2SBarry Smith .  snes - the nonlinear solver context
2853d763cef2SBarry Smith 
2854d763cef2SBarry Smith    Notes:
2855d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2856d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
285794b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2858d763cef2SBarry Smith 
2859d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
28600298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2861d763cef2SBarry Smith 
2862d763cef2SBarry Smith    Level: beginner
2863d763cef2SBarry Smith 
2864d763cef2SBarry Smith @*/
28657087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2866d763cef2SBarry Smith {
2867d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2868d372ba47SLisandro Dalcin 
2869d763cef2SBarry Smith   PetscFunctionBegin;
28700700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28714482741eSBarry Smith   PetscValidPointer(snes,2);
2872d372ba47SLisandro Dalcin   if (!ts->snes) {
2873ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
287416413a6aSBarry Smith     ierr = PetscObjectSetOptions((PetscObject)ts->snes,((PetscObject)ts)->options);CHKERRQ(ierr);
28750298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
28763bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2877d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2878496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
28799e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
28809e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
28819e2a6581SJed Brown     }
2882d372ba47SLisandro Dalcin   }
2883d763cef2SBarry Smith   *snes = ts->snes;
2884d763cef2SBarry Smith   PetscFunctionReturn(0);
2885d763cef2SBarry Smith }
2886d763cef2SBarry Smith 
2887deb2cd25SJed Brown /*@
2888deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2889deb2cd25SJed Brown 
2890deb2cd25SJed Brown    Collective
2891deb2cd25SJed Brown 
2892deb2cd25SJed Brown    Input Parameter:
2893deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2894deb2cd25SJed Brown -  snes - the nonlinear solver context
2895deb2cd25SJed Brown 
2896deb2cd25SJed Brown    Notes:
2897deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2898deb2cd25SJed Brown 
2899deb2cd25SJed Brown    Level: developer
2900deb2cd25SJed Brown 
2901deb2cd25SJed Brown @*/
2902deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2903deb2cd25SJed Brown {
2904deb2cd25SJed Brown   PetscErrorCode ierr;
2905d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2906deb2cd25SJed Brown 
2907deb2cd25SJed Brown   PetscFunctionBegin;
2908deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2909deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2910deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2911deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2912bbd56ea5SKarl Rupp 
2913deb2cd25SJed Brown   ts->snes = snes;
2914bbd56ea5SKarl Rupp 
29150298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
29160298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2917740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
29180298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2919740132f1SEmil Constantinescu   }
2920deb2cd25SJed Brown   PetscFunctionReturn(0);
2921deb2cd25SJed Brown }
2922deb2cd25SJed Brown 
2923d8e5e3e6SSatish Balay /*@
292494b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2925d763cef2SBarry Smith    a TS (timestepper) context.
2926d763cef2SBarry Smith 
292794b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2928d763cef2SBarry Smith 
2929d763cef2SBarry Smith    Input Parameter:
2930d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2931d763cef2SBarry Smith 
2932d763cef2SBarry Smith    Output Parameter:
293394b7f48cSBarry Smith .  ksp - the nonlinear solver context
2934d763cef2SBarry Smith 
2935d763cef2SBarry Smith    Notes:
293694b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2937d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2938d763cef2SBarry Smith    KSP and PC contexts as well.
2939d763cef2SBarry Smith 
294094b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
29410298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2942d763cef2SBarry Smith 
2943d763cef2SBarry Smith    Level: beginner
2944d763cef2SBarry Smith 
2945d763cef2SBarry Smith @*/
29467087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2947d763cef2SBarry Smith {
2948d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2949089b2837SJed Brown   SNES           snes;
2950d372ba47SLisandro Dalcin 
2951d763cef2SBarry Smith   PetscFunctionBegin;
29520700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29534482741eSBarry Smith   PetscValidPointer(ksp,2);
295417186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2955e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2956089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2957089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2958d763cef2SBarry Smith   PetscFunctionReturn(0);
2959d763cef2SBarry Smith }
2960d763cef2SBarry Smith 
2961d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2962d763cef2SBarry Smith 
2963adb62b0dSMatthew Knepley /*@
2964618ce8baSLisandro Dalcin    TSSetMaxSteps - Sets the maximum number of steps to use.
2965618ce8baSLisandro Dalcin 
2966618ce8baSLisandro Dalcin    Logically Collective on TS
2967618ce8baSLisandro Dalcin 
2968618ce8baSLisandro Dalcin    Input Parameters:
2969618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2970618ce8baSLisandro Dalcin -  maxsteps - maximum number of steps to use
2971618ce8baSLisandro Dalcin 
2972618ce8baSLisandro Dalcin    Options Database Keys:
2973618ce8baSLisandro Dalcin .  -ts_max_steps <maxsteps> - Sets maxsteps
2974618ce8baSLisandro Dalcin 
2975618ce8baSLisandro Dalcin    Notes:
2976618ce8baSLisandro Dalcin    The default maximum number of steps is 5000
2977618ce8baSLisandro Dalcin 
2978618ce8baSLisandro Dalcin    Level: intermediate
2979618ce8baSLisandro Dalcin 
2980618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime()
2981618ce8baSLisandro Dalcin @*/
2982618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps)
2983618ce8baSLisandro Dalcin {
2984618ce8baSLisandro Dalcin   PetscFunctionBegin;
2985618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2986618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2987618ce8baSLisandro Dalcin   if (maxsteps < 0 ) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative");
2988618ce8baSLisandro Dalcin   ts->max_steps = maxsteps;
2989618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2990618ce8baSLisandro Dalcin }
2991618ce8baSLisandro Dalcin 
2992618ce8baSLisandro Dalcin /*@
2993618ce8baSLisandro Dalcin    TSGetMaxSteps - Gets the maximum number of steps to use.
2994618ce8baSLisandro Dalcin 
2995618ce8baSLisandro Dalcin    Not Collective
2996618ce8baSLisandro Dalcin 
2997618ce8baSLisandro Dalcin    Input Parameters:
2998618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2999618ce8baSLisandro Dalcin 
3000618ce8baSLisandro Dalcin    Output Parameter:
3001618ce8baSLisandro Dalcin .  maxsteps - maximum number of steps to use
3002618ce8baSLisandro Dalcin 
3003618ce8baSLisandro Dalcin    Level: advanced
3004618ce8baSLisandro Dalcin 
3005618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime()
3006618ce8baSLisandro Dalcin @*/
3007618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps)
3008618ce8baSLisandro Dalcin {
3009618ce8baSLisandro Dalcin   PetscFunctionBegin;
3010618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3011618ce8baSLisandro Dalcin   PetscValidIntPointer(maxsteps,2);
3012618ce8baSLisandro Dalcin   *maxsteps = ts->max_steps;
3013618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3014618ce8baSLisandro Dalcin }
3015618ce8baSLisandro Dalcin 
3016618ce8baSLisandro Dalcin /*@
3017618ce8baSLisandro Dalcin    TSSetMaxTime - Sets the maximum (or final) time for timestepping.
3018618ce8baSLisandro Dalcin 
3019618ce8baSLisandro Dalcin    Logically Collective on TS
3020618ce8baSLisandro Dalcin 
3021618ce8baSLisandro Dalcin    Input Parameters:
3022618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
3023618ce8baSLisandro Dalcin -  maxtime - final time to step to
3024618ce8baSLisandro Dalcin 
3025618ce8baSLisandro Dalcin    Options Database Keys:
3026ef85077eSLisandro Dalcin .  -ts_max_time <maxtime> - Sets maxtime
3027618ce8baSLisandro Dalcin 
3028618ce8baSLisandro Dalcin    Notes:
3029618ce8baSLisandro Dalcin    The default maximum time is 5.0
3030618ce8baSLisandro Dalcin 
3031618ce8baSLisandro Dalcin    Level: intermediate
3032618ce8baSLisandro Dalcin 
3033618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime()
3034618ce8baSLisandro Dalcin @*/
3035618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime)
3036618ce8baSLisandro Dalcin {
3037618ce8baSLisandro Dalcin   PetscFunctionBegin;
3038618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3039618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveReal(ts,maxtime,2);
3040618ce8baSLisandro Dalcin   ts->max_time = maxtime;
3041618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3042618ce8baSLisandro Dalcin }
3043618ce8baSLisandro Dalcin 
3044618ce8baSLisandro Dalcin /*@
3045618ce8baSLisandro Dalcin    TSGetMaxTime - Gets the maximum (or final) time for timestepping.
3046618ce8baSLisandro Dalcin 
3047618ce8baSLisandro Dalcin    Not Collective
3048618ce8baSLisandro Dalcin 
3049618ce8baSLisandro Dalcin    Input Parameters:
3050618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
3051618ce8baSLisandro Dalcin 
3052618ce8baSLisandro Dalcin    Output Parameter:
3053618ce8baSLisandro Dalcin .  maxtime - final time to step to
3054618ce8baSLisandro Dalcin 
3055618ce8baSLisandro Dalcin    Level: advanced
3056618ce8baSLisandro Dalcin 
3057618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps()
3058618ce8baSLisandro Dalcin @*/
3059618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime)
3060618ce8baSLisandro Dalcin {
3061618ce8baSLisandro Dalcin   PetscFunctionBegin;
3062618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3063618ce8baSLisandro Dalcin   PetscValidRealPointer(maxtime,2);
3064618ce8baSLisandro Dalcin   *maxtime = ts->max_time;
3065618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3066618ce8baSLisandro Dalcin }
3067618ce8baSLisandro Dalcin 
3068618ce8baSLisandro Dalcin /*@
3069aaa6c58dSLisandro Dalcin    TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep().
3070edc382c3SSatish Balay 
3071edc382c3SSatish Balay    Level: deprecated
3072edc382c3SSatish Balay 
3073aaa6c58dSLisandro Dalcin @*/
3074aaa6c58dSLisandro Dalcin PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
3075aaa6c58dSLisandro Dalcin {
3076aaa6c58dSLisandro Dalcin   PetscErrorCode ierr;
3077aaa6c58dSLisandro Dalcin   PetscFunctionBegin;
3078aaa6c58dSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3079aaa6c58dSLisandro Dalcin   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
3080aaa6c58dSLisandro Dalcin   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
3081aaa6c58dSLisandro Dalcin   PetscFunctionReturn(0);
3082aaa6c58dSLisandro Dalcin }
3083aaa6c58dSLisandro Dalcin 
3084aaa6c58dSLisandro Dalcin /*@
308519eac22cSLisandro Dalcin    TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime().
3086edc382c3SSatish Balay 
3087edc382c3SSatish Balay    Level: deprecated
3088edc382c3SSatish Balay 
3089adb62b0dSMatthew Knepley @*/
30907087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
3091adb62b0dSMatthew Knepley {
3092adb62b0dSMatthew Knepley   PetscFunctionBegin;
30930700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3094abc0a331SBarry Smith   if (maxsteps) {
30954482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
3096adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
3097adb62b0dSMatthew Knepley   }
3098abc0a331SBarry Smith   if (maxtime) {
30994482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
3100adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
3101adb62b0dSMatthew Knepley   }
3102adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
3103adb62b0dSMatthew Knepley }
3104adb62b0dSMatthew Knepley 
3105d763cef2SBarry Smith /*@
310619eac22cSLisandro Dalcin    TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime().
3107edc382c3SSatish Balay 
3108edc382c3SSatish Balay    Level: deprecated
3109edc382c3SSatish Balay 
3110d763cef2SBarry Smith @*/
31117087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
3112d763cef2SBarry Smith {
3113d763cef2SBarry Smith   PetscFunctionBegin;
31140700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3115c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
3116c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
311739b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
311839b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
3119d763cef2SBarry Smith   PetscFunctionReturn(0);
3120d763cef2SBarry Smith }
3121d763cef2SBarry Smith 
3122d763cef2SBarry Smith /*@
31235c5f5948SLisandro Dalcin    TSGetTimeStepNumber - Deprecated, use TSGetStepNumber().
3124edc382c3SSatish Balay 
3125edc382c3SSatish Balay    Level: deprecated
3126edc382c3SSatish Balay 
31275c5f5948SLisandro Dalcin @*/
3128e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31295c5f5948SLisandro Dalcin 
313019eac22cSLisandro Dalcin /*@
31314f4e0956SLisandro Dalcin    TSGetTotalSteps - Deprecated, use TSGetStepNumber().
3132edc382c3SSatish Balay 
3133edc382c3SSatish Balay    Level: deprecated
3134edc382c3SSatish Balay 
31354f4e0956SLisandro Dalcin @*/
31364f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31374f4e0956SLisandro Dalcin 
31384f4e0956SLisandro Dalcin /*@
3139d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
3140d763cef2SBarry Smith    for use by the TS routines.
3141d763cef2SBarry Smith 
3142d083f849SBarry Smith    Logically Collective on TS
3143d763cef2SBarry Smith 
3144d763cef2SBarry Smith    Input Parameters:
3145d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
31460910c330SBarry Smith -  u - the solution vector
3147d763cef2SBarry Smith 
3148d763cef2SBarry Smith    Level: beginner
3149d763cef2SBarry Smith 
31500ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate()
3151d763cef2SBarry Smith @*/
31520910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
3153d763cef2SBarry Smith {
31548737fe31SLisandro Dalcin   PetscErrorCode ierr;
3155496e6a7aSJed Brown   DM             dm;
31568737fe31SLisandro Dalcin 
3157d763cef2SBarry Smith   PetscFunctionBegin;
31580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31590910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
31600910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
31616bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
31620910c330SBarry Smith   ts->vec_sol = u;
3163bbd56ea5SKarl Rupp 
3164496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
31650910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
3166d763cef2SBarry Smith   PetscFunctionReturn(0);
3167d763cef2SBarry Smith }
3168d763cef2SBarry Smith 
3169ac226902SBarry Smith /*@C
3170000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
31713f2090d5SJed Brown   called once at the beginning of each time step.
3172000e7ae3SMatthew Knepley 
31733f9fe445SBarry Smith   Logically Collective on TS
3174000e7ae3SMatthew Knepley 
3175000e7ae3SMatthew Knepley   Input Parameters:
3176000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3177000e7ae3SMatthew Knepley - func - The function
3178000e7ae3SMatthew Knepley 
3179000e7ae3SMatthew Knepley   Calling sequence of func:
31806bc98fa9SBarry Smith .   PetscErrorCode func (TS ts);
3181000e7ae3SMatthew Knepley 
3182000e7ae3SMatthew Knepley   Level: intermediate
3183000e7ae3SMatthew Knepley 
3184dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep()
3185000e7ae3SMatthew Knepley @*/
31867087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3187000e7ae3SMatthew Knepley {
3188000e7ae3SMatthew Knepley   PetscFunctionBegin;
31890700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3190ae60f76fSBarry Smith   ts->prestep = func;
3191000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3192000e7ae3SMatthew Knepley }
3193000e7ae3SMatthew Knepley 
319409ee8438SJed Brown /*@
31953f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
31963f2090d5SJed Brown 
31973f2090d5SJed Brown   Collective on TS
31983f2090d5SJed Brown 
31993f2090d5SJed Brown   Input Parameters:
32003f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
32013f2090d5SJed Brown 
32023f2090d5SJed Brown   Notes:
32033f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
32043f2090d5SJed Brown   so most users would not generally call this routine themselves.
32053f2090d5SJed Brown 
32063f2090d5SJed Brown   Level: developer
32073f2090d5SJed Brown 
32089be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
32093f2090d5SJed Brown @*/
32107087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
32113f2090d5SJed Brown {
32123f2090d5SJed Brown   PetscErrorCode ierr;
32133f2090d5SJed Brown 
32143f2090d5SJed Brown   PetscFunctionBegin;
32150700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3216ae60f76fSBarry Smith   if (ts->prestep) {
32175efd42a4SStefano Zampini     Vec              U;
32185efd42a4SStefano Zampini     PetscObjectState sprev,spost;
32195efd42a4SStefano Zampini 
32205efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
32215efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3222ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
32235efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3224dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3225312ce896SJed Brown   }
32263f2090d5SJed Brown   PetscFunctionReturn(0);
32273f2090d5SJed Brown }
32283f2090d5SJed Brown 
3229b8123daeSJed Brown /*@C
3230b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3231b8123daeSJed Brown   called once at the beginning of each stage.
3232b8123daeSJed Brown 
3233b8123daeSJed Brown   Logically Collective on TS
3234b8123daeSJed Brown 
3235b8123daeSJed Brown   Input Parameters:
3236b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3237b8123daeSJed Brown - func - The function
3238b8123daeSJed Brown 
3239b8123daeSJed Brown   Calling sequence of func:
3240b8123daeSJed Brown .    PetscErrorCode func(TS ts, PetscReal stagetime);
3241b8123daeSJed Brown 
3242b8123daeSJed Brown   Level: intermediate
3243b8123daeSJed Brown 
3244b8123daeSJed Brown   Note:
3245b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
324680275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
3247b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3248b8123daeSJed Brown 
32499be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3250b8123daeSJed Brown @*/
3251b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3252b8123daeSJed Brown {
3253b8123daeSJed Brown   PetscFunctionBegin;
3254b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3255ae60f76fSBarry Smith   ts->prestage = func;
3256b8123daeSJed Brown   PetscFunctionReturn(0);
3257b8123daeSJed Brown }
3258b8123daeSJed Brown 
32599be3e283SDebojyoti Ghosh /*@C
32609be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
32619be3e283SDebojyoti Ghosh   called once at the end of each stage.
32629be3e283SDebojyoti Ghosh 
32639be3e283SDebojyoti Ghosh   Logically Collective on TS
32649be3e283SDebojyoti Ghosh 
32659be3e283SDebojyoti Ghosh   Input Parameters:
32669be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
32679be3e283SDebojyoti Ghosh - func - The function
32689be3e283SDebojyoti Ghosh 
32699be3e283SDebojyoti Ghosh   Calling sequence of func:
32709be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
32719be3e283SDebojyoti Ghosh 
32729be3e283SDebojyoti Ghosh   Level: intermediate
32739be3e283SDebojyoti Ghosh 
32749be3e283SDebojyoti Ghosh   Note:
32759be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
327680275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
32779be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
32789be3e283SDebojyoti Ghosh 
32799be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
32809be3e283SDebojyoti Ghosh @*/
32819be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
32829be3e283SDebojyoti Ghosh {
32839be3e283SDebojyoti Ghosh   PetscFunctionBegin;
32849be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
32859be3e283SDebojyoti Ghosh   ts->poststage = func;
32869be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
32879be3e283SDebojyoti Ghosh }
32889be3e283SDebojyoti Ghosh 
3289c688d042SShri Abhyankar /*@C
3290c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3291c688d042SShri Abhyankar   called once at the end of each step evaluation.
3292c688d042SShri Abhyankar 
3293c688d042SShri Abhyankar   Logically Collective on TS
3294c688d042SShri Abhyankar 
3295c688d042SShri Abhyankar   Input Parameters:
3296c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3297c688d042SShri Abhyankar - func - The function
3298c688d042SShri Abhyankar 
3299c688d042SShri Abhyankar   Calling sequence of func:
3300c688d042SShri Abhyankar . PetscErrorCode func(TS ts);
3301c688d042SShri Abhyankar 
3302c688d042SShri Abhyankar   Level: intermediate
3303c688d042SShri Abhyankar 
3304c688d042SShri Abhyankar   Note:
33051785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
33061785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3307e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3308e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3309e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3310c688d042SShri Abhyankar 
3311c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3312c688d042SShri Abhyankar @*/
3313c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3314c688d042SShri Abhyankar {
3315c688d042SShri Abhyankar   PetscFunctionBegin;
3316c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3317c688d042SShri Abhyankar   ts->postevaluate = func;
3318c688d042SShri Abhyankar   PetscFunctionReturn(0);
3319c688d042SShri Abhyankar }
3320c688d042SShri Abhyankar 
3321b8123daeSJed Brown /*@
3322b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3323b8123daeSJed Brown 
3324b8123daeSJed Brown   Collective on TS
3325b8123daeSJed Brown 
3326b8123daeSJed Brown   Input Parameters:
3327b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
33289be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3329b8123daeSJed Brown 
3330b8123daeSJed Brown   Notes:
3331b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3332b8123daeSJed Brown   most users would not generally call this routine themselves.
3333b8123daeSJed Brown 
3334b8123daeSJed Brown   Level: developer
3335b8123daeSJed Brown 
33369be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3337b8123daeSJed Brown @*/
3338b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3339b8123daeSJed Brown {
3340b8123daeSJed Brown   PetscFunctionBegin;
3341b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3342ae60f76fSBarry Smith   if (ts->prestage) {
3343ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3344b8123daeSJed Brown   }
3345b8123daeSJed Brown   PetscFunctionReturn(0);
3346b8123daeSJed Brown }
3347b8123daeSJed Brown 
33489be3e283SDebojyoti Ghosh /*@
33499be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
33509be3e283SDebojyoti Ghosh 
33519be3e283SDebojyoti Ghosh   Collective on TS
33529be3e283SDebojyoti Ghosh 
33539be3e283SDebojyoti Ghosh   Input Parameters:
33549be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
33559be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
33569be3e283SDebojyoti Ghosh   stageindex  - Stage number
33579be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
33589be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
33599be3e283SDebojyoti Ghosh 
33609be3e283SDebojyoti Ghosh   Notes:
33619be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
33629be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
33639be3e283SDebojyoti Ghosh 
33649be3e283SDebojyoti Ghosh   Level: developer
33659be3e283SDebojyoti Ghosh 
33669be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
33679be3e283SDebojyoti Ghosh @*/
33689be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
33699be3e283SDebojyoti Ghosh {
33709be3e283SDebojyoti Ghosh   PetscFunctionBegin;
33719be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33724beae5d8SLisandro Dalcin   if (ts->poststage) {
33739be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
33749be3e283SDebojyoti Ghosh   }
33759be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
33769be3e283SDebojyoti Ghosh }
33779be3e283SDebojyoti Ghosh 
3378c688d042SShri Abhyankar /*@
3379c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3380c688d042SShri Abhyankar 
3381c688d042SShri Abhyankar   Collective on TS
3382c688d042SShri Abhyankar 
3383c688d042SShri Abhyankar   Input Parameters:
3384c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3385c688d042SShri Abhyankar 
3386c688d042SShri Abhyankar   Notes:
3387c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3388c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3389c688d042SShri Abhyankar 
3390c688d042SShri Abhyankar   Level: developer
3391c688d042SShri Abhyankar 
3392c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3393c688d042SShri Abhyankar @*/
3394c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3395c688d042SShri Abhyankar {
3396c688d042SShri Abhyankar   PetscErrorCode ierr;
3397c688d042SShri Abhyankar 
3398c688d042SShri Abhyankar   PetscFunctionBegin;
3399c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3400c688d042SShri Abhyankar   if (ts->postevaluate) {
3401dcb233daSLisandro Dalcin     Vec              U;
3402dcb233daSLisandro Dalcin     PetscObjectState sprev,spost;
3403dcb233daSLisandro Dalcin 
3404dcb233daSLisandro Dalcin     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
3405dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3406c688d042SShri Abhyankar     PetscStackCallStandard((*ts->postevaluate),(ts));
3407dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3408dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3409c688d042SShri Abhyankar   }
3410c688d042SShri Abhyankar   PetscFunctionReturn(0);
3411c688d042SShri Abhyankar }
3412c688d042SShri Abhyankar 
3413ac226902SBarry Smith /*@C
3414000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
34153f2090d5SJed Brown   called once at the end of each time step.
3416000e7ae3SMatthew Knepley 
34173f9fe445SBarry Smith   Logically Collective on TS
3418000e7ae3SMatthew Knepley 
3419000e7ae3SMatthew Knepley   Input Parameters:
3420000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3421000e7ae3SMatthew Knepley - func - The function
3422000e7ae3SMatthew Knepley 
3423000e7ae3SMatthew Knepley   Calling sequence of func:
3424b8123daeSJed Brown $ func (TS ts);
3425000e7ae3SMatthew Knepley 
34261785ff2aSShri Abhyankar   Notes:
34271785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
34281785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
34291785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
34301785ff2aSShri Abhyankar 
3431000e7ae3SMatthew Knepley   Level: intermediate
3432000e7ae3SMatthew Knepley 
3433dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep()
3434000e7ae3SMatthew Knepley @*/
34357087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3436000e7ae3SMatthew Knepley {
3437000e7ae3SMatthew Knepley   PetscFunctionBegin;
34380700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3439ae60f76fSBarry Smith   ts->poststep = func;
3440000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3441000e7ae3SMatthew Knepley }
3442000e7ae3SMatthew Knepley 
344309ee8438SJed Brown /*@
34443f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
34453f2090d5SJed Brown 
34463f2090d5SJed Brown   Collective on TS
34473f2090d5SJed Brown 
34483f2090d5SJed Brown   Input Parameters:
34493f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
34503f2090d5SJed Brown 
34513f2090d5SJed Brown   Notes:
34523f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
34533f2090d5SJed Brown   so most users would not generally call this routine themselves.
34543f2090d5SJed Brown 
34553f2090d5SJed Brown   Level: developer
34563f2090d5SJed Brown 
34573f2090d5SJed Brown @*/
34587087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
34593f2090d5SJed Brown {
34603f2090d5SJed Brown   PetscErrorCode ierr;
34613f2090d5SJed Brown 
34623f2090d5SJed Brown   PetscFunctionBegin;
34630700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3464ae60f76fSBarry Smith   if (ts->poststep) {
34655efd42a4SStefano Zampini     Vec              U;
34665efd42a4SStefano Zampini     PetscObjectState sprev,spost;
34675efd42a4SStefano Zampini 
34685efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
34695efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3470ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
34715efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3472dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
347372ac3e02SJed Brown   }
34743f2090d5SJed Brown   PetscFunctionReturn(0);
34753f2090d5SJed Brown }
34763f2090d5SJed Brown 
3477d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3478d763cef2SBarry Smith 
3479d763cef2SBarry Smith /*@C
3480a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3481d763cef2SBarry Smith    timestep to display the iteration's  progress.
3482d763cef2SBarry Smith 
34833f9fe445SBarry Smith    Logically Collective on TS
3484d763cef2SBarry Smith 
3485d763cef2SBarry Smith    Input Parameters:
3486d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3487e213d8f1SJed Brown .  monitor - monitoring routine
3488329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
34890298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3490b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
34910298fd71SBarry Smith           (may be NULL)
3492d763cef2SBarry Smith 
3493e213d8f1SJed Brown    Calling sequence of monitor:
3494dcb233daSLisandro Dalcin $    PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3495d763cef2SBarry Smith 
3496d763cef2SBarry Smith +    ts - the TS context
349763e21af5SBarry Smith .    steps - iteration number (after the final time step the monitor routine may be called with a step of -1, this indicates the solution has been interpolated to this time)
34981f06c33eSBarry Smith .    time - current time
34990910c330SBarry Smith .    u - current iterate
3500d763cef2SBarry Smith -    mctx - [optional] monitoring context
3501d763cef2SBarry Smith 
3502d763cef2SBarry Smith    Notes:
3503d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3504d763cef2SBarry Smith    already has been loaded.
3505d763cef2SBarry Smith 
350695452b02SPatrick Sanan    Fortran Notes:
350795452b02SPatrick Sanan     Only a single monitor function can be set for each TS object
3508025f1a04SBarry Smith 
3509d763cef2SBarry Smith    Level: intermediate
3510d763cef2SBarry Smith 
3511a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3512d763cef2SBarry Smith @*/
3513c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3514d763cef2SBarry Smith {
351578064530SBarry Smith   PetscErrorCode ierr;
351678064530SBarry Smith   PetscInt       i;
351778064530SBarry Smith   PetscBool      identical;
351878064530SBarry Smith 
3519d763cef2SBarry Smith   PetscFunctionBegin;
35200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
352178064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
352278064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
352378064530SBarry Smith     if (identical) PetscFunctionReturn(0);
352478064530SBarry Smith   }
352517186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3526d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
35278704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3528d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3529d763cef2SBarry Smith   PetscFunctionReturn(0);
3530d763cef2SBarry Smith }
3531d763cef2SBarry Smith 
3532d763cef2SBarry Smith /*@C
3533a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3534d763cef2SBarry Smith 
35353f9fe445SBarry Smith    Logically Collective on TS
3536d763cef2SBarry Smith 
3537d763cef2SBarry Smith    Input Parameters:
3538d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3539d763cef2SBarry Smith 
3540d763cef2SBarry Smith    Notes:
3541d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3542d763cef2SBarry Smith 
3543d763cef2SBarry Smith    Level: intermediate
3544d763cef2SBarry Smith 
3545a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3546d763cef2SBarry Smith @*/
35477087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3548d763cef2SBarry Smith {
3549d952e501SBarry Smith   PetscErrorCode ierr;
3550d952e501SBarry Smith   PetscInt       i;
3551d952e501SBarry Smith 
3552d763cef2SBarry Smith   PetscFunctionBegin;
35530700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3554d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
35558704b422SBarry Smith     if (ts->monitordestroy[i]) {
35568704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3557d952e501SBarry Smith     }
3558d952e501SBarry Smith   }
3559d763cef2SBarry Smith   ts->numbermonitors = 0;
3560d763cef2SBarry Smith   PetscFunctionReturn(0);
3561d763cef2SBarry Smith }
3562d763cef2SBarry Smith 
3563721cd6eeSBarry Smith /*@C
3564721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
35655516499fSSatish Balay 
35665516499fSSatish Balay    Level: intermediate
356741251cbbSSatish Balay 
356863e21af5SBarry Smith .seealso:  TSMonitorSet()
356941251cbbSSatish Balay @*/
3570721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3571d763cef2SBarry Smith {
3572dfbe8321SBarry Smith   PetscErrorCode ierr;
3573721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
357441aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3575d132466eSBarry Smith 
3576d763cef2SBarry Smith   PetscFunctionBegin;
35774d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
357841aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
357941aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3580721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
358141aca3d6SBarry Smith   if (iascii) {
3582649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
358363e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
358463e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
358563e21af5SBarry Smith     } else {
35868392e04aSShri Abhyankar       ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr);
358763e21af5SBarry Smith     }
3588649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
358941aca3d6SBarry Smith   } else if (ibinary) {
359041aca3d6SBarry Smith     PetscMPIInt rank;
359141aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
359241aca3d6SBarry Smith     if (!rank) {
3593450a797fSBarry Smith       PetscBool skipHeader;
3594450a797fSBarry Smith       PetscInt  classid = REAL_FILE_CLASSID;
3595450a797fSBarry Smith 
3596450a797fSBarry Smith       ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr);
3597450a797fSBarry Smith       if (!skipHeader) {
3598f253e43cSLisandro Dalcin          ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
3599450a797fSBarry Smith        }
360041aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
360141aca3d6SBarry Smith     } else {
360241aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
360341aca3d6SBarry Smith     }
360441aca3d6SBarry Smith   }
3605721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3606d763cef2SBarry Smith   PetscFunctionReturn(0);
3607d763cef2SBarry Smith }
3608d763cef2SBarry Smith 
3609cc9c3a59SBarry Smith /*@C
3610cc9c3a59SBarry Smith    TSMonitorExtreme - Prints the extreme values of the solution at each timestep
3611cc9c3a59SBarry Smith 
3612cc9c3a59SBarry Smith    Level: intermediate
3613cc9c3a59SBarry Smith 
3614cc9c3a59SBarry Smith .seealso:  TSMonitorSet()
3615cc9c3a59SBarry Smith @*/
3616cc9c3a59SBarry Smith PetscErrorCode TSMonitorExtreme(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3617cc9c3a59SBarry Smith {
3618cc9c3a59SBarry Smith   PetscErrorCode ierr;
3619cc9c3a59SBarry Smith   PetscViewer    viewer =  vf->viewer;
3620cc9c3a59SBarry Smith   PetscBool      iascii;
3621cc9c3a59SBarry Smith   PetscReal      max,min;
3622cc9c3a59SBarry Smith 
3623cc9c3a59SBarry Smith 
3624cc9c3a59SBarry Smith   PetscFunctionBegin;
3625cc9c3a59SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3626cc9c3a59SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
3627cc9c3a59SBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
3628cc9c3a59SBarry Smith   if (iascii) {
3629cc9c3a59SBarry Smith     ierr = VecMax(v,NULL,&max);CHKERRQ(ierr);
3630cc9c3a59SBarry Smith     ierr = VecMin(v,NULL,&min);CHKERRQ(ierr);
3631cc9c3a59SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
36325132926bSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s max %g min %g\n",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)" : "",(double)max,(double)min);CHKERRQ(ierr);
3633cc9c3a59SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3634cc9c3a59SBarry Smith   }
3635cc9c3a59SBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3636cc9c3a59SBarry Smith   PetscFunctionReturn(0);
3637cc9c3a59SBarry Smith }
3638cc9c3a59SBarry Smith 
3639cd652676SJed Brown /*@
3640cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3641cd652676SJed Brown 
3642cd652676SJed Brown    Collective on TS
3643cd652676SJed Brown 
3644cd652676SJed Brown    Input Argument:
3645cd652676SJed Brown +  ts - time stepping context
3646cd652676SJed Brown -  t - time to interpolate to
3647cd652676SJed Brown 
3648cd652676SJed Brown    Output Argument:
36490910c330SBarry Smith .  U - state at given time
3650cd652676SJed Brown 
3651cd652676SJed Brown    Level: intermediate
3652cd652676SJed Brown 
3653cd652676SJed Brown    Developer Notes:
3654cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3655cd652676SJed Brown 
3656874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
3657cd652676SJed Brown @*/
36580910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3659cd652676SJed Brown {
3660cd652676SJed Brown   PetscErrorCode ierr;
3661cd652676SJed Brown 
3662cd652676SJed Brown   PetscFunctionBegin;
3663cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3664b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3665be5899b3SLisandro Dalcin   if (t < ts->ptime_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)ts->ptime_prev,(double)ts->ptime);
3666ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
36670910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3668cd652676SJed Brown   PetscFunctionReturn(0);
3669cd652676SJed Brown }
3670cd652676SJed Brown 
3671d763cef2SBarry Smith /*@
36726d9e5789SSean Farley    TSStep - Steps one time step
3673d763cef2SBarry Smith 
3674d763cef2SBarry Smith    Collective on TS
3675d763cef2SBarry Smith 
3676d763cef2SBarry Smith    Input Parameter:
3677d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3678d763cef2SBarry Smith 
367927829d71SBarry Smith    Level: developer
3680d763cef2SBarry Smith 
3681b8123daeSJed Brown    Notes:
368227829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
368327829d71SBarry Smith 
3684b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3685b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3686b8123daeSJed Brown 
368719eac22cSLisandro Dalcin    This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the
368819eac22cSLisandro Dalcin    time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
368925cb2221SBarry Smith 
36909be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3691d763cef2SBarry Smith @*/
3692193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3693d763cef2SBarry Smith {
3694dfbe8321SBarry Smith   PetscErrorCode   ierr;
3695fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3696be5899b3SLisandro Dalcin   PetscReal        ptime;
3697d763cef2SBarry Smith 
3698d763cef2SBarry Smith   PetscFunctionBegin;
36990700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3700f1d62c27SHong Zhang   ierr = PetscCitationsRegister("@article{tspaper,\n"
3701fffbeea8SBarry Smith                                 "  title         = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3702f1d62c27SHong Zhang                                 "  author        = {Abhyankar, Shrirang and Brown, Jed and Constantinescu, Emil and Ghosh, Debojyoti and Smith, Barry F. and Zhang, Hong},\n"
3703f1d62c27SHong Zhang                                 "  journal       = {arXiv e-preprints},\n"
3704f1d62c27SHong Zhang                                 "  eprint        = {1806.01437},\n"
3705f1d62c27SHong Zhang                                 "  archivePrefix = {arXiv},\n"
3706f1d62c27SHong Zhang                                 "  year          = {2018}\n}\n",&cite);CHKERRQ(ierr);
3707fffbeea8SBarry Smith 
3708d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
370968bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3710d405a339SMatthew Knepley 
3711fc8dbba5SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3712ef85077eSLisandro Dalcin   if (ts->max_time >= PETSC_MAX_REAL && ts->max_steps == PETSC_MAX_INT) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>");
3713a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSStep()");
3714be5899b3SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
3715a6772fa2SLisandro Dalcin 
3716be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
3717be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
37182808aa04SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3719fc8dbba5SLisandro Dalcin 
3720d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3721193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3722d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3723fc8dbba5SLisandro Dalcin 
3724fc8dbba5SLisandro Dalcin   if (ts->reason >= 0) {
3725be5899b3SLisandro Dalcin     ts->ptime_prev = ptime;
37262808aa04SLisandro Dalcin     ts->steps++;
3727be5899b3SLisandro Dalcin     ts->steprollback = PETSC_FALSE;
372828d5b5d6SLisandro Dalcin     ts->steprestart  = PETSC_FALSE;
3729d2daff3dSHong Zhang   }
3730fc8dbba5SLisandro Dalcin 
3731fc8dbba5SLisandro Dalcin   if (!ts->reason) {
373208c7845fSBarry Smith     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
373308c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
373408c7845fSBarry Smith   }
3735fc8dbba5SLisandro Dalcin 
3736fc8dbba5SLisandro Dalcin   if (ts->reason < 0 && ts->errorifstepfailed && ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
3737fc8dbba5SLisandro Dalcin   if (ts->reason < 0 && ts->errorifstepfailed) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
373808c7845fSBarry Smith   PetscFunctionReturn(0);
373908c7845fSBarry Smith }
374008c7845fSBarry Smith 
374108c7845fSBarry Smith /*@
37427cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
37437cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
37447cbde773SLisandro Dalcin 
37457cbde773SLisandro Dalcin    Collective on TS
37467cbde773SLisandro Dalcin 
37477cbde773SLisandro Dalcin    Input Arguments:
37487cbde773SLisandro Dalcin +  ts - time stepping context
37497cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
37507cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
37517cbde773SLisandro Dalcin 
37527cbde773SLisandro Dalcin    Output Arguments:
37537cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
37547cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
37557cbde773SLisandro Dalcin 
37567cbde773SLisandro Dalcin    Level: advanced
37577cbde773SLisandro Dalcin 
37587cbde773SLisandro Dalcin    Notes:
37597cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
37607cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
37617cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
37627cbde773SLisandro Dalcin 
37637cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
37647cbde773SLisandro Dalcin @*/
37657cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
37667cbde773SLisandro Dalcin {
37677cbde773SLisandro Dalcin   PetscErrorCode ierr;
37687cbde773SLisandro Dalcin 
37697cbde773SLisandro Dalcin   PetscFunctionBegin;
37707cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
37717cbde773SLisandro Dalcin   PetscValidType(ts,1);
37727cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
37737cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
37747cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
37757cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
37767cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
37777cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
37787cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
37797cbde773SLisandro Dalcin   PetscFunctionReturn(0);
37807cbde773SLisandro Dalcin }
37817cbde773SLisandro Dalcin 
378205175c85SJed Brown /*@
378305175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
378405175c85SJed Brown 
37851c3436cfSJed Brown    Collective on TS
378605175c85SJed Brown 
378705175c85SJed Brown    Input Arguments:
37881c3436cfSJed Brown +  ts - time stepping context
37891c3436cfSJed Brown .  order - desired order of accuracy
37900298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
379105175c85SJed Brown 
379205175c85SJed Brown    Output Arguments:
37930910c330SBarry Smith .  U - state at the end of the current step
379405175c85SJed Brown 
379505175c85SJed Brown    Level: advanced
379605175c85SJed Brown 
3797108c343cSJed Brown    Notes:
3798108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3799108c343cSJed 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.
3800108c343cSJed Brown 
38011c3436cfSJed Brown .seealso: TSStep(), TSAdapt
380205175c85SJed Brown @*/
38030910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
380405175c85SJed Brown {
380505175c85SJed Brown   PetscErrorCode ierr;
380605175c85SJed Brown 
380705175c85SJed Brown   PetscFunctionBegin;
380805175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
380905175c85SJed Brown   PetscValidType(ts,1);
38100910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3811ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
38120910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
381305175c85SJed Brown   PetscFunctionReturn(0);
381405175c85SJed Brown }
381505175c85SJed Brown 
3816aad739acSMatthew G. Knepley /*@C
38172e61be88SMatthew G. Knepley   TSGetComputeInitialCondition - Get the function used to automatically compute an initial condition for the timestepping.
3818aad739acSMatthew G. Knepley 
3819aad739acSMatthew G. Knepley   Not collective
3820aad739acSMatthew G. Knepley 
3821aad739acSMatthew G. Knepley   Input Argument:
3822aad739acSMatthew G. Knepley . ts        - time stepping context
3823aad739acSMatthew G. Knepley 
3824aad739acSMatthew G. Knepley   Output Argument:
38252e61be88SMatthew G. Knepley . initConditions - The function which computes an initial condition
3826aad739acSMatthew G. Knepley 
3827aad739acSMatthew G. Knepley    Level: advanced
3828aad739acSMatthew G. Knepley 
3829aad739acSMatthew G. Knepley    Notes:
3830aad739acSMatthew G. Knepley    The calling sequence for the function is
38312e61be88SMatthew G. Knepley $ initCondition(TS ts, Vec u)
3832aad739acSMatthew G. Knepley $ ts - The timestepping context
38332e61be88SMatthew G. Knepley $ u  - The input vector in which the initial condition is stored
3834aad739acSMatthew G. Knepley 
38352e61be88SMatthew G. Knepley .seealso: TSSetComputeInitialCondition(), TSComputeInitialCondition()
3836aad739acSMatthew G. Knepley @*/
38372e61be88SMatthew G. Knepley PetscErrorCode TSGetComputeInitialCondition(TS ts, PetscErrorCode (**initCondition)(TS, Vec))
3838aad739acSMatthew G. Knepley {
3839aad739acSMatthew G. Knepley   PetscFunctionBegin;
3840aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
38412e61be88SMatthew G. Knepley   PetscValidPointer(initCondition, 2);
38422e61be88SMatthew G. Knepley   *initCondition = ts->ops->initcondition;
3843aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3844aad739acSMatthew G. Knepley }
3845aad739acSMatthew G. Knepley 
3846aad739acSMatthew G. Knepley /*@C
38472e61be88SMatthew G. Knepley   TSSetComputeInitialCondition - Set the function used to automatically compute an initial condition for the timestepping.
3848aad739acSMatthew G. Knepley 
3849aad739acSMatthew G. Knepley   Logically collective on ts
3850aad739acSMatthew G. Knepley 
3851aad739acSMatthew G. Knepley   Input Arguments:
3852aad739acSMatthew G. Knepley + ts        - time stepping context
38532e61be88SMatthew G. Knepley - initCondition - The function which computes an initial condition
3854aad739acSMatthew G. Knepley 
3855aad739acSMatthew G. Knepley   Level: advanced
3856aad739acSMatthew G. Knepley 
3857aad739acSMatthew G. Knepley   Notes:
3858aad739acSMatthew G. Knepley   The calling sequence for the function is
38592e61be88SMatthew G. Knepley $ initCondition(TS ts, Vec u)
3860aad739acSMatthew G. Knepley $ ts - The timestepping context
38612e61be88SMatthew G. Knepley $ u  - The input vector in which the initial condition is stored
3862aad739acSMatthew G. Knepley 
38632e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSComputeInitialCondition()
3864aad739acSMatthew G. Knepley @*/
38652e61be88SMatthew G. Knepley PetscErrorCode TSSetComputeInitialCondition(TS ts, PetscErrorCode (*initCondition)(TS, Vec))
3866aad739acSMatthew G. Knepley {
3867aad739acSMatthew G. Knepley   PetscFunctionBegin;
3868aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
38692e61be88SMatthew G. Knepley   PetscValidFunction(initCondition, 2);
38702e61be88SMatthew G. Knepley   ts->ops->initcondition = initCondition;
3871aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3872aad739acSMatthew G. Knepley }
3873aad739acSMatthew G. Knepley 
3874aad739acSMatthew G. Knepley /*@
38752e61be88SMatthew G. Knepley   TSComputeInitialCondition - Compute an initial condition for the timestepping using the function previously set.
3876aad739acSMatthew G. Knepley 
3877aad739acSMatthew G. Knepley   Collective on ts
3878aad739acSMatthew G. Knepley 
3879aad739acSMatthew G. Knepley   Input Arguments:
3880aad739acSMatthew G. Knepley + ts - time stepping context
38812e61be88SMatthew G. Knepley - u  - The Vec to store the condition in which will be used in TSSolve()
3882aad739acSMatthew G. Knepley 
3883aad739acSMatthew G. Knepley   Level: advanced
3884aad739acSMatthew G. Knepley 
3885aad739acSMatthew G. Knepley   Notes:
3886aad739acSMatthew G. Knepley   The calling sequence for the function is
38872e61be88SMatthew G. Knepley $ initCondition(TS ts, Vec u)
3888aad739acSMatthew G. Knepley $ ts - The timestepping context
38892e61be88SMatthew G. Knepley $ u  - The input vector in which the initial condition is stored
3890aad739acSMatthew G. Knepley 
38912e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve()
3892aad739acSMatthew G. Knepley @*/
38932e61be88SMatthew G. Knepley PetscErrorCode TSComputeInitialCondition(TS ts, Vec u)
3894aad739acSMatthew G. Knepley {
3895aad739acSMatthew G. Knepley   PetscErrorCode ierr;
3896aad739acSMatthew G. Knepley 
3897aad739acSMatthew G. Knepley   PetscFunctionBegin;
3898aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3899aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
39002e61be88SMatthew G. Knepley   if (ts->ops->initcondition) {ierr = (*ts->ops->initcondition)(ts, u);CHKERRQ(ierr);}
3901aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3902aad739acSMatthew G. Knepley }
3903aad739acSMatthew G. Knepley 
3904aad739acSMatthew G. Knepley /*@C
3905aad739acSMatthew G. Knepley   TSGetComputeExactError - Get the function used to automatically compute the exact error for the timestepping.
3906aad739acSMatthew G. Knepley 
3907aad739acSMatthew G. Knepley   Not collective
3908aad739acSMatthew G. Knepley 
3909aad739acSMatthew G. Knepley   Input Argument:
3910aad739acSMatthew G. Knepley . ts         - time stepping context
3911aad739acSMatthew G. Knepley 
3912aad739acSMatthew G. Knepley   Output Argument:
3913aad739acSMatthew G. Knepley . exactError - The function which computes the solution error
3914aad739acSMatthew G. Knepley 
3915aad739acSMatthew G. Knepley   Level: advanced
3916aad739acSMatthew G. Knepley 
3917aad739acSMatthew G. Knepley   Notes:
3918aad739acSMatthew G. Knepley   The calling sequence for the function is
3919aad739acSMatthew G. Knepley $ exactError(TS ts, Vec u)
3920aad739acSMatthew G. Knepley $ ts - The timestepping context
3921aad739acSMatthew G. Knepley $ u  - The approximate solution vector
3922aad739acSMatthew G. Knepley $ e  - The input vector in which the error is stored
3923aad739acSMatthew G. Knepley 
3924aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError()
3925aad739acSMatthew G. Knepley @*/
3926aad739acSMatthew G. Knepley PetscErrorCode TSGetComputeExactError(TS ts, PetscErrorCode (**exactError)(TS, Vec, Vec))
3927aad739acSMatthew G. Knepley {
3928aad739acSMatthew G. Knepley   PetscFunctionBegin;
3929aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3930aad739acSMatthew G. Knepley   PetscValidPointer(exactError, 2);
3931aad739acSMatthew G. Knepley   *exactError = ts->ops->exacterror;
3932aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3933aad739acSMatthew G. Knepley }
3934aad739acSMatthew G. Knepley 
3935aad739acSMatthew G. Knepley /*@C
3936aad739acSMatthew G. Knepley   TSSetComputeExactError - Set the function used to automatically compute the exact error for the timestepping.
3937aad739acSMatthew G. Knepley 
3938aad739acSMatthew G. Knepley   Logically collective on ts
3939aad739acSMatthew G. Knepley 
3940aad739acSMatthew G. Knepley   Input Arguments:
3941aad739acSMatthew G. Knepley + ts         - time stepping context
3942aad739acSMatthew G. Knepley - exactError - The function which computes the solution error
3943aad739acSMatthew G. Knepley 
3944aad739acSMatthew G. Knepley   Level: advanced
3945aad739acSMatthew G. Knepley 
3946aad739acSMatthew G. Knepley   Notes:
3947aad739acSMatthew G. Knepley   The calling sequence for the function is
3948aad739acSMatthew G. Knepley $ exactError(TS ts, Vec u)
3949aad739acSMatthew G. Knepley $ ts - The timestepping context
3950aad739acSMatthew G. Knepley $ u  - The approximate solution vector
3951aad739acSMatthew G. Knepley $ e  - The input vector in which the error is stored
3952aad739acSMatthew G. Knepley 
3953aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError()
3954aad739acSMatthew G. Knepley @*/
3955aad739acSMatthew G. Knepley PetscErrorCode TSSetComputeExactError(TS ts, PetscErrorCode (*exactError)(TS, Vec, Vec))
3956aad739acSMatthew G. Knepley {
3957aad739acSMatthew G. Knepley   PetscFunctionBegin;
3958aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3959f907fdbfSMatthew G. Knepley   PetscValidFunction(exactError, 2);
3960aad739acSMatthew G. Knepley   ts->ops->exacterror = exactError;
3961aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3962aad739acSMatthew G. Knepley }
3963aad739acSMatthew G. Knepley 
3964aad739acSMatthew G. Knepley /*@
3965aad739acSMatthew G. Knepley   TSComputeExactError - Compute the solution error for the timestepping using the function previously set.
3966aad739acSMatthew G. Knepley 
3967aad739acSMatthew G. Knepley   Collective on ts
3968aad739acSMatthew G. Knepley 
3969aad739acSMatthew G. Knepley   Input Arguments:
3970aad739acSMatthew G. Knepley + ts - time stepping context
3971aad739acSMatthew G. Knepley . u  - The approximate solution
3972aad739acSMatthew G. Knepley - e  - The Vec used to store the error
3973aad739acSMatthew G. Knepley 
3974aad739acSMatthew G. Knepley   Level: advanced
3975aad739acSMatthew G. Knepley 
3976aad739acSMatthew G. Knepley   Notes:
3977aad739acSMatthew G. Knepley   The calling sequence for the function is
3978aad739acSMatthew G. Knepley $ exactError(TS ts, Vec u)
3979aad739acSMatthew G. Knepley $ ts - The timestepping context
3980aad739acSMatthew G. Knepley $ u  - The approximate solution vector
3981aad739acSMatthew G. Knepley $ e  - The input vector in which the error is stored
3982aad739acSMatthew G. Knepley 
39832e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve()
3984aad739acSMatthew G. Knepley @*/
3985aad739acSMatthew G. Knepley PetscErrorCode TSComputeExactError(TS ts, Vec u, Vec e)
3986aad739acSMatthew G. Knepley {
3987aad739acSMatthew G. Knepley   PetscErrorCode ierr;
3988aad739acSMatthew G. Knepley 
3989aad739acSMatthew G. Knepley   PetscFunctionBegin;
3990aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3991aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
3992aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(e, VEC_CLASSID, 3);
3993aad739acSMatthew G. Knepley   if (ts->ops->exacterror) {ierr = (*ts->ops->exacterror)(ts, u, e);CHKERRQ(ierr);}
3994aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3995aad739acSMatthew G. Knepley }
3996aad739acSMatthew G. Knepley 
3997b1cb36f3SHong Zhang /*@
39986a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
39996a4d4014SLisandro Dalcin 
40006a4d4014SLisandro Dalcin    Collective on TS
40016a4d4014SLisandro Dalcin 
40026a4d4014SLisandro Dalcin    Input Parameter:
40036a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
400463e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
400563e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
40065a3a76d0SJed Brown 
40076a4d4014SLisandro Dalcin    Level: beginner
40086a4d4014SLisandro Dalcin 
40095a3a76d0SJed Brown    Notes:
40105a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
40115a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
40125a3a76d0SJed Brown    stepped over the final time.
40135a3a76d0SJed Brown 
401463e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
40156a4d4014SLisandro Dalcin @*/
4016cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
40176a4d4014SLisandro Dalcin {
4018b06615a5SLisandro Dalcin   Vec               solution;
40196a4d4014SLisandro Dalcin   PetscErrorCode    ierr;
4020f22f69f0SBarry Smith 
40216a4d4014SLisandro Dalcin   PetscFunctionBegin;
40220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4023f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
4024ee41a567SStefano 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 */
40250910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
4026b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
4027b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
4028b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
40295a3a76d0SJed Brown     }
40300910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
4031715f1b00SHong Zhang     if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
4032bbd56ea5SKarl Rupp   } else if (u) {
40330910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
40345a3a76d0SJed Brown   }
4035b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
403668bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4037a6772fa2SLisandro Dalcin 
4038ef85077eSLisandro Dalcin   if (ts->max_time >= PETSC_MAX_REAL && ts->max_steps == PETSC_MAX_INT) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>");
4039a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSSolve()");
4040a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
4041a6772fa2SLisandro Dalcin 
4042715f1b00SHong Zhang   if (ts->forward_solve) {
4043715f1b00SHong Zhang     ierr = TSForwardSetUp(ts);CHKERRQ(ierr);
4044715f1b00SHong Zhang   }
4045715f1b00SHong Zhang 
4046e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
4047715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
4048e7069c78SShri      TSTrajectory to incorrectly save the output files
4049e7069c78SShri   */
4050715f1b00SHong Zhang   /* reset time step and iteration counters */
40512808aa04SLisandro Dalcin   if (!ts->steps) {
40525ef26d82SJed Brown     ts->ksp_its           = 0;
40535ef26d82SJed Brown     ts->snes_its          = 0;
4054c610991cSLisandro Dalcin     ts->num_snes_failures = 0;
4055c610991cSLisandro Dalcin     ts->reject            = 0;
40562808aa04SLisandro Dalcin     ts->steprestart       = PETSC_TRUE;
40572808aa04SLisandro Dalcin     ts->steprollback      = PETSC_FALSE;
40587d51462cSStefano Zampini     ts->rhsjacobian.time  = PETSC_MIN_REAL;
40592808aa04SLisandro Dalcin   }
4060e97c63d7SStefano Zampini 
4061e97c63d7SStefano Zampini   /* make sure initial time step does not overshoot final time */
4062e97c63d7SStefano Zampini   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP) {
4063e97c63d7SStefano Zampini     PetscReal maxdt = ts->max_time-ts->ptime;
4064e97c63d7SStefano Zampini     PetscReal dt = ts->time_step;
4065e97c63d7SStefano Zampini 
4066e97c63d7SStefano Zampini     ts->time_step = dt >= maxdt ? maxdt : (PetscIsCloseAtTol(dt,maxdt,10*PETSC_MACHINE_EPSILON,0) ? maxdt : dt);
4067e97c63d7SStefano Zampini   }
4068193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
4069193ac0bcSJed Brown 
4070900f6b5bSMatthew G. Knepley   {
4071900f6b5bSMatthew G. Knepley     PetscViewer       viewer;
4072900f6b5bSMatthew G. Knepley     PetscViewerFormat format;
4073900f6b5bSMatthew G. Knepley     PetscBool         flg;
4074900f6b5bSMatthew G. Knepley     static PetscBool  incall = PETSC_FALSE;
4075900f6b5bSMatthew G. Knepley 
4076900f6b5bSMatthew G. Knepley     if (!incall) {
4077900f6b5bSMatthew G. Knepley       /* Estimate the convergence rate of the time discretization */
4078900f6b5bSMatthew G. Knepley       ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) ts),((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_estimate", &viewer, &format, &flg);CHKERRQ(ierr);
4079900f6b5bSMatthew G. Knepley       if (flg) {
4080900f6b5bSMatthew G. Knepley         PetscConvEst conv;
4081900f6b5bSMatthew G. Knepley         DM           dm;
4082900f6b5bSMatthew G. Knepley         PetscReal   *alpha; /* Convergence rate of the solution error for each field in the L_2 norm */
4083900f6b5bSMatthew G. Knepley         PetscInt     Nf;
4084900f6b5bSMatthew G. Knepley 
4085900f6b5bSMatthew G. Knepley         incall = PETSC_TRUE;
4086900f6b5bSMatthew G. Knepley         ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
4087900f6b5bSMatthew G. Knepley         ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4088900f6b5bSMatthew G. Knepley         ierr = PetscCalloc1(PetscMax(Nf, 1), &alpha);CHKERRQ(ierr);
4089900f6b5bSMatthew G. Knepley         ierr = PetscConvEstCreate(PetscObjectComm((PetscObject) ts), &conv);CHKERRQ(ierr);
4090900f6b5bSMatthew G. Knepley         ierr = PetscConvEstUseTS(conv);CHKERRQ(ierr);
4091900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetSolver(conv, (PetscObject) ts);CHKERRQ(ierr);
4092900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetFromOptions(conv);CHKERRQ(ierr);
4093900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetUp(conv);CHKERRQ(ierr);
4094900f6b5bSMatthew G. Knepley         ierr = PetscConvEstGetConvRate(conv, alpha);CHKERRQ(ierr);
4095900f6b5bSMatthew G. Knepley         ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);
4096900f6b5bSMatthew G. Knepley         ierr = PetscConvEstRateView(conv, alpha, viewer);CHKERRQ(ierr);
4097900f6b5bSMatthew G. Knepley         ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
4098900f6b5bSMatthew G. Knepley         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4099900f6b5bSMatthew G. Knepley         ierr = PetscConvEstDestroy(&conv);CHKERRQ(ierr);
4100900f6b5bSMatthew G. Knepley         ierr = PetscFree(alpha);CHKERRQ(ierr);
4101900f6b5bSMatthew G. Knepley         incall = PETSC_FALSE;
4102900f6b5bSMatthew G. Knepley       }
4103900f6b5bSMatthew G. Knepley     }
4104900f6b5bSMatthew G. Knepley   }
4105900f6b5bSMatthew G. Knepley 
4106ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
4107f05ece33SBarry Smith 
4108193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
4109193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
4110a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4111cc708dedSBarry Smith     ts->solvetime = ts->ptime;
4112a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
4113be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
4114db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
4115db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
4116e7069c78SShri 
41172808aa04SLisandro Dalcin     if (!ts->steps) {
41182808aa04SLisandro Dalcin       ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41196427ac75SLisandro Dalcin       ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41202808aa04SLisandro Dalcin     }
41216427ac75SLisandro Dalcin 
4122e1a7a14fSJed Brown     while (!ts->reason) {
41232808aa04SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41249687d888SLisandro Dalcin       if (!ts->steprollback) {
41259687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
41269687d888SLisandro Dalcin       }
4127193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
4128f3b1f45cSBarry Smith       if (ts->testjacobian) {
4129f3b1f45cSBarry Smith         ierr = TSRHSJacobianTest(ts,NULL);CHKERRQ(ierr);
4130f3b1f45cSBarry Smith       }
4131f3b1f45cSBarry Smith       if (ts->testjacobiantranspose) {
4132f3b1f45cSBarry Smith         ierr = TSRHSJacobianTestTranspose(ts,NULL);CHKERRQ(ierr);
4133f3b1f45cSBarry Smith       }
4134cd4cee2dSHong Zhang       if (ts->quadraturets && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */
41357b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */
4136b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
41377b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps++;
4138b1cb36f3SHong Zhang       }
413958818c2dSLisandro Dalcin       if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */
41407b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */
4141715f1b00SHong Zhang         ierr = TSForwardStep(ts);CHKERRQ(ierr);
41427b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps++;
4143715f1b00SHong Zhang       }
414410b82f12SShri Abhyankar       ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
4145e783b05fSHong Zhang       ierr = TSEventHandler(ts);CHKERRQ(ierr); /* The right-hand side may be changed due to event. Be careful with Any computation using the RHS information after this point. */
414658818c2dSLisandro Dalcin       if (ts->steprollback) {
414758818c2dSLisandro Dalcin         ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
414858818c2dSLisandro Dalcin       }
4149e783b05fSHong Zhang       if (!ts->steprollback) {
41502808aa04SLisandro Dalcin         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41511eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
4152aeb4809dSShri Abhyankar       }
4153193ac0bcSJed Brown     }
41542808aa04SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41556427ac75SLisandro Dalcin 
415649354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
41570910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
4158cc708dedSBarry Smith       ts->solvetime = ts->max_time;
4159b06615a5SLisandro Dalcin       solution = u;
416063e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
41610574a7fbSJed Brown     } else {
4162ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4163cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4164b06615a5SLisandro Dalcin       solution = ts->vec_sol;
41650574a7fbSJed Brown     }
4166193ac0bcSJed Brown   }
4167d2daff3dSHong Zhang 
4168ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
416963e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
417056f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
4171ef222394SBarry Smith   if (ts->adjoint_solve) {
4172ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
41732b0a91c0SBarry Smith   }
41746a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
41756a4d4014SLisandro Dalcin }
41766a4d4014SLisandro Dalcin 
41777db568b7SBarry Smith /*@C
4178228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4179228d79bcSJed Brown 
4180228d79bcSJed Brown    Collective on TS
4181228d79bcSJed Brown 
4182228d79bcSJed Brown    Input Parameters:
4183228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
4184228d79bcSJed Brown .  step - step number that has just completed
4185228d79bcSJed Brown .  ptime - model time of the state
41860910c330SBarry Smith -  u - state at the current model time
4187228d79bcSJed Brown 
4188228d79bcSJed Brown    Notes:
41897db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
41907db568b7SBarry Smith    Users would almost never call this routine directly.
4191228d79bcSJed Brown 
419263e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
419363e21af5SBarry Smith 
41947db568b7SBarry Smith    Level: developer
4195228d79bcSJed Brown 
4196228d79bcSJed Brown @*/
41970910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4198d763cef2SBarry Smith {
4199d6152f81SLisandro Dalcin   DM             dm;
4200a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
4201d6152f81SLisandro Dalcin   PetscErrorCode ierr;
4202d763cef2SBarry Smith 
4203d763cef2SBarry Smith   PetscFunctionBegin;
4204b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4205b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4206d6152f81SLisandro Dalcin 
4207d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
4208d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
4209d6152f81SLisandro Dalcin 
42108860a134SJunchao Zhang   ierr = VecLockReadPush(u);CHKERRQ(ierr);
4211d763cef2SBarry Smith   for (i=0; i<n; i++) {
42120910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
4213d763cef2SBarry Smith   }
42148860a134SJunchao Zhang   ierr = VecLockReadPop(u);CHKERRQ(ierr);
4215d763cef2SBarry Smith   PetscFunctionReturn(0);
4216d763cef2SBarry Smith }
4217d763cef2SBarry Smith 
4218d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
4219d763cef2SBarry Smith /*@C
42207db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4221a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
4222d763cef2SBarry Smith 
4223d763cef2SBarry Smith    Collective on TS
4224d763cef2SBarry Smith 
4225d763cef2SBarry Smith    Input Parameters:
4226d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
4227d763cef2SBarry Smith .  label - the title to put in the title bar
42287c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
4229a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
4230a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4231d763cef2SBarry Smith 
4232d763cef2SBarry Smith    Output Parameter:
42330b039ecaSBarry Smith .  ctx - the context
4234d763cef2SBarry Smith 
4235d763cef2SBarry Smith    Options Database Key:
42364f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
42378b668821SLisandro Dalcin +  -ts_monitor_lg_timestep_log - automatically sets line graph monitor
42387db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
42397db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
42407db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
42417db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4242b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4243d763cef2SBarry Smith 
4244d763cef2SBarry Smith    Notes:
4245a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
4246d763cef2SBarry Smith 
42477db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
42487db568b7SBarry Smith 
42497db568b7SBarry Smith    Many of the functions that control the monitoring have two forms: TSMonitorLGSet/GetXXXX() and TSMonitorLGCtxSet/GetXXXX() the first take a TS object as the
42507db568b7SBarry Smith    first argument (if that TS object does not have a TSMonitorLGCtx associated with it the function call is ignored) and the second takes a TSMonitorLGCtx object
42517db568b7SBarry Smith    as the first argument.
42527db568b7SBarry Smith 
42537db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
42547db568b7SBarry Smith 
4255d763cef2SBarry Smith    Level: intermediate
4256d763cef2SBarry Smith 
42577db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
42587db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
42597db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
42607db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
42617db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
42627c922b88SBarry Smith 
4263d763cef2SBarry Smith @*/
4264a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4265d763cef2SBarry Smith {
42667f52daa2SLisandro Dalcin   PetscDraw      draw;
4267dfbe8321SBarry Smith   PetscErrorCode ierr;
4268d763cef2SBarry Smith 
4269d763cef2SBarry Smith   PetscFunctionBegin;
4270b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
42717f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
42727f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
42737f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
4274287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
42757f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
4276a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
4277d763cef2SBarry Smith   PetscFunctionReturn(0);
4278d763cef2SBarry Smith }
4279d763cef2SBarry Smith 
4280b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4281d763cef2SBarry Smith {
42820b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4283c32365f1SBarry Smith   PetscReal      x   = ptime,y;
4284dfbe8321SBarry Smith   PetscErrorCode ierr;
4285d763cef2SBarry Smith 
4286d763cef2SBarry Smith   PetscFunctionBegin;
428763e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
4288b06615a5SLisandro Dalcin   if (!step) {
4289a9f9c1f6SBarry Smith     PetscDrawAxis axis;
42908b668821SLisandro Dalcin     const char *ylabel = ctx->semilogy ? "Log Time Step" : "Time Step";
4291a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
42928b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time",ylabel);CHKERRQ(ierr);
4293a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4294a9f9c1f6SBarry Smith   }
4295c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
42968b668821SLisandro Dalcin   if (ctx->semilogy) y = PetscLog10Real(y);
42970b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
4298b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
42990b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
43006934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
43013923b477SBarry Smith   }
4302d763cef2SBarry Smith   PetscFunctionReturn(0);
4303d763cef2SBarry Smith }
4304d763cef2SBarry Smith 
4305d763cef2SBarry Smith /*@C
4306a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4307a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
4308d763cef2SBarry Smith 
43090b039ecaSBarry Smith    Collective on TSMonitorLGCtx
4310d763cef2SBarry Smith 
4311d763cef2SBarry Smith    Input Parameter:
43120b039ecaSBarry Smith .  ctx - the monitor context
4313d763cef2SBarry Smith 
4314d763cef2SBarry Smith    Level: intermediate
4315d763cef2SBarry Smith 
43164f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
4317d763cef2SBarry Smith @*/
4318a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4319d763cef2SBarry Smith {
4320dfbe8321SBarry Smith   PetscErrorCode ierr;
4321d763cef2SBarry Smith 
4322d763cef2SBarry Smith   PetscFunctionBegin;
43237684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
43247684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
43257684fa3eSBarry Smith   }
43260b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
432731152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
4328387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
4329387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
4330387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
43310b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
4332d763cef2SBarry Smith   PetscFunctionReturn(0);
4333d763cef2SBarry Smith }
4334d763cef2SBarry Smith 
43351b575b74SJoseph Pusztay /*
43361b575b74SJoseph Pusztay 
43371b575b74SJoseph Pusztay   Creates a TS Monitor SPCtx for use with DM Swarm particle visualizations
43381b575b74SJoseph Pusztay 
43391b575b74SJoseph Pusztay */
43401b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorSPCtx *ctx)
43411b575b74SJoseph Pusztay {
43421b575b74SJoseph Pusztay   PetscDraw      draw;
43431b575b74SJoseph Pusztay   PetscErrorCode ierr;
43441b575b74SJoseph Pusztay 
43451b575b74SJoseph Pusztay   PetscFunctionBegin;
43461b575b74SJoseph Pusztay   ierr = PetscNew(ctx);CHKERRQ(ierr);
43471b575b74SJoseph Pusztay   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
43481b575b74SJoseph Pusztay   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
43491b575b74SJoseph Pusztay   ierr = PetscDrawSPCreate(draw,1,&(*ctx)->sp);CHKERRQ(ierr);
43501b575b74SJoseph Pusztay   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
43511b575b74SJoseph Pusztay   (*ctx)->howoften = howoften;
43521b575b74SJoseph Pusztay   PetscFunctionReturn(0);
43531b575b74SJoseph Pusztay 
43541b575b74SJoseph Pusztay }
43551b575b74SJoseph Pusztay 
43561b575b74SJoseph Pusztay /*
43571b575b74SJoseph Pusztay   Destroys a TSMonitorSPCtx that was created with TSMonitorSPCtxCreate
43581b575b74SJoseph Pusztay */
43591b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx *ctx)
43601b575b74SJoseph Pusztay {
43611b575b74SJoseph Pusztay   PetscErrorCode ierr;
43621b575b74SJoseph Pusztay 
43631b575b74SJoseph Pusztay   PetscFunctionBegin;
43641b575b74SJoseph Pusztay 
43651b575b74SJoseph Pusztay   ierr = PetscDrawSPDestroy(&(*ctx)->sp);CHKERRQ(ierr);
43661b575b74SJoseph Pusztay   ierr = PetscFree(*ctx);CHKERRQ(ierr);
43671b575b74SJoseph Pusztay 
43681b575b74SJoseph Pusztay   PetscFunctionReturn(0);
43691b575b74SJoseph Pusztay 
43701b575b74SJoseph Pusztay }
43711b575b74SJoseph Pusztay 
4372d763cef2SBarry Smith /*@
4373b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4374d763cef2SBarry Smith 
4375d763cef2SBarry Smith    Not Collective
4376d763cef2SBarry Smith 
4377d763cef2SBarry Smith    Input Parameter:
4378d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4379d763cef2SBarry Smith 
4380d763cef2SBarry Smith    Output Parameter:
438119eac22cSLisandro Dalcin .  t  - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime().
4382d763cef2SBarry Smith 
4383d763cef2SBarry Smith    Level: beginner
4384d763cef2SBarry Smith 
4385b8123daeSJed Brown    Note:
4386b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
43879be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4388b8123daeSJed Brown 
43898f199f4dSPatrick Sanan .seealso:  TSGetSolveTime(), TSSetTime(), TSGetTimeStep(), TSGetStepNumber()
4390d763cef2SBarry Smith 
4391d763cef2SBarry Smith @*/
43927087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4393d763cef2SBarry Smith {
4394d763cef2SBarry Smith   PetscFunctionBegin;
43950700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4396f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4397d763cef2SBarry Smith   *t = ts->ptime;
4398d763cef2SBarry Smith   PetscFunctionReturn(0);
4399d763cef2SBarry Smith }
4400d763cef2SBarry Smith 
4401e5e524a1SHong Zhang /*@
4402e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4403e5e524a1SHong Zhang 
4404e5e524a1SHong Zhang    Not Collective
4405e5e524a1SHong Zhang 
4406e5e524a1SHong Zhang    Input Parameter:
4407e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4408e5e524a1SHong Zhang 
4409e5e524a1SHong Zhang    Output Parameter:
4410e5e524a1SHong Zhang .  t  - the previous time
4411e5e524a1SHong Zhang 
4412e5e524a1SHong Zhang    Level: beginner
4413e5e524a1SHong Zhang 
4414aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep()
4415e5e524a1SHong Zhang 
4416e5e524a1SHong Zhang @*/
4417e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4418e5e524a1SHong Zhang {
4419e5e524a1SHong Zhang   PetscFunctionBegin;
4420e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4421e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4422e5e524a1SHong Zhang   *t = ts->ptime_prev;
4423e5e524a1SHong Zhang   PetscFunctionReturn(0);
4424e5e524a1SHong Zhang }
4425e5e524a1SHong Zhang 
44266a4d4014SLisandro Dalcin /*@
44276a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
44286a4d4014SLisandro Dalcin 
44293f9fe445SBarry Smith    Logically Collective on TS
44306a4d4014SLisandro Dalcin 
44316a4d4014SLisandro Dalcin    Input Parameters:
44326a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
44336a4d4014SLisandro Dalcin -  time - the time
44346a4d4014SLisandro Dalcin 
44356a4d4014SLisandro Dalcin    Level: intermediate
44366a4d4014SLisandro Dalcin 
443719eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps()
44386a4d4014SLisandro Dalcin 
44396a4d4014SLisandro Dalcin @*/
44407087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
44416a4d4014SLisandro Dalcin {
44426a4d4014SLisandro Dalcin   PetscFunctionBegin;
44430700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4444c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
44456a4d4014SLisandro Dalcin   ts->ptime = t;
44466a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
44476a4d4014SLisandro Dalcin }
44486a4d4014SLisandro Dalcin 
4449d763cef2SBarry Smith /*@C
4450d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4451d763cef2SBarry Smith    TS options in the database.
4452d763cef2SBarry Smith 
44533f9fe445SBarry Smith    Logically Collective on TS
4454d763cef2SBarry Smith 
4455d763cef2SBarry Smith    Input Parameter:
4456d763cef2SBarry Smith +  ts     - The TS context
4457d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4458d763cef2SBarry Smith 
4459d763cef2SBarry Smith    Notes:
4460d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4461d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4462d763cef2SBarry Smith    hyphen.
4463d763cef2SBarry Smith 
4464d763cef2SBarry Smith    Level: advanced
4465d763cef2SBarry Smith 
4466d763cef2SBarry Smith .seealso: TSSetFromOptions()
4467d763cef2SBarry Smith 
4468d763cef2SBarry Smith @*/
44697087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4470d763cef2SBarry Smith {
4471dfbe8321SBarry Smith   PetscErrorCode ierr;
4472089b2837SJed Brown   SNES           snes;
4473d763cef2SBarry Smith 
4474d763cef2SBarry Smith   PetscFunctionBegin;
44750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4476d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4477089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4478089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4479d763cef2SBarry Smith   PetscFunctionReturn(0);
4480d763cef2SBarry Smith }
4481d763cef2SBarry Smith 
4482d763cef2SBarry Smith /*@C
4483d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4484d763cef2SBarry Smith    TS options in the database.
4485d763cef2SBarry Smith 
44863f9fe445SBarry Smith    Logically Collective on TS
4487d763cef2SBarry Smith 
4488d763cef2SBarry Smith    Input Parameter:
4489d763cef2SBarry Smith +  ts     - The TS context
4490d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4491d763cef2SBarry Smith 
4492d763cef2SBarry Smith    Notes:
4493d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4494d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4495d763cef2SBarry Smith    hyphen.
4496d763cef2SBarry Smith 
4497d763cef2SBarry Smith    Level: advanced
4498d763cef2SBarry Smith 
4499d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4500d763cef2SBarry Smith 
4501d763cef2SBarry Smith @*/
45027087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4503d763cef2SBarry Smith {
4504dfbe8321SBarry Smith   PetscErrorCode ierr;
4505089b2837SJed Brown   SNES           snes;
4506d763cef2SBarry Smith 
4507d763cef2SBarry Smith   PetscFunctionBegin;
45080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4509d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4510089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4511089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4512d763cef2SBarry Smith   PetscFunctionReturn(0);
4513d763cef2SBarry Smith }
4514d763cef2SBarry Smith 
4515d763cef2SBarry Smith /*@C
4516d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4517d763cef2SBarry Smith    TS options in the database.
4518d763cef2SBarry Smith 
4519d763cef2SBarry Smith    Not Collective
4520d763cef2SBarry Smith 
4521d763cef2SBarry Smith    Input Parameter:
4522d763cef2SBarry Smith .  ts - The TS context
4523d763cef2SBarry Smith 
4524d763cef2SBarry Smith    Output Parameter:
4525d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4526d763cef2SBarry Smith 
452795452b02SPatrick Sanan    Notes:
452895452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prifix' of
4529d763cef2SBarry Smith    sufficient length to hold the prefix.
4530d763cef2SBarry Smith 
4531d763cef2SBarry Smith    Level: intermediate
4532d763cef2SBarry Smith 
4533d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4534d763cef2SBarry Smith @*/
45357087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4536d763cef2SBarry Smith {
4537dfbe8321SBarry Smith   PetscErrorCode ierr;
4538d763cef2SBarry Smith 
4539d763cef2SBarry Smith   PetscFunctionBegin;
45400700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45414482741eSBarry Smith   PetscValidPointer(prefix,2);
4542d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4543d763cef2SBarry Smith   PetscFunctionReturn(0);
4544d763cef2SBarry Smith }
4545d763cef2SBarry Smith 
4546d763cef2SBarry Smith /*@C
4547d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4548d763cef2SBarry Smith 
4549d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4550d763cef2SBarry Smith 
4551d763cef2SBarry Smith    Input Parameter:
4552d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4553d763cef2SBarry Smith 
4554d763cef2SBarry Smith    Output Parameters:
4555e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4556e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4557e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4558e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4559d763cef2SBarry Smith 
456095452b02SPatrick Sanan    Notes:
456195452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
4562d763cef2SBarry Smith 
4563d763cef2SBarry Smith    Level: intermediate
4564d763cef2SBarry Smith 
456580275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
4566d763cef2SBarry Smith 
4567d763cef2SBarry Smith @*/
4568e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4569d763cef2SBarry Smith {
4570089b2837SJed Brown   PetscErrorCode ierr;
457124989b8cSPeter Brune   DM             dm;
4572089b2837SJed Brown 
4573d763cef2SBarry Smith   PetscFunctionBegin;
457423a57915SBarry Smith   if (Amat || Pmat) {
457523a57915SBarry Smith     SNES snes;
4576089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
457723a57915SBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4578e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
457923a57915SBarry Smith   }
458024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
458124989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4582d763cef2SBarry Smith   PetscFunctionReturn(0);
4583d763cef2SBarry Smith }
4584d763cef2SBarry Smith 
45852eca1d9cSJed Brown /*@C
45862eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
45872eca1d9cSJed Brown 
45882eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
45892eca1d9cSJed Brown 
45902eca1d9cSJed Brown    Input Parameter:
45912eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
45922eca1d9cSJed Brown 
45932eca1d9cSJed Brown    Output Parameters:
4594e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4595e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
45962eca1d9cSJed Brown .  f   - The function to compute the matrices
45972eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
45982eca1d9cSJed Brown 
459995452b02SPatrick Sanan    Notes:
460095452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
46012eca1d9cSJed Brown 
46022eca1d9cSJed Brown    Level: advanced
46032eca1d9cSJed Brown 
460480275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
46052eca1d9cSJed Brown 
46062eca1d9cSJed Brown @*/
4607e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
46082eca1d9cSJed Brown {
4609089b2837SJed Brown   PetscErrorCode ierr;
461024989b8cSPeter Brune   DM             dm;
46110910c330SBarry Smith 
46122eca1d9cSJed Brown   PetscFunctionBegin;
4613c0aab802Sstefano_zampini   if (Amat || Pmat) {
4614c0aab802Sstefano_zampini     SNES snes;
4615089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4616f7d39f7aSBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4617e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
4618c0aab802Sstefano_zampini   }
461924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
462024989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
46212eca1d9cSJed Brown   PetscFunctionReturn(0);
46222eca1d9cSJed Brown }
46232eca1d9cSJed Brown 
46241713a123SBarry Smith /*@C
462583a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
46261713a123SBarry Smith    VecView() for the solution at each timestep
46271713a123SBarry Smith 
46281713a123SBarry Smith    Collective on TS
46291713a123SBarry Smith 
46301713a123SBarry Smith    Input Parameters:
46311713a123SBarry Smith +  ts - the TS context
46321713a123SBarry Smith .  step - current time-step
4633142b95e3SSatish Balay .  ptime - current time
46340298fd71SBarry Smith -  dummy - either a viewer or NULL
46351713a123SBarry Smith 
463699fdda47SBarry Smith    Options Database:
463799fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
463899fdda47SBarry Smith 
463995452b02SPatrick Sanan    Notes:
464095452b02SPatrick Sanan     the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
464199fdda47SBarry Smith        will look bad
464299fdda47SBarry Smith 
46431713a123SBarry Smith    Level: intermediate
46441713a123SBarry Smith 
4645a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
46461713a123SBarry Smith @*/
46470910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
46481713a123SBarry Smith {
4649dfbe8321SBarry Smith   PetscErrorCode   ierr;
465083a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4651473a3ab2SBarry Smith   PetscDraw        draw;
46521713a123SBarry Smith 
46531713a123SBarry Smith   PetscFunctionBegin;
46546083293cSBarry Smith   if (!step && ictx->showinitial) {
46556083293cSBarry Smith     if (!ictx->initialsolution) {
46560910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
46571713a123SBarry Smith     }
46580910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
46596083293cSBarry Smith   }
4660b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
46610dcf80beSBarry Smith 
46626083293cSBarry Smith   if (ictx->showinitial) {
46636083293cSBarry Smith     PetscReal pause;
46646083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
46656083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
46666083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
46676083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
46686083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
46696083293cSBarry Smith   }
46700910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4671473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
467251fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4673473a3ab2SBarry Smith     char      time[32];
4674473a3ab2SBarry Smith 
4675473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
467685b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4677473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4678473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
467951fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4680473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4681473a3ab2SBarry Smith   }
4682473a3ab2SBarry Smith 
46836083293cSBarry Smith   if (ictx->showinitial) {
46846083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
46856083293cSBarry Smith   }
46861713a123SBarry Smith   PetscFunctionReturn(0);
46871713a123SBarry Smith }
46881713a123SBarry Smith 
46899110b2e7SHong Zhang /*@C
46902d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
46912d5ee99bSBarry Smith 
46922d5ee99bSBarry Smith    Collective on TS
46932d5ee99bSBarry Smith 
46942d5ee99bSBarry Smith    Input Parameters:
46952d5ee99bSBarry Smith +  ts - the TS context
46962d5ee99bSBarry Smith .  step - current time-step
46972d5ee99bSBarry Smith .  ptime - current time
46982d5ee99bSBarry Smith -  dummy - either a viewer or NULL
46992d5ee99bSBarry Smith 
47002d5ee99bSBarry Smith    Level: intermediate
47012d5ee99bSBarry Smith 
47022d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
47032d5ee99bSBarry Smith @*/
47042d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
47052d5ee99bSBarry Smith {
47062d5ee99bSBarry Smith   PetscErrorCode    ierr;
47072d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
47082d5ee99bSBarry Smith   PetscDraw         draw;
47096934998bSLisandro Dalcin   PetscDrawAxis     axis;
47102d5ee99bSBarry Smith   PetscInt          n;
47112d5ee99bSBarry Smith   PetscMPIInt       size;
47126934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
47132d5ee99bSBarry Smith   char              time[32];
47142d5ee99bSBarry Smith   const PetscScalar *U;
47152d5ee99bSBarry Smith 
47162d5ee99bSBarry Smith   PetscFunctionBegin;
47176934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
47186934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
47192d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
47206934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
47212d5ee99bSBarry Smith 
47222d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
47236934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
47246934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
47256934998bSLisandro Dalcin   if (!step) {
47266934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
47276934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
47286934998bSLisandro Dalcin   }
47292d5ee99bSBarry Smith 
47302d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
47316934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
47326934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
4733a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
47346934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
47352d5ee99bSBarry Smith 
47366934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
47376934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
47382d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
47394b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
474085b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
47412d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
474251fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
47432d5ee99bSBarry Smith   }
47446934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
47452d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
474656d62c8fSLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
47476934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
47482d5ee99bSBarry Smith   PetscFunctionReturn(0);
47492d5ee99bSBarry Smith }
47502d5ee99bSBarry Smith 
47516083293cSBarry Smith /*@C
475283a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
47536083293cSBarry Smith 
47546083293cSBarry Smith    Collective on TS
47556083293cSBarry Smith 
47566083293cSBarry Smith    Input Parameters:
47576083293cSBarry Smith .    ctx - the monitor context
47586083293cSBarry Smith 
47596083293cSBarry Smith    Level: intermediate
47606083293cSBarry Smith 
476183a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
47626083293cSBarry Smith @*/
476383a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
47646083293cSBarry Smith {
47656083293cSBarry Smith   PetscErrorCode ierr;
47666083293cSBarry Smith 
47676083293cSBarry Smith   PetscFunctionBegin;
476883a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
476983a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
477083a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
47716083293cSBarry Smith   PetscFunctionReturn(0);
47726083293cSBarry Smith }
47736083293cSBarry Smith 
47746083293cSBarry Smith /*@C
477583a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
47766083293cSBarry Smith 
47776083293cSBarry Smith    Collective on TS
47786083293cSBarry Smith 
47796083293cSBarry Smith    Input Parameter:
47806083293cSBarry Smith .    ts - time-step context
47816083293cSBarry Smith 
47826083293cSBarry Smith    Output Patameter:
47836083293cSBarry Smith .    ctx - the monitor context
47846083293cSBarry Smith 
478599fdda47SBarry Smith    Options Database:
478699fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
478799fdda47SBarry Smith 
47886083293cSBarry Smith    Level: intermediate
47896083293cSBarry Smith 
479083a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
47916083293cSBarry Smith @*/
479283a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
47936083293cSBarry Smith {
47946083293cSBarry Smith   PetscErrorCode   ierr;
47956083293cSBarry Smith 
47966083293cSBarry Smith   PetscFunctionBegin;
4797b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
479883a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4799e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4800bbd56ea5SKarl Rupp 
480183a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4802473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
4803c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4804473a3ab2SBarry Smith 
4805473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
4806c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
48076083293cSBarry Smith   PetscFunctionReturn(0);
48086083293cSBarry Smith }
48096083293cSBarry Smith 
48103a471f94SBarry Smith /*@C
48110ed3bfb6SBarry Smith    TSMonitorDrawSolutionFunction - Monitors progress of the TS solvers by calling
48120ed3bfb6SBarry Smith    VecView() for the solution provided by TSSetSolutionFunction() at each timestep
48130ed3bfb6SBarry Smith 
48140ed3bfb6SBarry Smith    Collective on TS
48150ed3bfb6SBarry Smith 
48160ed3bfb6SBarry Smith    Input Parameters:
48170ed3bfb6SBarry Smith +  ts - the TS context
48180ed3bfb6SBarry Smith .  step - current time-step
48190ed3bfb6SBarry Smith .  ptime - current time
48200ed3bfb6SBarry Smith -  dummy - either a viewer or NULL
48210ed3bfb6SBarry Smith 
48220ed3bfb6SBarry Smith    Options Database:
48230ed3bfb6SBarry Smith .  -ts_monitor_draw_solution_function - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
48240ed3bfb6SBarry Smith 
48250ed3bfb6SBarry Smith    Level: intermediate
48260ed3bfb6SBarry Smith 
48270ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
48280ed3bfb6SBarry Smith @*/
48290ed3bfb6SBarry Smith PetscErrorCode  TSMonitorDrawSolutionFunction(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
48300ed3bfb6SBarry Smith {
48310ed3bfb6SBarry Smith   PetscErrorCode   ierr;
48320ed3bfb6SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
48330ed3bfb6SBarry Smith   PetscViewer      viewer = ctx->viewer;
48340ed3bfb6SBarry Smith   Vec              work;
48350ed3bfb6SBarry Smith 
48360ed3bfb6SBarry Smith   PetscFunctionBegin;
48370ed3bfb6SBarry Smith   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
48380ed3bfb6SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
48390ed3bfb6SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
48400ed3bfb6SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
48410ed3bfb6SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
48420ed3bfb6SBarry Smith   PetscFunctionReturn(0);
48430ed3bfb6SBarry Smith }
48440ed3bfb6SBarry Smith 
48450ed3bfb6SBarry Smith /*@C
484683a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
48473a471f94SBarry Smith    VecView() for the error at each timestep
48483a471f94SBarry Smith 
48493a471f94SBarry Smith    Collective on TS
48503a471f94SBarry Smith 
48513a471f94SBarry Smith    Input Parameters:
48523a471f94SBarry Smith +  ts - the TS context
48533a471f94SBarry Smith .  step - current time-step
48543a471f94SBarry Smith .  ptime - current time
48550298fd71SBarry Smith -  dummy - either a viewer or NULL
48563a471f94SBarry Smith 
48570ed3bfb6SBarry Smith    Options Database:
48580ed3bfb6SBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
48590ed3bfb6SBarry Smith 
48603a471f94SBarry Smith    Level: intermediate
48613a471f94SBarry Smith 
48620ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
48633a471f94SBarry Smith @*/
48640910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
48653a471f94SBarry Smith {
48663a471f94SBarry Smith   PetscErrorCode   ierr;
486783a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
486883a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
48693a471f94SBarry Smith   Vec              work;
48703a471f94SBarry Smith 
48713a471f94SBarry Smith   PetscFunctionBegin;
4872b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
48730910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
48743a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
48750910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
48763a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
48773a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
48783a471f94SBarry Smith   PetscFunctionReturn(0);
48793a471f94SBarry Smith }
48803a471f94SBarry Smith 
4881af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
48826c699258SBarry Smith /*@
48832a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
48846c699258SBarry Smith 
4885d083f849SBarry Smith    Logically Collective on ts
48866c699258SBarry Smith 
48876c699258SBarry Smith    Input Parameters:
48882a808120SBarry Smith +  ts - the ODE integrator object
48892a808120SBarry Smith -  dm - the dm, cannot be NULL
48906c699258SBarry Smith 
4891e03a659cSJed Brown    Notes:
4892e03a659cSJed Brown    A DM can only be used for solving one problem at a time because information about the problem is stored on the DM,
4893e03a659cSJed Brown    even when not using interfaces like DMTSSetIFunction().  Use DMClone() to get a distinct DM when solving
4894e03a659cSJed Brown    different problems using the same function space.
4895e03a659cSJed Brown 
48966c699258SBarry Smith    Level: intermediate
48976c699258SBarry Smith 
48986c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
48996c699258SBarry Smith @*/
49007087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
49016c699258SBarry Smith {
49026c699258SBarry Smith   PetscErrorCode ierr;
4903089b2837SJed Brown   SNES           snes;
4904942e3340SBarry Smith   DMTS           tsdm;
49056c699258SBarry Smith 
49066c699258SBarry Smith   PetscFunctionBegin;
49070700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49082a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
490970663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4910942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
49112a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4912942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4913942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
491424989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
491524989b8cSPeter Brune         tsdm->originaldm = dm;
491624989b8cSPeter Brune       }
491724989b8cSPeter Brune     }
49186bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
491924989b8cSPeter Brune   }
49206c699258SBarry Smith   ts->dm = dm;
4921bbd56ea5SKarl Rupp 
4922089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4923089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
49246c699258SBarry Smith   PetscFunctionReturn(0);
49256c699258SBarry Smith }
49266c699258SBarry Smith 
49276c699258SBarry Smith /*@
49286c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
49296c699258SBarry Smith 
49303f9fe445SBarry Smith    Not Collective
49316c699258SBarry Smith 
49326c699258SBarry Smith    Input Parameter:
49336c699258SBarry Smith . ts - the preconditioner context
49346c699258SBarry Smith 
49356c699258SBarry Smith    Output Parameter:
49366c699258SBarry Smith .  dm - the dm
49376c699258SBarry Smith 
49386c699258SBarry Smith    Level: intermediate
49396c699258SBarry Smith 
49406c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
49416c699258SBarry Smith @*/
49427087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
49436c699258SBarry Smith {
4944496e6a7aSJed Brown   PetscErrorCode ierr;
4945496e6a7aSJed Brown 
49466c699258SBarry Smith   PetscFunctionBegin;
49470700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4948496e6a7aSJed Brown   if (!ts->dm) {
4949ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4950496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4951496e6a7aSJed Brown   }
49526c699258SBarry Smith   *dm = ts->dm;
49536c699258SBarry Smith   PetscFunctionReturn(0);
49546c699258SBarry Smith }
49551713a123SBarry Smith 
49560f5c6efeSJed Brown /*@
49570f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
49580f5c6efeSJed Brown 
49593f9fe445SBarry Smith    Logically Collective on SNES
49600f5c6efeSJed Brown 
49610f5c6efeSJed Brown    Input Parameter:
4962d42a1c89SJed Brown + snes - nonlinear solver
49630910c330SBarry Smith . U - the current state at which to evaluate the residual
4964d42a1c89SJed Brown - ctx - user context, must be a TS
49650f5c6efeSJed Brown 
49660f5c6efeSJed Brown    Output Parameter:
49670f5c6efeSJed Brown . F - the nonlinear residual
49680f5c6efeSJed Brown 
49690f5c6efeSJed Brown    Notes:
49700f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
49710f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
49720f5c6efeSJed Brown 
49730f5c6efeSJed Brown    Level: advanced
49740f5c6efeSJed Brown 
49750f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
49760f5c6efeSJed Brown @*/
49770910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
49780f5c6efeSJed Brown {
49790f5c6efeSJed Brown   TS             ts = (TS)ctx;
49800f5c6efeSJed Brown   PetscErrorCode ierr;
49810f5c6efeSJed Brown 
49820f5c6efeSJed Brown   PetscFunctionBegin;
49830f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
49840910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
49850f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
49860f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
49870910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
49880f5c6efeSJed Brown   PetscFunctionReturn(0);
49890f5c6efeSJed Brown }
49900f5c6efeSJed Brown 
49910f5c6efeSJed Brown /*@
49920f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
49930f5c6efeSJed Brown 
49940f5c6efeSJed Brown    Collective on SNES
49950f5c6efeSJed Brown 
49960f5c6efeSJed Brown    Input Parameter:
49970f5c6efeSJed Brown + snes - nonlinear solver
49980910c330SBarry Smith . U - the current state at which to evaluate the residual
49990f5c6efeSJed Brown - ctx - user context, must be a TS
50000f5c6efeSJed Brown 
50010f5c6efeSJed Brown    Output Parameter:
50020f5c6efeSJed Brown + A - the Jacobian
50030f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
50040f5c6efeSJed Brown - flag - indicates any structure change in the matrix
50050f5c6efeSJed Brown 
50060f5c6efeSJed Brown    Notes:
50070f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
50080f5c6efeSJed Brown 
50090f5c6efeSJed Brown    Level: developer
50100f5c6efeSJed Brown 
50110f5c6efeSJed Brown .seealso: SNESSetJacobian()
50120f5c6efeSJed Brown @*/
5013d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
50140f5c6efeSJed Brown {
50150f5c6efeSJed Brown   TS             ts = (TS)ctx;
50160f5c6efeSJed Brown   PetscErrorCode ierr;
50170f5c6efeSJed Brown 
50180f5c6efeSJed Brown   PetscFunctionBegin;
50190f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
50200910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
50210f5c6efeSJed Brown   PetscValidPointer(A,3);
502294ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
50230f5c6efeSJed Brown   PetscValidPointer(B,4);
502494ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
50250f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
5026d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
50270f5c6efeSJed Brown   PetscFunctionReturn(0);
50280f5c6efeSJed Brown }
5029325fc9f4SBarry Smith 
50300e4ef248SJed Brown /*@C
50319ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
50320e4ef248SJed Brown 
50330e4ef248SJed Brown    Collective on TS
50340e4ef248SJed Brown 
50350e4ef248SJed Brown    Input Arguments:
50360e4ef248SJed Brown +  ts - time stepping context
50370e4ef248SJed Brown .  t - time at which to evaluate
50380910c330SBarry Smith .  U - state at which to evaluate
50390e4ef248SJed Brown -  ctx - context
50400e4ef248SJed Brown 
50410e4ef248SJed Brown    Output Arguments:
50420e4ef248SJed Brown .  F - right hand side
50430e4ef248SJed Brown 
50440e4ef248SJed Brown    Level: intermediate
50450e4ef248SJed Brown 
50460e4ef248SJed Brown    Notes:
50470e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
50480e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
50490e4ef248SJed Brown 
50500e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
50510e4ef248SJed Brown @*/
50520910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
50530e4ef248SJed Brown {
50540e4ef248SJed Brown   PetscErrorCode ierr;
50550e4ef248SJed Brown   Mat            Arhs,Brhs;
50560e4ef248SJed Brown 
50570e4ef248SJed Brown   PetscFunctionBegin;
50580e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
5059d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
50600910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
50610e4ef248SJed Brown   PetscFunctionReturn(0);
50620e4ef248SJed Brown }
50630e4ef248SJed Brown 
50640e4ef248SJed Brown /*@C
50650e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
50660e4ef248SJed Brown 
50670e4ef248SJed Brown    Collective on TS
50680e4ef248SJed Brown 
50690e4ef248SJed Brown    Input Arguments:
50700e4ef248SJed Brown +  ts - time stepping context
50710e4ef248SJed Brown .  t - time at which to evaluate
50720910c330SBarry Smith .  U - state at which to evaluate
50730e4ef248SJed Brown -  ctx - context
50740e4ef248SJed Brown 
50750e4ef248SJed Brown    Output Arguments:
50760e4ef248SJed Brown +  A - pointer to operator
50770e4ef248SJed Brown .  B - pointer to preconditioning matrix
50780e4ef248SJed Brown -  flg - matrix structure flag
50790e4ef248SJed Brown 
50800e4ef248SJed Brown    Level: intermediate
50810e4ef248SJed Brown 
50820e4ef248SJed Brown    Notes:
50830e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
50840e4ef248SJed Brown 
50850e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
50860e4ef248SJed Brown @*/
5087d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
50880e4ef248SJed Brown {
50890e4ef248SJed Brown   PetscFunctionBegin;
50900e4ef248SJed Brown   PetscFunctionReturn(0);
50910e4ef248SJed Brown }
50920e4ef248SJed Brown 
50930026cea9SSean Farley /*@C
50940026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
50950026cea9SSean Farley 
50960026cea9SSean Farley    Collective on TS
50970026cea9SSean Farley 
50980026cea9SSean Farley    Input Arguments:
50990026cea9SSean Farley +  ts - time stepping context
51000026cea9SSean Farley .  t - time at which to evaluate
51010910c330SBarry Smith .  U - state at which to evaluate
51020910c330SBarry Smith .  Udot - time derivative of state vector
51030026cea9SSean Farley -  ctx - context
51040026cea9SSean Farley 
51050026cea9SSean Farley    Output Arguments:
51060026cea9SSean Farley .  F - left hand side
51070026cea9SSean Farley 
51080026cea9SSean Farley    Level: intermediate
51090026cea9SSean Farley 
51100026cea9SSean Farley    Notes:
51110910c330SBarry 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
51120026cea9SSean Farley    user is required to write their own TSComputeIFunction.
51130026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
51140026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
51150026cea9SSean Farley 
51169ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
51179ae8fd06SBarry Smith 
51189ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
51190026cea9SSean Farley @*/
51200910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
51210026cea9SSean Farley {
51220026cea9SSean Farley   PetscErrorCode ierr;
51230026cea9SSean Farley   Mat            A,B;
51240026cea9SSean Farley 
51250026cea9SSean Farley   PetscFunctionBegin;
51260298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
5127d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
51280910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
51290026cea9SSean Farley   PetscFunctionReturn(0);
51300026cea9SSean Farley }
51310026cea9SSean Farley 
51320026cea9SSean Farley /*@C
5133b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
51340026cea9SSean Farley 
51350026cea9SSean Farley    Collective on TS
51360026cea9SSean Farley 
51370026cea9SSean Farley    Input Arguments:
51380026cea9SSean Farley +  ts - time stepping context
51390026cea9SSean Farley .  t - time at which to evaluate
51400910c330SBarry Smith .  U - state at which to evaluate
51410910c330SBarry Smith .  Udot - time derivative of state vector
51420026cea9SSean Farley .  shift - shift to apply
51430026cea9SSean Farley -  ctx - context
51440026cea9SSean Farley 
51450026cea9SSean Farley    Output Arguments:
51460026cea9SSean Farley +  A - pointer to operator
51470026cea9SSean Farley .  B - pointer to preconditioning matrix
51480026cea9SSean Farley -  flg - matrix structure flag
51490026cea9SSean Farley 
5150b41af12eSJed Brown    Level: advanced
51510026cea9SSean Farley 
51520026cea9SSean Farley    Notes:
51530026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
51540026cea9SSean Farley 
5155b41af12eSJed Brown    It is only appropriate for problems of the form
5156b41af12eSJed Brown 
5157b41af12eSJed Brown $     M Udot = F(U,t)
5158b41af12eSJed Brown 
5159b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
5160b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5161b41af12eSJed Brown   an implicit operator of the form
5162b41af12eSJed Brown 
5163b41af12eSJed Brown $    shift*M + J
5164b41af12eSJed Brown 
5165b41af12eSJed 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
5166b41af12eSJed Brown   a copy of M or reassemble it when requested.
5167b41af12eSJed Brown 
51680026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
51690026cea9SSean Farley @*/
5170d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
51710026cea9SSean Farley {
5172b41af12eSJed Brown   PetscErrorCode ierr;
5173b41af12eSJed Brown 
51740026cea9SSean Farley   PetscFunctionBegin;
517594ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
5176b41af12eSJed Brown   ts->ijacobian.shift = shift;
51770026cea9SSean Farley   PetscFunctionReturn(0);
51780026cea9SSean Farley }
5179b41af12eSJed Brown 
5180e817cc15SEmil Constantinescu /*@
5181e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
5182e817cc15SEmil Constantinescu 
5183e817cc15SEmil Constantinescu    Not Collective
5184e817cc15SEmil Constantinescu 
5185e817cc15SEmil Constantinescu    Input Parameter:
5186e817cc15SEmil Constantinescu .  ts - the TS context
5187e817cc15SEmil Constantinescu 
5188e817cc15SEmil Constantinescu    Output Parameter:
51894e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
5190e817cc15SEmil Constantinescu 
5191e817cc15SEmil Constantinescu    Level: beginner
5192e817cc15SEmil Constantinescu 
5193e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
5194e817cc15SEmil Constantinescu @*/
5195e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
5196e817cc15SEmil Constantinescu {
5197e817cc15SEmil Constantinescu   PetscFunctionBegin;
5198e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5199e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
5200e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
5201e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5202e817cc15SEmil Constantinescu }
5203e817cc15SEmil Constantinescu 
5204e817cc15SEmil Constantinescu /*@
5205e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
5206e817cc15SEmil Constantinescu 
5207e817cc15SEmil Constantinescu    Not Collective
5208e817cc15SEmil Constantinescu 
5209e817cc15SEmil Constantinescu    Input Parameter:
5210e817cc15SEmil Constantinescu +  ts - the TS context
52111297b224SEmil Constantinescu -  equation_type - see TSEquationType
5212e817cc15SEmil Constantinescu 
5213e817cc15SEmil Constantinescu    Level: advanced
5214e817cc15SEmil Constantinescu 
5215e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
5216e817cc15SEmil Constantinescu @*/
5217e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
5218e817cc15SEmil Constantinescu {
5219e817cc15SEmil Constantinescu   PetscFunctionBegin;
5220e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5221e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
5222e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5223e817cc15SEmil Constantinescu }
52240026cea9SSean Farley 
52254af1b03aSJed Brown /*@
52264af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
52274af1b03aSJed Brown 
52284af1b03aSJed Brown    Not Collective
52294af1b03aSJed Brown 
52304af1b03aSJed Brown    Input Parameter:
52314af1b03aSJed Brown .  ts - the TS context
52324af1b03aSJed Brown 
52334af1b03aSJed Brown    Output Parameter:
52344af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
52354af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
52364af1b03aSJed Brown 
5237487e0bb9SJed Brown    Level: beginner
52384af1b03aSJed Brown 
5239cd652676SJed Brown    Notes:
5240cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
52414af1b03aSJed Brown 
52424af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
52434af1b03aSJed Brown @*/
52444af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
52454af1b03aSJed Brown {
52464af1b03aSJed Brown   PetscFunctionBegin;
52474af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
52484af1b03aSJed Brown   PetscValidPointer(reason,2);
52494af1b03aSJed Brown   *reason = ts->reason;
52504af1b03aSJed Brown   PetscFunctionReturn(0);
52514af1b03aSJed Brown }
52524af1b03aSJed Brown 
5253d6ad946cSShri Abhyankar /*@
5254d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5255d6ad946cSShri Abhyankar 
52566b221cbeSPatrick Sanan    Logically Collective; reason must contain common value
5257d6ad946cSShri Abhyankar 
52586b221cbeSPatrick Sanan    Input Parameters:
5259d6ad946cSShri Abhyankar +  ts - the TS context
52606b221cbeSPatrick Sanan -  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5261d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
5262d6ad946cSShri Abhyankar 
5263f5abba47SShri Abhyankar    Level: advanced
5264d6ad946cSShri Abhyankar 
5265d6ad946cSShri Abhyankar    Notes:
52666b221cbeSPatrick Sanan    Can only be called while TSSolve() is active.
5267d6ad946cSShri Abhyankar 
5268d6ad946cSShri Abhyankar .seealso: TSConvergedReason
5269d6ad946cSShri Abhyankar @*/
5270d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
5271d6ad946cSShri Abhyankar {
5272d6ad946cSShri Abhyankar   PetscFunctionBegin;
5273d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5274d6ad946cSShri Abhyankar   ts->reason = reason;
5275d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
5276d6ad946cSShri Abhyankar }
5277d6ad946cSShri Abhyankar 
5278cc708dedSBarry Smith /*@
5279cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
5280cc708dedSBarry Smith 
5281cc708dedSBarry Smith    Not Collective
5282cc708dedSBarry Smith 
5283cc708dedSBarry Smith    Input Parameter:
5284cc708dedSBarry Smith .  ts - the TS context
5285cc708dedSBarry Smith 
5286cc708dedSBarry Smith    Output Parameter:
528719eac22cSLisandro Dalcin .  ftime - the final time. This time corresponds to the final time set with TSSetMaxTime()
5288cc708dedSBarry Smith 
5289487e0bb9SJed Brown    Level: beginner
5290cc708dedSBarry Smith 
5291cc708dedSBarry Smith    Notes:
5292cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
5293cc708dedSBarry Smith 
5294cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
5295cc708dedSBarry Smith @*/
5296cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
5297cc708dedSBarry Smith {
5298cc708dedSBarry Smith   PetscFunctionBegin;
5299cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5300cc708dedSBarry Smith   PetscValidPointer(ftime,2);
5301cc708dedSBarry Smith   *ftime = ts->solvetime;
5302cc708dedSBarry Smith   PetscFunctionReturn(0);
5303cc708dedSBarry Smith }
5304cc708dedSBarry Smith 
53052c18e0fdSBarry Smith /*@
53065ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
53079f67acb7SJed Brown    used by the time integrator.
53089f67acb7SJed Brown 
53099f67acb7SJed Brown    Not Collective
53109f67acb7SJed Brown 
53119f67acb7SJed Brown    Input Parameter:
53129f67acb7SJed Brown .  ts - TS context
53139f67acb7SJed Brown 
53149f67acb7SJed Brown    Output Parameter:
53159f67acb7SJed Brown .  nits - number of nonlinear iterations
53169f67acb7SJed Brown 
53179f67acb7SJed Brown    Notes:
53189f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
53199f67acb7SJed Brown 
53209f67acb7SJed Brown    Level: intermediate
53219f67acb7SJed Brown 
53225ef26d82SJed Brown .seealso:  TSGetKSPIterations()
53239f67acb7SJed Brown @*/
53245ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
53259f67acb7SJed Brown {
53269f67acb7SJed Brown   PetscFunctionBegin;
53279f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53289f67acb7SJed Brown   PetscValidIntPointer(nits,2);
53295ef26d82SJed Brown   *nits = ts->snes_its;
53309f67acb7SJed Brown   PetscFunctionReturn(0);
53319f67acb7SJed Brown }
53329f67acb7SJed Brown 
53339f67acb7SJed Brown /*@
53345ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
53359f67acb7SJed Brown    used by the time integrator.
53369f67acb7SJed Brown 
53379f67acb7SJed Brown    Not Collective
53389f67acb7SJed Brown 
53399f67acb7SJed Brown    Input Parameter:
53409f67acb7SJed Brown .  ts - TS context
53419f67acb7SJed Brown 
53429f67acb7SJed Brown    Output Parameter:
53439f67acb7SJed Brown .  lits - number of linear iterations
53449f67acb7SJed Brown 
53459f67acb7SJed Brown    Notes:
53469f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
53479f67acb7SJed Brown 
53489f67acb7SJed Brown    Level: intermediate
53499f67acb7SJed Brown 
53505ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
53519f67acb7SJed Brown @*/
53525ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
53539f67acb7SJed Brown {
53549f67acb7SJed Brown   PetscFunctionBegin;
53559f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53569f67acb7SJed Brown   PetscValidIntPointer(lits,2);
53575ef26d82SJed Brown   *lits = ts->ksp_its;
53589f67acb7SJed Brown   PetscFunctionReturn(0);
53599f67acb7SJed Brown }
53609f67acb7SJed Brown 
5361cef5090cSJed Brown /*@
5362cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5363cef5090cSJed Brown 
5364cef5090cSJed Brown    Not Collective
5365cef5090cSJed Brown 
5366cef5090cSJed Brown    Input Parameter:
5367cef5090cSJed Brown .  ts - TS context
5368cef5090cSJed Brown 
5369cef5090cSJed Brown    Output Parameter:
5370cef5090cSJed Brown .  rejects - number of steps rejected
5371cef5090cSJed Brown 
5372cef5090cSJed Brown    Notes:
5373cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5374cef5090cSJed Brown 
5375cef5090cSJed Brown    Level: intermediate
5376cef5090cSJed Brown 
53775ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5378cef5090cSJed Brown @*/
5379cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5380cef5090cSJed Brown {
5381cef5090cSJed Brown   PetscFunctionBegin;
5382cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5383cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5384cef5090cSJed Brown   *rejects = ts->reject;
5385cef5090cSJed Brown   PetscFunctionReturn(0);
5386cef5090cSJed Brown }
5387cef5090cSJed Brown 
5388cef5090cSJed Brown /*@
5389cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5390cef5090cSJed Brown 
5391cef5090cSJed Brown    Not Collective
5392cef5090cSJed Brown 
5393cef5090cSJed Brown    Input Parameter:
5394cef5090cSJed Brown .  ts - TS context
5395cef5090cSJed Brown 
5396cef5090cSJed Brown    Output Parameter:
5397cef5090cSJed Brown .  fails - number of failed nonlinear solves
5398cef5090cSJed Brown 
5399cef5090cSJed Brown    Notes:
5400cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5401cef5090cSJed Brown 
5402cef5090cSJed Brown    Level: intermediate
5403cef5090cSJed Brown 
54045ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5405cef5090cSJed Brown @*/
5406cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5407cef5090cSJed Brown {
5408cef5090cSJed Brown   PetscFunctionBegin;
5409cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5410cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5411cef5090cSJed Brown   *fails = ts->num_snes_failures;
5412cef5090cSJed Brown   PetscFunctionReturn(0);
5413cef5090cSJed Brown }
5414cef5090cSJed Brown 
5415cef5090cSJed Brown /*@
5416cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5417cef5090cSJed Brown 
5418cef5090cSJed Brown    Not Collective
5419cef5090cSJed Brown 
5420cef5090cSJed Brown    Input Parameter:
5421cef5090cSJed Brown +  ts - TS context
5422cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5423cef5090cSJed Brown 
5424cef5090cSJed Brown    Notes:
5425cef5090cSJed Brown    The counter is reset to zero for each step
5426cef5090cSJed Brown 
5427cef5090cSJed Brown    Options Database Key:
5428cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5429cef5090cSJed Brown 
5430cef5090cSJed Brown    Level: intermediate
5431cef5090cSJed Brown 
54325ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5433cef5090cSJed Brown @*/
5434cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5435cef5090cSJed Brown {
5436cef5090cSJed Brown   PetscFunctionBegin;
5437cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5438cef5090cSJed Brown   ts->max_reject = rejects;
5439cef5090cSJed Brown   PetscFunctionReturn(0);
5440cef5090cSJed Brown }
5441cef5090cSJed Brown 
5442cef5090cSJed Brown /*@
5443cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5444cef5090cSJed Brown 
5445cef5090cSJed Brown    Not Collective
5446cef5090cSJed Brown 
5447cef5090cSJed Brown    Input Parameter:
5448cef5090cSJed Brown +  ts - TS context
5449cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5450cef5090cSJed Brown 
5451cef5090cSJed Brown    Notes:
5452cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5453cef5090cSJed Brown 
5454cef5090cSJed Brown    Options Database Key:
5455cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5456cef5090cSJed Brown 
5457cef5090cSJed Brown    Level: intermediate
5458cef5090cSJed Brown 
54595ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5460cef5090cSJed Brown @*/
5461cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5462cef5090cSJed Brown {
5463cef5090cSJed Brown   PetscFunctionBegin;
5464cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5465cef5090cSJed Brown   ts->max_snes_failures = fails;
5466cef5090cSJed Brown   PetscFunctionReturn(0);
5467cef5090cSJed Brown }
5468cef5090cSJed Brown 
5469cef5090cSJed Brown /*@
5470cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5471cef5090cSJed Brown 
5472cef5090cSJed Brown    Not Collective
5473cef5090cSJed Brown 
5474cef5090cSJed Brown    Input Parameter:
5475cef5090cSJed Brown +  ts - TS context
5476cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5477cef5090cSJed Brown 
5478cef5090cSJed Brown    Options Database Key:
5479cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5480cef5090cSJed Brown 
5481cef5090cSJed Brown    Level: intermediate
5482cef5090cSJed Brown 
54835ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5484cef5090cSJed Brown @*/
5485cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5486cef5090cSJed Brown {
5487cef5090cSJed Brown   PetscFunctionBegin;
5488cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5489cef5090cSJed Brown   ts->errorifstepfailed = err;
5490cef5090cSJed Brown   PetscFunctionReturn(0);
5491cef5090cSJed Brown }
5492cef5090cSJed Brown 
5493fb1732b5SBarry Smith /*@C
5494fde5950dSBarry Smith    TSMonitorSolution - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file or a PetscDraw object
5495fb1732b5SBarry Smith 
5496fb1732b5SBarry Smith    Collective on TS
5497fb1732b5SBarry Smith 
5498fb1732b5SBarry Smith    Input Parameters:
5499fb1732b5SBarry Smith +  ts - the TS context
5500fb1732b5SBarry Smith .  step - current time-step
5501fb1732b5SBarry Smith .  ptime - current time
55020910c330SBarry Smith .  u - current state
5503721cd6eeSBarry Smith -  vf - viewer and its format
5504fb1732b5SBarry Smith 
5505fb1732b5SBarry Smith    Level: intermediate
5506fb1732b5SBarry Smith 
5507fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5508fb1732b5SBarry Smith @*/
5509721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5510fb1732b5SBarry Smith {
5511fb1732b5SBarry Smith   PetscErrorCode ierr;
5512fb1732b5SBarry Smith 
5513fb1732b5SBarry Smith   PetscFunctionBegin;
5514721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5515721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5516721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5517ed81e22dSJed Brown   PetscFunctionReturn(0);
5518ed81e22dSJed Brown }
5519ed81e22dSJed Brown 
5520ed81e22dSJed Brown /*@C
5521ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5522ed81e22dSJed Brown 
5523ed81e22dSJed Brown    Collective on TS
5524ed81e22dSJed Brown 
5525ed81e22dSJed Brown    Input Parameters:
5526ed81e22dSJed Brown +  ts - the TS context
5527ed81e22dSJed Brown .  step - current time-step
5528ed81e22dSJed Brown .  ptime - current time
55290910c330SBarry Smith .  u - current state
5530ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5531ed81e22dSJed Brown 
5532ed81e22dSJed Brown    Level: intermediate
5533ed81e22dSJed Brown 
5534ed81e22dSJed Brown    Notes:
5535ed81e22dSJed Brown    The VTK format does not allow writing multiple time steps in the same file, therefore a different file will be written for each time step.
5536ed81e22dSJed Brown    These are named according to the file name template.
5537ed81e22dSJed Brown 
5538ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5539ed81e22dSJed Brown 
5540ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5541ed81e22dSJed Brown @*/
55420910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5543ed81e22dSJed Brown {
5544ed81e22dSJed Brown   PetscErrorCode ierr;
5545ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5546ed81e22dSJed Brown   PetscViewer    viewer;
5547ed81e22dSJed Brown 
5548ed81e22dSJed Brown   PetscFunctionBegin;
554963e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
55508caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5551ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
55520910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5553ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5554ed81e22dSJed Brown   PetscFunctionReturn(0);
5555ed81e22dSJed Brown }
5556ed81e22dSJed Brown 
5557ed81e22dSJed Brown /*@C
5558ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5559ed81e22dSJed Brown 
5560ed81e22dSJed Brown    Collective on TS
5561ed81e22dSJed Brown 
5562ed81e22dSJed Brown    Input Parameters:
5563ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5564ed81e22dSJed Brown 
5565ed81e22dSJed Brown    Level: intermediate
5566ed81e22dSJed Brown 
5567ed81e22dSJed Brown    Note:
5568ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5569ed81e22dSJed Brown 
5570ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5571ed81e22dSJed Brown @*/
5572ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5573ed81e22dSJed Brown {
5574ed81e22dSJed Brown   PetscErrorCode ierr;
5575ed81e22dSJed Brown 
5576ed81e22dSJed Brown   PetscFunctionBegin;
5577ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5578fb1732b5SBarry Smith   PetscFunctionReturn(0);
5579fb1732b5SBarry Smith }
5580fb1732b5SBarry Smith 
558184df9cb4SJed Brown /*@
5582552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
558384df9cb4SJed Brown 
5584ed81e22dSJed Brown    Collective on TS if controller has not been created yet
558584df9cb4SJed Brown 
558684df9cb4SJed Brown    Input Arguments:
5587ed81e22dSJed Brown .  ts - time stepping context
558884df9cb4SJed Brown 
558984df9cb4SJed Brown    Output Arguments:
5590ed81e22dSJed Brown .  adapt - adaptive controller
559184df9cb4SJed Brown 
559284df9cb4SJed Brown    Level: intermediate
559384df9cb4SJed Brown 
5594ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
559584df9cb4SJed Brown @*/
5596552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
559784df9cb4SJed Brown {
559884df9cb4SJed Brown   PetscErrorCode ierr;
559984df9cb4SJed Brown 
560084df9cb4SJed Brown   PetscFunctionBegin;
560184df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5602bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
560384df9cb4SJed Brown   if (!ts->adapt) {
5604ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
56053bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
56061c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
560784df9cb4SJed Brown   }
5608bec58848SLisandro Dalcin   *adapt = ts->adapt;
560984df9cb4SJed Brown   PetscFunctionReturn(0);
561084df9cb4SJed Brown }
5611d6ebe24aSShri Abhyankar 
56121c3436cfSJed Brown /*@
56131c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
56141c3436cfSJed Brown 
56151c3436cfSJed Brown    Logically Collective
56161c3436cfSJed Brown 
56171c3436cfSJed Brown    Input Arguments:
56181c3436cfSJed Brown +  ts - time integration context
56191c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
56200298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
56211c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
56220298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
56231c3436cfSJed Brown 
5624a3cdaa26SBarry Smith    Options Database keys:
5625a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5626a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5627a3cdaa26SBarry Smith 
56283ff766beSShri Abhyankar    Notes:
56293ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
56303ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
56313ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
56323ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
56333ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
56343ff766beSShri Abhyankar    differential variables.
56353ff766beSShri Abhyankar 
56361c3436cfSJed Brown    Level: beginner
56371c3436cfSJed Brown 
56385c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSGetTolerances()
56391c3436cfSJed Brown @*/
56401c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
56411c3436cfSJed Brown {
56421c3436cfSJed Brown   PetscErrorCode ierr;
56431c3436cfSJed Brown 
56441c3436cfSJed Brown   PetscFunctionBegin;
5645c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
56461c3436cfSJed Brown   if (vatol) {
56471c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
56481c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
56491c3436cfSJed Brown     ts->vatol = vatol;
56501c3436cfSJed Brown   }
5651c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
56521c3436cfSJed Brown   if (vrtol) {
56531c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
56541c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
56551c3436cfSJed Brown     ts->vrtol = vrtol;
56561c3436cfSJed Brown   }
56571c3436cfSJed Brown   PetscFunctionReturn(0);
56581c3436cfSJed Brown }
56591c3436cfSJed Brown 
5660c5033834SJed Brown /*@
5661c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5662c5033834SJed Brown 
5663c5033834SJed Brown    Logically Collective
5664c5033834SJed Brown 
5665c5033834SJed Brown    Input Arguments:
5666c5033834SJed Brown .  ts - time integration context
5667c5033834SJed Brown 
5668c5033834SJed Brown    Output Arguments:
56690298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
56700298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
56710298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
56720298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5673c5033834SJed Brown 
5674c5033834SJed Brown    Level: beginner
5675c5033834SJed Brown 
56765c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSSetTolerances()
5677c5033834SJed Brown @*/
5678c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5679c5033834SJed Brown {
5680c5033834SJed Brown   PetscFunctionBegin;
5681c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5682c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5683c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5684c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5685c5033834SJed Brown   PetscFunctionReturn(0);
5686c5033834SJed Brown }
5687c5033834SJed Brown 
56889c6b16b5SShri Abhyankar /*@
5689a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
56909c6b16b5SShri Abhyankar 
56919c6b16b5SShri Abhyankar    Collective on TS
56929c6b16b5SShri Abhyankar 
56939c6b16b5SShri Abhyankar    Input Arguments:
56949c6b16b5SShri Abhyankar +  ts - time stepping context
5695a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5696a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
56979c6b16b5SShri Abhyankar 
56989c6b16b5SShri Abhyankar    Output Arguments:
5699a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
57007453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5701a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
57029c6b16b5SShri Abhyankar 
57039c6b16b5SShri Abhyankar    Level: developer
57049c6b16b5SShri Abhyankar 
5705deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
57069c6b16b5SShri Abhyankar @*/
57077453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
57089c6b16b5SShri Abhyankar {
57099c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
57109c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
57117453f775SEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
57127453f775SEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
57139c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
57147453f775SEmil Constantinescu   PetscReal         sum,suma,sumr,gsum,gsuma,gsumr,diff;
57157453f775SEmil Constantinescu   PetscReal         tol,tola,tolr;
57167453f775SEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
57179c6b16b5SShri Abhyankar 
57189c6b16b5SShri Abhyankar   PetscFunctionBegin;
57199c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5720a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5721a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5722a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5723a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5724a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5725a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
57268a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
57278a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
5728a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
57299c6b16b5SShri Abhyankar 
57309c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
57319c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
57329c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
57339c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
57349c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
57357453f775SEmil Constantinescu   sum  = 0.; n_loc  = 0;
57367453f775SEmil Constantinescu   suma = 0.; na_loc = 0;
57377453f775SEmil Constantinescu   sumr = 0.; nr_loc = 0;
57389c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
57399c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
57409c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
57419c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
57429c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
574376cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
57447453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
57457453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
57467453f775SEmil Constantinescu       if(tola>0.){
57477453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
57487453f775SEmil Constantinescu         na_loc++;
57497453f775SEmil Constantinescu       }
57507453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
57517453f775SEmil Constantinescu       if(tolr>0.){
57527453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
57537453f775SEmil Constantinescu         nr_loc++;
57547453f775SEmil Constantinescu       }
57557453f775SEmil Constantinescu       tol=tola+tolr;
57567453f775SEmil Constantinescu       if(tol>0.){
57577453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
57587453f775SEmil Constantinescu         n_loc++;
57597453f775SEmil Constantinescu       }
57609c6b16b5SShri Abhyankar     }
57619c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
57629c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
57639c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
57649c6b16b5SShri Abhyankar     const PetscScalar *atol;
57659c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
57669c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
576776cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
57687453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
57697453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
57707453f775SEmil Constantinescu       if(tola>0.){
57717453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
57727453f775SEmil Constantinescu         na_loc++;
57737453f775SEmil Constantinescu       }
57747453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
57757453f775SEmil Constantinescu       if(tolr>0.){
57767453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
57777453f775SEmil Constantinescu         nr_loc++;
57787453f775SEmil Constantinescu       }
57797453f775SEmil Constantinescu       tol=tola+tolr;
57807453f775SEmil Constantinescu       if(tol>0.){
57817453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
57827453f775SEmil Constantinescu         n_loc++;
57837453f775SEmil Constantinescu       }
57849c6b16b5SShri Abhyankar     }
57859c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
57869c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
57879c6b16b5SShri Abhyankar     const PetscScalar *rtol;
57889c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
57899c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
579076cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
57917453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
57927453f775SEmil Constantinescu       tola = ts->atol;
57937453f775SEmil Constantinescu       if(tola>0.){
57947453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
57957453f775SEmil Constantinescu         na_loc++;
57967453f775SEmil Constantinescu       }
57977453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
57987453f775SEmil Constantinescu       if(tolr>0.){
57997453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
58007453f775SEmil Constantinescu         nr_loc++;
58017453f775SEmil Constantinescu       }
58027453f775SEmil Constantinescu       tol=tola+tolr;
58037453f775SEmil Constantinescu       if(tol>0.){
58047453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
58057453f775SEmil Constantinescu         n_loc++;
58067453f775SEmil Constantinescu       }
58079c6b16b5SShri Abhyankar     }
58089c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58099c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
58109c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
581176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
58127453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
58137453f775SEmil Constantinescu       tola = ts->atol;
58147453f775SEmil Constantinescu       if(tola>0.){
58157453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
58167453f775SEmil Constantinescu         na_loc++;
58177453f775SEmil Constantinescu       }
58187453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58197453f775SEmil Constantinescu       if(tolr>0.){
58207453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
58217453f775SEmil Constantinescu         nr_loc++;
58227453f775SEmil Constantinescu       }
58237453f775SEmil Constantinescu       tol=tola+tolr;
58247453f775SEmil Constantinescu       if(tol>0.){
58257453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
58267453f775SEmil Constantinescu         n_loc++;
58277453f775SEmil Constantinescu       }
58289c6b16b5SShri Abhyankar     }
58299c6b16b5SShri Abhyankar   }
58309c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
58319c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
58329c6b16b5SShri Abhyankar 
58337453f775SEmil Constantinescu   err_loc[0] = sum;
58347453f775SEmil Constantinescu   err_loc[1] = suma;
58357453f775SEmil Constantinescu   err_loc[2] = sumr;
58367453f775SEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
58377453f775SEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
58387453f775SEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
58397453f775SEmil Constantinescu 
5840a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
58417453f775SEmil Constantinescu 
58427453f775SEmil Constantinescu   gsum   = err_glb[0];
58437453f775SEmil Constantinescu   gsuma  = err_glb[1];
58447453f775SEmil Constantinescu   gsumr  = err_glb[2];
58457453f775SEmil Constantinescu   n_glb  = err_glb[3];
58467453f775SEmil Constantinescu   na_glb = err_glb[4];
58477453f775SEmil Constantinescu   nr_glb = err_glb[5];
58487453f775SEmil Constantinescu 
5849b1316ef9SEmil Constantinescu   *norm  = 0.;
5850b1316ef9SEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
5851b1316ef9SEmil Constantinescu   *norma = 0.;
5852b1316ef9SEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
5853b1316ef9SEmil Constantinescu   *normr = 0.;
5854b1316ef9SEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
58559c6b16b5SShri Abhyankar 
58569c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
58577453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
58587453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
58599c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
58609c6b16b5SShri Abhyankar }
58619c6b16b5SShri Abhyankar 
58629c6b16b5SShri Abhyankar /*@
5863a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
58649c6b16b5SShri Abhyankar 
58659c6b16b5SShri Abhyankar    Collective on TS
58669c6b16b5SShri Abhyankar 
58679c6b16b5SShri Abhyankar    Input Arguments:
58689c6b16b5SShri Abhyankar +  ts - time stepping context
5869a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5870a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
58719c6b16b5SShri Abhyankar 
58729c6b16b5SShri Abhyankar    Output Arguments:
5873a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
58747453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5875a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
58769c6b16b5SShri Abhyankar 
58779c6b16b5SShri Abhyankar    Level: developer
58789c6b16b5SShri Abhyankar 
5879deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
58809c6b16b5SShri Abhyankar @*/
58817453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
58829c6b16b5SShri Abhyankar {
58839c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
58847453f775SEmil Constantinescu   PetscInt          i,n,N,rstart;
58859c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
58867453f775SEmil Constantinescu   PetscReal         max,gmax,maxa,gmaxa,maxr,gmaxr;
58877453f775SEmil Constantinescu   PetscReal         tol,tola,tolr,diff;
58887453f775SEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
58899c6b16b5SShri Abhyankar 
58909c6b16b5SShri Abhyankar   PetscFunctionBegin;
58919c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5892a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5893a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5894a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5895a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5896a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5897a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
58988a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
58998a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
5900a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
59019c6b16b5SShri Abhyankar 
59029c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
59039c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
59049c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
59059c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
59069c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
59077453f775SEmil Constantinescu 
59087453f775SEmil Constantinescu   max=0.;
59097453f775SEmil Constantinescu   maxa=0.;
59107453f775SEmil Constantinescu   maxr=0.;
59117453f775SEmil Constantinescu 
59127453f775SEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
59139c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
59149c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59159c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59167453f775SEmil Constantinescu 
59177453f775SEmil Constantinescu     for (i=0; i<n; i++) {
591876cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59197453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59207453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
59217453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59227453f775SEmil Constantinescu       tol  = tola+tolr;
59237453f775SEmil Constantinescu       if(tola>0.){
59247453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
59257453f775SEmil Constantinescu       }
59267453f775SEmil Constantinescu       if(tolr>0.){
59277453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
59287453f775SEmil Constantinescu       }
59297453f775SEmil Constantinescu       if(tol>0.){
59307453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
59317453f775SEmil Constantinescu       }
59329c6b16b5SShri Abhyankar     }
59339c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59349c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59359c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
59369c6b16b5SShri Abhyankar     const PetscScalar *atol;
59379c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59387453f775SEmil Constantinescu     for (i=0; i<n; i++) {
593976cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59407453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59417453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
59427453f775SEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59437453f775SEmil Constantinescu       tol  = tola+tolr;
59447453f775SEmil Constantinescu       if(tola>0.){
59457453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
59467453f775SEmil Constantinescu       }
59477453f775SEmil Constantinescu       if(tolr>0.){
59487453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
59497453f775SEmil Constantinescu       }
59507453f775SEmil Constantinescu       if(tol>0.){
59517453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
59527453f775SEmil Constantinescu       }
59539c6b16b5SShri Abhyankar     }
59549c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59559c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
59569c6b16b5SShri Abhyankar     const PetscScalar *rtol;
59579c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59587453f775SEmil Constantinescu 
59597453f775SEmil Constantinescu     for (i=0; i<n; i++) {
596076cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59617453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59627453f775SEmil Constantinescu       tola = ts->atol;
59637453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59647453f775SEmil Constantinescu       tol  = tola+tolr;
59657453f775SEmil Constantinescu       if(tola>0.){
59667453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
59677453f775SEmil Constantinescu       }
59687453f775SEmil Constantinescu       if(tolr>0.){
59697453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
59707453f775SEmil Constantinescu       }
59717453f775SEmil Constantinescu       if(tol>0.){
59727453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
59737453f775SEmil Constantinescu       }
59749c6b16b5SShri Abhyankar     }
59759c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59769c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
59777453f775SEmil Constantinescu 
59787453f775SEmil Constantinescu     for (i=0; i<n; i++) {
597976cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59807453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59817453f775SEmil Constantinescu       tola = ts->atol;
59827453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59837453f775SEmil Constantinescu       tol  = tola+tolr;
59847453f775SEmil Constantinescu       if(tola>0.){
59857453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
59867453f775SEmil Constantinescu       }
59877453f775SEmil Constantinescu       if(tolr>0.){
59887453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
59897453f775SEmil Constantinescu       }
59907453f775SEmil Constantinescu       if(tol>0.){
59917453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
59927453f775SEmil Constantinescu       }
59939c6b16b5SShri Abhyankar     }
59949c6b16b5SShri Abhyankar   }
59959c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
59969c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
59977453f775SEmil Constantinescu   err_loc[0] = max;
59987453f775SEmil Constantinescu   err_loc[1] = maxa;
59997453f775SEmil Constantinescu   err_loc[2] = maxr;
6000a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
60017453f775SEmil Constantinescu   gmax   = err_glb[0];
60027453f775SEmil Constantinescu   gmaxa  = err_glb[1];
60037453f775SEmil Constantinescu   gmaxr  = err_glb[2];
60049c6b16b5SShri Abhyankar 
60059c6b16b5SShri Abhyankar   *norm = gmax;
60067453f775SEmil Constantinescu   *norma = gmaxa;
60077453f775SEmil Constantinescu   *normr = gmaxr;
60089c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
60097453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
60107453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
60119c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
60129c6b16b5SShri Abhyankar }
60139c6b16b5SShri Abhyankar 
60141c3436cfSJed Brown /*@
60158a175baeSEmil Constantinescu    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
60161c3436cfSJed Brown 
60171c3436cfSJed Brown    Collective on TS
60181c3436cfSJed Brown 
60191c3436cfSJed Brown    Input Arguments:
60201c3436cfSJed Brown +  ts - time stepping context
6021a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6022a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
6023a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
60247619abb3SShri 
60251c3436cfSJed Brown    Output Arguments:
6026a2b725a8SWilliam Gropp +  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
60278a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
6028a2b725a8SWilliam Gropp -  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
6029a4868fbcSLisandro Dalcin 
6030a4868fbcSLisandro Dalcin    Options Database Keys:
6031a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
6032a4868fbcSLisandro Dalcin 
60331c3436cfSJed Brown    Level: developer
60341c3436cfSJed Brown 
60358a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm
60361c3436cfSJed Brown @*/
60377453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
60381c3436cfSJed Brown {
60398beabaa1SBarry Smith   PetscErrorCode ierr;
60401c3436cfSJed Brown 
60411c3436cfSJed Brown   PetscFunctionBegin;
6042a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
60437453f775SEmil Constantinescu     ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6044a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
60457453f775SEmil Constantinescu     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6046a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
60471c3436cfSJed Brown   PetscFunctionReturn(0);
60481c3436cfSJed Brown }
60491c3436cfSJed Brown 
60508a175baeSEmil Constantinescu 
60518a175baeSEmil Constantinescu /*@
60528a175baeSEmil Constantinescu    TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances
60538a175baeSEmil Constantinescu 
60548a175baeSEmil Constantinescu    Collective on TS
60558a175baeSEmil Constantinescu 
60568a175baeSEmil Constantinescu    Input Arguments:
60578a175baeSEmil Constantinescu +  ts - time stepping context
60588a175baeSEmil Constantinescu .  E - error vector
60598a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
60608a175baeSEmil Constantinescu -  Y - state vector, previous time step
60618a175baeSEmil Constantinescu 
60628a175baeSEmil Constantinescu    Output Arguments:
6063a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
60648a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
6065a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
60668a175baeSEmil Constantinescu 
60678a175baeSEmil Constantinescu    Level: developer
60688a175baeSEmil Constantinescu 
60698a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity()
60708a175baeSEmil Constantinescu @*/
60718a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
60728a175baeSEmil Constantinescu {
60738a175baeSEmil Constantinescu   PetscErrorCode    ierr;
60748a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
60758a175baeSEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
60768a175baeSEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
60778a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
60788a175baeSEmil Constantinescu   PetscReal         err,sum,suma,sumr,gsum,gsuma,gsumr;
60798a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
60808a175baeSEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
60818a175baeSEmil Constantinescu 
60828a175baeSEmil Constantinescu   PetscFunctionBegin;
60838a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
60848a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
60858a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
60868a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
60878a175baeSEmil Constantinescu   PetscValidType(E,2);
60888a175baeSEmil Constantinescu   PetscValidType(U,3);
60898a175baeSEmil Constantinescu   PetscValidType(Y,4);
60908a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
60918a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
60928a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
60938a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
60948a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
60958a175baeSEmil Constantinescu 
60968a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
60978a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
60988a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
60998a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
61008a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
61018a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
61028a175baeSEmil Constantinescu   sum  = 0.; n_loc  = 0;
61038a175baeSEmil Constantinescu   suma = 0.; na_loc = 0;
61048a175baeSEmil Constantinescu   sumr = 0.; nr_loc = 0;
61058a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {
61068a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
61078a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61088a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61098a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
611076cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61118a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61128a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
61138a175baeSEmil Constantinescu       if(tola>0.){
61148a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
61158a175baeSEmil Constantinescu         na_loc++;
61168a175baeSEmil Constantinescu       }
61178a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61188a175baeSEmil Constantinescu       if(tolr>0.){
61198a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
61208a175baeSEmil Constantinescu         nr_loc++;
61218a175baeSEmil Constantinescu       }
61228a175baeSEmil Constantinescu       tol=tola+tolr;
61238a175baeSEmil Constantinescu       if(tol>0.){
61248a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
61258a175baeSEmil Constantinescu         n_loc++;
61268a175baeSEmil Constantinescu       }
61278a175baeSEmil Constantinescu     }
61288a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61298a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61308a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
61318a175baeSEmil Constantinescu     const PetscScalar *atol;
61328a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61338a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
613476cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61358a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61368a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
61378a175baeSEmil Constantinescu       if(tola>0.){
61388a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
61398a175baeSEmil Constantinescu         na_loc++;
61408a175baeSEmil Constantinescu       }
61418a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61428a175baeSEmil Constantinescu       if(tolr>0.){
61438a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
61448a175baeSEmil Constantinescu         nr_loc++;
61458a175baeSEmil Constantinescu       }
61468a175baeSEmil Constantinescu       tol=tola+tolr;
61478a175baeSEmil Constantinescu       if(tol>0.){
61488a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
61498a175baeSEmil Constantinescu         n_loc++;
61508a175baeSEmil Constantinescu       }
61518a175baeSEmil Constantinescu     }
61528a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61538a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
61548a175baeSEmil Constantinescu     const PetscScalar *rtol;
61558a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61568a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
615776cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61588a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61598a175baeSEmil Constantinescu       tola = ts->atol;
61608a175baeSEmil Constantinescu       if(tola>0.){
61618a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
61628a175baeSEmil Constantinescu         na_loc++;
61638a175baeSEmil Constantinescu       }
61648a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61658a175baeSEmil Constantinescu       if(tolr>0.){
61668a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
61678a175baeSEmil Constantinescu         nr_loc++;
61688a175baeSEmil Constantinescu       }
61698a175baeSEmil Constantinescu       tol=tola+tolr;
61708a175baeSEmil Constantinescu       if(tol>0.){
61718a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
61728a175baeSEmil Constantinescu         n_loc++;
61738a175baeSEmil Constantinescu       }
61748a175baeSEmil Constantinescu     }
61758a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61768a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
61778a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
617876cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61798a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61808a175baeSEmil Constantinescu       tola = ts->atol;
61818a175baeSEmil Constantinescu       if(tola>0.){
61828a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
61838a175baeSEmil Constantinescu         na_loc++;
61848a175baeSEmil Constantinescu       }
61858a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61868a175baeSEmil Constantinescu       if(tolr>0.){
61878a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
61888a175baeSEmil Constantinescu         nr_loc++;
61898a175baeSEmil Constantinescu       }
61908a175baeSEmil Constantinescu       tol=tola+tolr;
61918a175baeSEmil Constantinescu       if(tol>0.){
61928a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
61938a175baeSEmil Constantinescu         n_loc++;
61948a175baeSEmil Constantinescu       }
61958a175baeSEmil Constantinescu     }
61968a175baeSEmil Constantinescu   }
61978a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
61988a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
61998a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
62008a175baeSEmil Constantinescu 
62018a175baeSEmil Constantinescu   err_loc[0] = sum;
62028a175baeSEmil Constantinescu   err_loc[1] = suma;
62038a175baeSEmil Constantinescu   err_loc[2] = sumr;
62048a175baeSEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
62058a175baeSEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
62068a175baeSEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
62078a175baeSEmil Constantinescu 
6208a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
62098a175baeSEmil Constantinescu 
62108a175baeSEmil Constantinescu   gsum   = err_glb[0];
62118a175baeSEmil Constantinescu   gsuma  = err_glb[1];
62128a175baeSEmil Constantinescu   gsumr  = err_glb[2];
62138a175baeSEmil Constantinescu   n_glb  = err_glb[3];
62148a175baeSEmil Constantinescu   na_glb = err_glb[4];
62158a175baeSEmil Constantinescu   nr_glb = err_glb[5];
62168a175baeSEmil Constantinescu 
62178a175baeSEmil Constantinescu   *norm  = 0.;
62188a175baeSEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
62198a175baeSEmil Constantinescu   *norma = 0.;
62208a175baeSEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
62218a175baeSEmil Constantinescu   *normr = 0.;
62228a175baeSEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
62238a175baeSEmil Constantinescu 
62248a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
62258a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
62268a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
62278a175baeSEmil Constantinescu   PetscFunctionReturn(0);
62288a175baeSEmil Constantinescu }
62298a175baeSEmil Constantinescu 
62308a175baeSEmil Constantinescu /*@
62318a175baeSEmil Constantinescu    TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances
62328a175baeSEmil Constantinescu    Collective on TS
62338a175baeSEmil Constantinescu 
62348a175baeSEmil Constantinescu    Input Arguments:
62358a175baeSEmil Constantinescu +  ts - time stepping context
62368a175baeSEmil Constantinescu .  E - error vector
62378a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
62388a175baeSEmil Constantinescu -  Y - state vector, previous time step
62398a175baeSEmil Constantinescu 
62408a175baeSEmil Constantinescu    Output Arguments:
6241a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
62428a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
6243a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
62448a175baeSEmil Constantinescu 
62458a175baeSEmil Constantinescu    Level: developer
62468a175baeSEmil Constantinescu 
62478a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2()
62488a175baeSEmil Constantinescu @*/
62498a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
62508a175baeSEmil Constantinescu {
62518a175baeSEmil Constantinescu   PetscErrorCode    ierr;
62528a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
62538a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
62548a175baeSEmil Constantinescu   PetscReal         err,max,gmax,maxa,gmaxa,maxr,gmaxr;
62558a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
62568a175baeSEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
62578a175baeSEmil Constantinescu 
62588a175baeSEmil Constantinescu   PetscFunctionBegin;
62598a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
62608a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
62618a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
62628a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
62638a175baeSEmil Constantinescu   PetscValidType(E,2);
62648a175baeSEmil Constantinescu   PetscValidType(U,3);
62658a175baeSEmil Constantinescu   PetscValidType(Y,4);
62668a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
62678a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
62688a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
62698a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
62708a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
62718a175baeSEmil Constantinescu 
62728a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
62738a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
62748a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
62758a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
62768a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
62778a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
62788a175baeSEmil Constantinescu 
62798a175baeSEmil Constantinescu   max=0.;
62808a175baeSEmil Constantinescu   maxa=0.;
62818a175baeSEmil Constantinescu   maxr=0.;
62828a175baeSEmil Constantinescu 
62838a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
62848a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
62858a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
62868a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62878a175baeSEmil Constantinescu 
62888a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
628976cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
62908a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
62918a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
62928a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62938a175baeSEmil Constantinescu       tol  = tola+tolr;
62948a175baeSEmil Constantinescu       if(tola>0.){
62958a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
62968a175baeSEmil Constantinescu       }
62978a175baeSEmil Constantinescu       if(tolr>0.){
62988a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
62998a175baeSEmil Constantinescu       }
63008a175baeSEmil Constantinescu       if(tol>0.){
63018a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63028a175baeSEmil Constantinescu       }
63038a175baeSEmil Constantinescu     }
63048a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63058a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63068a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
63078a175baeSEmil Constantinescu     const PetscScalar *atol;
63088a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63098a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
631076cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
63118a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63128a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
63138a175baeSEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63148a175baeSEmil Constantinescu       tol  = tola+tolr;
63158a175baeSEmil Constantinescu       if(tola>0.){
63168a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
63178a175baeSEmil Constantinescu       }
63188a175baeSEmil Constantinescu       if(tolr>0.){
63198a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
63208a175baeSEmil Constantinescu       }
63218a175baeSEmil Constantinescu       if(tol>0.){
63228a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63238a175baeSEmil Constantinescu       }
63248a175baeSEmil Constantinescu     }
63258a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63268a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
63278a175baeSEmil Constantinescu     const PetscScalar *rtol;
63288a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63298a175baeSEmil Constantinescu 
63308a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
633176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
63328a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63338a175baeSEmil Constantinescu       tola = ts->atol;
63348a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63358a175baeSEmil Constantinescu       tol  = tola+tolr;
63368a175baeSEmil Constantinescu       if(tola>0.){
63378a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
63388a175baeSEmil Constantinescu       }
63398a175baeSEmil Constantinescu       if(tolr>0.){
63408a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
63418a175baeSEmil Constantinescu       }
63428a175baeSEmil Constantinescu       if(tol>0.){
63438a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63448a175baeSEmil Constantinescu       }
63458a175baeSEmil Constantinescu     }
63468a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63478a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
63488a175baeSEmil Constantinescu 
63498a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
635076cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
63518a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63528a175baeSEmil Constantinescu       tola = ts->atol;
63538a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63548a175baeSEmil Constantinescu       tol  = tola+tolr;
63558a175baeSEmil Constantinescu       if(tola>0.){
63568a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
63578a175baeSEmil Constantinescu       }
63588a175baeSEmil Constantinescu       if(tolr>0.){
63598a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
63608a175baeSEmil Constantinescu       }
63618a175baeSEmil Constantinescu       if(tol>0.){
63628a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63638a175baeSEmil Constantinescu       }
63648a175baeSEmil Constantinescu     }
63658a175baeSEmil Constantinescu   }
63668a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
63678a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
63688a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
63698a175baeSEmil Constantinescu   err_loc[0] = max;
63708a175baeSEmil Constantinescu   err_loc[1] = maxa;
63718a175baeSEmil Constantinescu   err_loc[2] = maxr;
6372a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
63738a175baeSEmil Constantinescu   gmax   = err_glb[0];
63748a175baeSEmil Constantinescu   gmaxa  = err_glb[1];
63758a175baeSEmil Constantinescu   gmaxr  = err_glb[2];
63768a175baeSEmil Constantinescu 
63778a175baeSEmil Constantinescu   *norm = gmax;
63788a175baeSEmil Constantinescu   *norma = gmaxa;
63798a175baeSEmil Constantinescu   *normr = gmaxr;
63808a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
63818a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
63828a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
63838a175baeSEmil Constantinescu   PetscFunctionReturn(0);
63848a175baeSEmil Constantinescu }
63858a175baeSEmil Constantinescu 
63868a175baeSEmil Constantinescu /*@
63878a175baeSEmil Constantinescu    TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
63888a175baeSEmil Constantinescu 
63898a175baeSEmil Constantinescu    Collective on TS
63908a175baeSEmil Constantinescu 
63918a175baeSEmil Constantinescu    Input Arguments:
63928a175baeSEmil Constantinescu +  ts - time stepping context
63938a175baeSEmil Constantinescu .  E - error vector
63948a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
63958a175baeSEmil Constantinescu .  Y - state vector, previous time step
63968a175baeSEmil Constantinescu -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
63978a175baeSEmil Constantinescu 
63988a175baeSEmil Constantinescu    Output Arguments:
6399a2b725a8SWilliam Gropp +  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
64008a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
6401a2b725a8SWilliam Gropp -  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
64028a175baeSEmil Constantinescu 
64038a175baeSEmil Constantinescu    Options Database Keys:
64048a175baeSEmil Constantinescu .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
64058a175baeSEmil Constantinescu 
64068a175baeSEmil Constantinescu    Level: developer
64078a175baeSEmil Constantinescu 
64088a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
64098a175baeSEmil Constantinescu @*/
64108a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
64118a175baeSEmil Constantinescu {
64128a175baeSEmil Constantinescu   PetscErrorCode ierr;
64138a175baeSEmil Constantinescu 
64148a175baeSEmil Constantinescu   PetscFunctionBegin;
64158a175baeSEmil Constantinescu   if (wnormtype == NORM_2) {
64168a175baeSEmil Constantinescu     ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
64178a175baeSEmil Constantinescu   } else if(wnormtype == NORM_INFINITY) {
64188a175baeSEmil Constantinescu     ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
64198a175baeSEmil Constantinescu   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
64208a175baeSEmil Constantinescu   PetscFunctionReturn(0);
64218a175baeSEmil Constantinescu }
64228a175baeSEmil Constantinescu 
64238a175baeSEmil Constantinescu 
64248d59e960SJed Brown /*@
64258d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
64268d59e960SJed Brown 
64278d59e960SJed Brown    Logically Collective on TS
64288d59e960SJed Brown 
64298d59e960SJed Brown    Input Arguments:
64308d59e960SJed Brown +  ts - time stepping context
64318d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
64328d59e960SJed Brown 
64338d59e960SJed Brown    Note:
64348d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
64358d59e960SJed Brown 
64368d59e960SJed Brown    Level: intermediate
64378d59e960SJed Brown 
64388d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
64398d59e960SJed Brown @*/
64408d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
64418d59e960SJed Brown {
64428d59e960SJed Brown   PetscFunctionBegin;
64438d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
64448d59e960SJed Brown   ts->cfltime_local = cfltime;
64458d59e960SJed Brown   ts->cfltime       = -1.;
64468d59e960SJed Brown   PetscFunctionReturn(0);
64478d59e960SJed Brown }
64488d59e960SJed Brown 
64498d59e960SJed Brown /*@
64508d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
64518d59e960SJed Brown 
64528d59e960SJed Brown    Collective on TS
64538d59e960SJed Brown 
64548d59e960SJed Brown    Input Arguments:
64558d59e960SJed Brown .  ts - time stepping context
64568d59e960SJed Brown 
64578d59e960SJed Brown    Output Arguments:
64588d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
64598d59e960SJed Brown 
64608d59e960SJed Brown    Level: advanced
64618d59e960SJed Brown 
64628d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
64638d59e960SJed Brown @*/
64648d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
64658d59e960SJed Brown {
64668d59e960SJed Brown   PetscErrorCode ierr;
64678d59e960SJed Brown 
64688d59e960SJed Brown   PetscFunctionBegin;
64698d59e960SJed Brown   if (ts->cfltime < 0) {
6470b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
64718d59e960SJed Brown   }
64728d59e960SJed Brown   *cfltime = ts->cfltime;
64738d59e960SJed Brown   PetscFunctionReturn(0);
64748d59e960SJed Brown }
64758d59e960SJed Brown 
6476d6ebe24aSShri Abhyankar /*@
6477d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6478d6ebe24aSShri Abhyankar 
6479d6ebe24aSShri Abhyankar    Input Parameters:
6480a2b725a8SWilliam Gropp +  ts   - the TS context.
6481d6ebe24aSShri Abhyankar .  xl   - lower bound.
6482a2b725a8SWilliam Gropp -  xu   - upper bound.
6483d6ebe24aSShri Abhyankar 
6484d6ebe24aSShri Abhyankar    Notes:
6485d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6486e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6487d6ebe24aSShri Abhyankar 
64882bd2b0e6SSatish Balay    Level: advanced
64892bd2b0e6SSatish Balay 
6490d6ebe24aSShri Abhyankar @*/
6491d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6492d6ebe24aSShri Abhyankar {
6493d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6494d6ebe24aSShri Abhyankar   SNES           snes;
6495d6ebe24aSShri Abhyankar 
6496d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6497d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6498d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6499d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6500d6ebe24aSShri Abhyankar }
6501d6ebe24aSShri Abhyankar 
6502b3603a34SBarry Smith /*@C
65034f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
6504b3603a34SBarry Smith        in a time based line graph
6505b3603a34SBarry Smith 
6506b3603a34SBarry Smith    Collective on TS
6507b3603a34SBarry Smith 
6508b3603a34SBarry Smith    Input Parameters:
6509b3603a34SBarry Smith +  ts - the TS context
6510b3603a34SBarry Smith .  step - current time-step
6511b3603a34SBarry Smith .  ptime - current time
65127db568b7SBarry Smith .  u - current solution
65137db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
6514b3603a34SBarry Smith 
6515b3d3934dSBarry Smith    Options Database:
65169ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
6517b3d3934dSBarry Smith 
6518b3603a34SBarry Smith    Level: intermediate
6519b3603a34SBarry Smith 
652095452b02SPatrick Sanan    Notes:
652195452b02SPatrick Sanan     Each process in a parallel run displays its component solutions in a separate window
6522b3603a34SBarry Smith 
65237db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
65247db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
65257db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
65267db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
6527b3603a34SBarry Smith @*/
65287db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6529b3603a34SBarry Smith {
6530b3603a34SBarry Smith   PetscErrorCode    ierr;
65317db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
6532b3603a34SBarry Smith   const PetscScalar *yy;
653380666b62SBarry Smith   Vec               v;
6534b3603a34SBarry Smith 
6535b3603a34SBarry Smith   PetscFunctionBegin;
653663e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
653758ff32f7SBarry Smith   if (!step) {
6538a9f9c1f6SBarry Smith     PetscDrawAxis axis;
65396934998bSLisandro Dalcin     PetscInt      dim;
6540a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
65410ec8ee2bSJoseph Pusztay     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
6542bab0a581SBarry Smith     if (!ctx->names) {
6543bab0a581SBarry Smith       PetscBool flg;
6544bab0a581SBarry Smith       /* user provides names of variables to plot but no names has been set so assume names are integer values */
6545bab0a581SBarry Smith       ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr);
6546bab0a581SBarry Smith       if (flg) {
6547bab0a581SBarry Smith         PetscInt i,n;
6548bab0a581SBarry Smith         char     **names;
6549bab0a581SBarry Smith         ierr = VecGetSize(u,&n);CHKERRQ(ierr);
6550bab0a581SBarry Smith         ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr);
6551bab0a581SBarry Smith         for (i=0; i<n; i++) {
6552bab0a581SBarry Smith           ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr);
6553bab0a581SBarry Smith           ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr);
6554bab0a581SBarry Smith         }
6555bab0a581SBarry Smith         names[n] = NULL;
6556bab0a581SBarry Smith         ctx->names = names;
6557bab0a581SBarry Smith       }
6558bab0a581SBarry Smith     }
6559387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
6560387f4636SBarry Smith       char      **displaynames;
6561387f4636SBarry Smith       PetscBool flg;
6562387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6563580bdb30SBarry Smith       ierr = PetscCalloc1(dim+1,&displaynames);CHKERRQ(ierr);
6564c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
6565387f4636SBarry Smith       if (flg) {
6566a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
6567387f4636SBarry Smith       }
6568387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
6569387f4636SBarry Smith     }
6570387f4636SBarry Smith     if (ctx->displaynames) {
6571387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
6572387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
6573387f4636SBarry Smith     } else if (ctx->names) {
65740910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
65750b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6576387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
6577b0bc92c6SBarry Smith     } else {
6578b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6579b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6580387f4636SBarry Smith     }
65810b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
658258ff32f7SBarry Smith   }
65836934998bSLisandro Dalcin 
65846934998bSLisandro Dalcin   if (!ctx->transform) v = u;
65856934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
658680666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
65876934998bSLisandro Dalcin   if (ctx->displaynames) {
65886934998bSLisandro Dalcin     PetscInt i;
65896934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
65906934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
65916934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
65926934998bSLisandro Dalcin   } else {
6593e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6594e3efe391SJed Brown     PetscInt  i,n;
65956934998bSLisandro Dalcin     PetscReal *yreal;
659680666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
6597785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6598e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
65990b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6600e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6601e3efe391SJed Brown #else
66020b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6603e3efe391SJed Brown #endif
660480666b62SBarry Smith   }
66056934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
66066934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
66076934998bSLisandro Dalcin 
6608b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
66090b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
66106934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
66113923b477SBarry Smith   }
6612b3603a34SBarry Smith   PetscFunctionReturn(0);
6613b3603a34SBarry Smith }
6614b3603a34SBarry Smith 
6615b037adc7SBarry Smith /*@C
661631152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6617b037adc7SBarry Smith 
6618b037adc7SBarry Smith    Collective on TS
6619b037adc7SBarry Smith 
6620b037adc7SBarry Smith    Input Parameters:
6621b037adc7SBarry Smith +  ts - the TS context
6622b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
6623b037adc7SBarry Smith 
6624b037adc7SBarry Smith    Level: intermediate
6625b037adc7SBarry Smith 
662695452b02SPatrick Sanan    Notes:
662795452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66287db568b7SBarry Smith 
6629a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
6630b037adc7SBarry Smith @*/
663131152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
6632b037adc7SBarry Smith {
6633b037adc7SBarry Smith   PetscErrorCode    ierr;
6634b037adc7SBarry Smith   PetscInt          i;
6635b037adc7SBarry Smith 
6636b037adc7SBarry Smith   PetscFunctionBegin;
6637b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6638b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
66395537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
6640b3d3934dSBarry Smith       break;
6641b3d3934dSBarry Smith     }
6642b3d3934dSBarry Smith   }
6643b3d3934dSBarry Smith   PetscFunctionReturn(0);
6644b3d3934dSBarry Smith }
6645b3d3934dSBarry Smith 
6646e673d494SBarry Smith /*@C
6647e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6648e673d494SBarry Smith 
6649e673d494SBarry Smith    Collective on TS
6650e673d494SBarry Smith 
6651e673d494SBarry Smith    Input Parameters:
6652e673d494SBarry Smith +  ts - the TS context
6653e673d494SBarry Smith -  names - the names of the components, final string must be NULL
6654e673d494SBarry Smith 
6655e673d494SBarry Smith    Level: intermediate
6656e673d494SBarry Smith 
6657a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
6658e673d494SBarry Smith @*/
6659e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
6660e673d494SBarry Smith {
6661e673d494SBarry Smith   PetscErrorCode    ierr;
6662e673d494SBarry Smith 
6663e673d494SBarry Smith   PetscFunctionBegin;
6664e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
6665e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
6666e673d494SBarry Smith   PetscFunctionReturn(0);
6667e673d494SBarry Smith }
6668e673d494SBarry Smith 
6669b3d3934dSBarry Smith /*@C
6670b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
6671b3d3934dSBarry Smith 
6672b3d3934dSBarry Smith    Collective on TS
6673b3d3934dSBarry Smith 
6674b3d3934dSBarry Smith    Input Parameter:
6675b3d3934dSBarry Smith .  ts - the TS context
6676b3d3934dSBarry Smith 
6677b3d3934dSBarry Smith    Output Parameter:
6678b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
6679b3d3934dSBarry Smith 
6680b3d3934dSBarry Smith    Level: intermediate
6681b3d3934dSBarry Smith 
668295452b02SPatrick Sanan    Notes:
668395452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66847db568b7SBarry Smith 
6685b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6686b3d3934dSBarry Smith @*/
6687b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
6688b3d3934dSBarry Smith {
6689b3d3934dSBarry Smith   PetscInt       i;
6690b3d3934dSBarry Smith 
6691b3d3934dSBarry Smith   PetscFunctionBegin;
6692b3d3934dSBarry Smith   *names = NULL;
6693b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6694b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
66955537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
6696b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
6697b3d3934dSBarry Smith       break;
6698387f4636SBarry Smith     }
6699387f4636SBarry Smith   }
6700387f4636SBarry Smith   PetscFunctionReturn(0);
6701387f4636SBarry Smith }
6702387f4636SBarry Smith 
6703a66092f1SBarry Smith /*@C
6704a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
6705a66092f1SBarry Smith 
6706a66092f1SBarry Smith    Collective on TS
6707a66092f1SBarry Smith 
6708a66092f1SBarry Smith    Input Parameters:
6709a66092f1SBarry Smith +  ctx - the TSMonitorLG context
6710a2b725a8SWilliam Gropp -  displaynames - the names of the components, final string must be NULL
6711a66092f1SBarry Smith 
6712a66092f1SBarry Smith    Level: intermediate
6713a66092f1SBarry Smith 
6714a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6715a66092f1SBarry Smith @*/
6716a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6717a66092f1SBarry Smith {
6718a66092f1SBarry Smith   PetscInt          j = 0,k;
6719a66092f1SBarry Smith   PetscErrorCode    ierr;
6720a66092f1SBarry Smith 
6721a66092f1SBarry Smith   PetscFunctionBegin;
6722a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6723a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6724a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6725a66092f1SBarry Smith   while (displaynames[j]) j++;
6726a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6727a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6728a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6729a66092f1SBarry Smith   j = 0;
6730a66092f1SBarry Smith   while (displaynames[j]) {
6731a66092f1SBarry Smith     k = 0;
6732a66092f1SBarry Smith     while (ctx->names[k]) {
6733a66092f1SBarry Smith       PetscBool flg;
6734a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6735a66092f1SBarry Smith       if (flg) {
6736a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6737a66092f1SBarry Smith         break;
6738a66092f1SBarry Smith       }
6739a66092f1SBarry Smith       k++;
6740a66092f1SBarry Smith     }
6741a66092f1SBarry Smith     j++;
6742a66092f1SBarry Smith   }
6743a66092f1SBarry Smith   PetscFunctionReturn(0);
6744a66092f1SBarry Smith }
6745a66092f1SBarry Smith 
6746387f4636SBarry Smith /*@C
6747387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6748387f4636SBarry Smith 
6749387f4636SBarry Smith    Collective on TS
6750387f4636SBarry Smith 
6751387f4636SBarry Smith    Input Parameters:
6752387f4636SBarry Smith +  ts - the TS context
6753a2b725a8SWilliam Gropp -  displaynames - the names of the components, final string must be NULL
6754387f4636SBarry Smith 
675595452b02SPatrick Sanan    Notes:
675695452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
67577db568b7SBarry Smith 
6758387f4636SBarry Smith    Level: intermediate
6759387f4636SBarry Smith 
6760387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6761387f4636SBarry Smith @*/
6762387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6763387f4636SBarry Smith {
6764a66092f1SBarry Smith   PetscInt          i;
6765387f4636SBarry Smith   PetscErrorCode    ierr;
6766387f4636SBarry Smith 
6767387f4636SBarry Smith   PetscFunctionBegin;
6768387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6769387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
67705537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6771b3d3934dSBarry Smith       break;
6772b037adc7SBarry Smith     }
6773b037adc7SBarry Smith   }
6774b037adc7SBarry Smith   PetscFunctionReturn(0);
6775b037adc7SBarry Smith }
6776b037adc7SBarry Smith 
677780666b62SBarry Smith /*@C
677880666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
677980666b62SBarry Smith 
678080666b62SBarry Smith    Collective on TS
678180666b62SBarry Smith 
678280666b62SBarry Smith    Input Parameters:
678380666b62SBarry Smith +  ts - the TS context
678480666b62SBarry Smith .  transform - the transform function
67857684fa3eSBarry Smith .  destroy - function to destroy the optional context
678680666b62SBarry Smith -  ctx - optional context used by transform function
678780666b62SBarry Smith 
678895452b02SPatrick Sanan    Notes:
678995452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
67907db568b7SBarry Smith 
679180666b62SBarry Smith    Level: intermediate
679280666b62SBarry Smith 
6793a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
679480666b62SBarry Smith @*/
67957684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
679680666b62SBarry Smith {
679780666b62SBarry Smith   PetscInt          i;
6798a66092f1SBarry Smith   PetscErrorCode    ierr;
679980666b62SBarry Smith 
680080666b62SBarry Smith   PetscFunctionBegin;
680180666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
680280666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
68035537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
680480666b62SBarry Smith     }
680580666b62SBarry Smith   }
680680666b62SBarry Smith   PetscFunctionReturn(0);
680780666b62SBarry Smith }
680880666b62SBarry Smith 
6809e673d494SBarry Smith /*@C
6810e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6811e673d494SBarry Smith 
6812e673d494SBarry Smith    Collective on TSLGCtx
6813e673d494SBarry Smith 
6814e673d494SBarry Smith    Input Parameters:
6815e673d494SBarry Smith +  ts - the TS context
6816e673d494SBarry Smith .  transform - the transform function
68177684fa3eSBarry Smith .  destroy - function to destroy the optional context
6818e673d494SBarry Smith -  ctx - optional context used by transform function
6819e673d494SBarry Smith 
6820e673d494SBarry Smith    Level: intermediate
6821e673d494SBarry Smith 
6822a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6823e673d494SBarry Smith @*/
68247684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6825e673d494SBarry Smith {
6826e673d494SBarry Smith   PetscFunctionBegin;
6827e673d494SBarry Smith   ctx->transform    = transform;
68287684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6829e673d494SBarry Smith   ctx->transformctx = tctx;
6830e673d494SBarry Smith   PetscFunctionReturn(0);
6831e673d494SBarry Smith }
6832e673d494SBarry Smith 
6833ef20d060SBarry Smith /*@C
68348b668821SLisandro Dalcin    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the error
6835ef20d060SBarry Smith        in a time based line graph
6836ef20d060SBarry Smith 
6837ef20d060SBarry Smith    Collective on TS
6838ef20d060SBarry Smith 
6839ef20d060SBarry Smith    Input Parameters:
6840ef20d060SBarry Smith +  ts - the TS context
6841ef20d060SBarry Smith .  step - current time-step
6842ef20d060SBarry Smith .  ptime - current time
68437db568b7SBarry Smith .  u - current solution
68447db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6845ef20d060SBarry Smith 
6846ef20d060SBarry Smith    Level: intermediate
6847ef20d060SBarry Smith 
684895452b02SPatrick Sanan    Notes:
684995452b02SPatrick Sanan     Each process in a parallel run displays its component errors in a separate window
6850abd5a294SJed Brown 
6851abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6852abd5a294SJed Brown 
6853abd5a294SJed Brown    Options Database Keys:
68544f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6855ef20d060SBarry Smith 
6856abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6857ef20d060SBarry Smith @*/
68580910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6859ef20d060SBarry Smith {
6860ef20d060SBarry Smith   PetscErrorCode    ierr;
68610b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6862ef20d060SBarry Smith   const PetscScalar *yy;
6863ef20d060SBarry Smith   Vec               y;
6864ef20d060SBarry Smith 
6865ef20d060SBarry Smith   PetscFunctionBegin;
6866a9f9c1f6SBarry Smith   if (!step) {
6867a9f9c1f6SBarry Smith     PetscDrawAxis axis;
68686934998bSLisandro Dalcin     PetscInt      dim;
6869a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
68708b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Error");CHKERRQ(ierr);
68710910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6872a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6873a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6874a9f9c1f6SBarry Smith   }
68750910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6876ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
68770910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6878ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6879e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6880e3efe391SJed Brown   {
6881e3efe391SJed Brown     PetscReal *yreal;
6882e3efe391SJed Brown     PetscInt  i,n;
6883e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6884785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6885e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
68860b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6887e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6888e3efe391SJed Brown   }
6889e3efe391SJed Brown #else
68900b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6891e3efe391SJed Brown #endif
6892ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6893ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6894b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
68950b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
68966934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
68973923b477SBarry Smith   }
6898ef20d060SBarry Smith   PetscFunctionReturn(0);
6899ef20d060SBarry Smith }
6900ef20d060SBarry Smith 
69015e3b7effSJoseph Pusztay /*@C
69025e3b7effSJoseph Pusztay    TSMonitorSPSwarmSolution - Graphically displays phase plots of DMSwarm particles on a scatter plot
69035e3b7effSJoseph Pusztay 
69045e3b7effSJoseph Pusztay    Input Parameters:
69055e3b7effSJoseph Pusztay +  ts - the TS context
69065e3b7effSJoseph Pusztay .  step - current time-step
69075e3b7effSJoseph Pusztay .  ptime - current time
69085e3b7effSJoseph Pusztay .  u - current solution
69095e3b7effSJoseph Pusztay -  dctx - the TSMonitorSPCtx object that contains all the options for the monitoring, this is created with TSMonitorSPCtxCreate()
69105e3b7effSJoseph Pusztay 
69115e3b7effSJoseph Pusztay    Options Database:
6912918b1d10SJoseph Pusztay .   -ts_monitor_sp_swarm
69135e3b7effSJoseph Pusztay 
69145e3b7effSJoseph Pusztay    Level: intermediate
69155e3b7effSJoseph Pusztay 
69165e3b7effSJoseph Pusztay @*/
69170ec8ee2bSJoseph Pusztay PetscErrorCode TSMonitorSPSwarmSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
69181b575b74SJoseph Pusztay {
69191b575b74SJoseph Pusztay   PetscErrorCode    ierr;
69201b575b74SJoseph Pusztay   TSMonitorSPCtx    ctx = (TSMonitorSPCtx)dctx;
69211b575b74SJoseph Pusztay   const PetscScalar *yy;
6922b1670a61SJoseph Pusztay   PetscReal       *y,*x;
69231b575b74SJoseph Pusztay   PetscInt          Np, p, dim=2;
69241b575b74SJoseph Pusztay   DM                dm;
69251b575b74SJoseph Pusztay 
69261b575b74SJoseph Pusztay   PetscFunctionBegin;
69271b575b74SJoseph Pusztay 
69281b575b74SJoseph Pusztay   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
69291b575b74SJoseph Pusztay   if (!step) {
69301b575b74SJoseph Pusztay     PetscDrawAxis axis;
69311b575b74SJoseph Pusztay     ierr = PetscDrawSPGetAxis(ctx->sp,&axis);CHKERRQ(ierr);
69321b575b74SJoseph Pusztay     ierr = PetscDrawAxisSetLabels(axis,"Particles","X","Y");CHKERRQ(ierr);
6933895f37d5SJoseph Pusztay     ierr = PetscDrawAxisSetLimits(axis, -5, 5, -5, 5);CHKERRQ(ierr);
6934895f37d5SJoseph Pusztay     ierr = PetscDrawAxisSetHoldLimits(axis, PETSC_TRUE);CHKERRQ(ierr);
69351b575b74SJoseph Pusztay     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
69361b575b74SJoseph Pusztay     ierr = DMGetDimension(dm, &dim);
69371b575b74SJoseph Pusztay     if(dim!=2) SETERRQ(PETSC_COMM_SELF, ierr, "Dimensions improper for monitor arguments! Current support: two dimensions.");CHKERRQ(ierr);
69381b575b74SJoseph Pusztay     ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr);
69391b575b74SJoseph Pusztay     Np /= 2*dim;
69401b575b74SJoseph Pusztay     ierr = PetscDrawSPSetDimension(ctx->sp, Np);CHKERRQ(ierr);
69411b575b74SJoseph Pusztay     ierr = PetscDrawSPReset(ctx->sp);CHKERRQ(ierr);
69421b575b74SJoseph Pusztay   }
69431b575b74SJoseph Pusztay 
69441b575b74SJoseph Pusztay   ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr);
69451b575b74SJoseph Pusztay   Np /= 2*dim;
69461b575b74SJoseph Pusztay   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
6947895f37d5SJoseph Pusztay   ierr = PetscMalloc2(Np, &x, Np, &y);CHKERRQ(ierr);
69481b575b74SJoseph Pusztay   /* get points from solution vector */
69491b575b74SJoseph Pusztay   for (p=0; p<Np; ++p){
6950b1670a61SJoseph Pusztay     x[p] = PetscRealPart(yy[2*dim*p]);
6951b1670a61SJoseph Pusztay     y[p] = PetscRealPart(yy[2*dim*p+1]);
6952895f37d5SJoseph Pusztay   }
69531b575b74SJoseph Pusztay   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
69541b575b74SJoseph Pusztay 
69551b575b74SJoseph Pusztay   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
69561b575b74SJoseph Pusztay     ierr = PetscDrawSPAddPoint(ctx->sp,x,y);CHKERRQ(ierr);
69571b575b74SJoseph Pusztay     ierr = PetscDrawSPDraw(ctx->sp,PETSC_FALSE);CHKERRQ(ierr);
69581b575b74SJoseph Pusztay     ierr = PetscDrawSPSave(ctx->sp);CHKERRQ(ierr);
69591b575b74SJoseph Pusztay   }
69601b575b74SJoseph Pusztay 
6961918b1d10SJoseph Pusztay   ierr = PetscFree2(x, y);CHKERRQ(ierr);
6962918b1d10SJoseph Pusztay 
69631b575b74SJoseph Pusztay   PetscFunctionReturn(0);
69641b575b74SJoseph Pusztay }
69651b575b74SJoseph Pusztay 
69661b575b74SJoseph Pusztay 
69671b575b74SJoseph Pusztay 
69687cf37e64SBarry Smith /*@C
69697cf37e64SBarry Smith    TSMonitorError - Monitors progress of the TS solvers by printing the 2 norm of the error at each timestep
69707cf37e64SBarry Smith 
69717cf37e64SBarry Smith    Collective on TS
69727cf37e64SBarry Smith 
69737cf37e64SBarry Smith    Input Parameters:
69747cf37e64SBarry Smith +  ts - the TS context
69757cf37e64SBarry Smith .  step - current time-step
69767cf37e64SBarry Smith .  ptime - current time
69777cf37e64SBarry Smith .  u - current solution
69787cf37e64SBarry Smith -  dctx - unused context
69797cf37e64SBarry Smith 
69807cf37e64SBarry Smith    Level: intermediate
69817cf37e64SBarry Smith 
69827cf37e64SBarry Smith    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
69837cf37e64SBarry Smith 
69847cf37e64SBarry Smith    Options Database Keys:
69857cf37e64SBarry Smith .  -ts_monitor_error - create a graphical monitor of error history
69867cf37e64SBarry Smith 
69877cf37e64SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
69887cf37e64SBarry Smith @*/
6989edbaebb3SBarry Smith PetscErrorCode  TSMonitorError(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
69907cf37e64SBarry Smith {
69917cf37e64SBarry Smith   PetscErrorCode    ierr;
69927cf37e64SBarry Smith   Vec               y;
69937cf37e64SBarry Smith   PetscReal         nrm;
6994edbaebb3SBarry Smith   PetscBool         flg;
69957cf37e64SBarry Smith 
69967cf37e64SBarry Smith   PetscFunctionBegin;
69977cf37e64SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
69987cf37e64SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
69997cf37e64SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
7000edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERASCII,&flg);CHKERRQ(ierr);
7001edbaebb3SBarry Smith   if (flg) {
70027cf37e64SBarry Smith     ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
7003edbaebb3SBarry Smith     ierr = PetscViewerASCIIPrintf(vf->viewer,"2-norm of error %g\n",(double)nrm);CHKERRQ(ierr);
7004edbaebb3SBarry Smith   }
7005edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERDRAW,&flg);CHKERRQ(ierr);
7006edbaebb3SBarry Smith   if (flg) {
7007edbaebb3SBarry Smith     ierr = VecView(y,vf->viewer);CHKERRQ(ierr);
7008edbaebb3SBarry Smith   }
7009edbaebb3SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
70107cf37e64SBarry Smith   PetscFunctionReturn(0);
70117cf37e64SBarry Smith }
70127cf37e64SBarry Smith 
7013201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7014201da799SBarry Smith {
7015201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7016201da799SBarry Smith   PetscReal      x   = ptime,y;
7017201da799SBarry Smith   PetscErrorCode ierr;
7018201da799SBarry Smith   PetscInt       its;
7019201da799SBarry Smith 
7020201da799SBarry Smith   PetscFunctionBegin;
702163e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7022201da799SBarry Smith   if (!n) {
7023201da799SBarry Smith     PetscDrawAxis axis;
7024201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7025201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
7026201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7027201da799SBarry Smith     ctx->snes_its = 0;
7028201da799SBarry Smith   }
7029201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
7030201da799SBarry Smith   y    = its - ctx->snes_its;
7031201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
70323fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7033201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
70346934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7035201da799SBarry Smith   }
7036201da799SBarry Smith   ctx->snes_its = its;
7037201da799SBarry Smith   PetscFunctionReturn(0);
7038201da799SBarry Smith }
7039201da799SBarry Smith 
7040201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7041201da799SBarry Smith {
7042201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7043201da799SBarry Smith   PetscReal      x   = ptime,y;
7044201da799SBarry Smith   PetscErrorCode ierr;
7045201da799SBarry Smith   PetscInt       its;
7046201da799SBarry Smith 
7047201da799SBarry Smith   PetscFunctionBegin;
704863e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7049201da799SBarry Smith   if (!n) {
7050201da799SBarry Smith     PetscDrawAxis axis;
7051201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7052201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
7053201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7054201da799SBarry Smith     ctx->ksp_its = 0;
7055201da799SBarry Smith   }
7056201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
7057201da799SBarry Smith   y    = its - ctx->ksp_its;
7058201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
705999fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7060201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
70616934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7062201da799SBarry Smith   }
7063201da799SBarry Smith   ctx->ksp_its = its;
7064201da799SBarry Smith   PetscFunctionReturn(0);
7065201da799SBarry Smith }
7066f9c1d6abSBarry Smith 
7067f9c1d6abSBarry Smith /*@
7068f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
7069f9c1d6abSBarry Smith 
7070d083f849SBarry Smith    Collective on TS
7071f9c1d6abSBarry Smith 
7072f9c1d6abSBarry Smith    Input Parameters:
7073f9c1d6abSBarry Smith +  ts - the TS context
7074f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
7075f9c1d6abSBarry Smith 
7076f9c1d6abSBarry Smith    Output Parameters:
7077f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
7078f9c1d6abSBarry Smith 
7079f9c1d6abSBarry Smith    Level: developer
7080f9c1d6abSBarry Smith 
7081f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
7082f9c1d6abSBarry Smith @*/
7083f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
7084f9c1d6abSBarry Smith {
7085f9c1d6abSBarry Smith   PetscErrorCode ierr;
7086f9c1d6abSBarry Smith 
7087f9c1d6abSBarry Smith   PetscFunctionBegin;
7088f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7089ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
7090f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
7091f9c1d6abSBarry Smith   PetscFunctionReturn(0);
7092f9c1d6abSBarry Smith }
709324655328SShri 
7094b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
7095b3d3934dSBarry Smith /*@C
7096b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
7097b3d3934dSBarry Smith 
7098b3d3934dSBarry Smith    Collective on TS
7099b3d3934dSBarry Smith 
7100b3d3934dSBarry Smith    Input Parameters:
7101b3d3934dSBarry Smith .  ts  - the ODE solver object
7102b3d3934dSBarry Smith 
7103b3d3934dSBarry Smith    Output Parameter:
7104b3d3934dSBarry Smith .  ctx - the context
7105b3d3934dSBarry Smith 
7106b3d3934dSBarry Smith    Level: intermediate
7107b3d3934dSBarry Smith 
7108b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
7109b3d3934dSBarry Smith 
7110b3d3934dSBarry Smith @*/
7111b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
7112b3d3934dSBarry Smith {
7113b3d3934dSBarry Smith   PetscErrorCode ierr;
7114b3d3934dSBarry Smith 
7115b3d3934dSBarry Smith   PetscFunctionBegin;
7116a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
7117b3d3934dSBarry Smith   PetscFunctionReturn(0);
7118b3d3934dSBarry Smith }
7119b3d3934dSBarry Smith 
7120b3d3934dSBarry Smith /*@C
7121b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
7122b3d3934dSBarry Smith 
7123b3d3934dSBarry Smith    Collective on TS
7124b3d3934dSBarry Smith 
7125b3d3934dSBarry Smith    Input Parameters:
7126b3d3934dSBarry Smith +  ts - the TS context
7127b3d3934dSBarry Smith .  step - current time-step
7128b3d3934dSBarry Smith .  ptime - current time
71297db568b7SBarry Smith .  u  - current solution
71307db568b7SBarry Smith -  dctx - the envelope context
7131b3d3934dSBarry Smith 
7132b3d3934dSBarry Smith    Options Database:
7133b3d3934dSBarry Smith .  -ts_monitor_envelope
7134b3d3934dSBarry Smith 
7135b3d3934dSBarry Smith    Level: intermediate
7136b3d3934dSBarry Smith 
713795452b02SPatrick Sanan    Notes:
713895452b02SPatrick Sanan     after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
7139b3d3934dSBarry Smith 
71407db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
7141b3d3934dSBarry Smith @*/
71427db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7143b3d3934dSBarry Smith {
7144b3d3934dSBarry Smith   PetscErrorCode       ierr;
71457db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
7146b3d3934dSBarry Smith 
7147b3d3934dSBarry Smith   PetscFunctionBegin;
7148b3d3934dSBarry Smith   if (!ctx->max) {
7149b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
7150b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
7151b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
7152b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
7153b3d3934dSBarry Smith   } else {
7154b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
7155b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
7156b3d3934dSBarry Smith   }
7157b3d3934dSBarry Smith   PetscFunctionReturn(0);
7158b3d3934dSBarry Smith }
7159b3d3934dSBarry Smith 
7160b3d3934dSBarry Smith /*@C
7161b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
7162b3d3934dSBarry Smith 
7163b3d3934dSBarry Smith    Collective on TS
7164b3d3934dSBarry Smith 
7165b3d3934dSBarry Smith    Input Parameter:
7166b3d3934dSBarry Smith .  ts - the TS context
7167b3d3934dSBarry Smith 
7168b3d3934dSBarry Smith    Output Parameter:
7169b3d3934dSBarry Smith +  max - the maximum values
7170b3d3934dSBarry Smith -  min - the minimum values
7171b3d3934dSBarry Smith 
717295452b02SPatrick Sanan    Notes:
717395452b02SPatrick Sanan     If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
71747db568b7SBarry Smith 
7175b3d3934dSBarry Smith    Level: intermediate
7176b3d3934dSBarry Smith 
7177b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7178b3d3934dSBarry Smith @*/
7179b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
7180b3d3934dSBarry Smith {
7181b3d3934dSBarry Smith   PetscInt i;
7182b3d3934dSBarry Smith 
7183b3d3934dSBarry Smith   PetscFunctionBegin;
7184b3d3934dSBarry Smith   if (max) *max = NULL;
7185b3d3934dSBarry Smith   if (min) *min = NULL;
7186b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7187b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
71885537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7189b3d3934dSBarry Smith       if (max) *max = ctx->max;
7190b3d3934dSBarry Smith       if (min) *min = ctx->min;
7191b3d3934dSBarry Smith       break;
7192b3d3934dSBarry Smith     }
7193b3d3934dSBarry Smith   }
7194b3d3934dSBarry Smith   PetscFunctionReturn(0);
7195b3d3934dSBarry Smith }
7196b3d3934dSBarry Smith 
7197b3d3934dSBarry Smith /*@C
7198b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7199b3d3934dSBarry Smith 
7200b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7201b3d3934dSBarry Smith 
7202b3d3934dSBarry Smith    Input Parameter:
7203b3d3934dSBarry Smith .  ctx - the monitor context
7204b3d3934dSBarry Smith 
7205b3d3934dSBarry Smith    Level: intermediate
7206b3d3934dSBarry Smith 
72077db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7208b3d3934dSBarry Smith @*/
7209b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7210b3d3934dSBarry Smith {
7211b3d3934dSBarry Smith   PetscErrorCode ierr;
7212b3d3934dSBarry Smith 
7213b3d3934dSBarry Smith   PetscFunctionBegin;
7214b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7215b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7216b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7217b3d3934dSBarry Smith   PetscFunctionReturn(0);
7218b3d3934dSBarry Smith }
7219f2dee214SBarry Smith 
722024655328SShri /*@
7221dcb233daSLisandro Dalcin    TSRestartStep - Flags the solver to restart the next step
7222dcb233daSLisandro Dalcin 
7223dcb233daSLisandro Dalcin    Collective on TS
7224dcb233daSLisandro Dalcin 
7225dcb233daSLisandro Dalcin    Input Parameter:
7226dcb233daSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
7227dcb233daSLisandro Dalcin 
7228dcb233daSLisandro Dalcin    Level: advanced
7229dcb233daSLisandro Dalcin 
7230dcb233daSLisandro Dalcin    Notes:
7231dcb233daSLisandro Dalcin    Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of
7232dcb233daSLisandro Dalcin    discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution
7233dcb233daSLisandro Dalcin    vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For
7234dcb233daSLisandro Dalcin    the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce
7235dcb233daSLisandro Dalcin    discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with
7236dcb233daSLisandro Dalcin    discontinuous source terms).
7237dcb233daSLisandro Dalcin 
7238dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep()
7239dcb233daSLisandro Dalcin @*/
7240dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts)
7241dcb233daSLisandro Dalcin {
7242dcb233daSLisandro Dalcin   PetscFunctionBegin;
7243dcb233daSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7244dcb233daSLisandro Dalcin   ts->steprestart = PETSC_TRUE;
7245dcb233daSLisandro Dalcin   PetscFunctionReturn(0);
7246dcb233daSLisandro Dalcin }
7247dcb233daSLisandro Dalcin 
7248dcb233daSLisandro Dalcin /*@
724924655328SShri    TSRollBack - Rolls back one time step
725024655328SShri 
725124655328SShri    Collective on TS
725224655328SShri 
725324655328SShri    Input Parameter:
725424655328SShri .  ts - the TS context obtained from TSCreate()
725524655328SShri 
725624655328SShri    Level: advanced
725724655328SShri 
725824655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
725924655328SShri @*/
726024655328SShri PetscErrorCode  TSRollBack(TS ts)
726124655328SShri {
726224655328SShri   PetscErrorCode ierr;
726324655328SShri 
726424655328SShri   PetscFunctionBegin;
726524655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7266b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
726724655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
726824655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
726924655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
727024655328SShri   ts->ptime = ts->ptime_prev;
7271be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
72722808aa04SLisandro Dalcin   ts->steps--;
7273b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
727424655328SShri   PetscFunctionReturn(0);
727524655328SShri }
7276aeb4809dSShri Abhyankar 
7277ff22ae23SHong Zhang /*@
7278ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7279ff22ae23SHong Zhang 
7280ff22ae23SHong Zhang    Input Parameter:
7281ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7282ff22ae23SHong Zhang 
72830429704eSStefano Zampini    Output Parameters:
72840429704eSStefano Zampini +  ns - the number of stages
72850429704eSStefano Zampini -  Y - the current stage vectors
72860429704eSStefano Zampini 
7287ff22ae23SHong Zhang    Level: advanced
7288ff22ae23SHong Zhang 
72890429704eSStefano Zampini    Notes: Both ns and Y can be NULL.
72900429704eSStefano Zampini 
7291ff22ae23SHong Zhang .seealso: TSCreate()
7292ff22ae23SHong Zhang @*/
7293ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7294ff22ae23SHong Zhang {
7295ff22ae23SHong Zhang   PetscErrorCode ierr;
7296ff22ae23SHong Zhang 
7297ff22ae23SHong Zhang   PetscFunctionBegin;
7298ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
72990429704eSStefano Zampini   if (ns) PetscValidPointer(ns,2);
73000429704eSStefano Zampini   if (Y) PetscValidPointer(Y,3);
73010429704eSStefano Zampini   if (!ts->ops->getstages) {
73020429704eSStefano Zampini     if (ns) *ns = 0;
73030429704eSStefano Zampini     if (Y) *Y = NULL;
73040429704eSStefano Zampini   } else {
7305ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7306ff22ae23SHong Zhang   }
7307ff22ae23SHong Zhang   PetscFunctionReturn(0);
7308ff22ae23SHong Zhang }
7309ff22ae23SHong Zhang 
7310847ff0e1SMatthew G. Knepley /*@C
7311847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7312847ff0e1SMatthew G. Knepley 
7313847ff0e1SMatthew G. Knepley   Collective on SNES
7314847ff0e1SMatthew G. Knepley 
7315847ff0e1SMatthew G. Knepley   Input Parameters:
7316847ff0e1SMatthew G. Knepley + ts - the TS context
7317847ff0e1SMatthew G. Knepley . t - current timestep
7318847ff0e1SMatthew G. Knepley . U - state vector
7319847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7320847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7321847ff0e1SMatthew G. Knepley - ctx - an optional user context
7322847ff0e1SMatthew G. Knepley 
7323847ff0e1SMatthew G. Knepley   Output Parameters:
7324847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7325847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7326847ff0e1SMatthew G. Knepley 
7327847ff0e1SMatthew G. Knepley   Level: intermediate
7328847ff0e1SMatthew G. Knepley 
7329847ff0e1SMatthew G. Knepley   Notes:
7330847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7331847ff0e1SMatthew G. Knepley 
7332847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7333847ff0e1SMatthew G. Knepley 
7334847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7335847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7336847ff0e1SMatthew G. Knepley 
7337847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7338847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7339847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7340847ff0e1SMatthew G. Knepley 
7341847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7342847ff0e1SMatthew G. Knepley @*/
7343847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7344847ff0e1SMatthew G. Knepley {
7345847ff0e1SMatthew G. Knepley   SNES           snes;
7346847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7347847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7348847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
7349847ff0e1SMatthew G. Knepley 
7350847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
7351c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
7352847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
7353847ff0e1SMatthew G. Knepley   if (!color) {
7354847ff0e1SMatthew G. Knepley     DM         dm;
7355847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
7356847ff0e1SMatthew G. Knepley 
7357847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
7358847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
7359847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
7360847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
7361847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7362847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7363847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7364847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7365847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7366847ff0e1SMatthew G. Knepley     } else {
7367847ff0e1SMatthew G. Knepley       MatColoring mc;
7368847ff0e1SMatthew G. Knepley 
7369847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
7370847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
7371847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
7372847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
7373847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
7374847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
7375847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7376847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7377847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7378847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7379847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7380847ff0e1SMatthew G. Knepley     }
7381847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
7382847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
7383847ff0e1SMatthew G. Knepley   }
7384847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
7385847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
7386847ff0e1SMatthew G. Knepley   if (J != B) {
7387847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7388847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7389847ff0e1SMatthew G. Knepley   }
7390847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
7391847ff0e1SMatthew G. Knepley }
739293b34091SDebojyoti Ghosh 
7393cb9d8021SPierre Barbier de Reuille /*@
73946bc98fa9SBarry Smith     TSSetFunctionDomainError - Set a function that tests if the current state vector is valid
7395cb9d8021SPierre Barbier de Reuille 
7396cb9d8021SPierre Barbier de Reuille     Input Parameters:
73976bc98fa9SBarry Smith +    ts - the TS context
73986bc98fa9SBarry Smith -    func - function called within TSFunctionDomainError
73996bc98fa9SBarry Smith 
74006bc98fa9SBarry Smith     Calling sequence of func:
74016bc98fa9SBarry Smith $     PetscErrorCode func(TS ts,PetscReal time,Vec state,PetscBool reject)
74026bc98fa9SBarry Smith 
74036bc98fa9SBarry Smith +   ts - the TS context
74046bc98fa9SBarry Smith .   time - the current time (of the stage)
74056bc98fa9SBarry Smith .   state - the state to check if it is valid
74066bc98fa9SBarry Smith -   reject - (output parameter) PETSC_FALSE if the state is acceptable, PETSC_TRUE if not acceptable
7407cb9d8021SPierre Barbier de Reuille 
7408cb9d8021SPierre Barbier de Reuille     Level: intermediate
7409cb9d8021SPierre Barbier de Reuille 
74106bc98fa9SBarry Smith     Notes:
74116bc98fa9SBarry Smith       If an implicit ODE solver is being used then, in addition to providing this routine, the
74126bc98fa9SBarry Smith       user's code should call SNESSetFunctionDomainError() when domain errors occur during
74136bc98fa9SBarry Smith       function evaluations where the functions are provided by TSSetIFunction() or TSSetRHSFunction().
74146bc98fa9SBarry Smith       Use TSGetSNES() to obtain the SNES object
74156bc98fa9SBarry Smith 
74166bc98fa9SBarry Smith     Developer Notes:
74176bc98fa9SBarry Smith       The naming of this function is inconsistent with the SNESSetFunctionDomainError()
74186bc98fa9SBarry Smith       since one takes a function pointer and the other does not.
74196bc98fa9SBarry Smith 
74206bc98fa9SBarry Smith .seealso: TSAdaptCheckStage(), TSFunctionDomainError(), SNESSetFunctionDomainError(), TSGetSNES()
7421cb9d8021SPierre Barbier de Reuille @*/
7422cb9d8021SPierre Barbier de Reuille 
7423d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
7424cb9d8021SPierre Barbier de Reuille {
7425cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7426cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7427cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
7428cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7429cb9d8021SPierre Barbier de Reuille }
7430cb9d8021SPierre Barbier de Reuille 
7431cb9d8021SPierre Barbier de Reuille /*@
74326bc98fa9SBarry Smith     TSFunctionDomainError - Checks if the current state is valid
7433cb9d8021SPierre Barbier de Reuille 
7434cb9d8021SPierre Barbier de Reuille     Input Parameters:
74356bc98fa9SBarry Smith +    ts - the TS context
74366bc98fa9SBarry Smith .    stagetime - time of the simulation
74376bc98fa9SBarry Smith -    Y - state vector to check.
7438cb9d8021SPierre Barbier de Reuille 
7439cb9d8021SPierre Barbier de Reuille     Output Parameter:
74406bc98fa9SBarry Smith .    accept - Set to PETSC_FALSE if the current state vector is valid.
7441cb9d8021SPierre Barbier de Reuille 
7442cb9d8021SPierre Barbier de Reuille     Note:
74436bc98fa9SBarry Smith     This function is called by the TS integration routines and calls the user provided function (set with TSSetFunctionDomainError())
74446bc98fa9SBarry Smith     to check if the current state is valid.
744596a0c994SBarry Smith 
74466bc98fa9SBarry Smith     Level: developer
74476bc98fa9SBarry Smith 
74486bc98fa9SBarry Smith .seealso: TSSetFunctionDomainError()
7449cb9d8021SPierre Barbier de Reuille @*/
7450d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
7451cb9d8021SPierre Barbier de Reuille {
7452cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7453cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7454cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
7455cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
7456d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
7457cb9d8021SPierre Barbier de Reuille   }
7458cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7459cb9d8021SPierre Barbier de Reuille }
74601ceb14c0SBarry Smith 
746193b34091SDebojyoti Ghosh /*@C
7462e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
746393b34091SDebojyoti Ghosh 
7464d083f849SBarry Smith   Collective
746593b34091SDebojyoti Ghosh 
746693b34091SDebojyoti Ghosh   Input Parameter:
746793b34091SDebojyoti Ghosh . tsin    - The input TS
746893b34091SDebojyoti Ghosh 
746993b34091SDebojyoti Ghosh   Output Parameter:
7470e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
747193b34091SDebojyoti Ghosh 
74725eca1a21SEmil Constantinescu   Notes:
74735eca1a21SEmil 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.
74745eca1a21SEmil Constantinescu 
7475928bb9adSStefano 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);
74765eca1a21SEmil Constantinescu 
74775eca1a21SEmil Constantinescu   Level: developer
747893b34091SDebojyoti Ghosh 
7479e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
748093b34091SDebojyoti Ghosh @*/
7481baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
748293b34091SDebojyoti Ghosh {
748393b34091SDebojyoti Ghosh   TS             t;
748493b34091SDebojyoti Ghosh   PetscErrorCode ierr;
7485dc846ba4SSatish Balay   SNES           snes_start;
7486dc846ba4SSatish Balay   DM             dm;
7487dc846ba4SSatish Balay   TSType         type;
748893b34091SDebojyoti Ghosh 
748993b34091SDebojyoti Ghosh   PetscFunctionBegin;
749093b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
749193b34091SDebojyoti Ghosh   *tsout = NULL;
749293b34091SDebojyoti Ghosh 
74937a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
749493b34091SDebojyoti Ghosh 
749593b34091SDebojyoti Ghosh   /* General TS description */
749693b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
749793b34091SDebojyoti Ghosh   t->setupcalled       = 0;
749893b34091SDebojyoti Ghosh   t->ksp_its           = 0;
749993b34091SDebojyoti Ghosh   t->snes_its          = 0;
750093b34091SDebojyoti Ghosh   t->nwork             = 0;
75017d51462cSStefano Zampini   t->rhsjacobian.time  = PETSC_MIN_REAL;
750293b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
750393b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
750493b34091SDebojyoti Ghosh 
750534561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
750634561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
7507d15a3a53SEmil Constantinescu 
750893b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
750993b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
751093b34091SDebojyoti Ghosh 
751193b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
751251699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
751393b34091SDebojyoti Ghosh 
7514e7069c78SShri   t->trajectory = tsin->trajectory;
7515e7069c78SShri   ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr);
7516e7069c78SShri 
7517e7069c78SShri   t->event = tsin->event;
75186b10a48eSSatish Balay   if (t->event) t->event->refct++;
7519e7069c78SShri 
752093b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
752193b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
7522e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
752393b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
752493b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
752593b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
752693b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
752793b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
752893b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
752993b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
753093b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
753193b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
753293b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
753393b34091SDebojyoti Ghosh 
753493b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
753593b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
753693b34091SDebojyoti Ghosh 
753793b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
753893b34091SDebojyoti Ghosh 
753993b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
754093b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
754193b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
754293b34091SDebojyoti Ghosh 
754393b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
754493b34091SDebojyoti Ghosh 
75450d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
75460d4fed19SBarry Smith     PetscInt i;
75470d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
75480d4fed19SBarry Smith     for (i=0; i<10; i++) {
75490d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
75500d4fed19SBarry Smith     }
75510d4fed19SBarry Smith   }
755293b34091SDebojyoti Ghosh   *tsout = t;
755393b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
755493b34091SDebojyoti Ghosh }
7555f3b1f45cSBarry Smith 
7556f3b1f45cSBarry Smith static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void* ctx,Vec x,Vec y)
7557f3b1f45cSBarry Smith {
7558f3b1f45cSBarry Smith   PetscErrorCode ierr;
7559f3b1f45cSBarry Smith   TS             ts = (TS) ctx;
7560f3b1f45cSBarry Smith 
7561f3b1f45cSBarry Smith   PetscFunctionBegin;
7562f3b1f45cSBarry Smith   ierr = TSComputeRHSFunction(ts,0,x,y);CHKERRQ(ierr);
7563f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7564f3b1f45cSBarry Smith }
7565f3b1f45cSBarry Smith 
7566f3b1f45cSBarry Smith /*@
7567f3b1f45cSBarry Smith     TSRHSJacobianTest - Compares the multiply routine provided to the MATSHELL with differencing on the TS given RHS function.
7568f3b1f45cSBarry Smith 
7569d083f849SBarry Smith    Logically Collective on TS
7570f3b1f45cSBarry Smith 
7571f3b1f45cSBarry Smith     Input Parameters:
7572f3b1f45cSBarry Smith     TS - the time stepping routine
7573f3b1f45cSBarry Smith 
7574f3b1f45cSBarry Smith    Output Parameter:
7575f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
7576f3b1f45cSBarry Smith 
7577f3b1f45cSBarry Smith    Options Database:
7578f3b1f45cSBarry Smith  .   -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator
7579f3b1f45cSBarry Smith 
7580f3b1f45cSBarry Smith    Level: advanced
7581f3b1f45cSBarry Smith 
758295452b02SPatrick Sanan    Notes:
758395452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
7584f3b1f45cSBarry Smith 
7585f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTestTranspose()
7586f3b1f45cSBarry Smith @*/
7587f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTest(TS ts,PetscBool *flg)
7588f3b1f45cSBarry Smith {
7589f3b1f45cSBarry Smith   Mat            J,B;
7590f3b1f45cSBarry Smith   PetscErrorCode ierr;
7591f3b1f45cSBarry Smith   TSRHSJacobian  func;
7592f3b1f45cSBarry Smith   void*          ctx;
7593f3b1f45cSBarry Smith 
7594f3b1f45cSBarry Smith   PetscFunctionBegin;
7595f3b1f45cSBarry Smith   ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr);
7596f3b1f45cSBarry Smith   ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr);
7597f3b1f45cSBarry Smith   ierr = MatShellTestMult(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr);
7598f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7599f3b1f45cSBarry Smith }
7600f3b1f45cSBarry Smith 
7601f3b1f45cSBarry Smith /*@C
7602f3b1f45cSBarry Smith     TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the MATSHELL with differencing on the TS given RHS function.
7603f3b1f45cSBarry Smith 
7604d083f849SBarry Smith    Logically Collective on TS
7605f3b1f45cSBarry Smith 
7606f3b1f45cSBarry Smith     Input Parameters:
7607f3b1f45cSBarry Smith     TS - the time stepping routine
7608f3b1f45cSBarry Smith 
7609f3b1f45cSBarry Smith    Output Parameter:
7610f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
7611f3b1f45cSBarry Smith 
7612f3b1f45cSBarry Smith    Options Database:
7613f3b1f45cSBarry Smith .   -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator
7614f3b1f45cSBarry Smith 
761595452b02SPatrick Sanan    Notes:
761695452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
7617f3b1f45cSBarry Smith 
7618f3b1f45cSBarry Smith    Level: advanced
7619f3b1f45cSBarry Smith 
7620f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTest()
7621f3b1f45cSBarry Smith @*/
7622f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTestTranspose(TS ts,PetscBool *flg)
7623f3b1f45cSBarry Smith {
7624f3b1f45cSBarry Smith   Mat            J,B;
7625f3b1f45cSBarry Smith   PetscErrorCode ierr;
7626f3b1f45cSBarry Smith   void           *ctx;
7627f3b1f45cSBarry Smith   TSRHSJacobian  func;
7628f3b1f45cSBarry Smith 
7629f3b1f45cSBarry Smith   PetscFunctionBegin;
7630f3b1f45cSBarry Smith   ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr);
7631f3b1f45cSBarry Smith   ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr);
7632f3b1f45cSBarry Smith   ierr = MatShellTestMultTranspose(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr);
7633f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7634f3b1f45cSBarry Smith }
76350fe4d17eSHong Zhang 
76360fe4d17eSHong Zhang /*@
76370fe4d17eSHong Zhang   TSSetUseSplitRHSFunction - Use the split RHSFunction when a multirate method is used.
76380fe4d17eSHong Zhang 
76390fe4d17eSHong Zhang   Logically collective
76400fe4d17eSHong Zhang 
76410fe4d17eSHong Zhang   Input Parameter:
76420fe4d17eSHong Zhang +  ts - timestepping context
76430fe4d17eSHong Zhang -  use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used
76440fe4d17eSHong Zhang 
76450fe4d17eSHong Zhang   Options Database:
76460fe4d17eSHong Zhang .   -ts_use_splitrhsfunction - <true,false>
76470fe4d17eSHong Zhang 
76480fe4d17eSHong Zhang   Notes:
76490fe4d17eSHong Zhang     This is only useful for multirate methods
76500fe4d17eSHong Zhang 
76510fe4d17eSHong Zhang   Level: intermediate
76520fe4d17eSHong Zhang 
76530fe4d17eSHong Zhang .seealso: TSGetUseSplitRHSFunction()
76540fe4d17eSHong Zhang @*/
76550fe4d17eSHong Zhang PetscErrorCode TSSetUseSplitRHSFunction(TS ts, PetscBool use_splitrhsfunction)
76560fe4d17eSHong Zhang {
76570fe4d17eSHong Zhang   PetscFunctionBegin;
76580fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
76590fe4d17eSHong Zhang   ts->use_splitrhsfunction = use_splitrhsfunction;
76600fe4d17eSHong Zhang   PetscFunctionReturn(0);
76610fe4d17eSHong Zhang }
76620fe4d17eSHong Zhang 
76630fe4d17eSHong Zhang /*@
76640fe4d17eSHong Zhang   TSGetUseSplitRHSFunction - Gets whether to use the split RHSFunction when a multirate method is used.
76650fe4d17eSHong Zhang 
76660fe4d17eSHong Zhang   Not collective
76670fe4d17eSHong Zhang 
76680fe4d17eSHong Zhang   Input Parameter:
76690fe4d17eSHong Zhang .  ts - timestepping context
76700fe4d17eSHong Zhang 
76710fe4d17eSHong Zhang   Output Parameter:
76720fe4d17eSHong Zhang .  use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used
76730fe4d17eSHong Zhang 
76740fe4d17eSHong Zhang   Level: intermediate
76750fe4d17eSHong Zhang 
76760fe4d17eSHong Zhang .seealso: TSSetUseSplitRHSFunction()
76770fe4d17eSHong Zhang @*/
76780fe4d17eSHong Zhang PetscErrorCode TSGetUseSplitRHSFunction(TS ts, PetscBool *use_splitrhsfunction)
76790fe4d17eSHong Zhang {
76800fe4d17eSHong Zhang   PetscFunctionBegin;
76810fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
76820fe4d17eSHong Zhang   *use_splitrhsfunction = ts->use_splitrhsfunction;
76830fe4d17eSHong Zhang   PetscFunctionReturn(0);
76840fe4d17eSHong Zhang }
7685