xref: /petsc/src/ts/interface/ts.c (revision fc8dbba5abe893115591fc243f2a1366e9bec62c)
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 
14feed9e9dSBarry Smith const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0};
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 
1855180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&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);
1946ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,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);
2046ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,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);
2536934998bSLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,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);
2710ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"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");
2856934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,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);
2990ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"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);
3090ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"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;
31491b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",0,monfilename,PETSC_MAX_PATH_LEN,&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 
331d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&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) {
351d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,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   }
35651b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&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);
37451b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,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;
395847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);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 
44478fbdcc8SBarry Smith    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 
1768efe9872eSLisandro Dalcin /*@
1769efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1770efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1771efe9872eSLisandro Dalcin 
1772d083f849SBarry Smith    Logically Collective on TS
1773efe9872eSLisandro Dalcin 
1774efe9872eSLisandro Dalcin    Input Parameters:
1775efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1776efe9872eSLisandro Dalcin .  u - the solution vector
1777efe9872eSLisandro Dalcin -  v - the time derivative vector
1778efe9872eSLisandro Dalcin 
1779efe9872eSLisandro Dalcin    Level: beginner
1780efe9872eSLisandro Dalcin 
1781efe9872eSLisandro Dalcin @*/
1782efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1783efe9872eSLisandro Dalcin {
1784efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1785efe9872eSLisandro Dalcin 
1786efe9872eSLisandro Dalcin   PetscFunctionBegin;
1787efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1788efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1789efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1790efe9872eSLisandro Dalcin   ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
1791efe9872eSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr);
1792efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
1793efe9872eSLisandro Dalcin   ts->vec_dot = v;
1794efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1795efe9872eSLisandro Dalcin }
1796efe9872eSLisandro Dalcin 
1797efe9872eSLisandro Dalcin /*@
1798efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1799efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1800efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1801efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1802efe9872eSLisandro Dalcin 
1803efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1804efe9872eSLisandro Dalcin 
1805efe9872eSLisandro Dalcin    Input Parameter:
1806efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1807efe9872eSLisandro Dalcin 
1808efe9872eSLisandro Dalcin    Output Parameter:
1809efe9872eSLisandro Dalcin +  u - the vector containing the solution
1810efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1811efe9872eSLisandro Dalcin 
1812efe9872eSLisandro Dalcin    Level: intermediate
1813efe9872eSLisandro Dalcin 
1814efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1815efe9872eSLisandro Dalcin 
1816efe9872eSLisandro Dalcin @*/
1817efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1818efe9872eSLisandro Dalcin {
1819efe9872eSLisandro Dalcin   PetscFunctionBegin;
1820efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1821efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1822efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1823efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1824efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1825efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1826efe9872eSLisandro Dalcin }
1827efe9872eSLisandro Dalcin 
182855849f57SBarry Smith /*@C
182955849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
183055849f57SBarry Smith 
183155849f57SBarry Smith   Collective on PetscViewer
183255849f57SBarry Smith 
183355849f57SBarry Smith   Input Parameters:
183455849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
183555849f57SBarry Smith            some related function before a call to TSLoad().
183655849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
183755849f57SBarry Smith 
183855849f57SBarry Smith    Level: intermediate
183955849f57SBarry Smith 
184055849f57SBarry Smith   Notes:
184155849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
184255849f57SBarry Smith 
184355849f57SBarry Smith   Notes for advanced users:
184455849f57SBarry Smith   Most users should not need to know the details of the binary storage
184555849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
184655849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
184755849f57SBarry Smith   format is
184855849f57SBarry Smith .vb
184955849f57SBarry Smith      has not yet been determined
185055849f57SBarry Smith .ve
185155849f57SBarry Smith 
185255849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
185355849f57SBarry Smith @*/
1854f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
185555849f57SBarry Smith {
185655849f57SBarry Smith   PetscErrorCode ierr;
185755849f57SBarry Smith   PetscBool      isbinary;
185855849f57SBarry Smith   PetscInt       classid;
185955849f57SBarry Smith   char           type[256];
18602d53ad75SBarry Smith   DMTS           sdm;
1861ad6bc421SBarry Smith   DM             dm;
186255849f57SBarry Smith 
186355849f57SBarry Smith   PetscFunctionBegin;
1864f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
186555849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
186655849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
186755849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
186855849f57SBarry Smith 
1869060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1870ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1871060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1872f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1873f2c2a1b9SBarry Smith   if (ts->ops->load) {
1874f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1875f2c2a1b9SBarry Smith   }
1876ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1877ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1878ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1879f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1880f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
18812d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
18822d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
188355849f57SBarry Smith   PetscFunctionReturn(0);
188455849f57SBarry Smith }
188555849f57SBarry Smith 
18869804daf3SBarry Smith #include <petscdraw.h>
1887e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1888e04113cfSBarry Smith #include <petscviewersaws.h>
1889f05ece33SBarry Smith #endif
1890fe2efc57SMark 
1891fe2efc57SMark /*@C
1892fe2efc57SMark    TSViewFromOptions - View from Options
1893fe2efc57SMark 
1894fe2efc57SMark    Collective on TS
1895fe2efc57SMark 
1896fe2efc57SMark    Input Parameters:
1897fe2efc57SMark +  A - the application ordering context
1898736c3998SJose E. Roman .  obj - Optional object
1899736c3998SJose E. Roman -  name - command line option
1900fe2efc57SMark 
1901fe2efc57SMark    Level: intermediate
1902fe2efc57SMark .seealso:  TS, TSView, PetscObjectViewFromOptions(), TSCreate()
1903fe2efc57SMark @*/
1904fe2efc57SMark PetscErrorCode  TSViewFromOptions(TS A,PetscObject obj,const char name[])
1905fe2efc57SMark {
1906fe2efc57SMark   PetscErrorCode ierr;
1907fe2efc57SMark 
1908fe2efc57SMark   PetscFunctionBegin;
1909fe2efc57SMark   PetscValidHeaderSpecific(A,TS_CLASSID,1);
1910fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)A,obj,name);CHKERRQ(ierr);
1911fe2efc57SMark   PetscFunctionReturn(0);
1912fe2efc57SMark }
1913fe2efc57SMark 
19147e2c5f70SBarry Smith /*@C
1915d763cef2SBarry Smith     TSView - Prints the TS data structure.
1916d763cef2SBarry Smith 
19174c49b128SBarry Smith     Collective on TS
1918d763cef2SBarry Smith 
1919d763cef2SBarry Smith     Input Parameters:
1920d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1921d763cef2SBarry Smith -   viewer - visualization context
1922d763cef2SBarry Smith 
1923d763cef2SBarry Smith     Options Database Key:
1924d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1925d763cef2SBarry Smith 
1926d763cef2SBarry Smith     Notes:
1927d763cef2SBarry Smith     The available visualization contexts include
1928b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1929b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1930d763cef2SBarry Smith          output where only the first processor opens
1931d763cef2SBarry Smith          the file.  All other processors send their
1932d763cef2SBarry Smith          data to the first processor to print.
1933d763cef2SBarry Smith 
1934d763cef2SBarry Smith     The user can open an alternative visualization context with
1935b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1936d763cef2SBarry Smith 
1937d763cef2SBarry Smith     Level: beginner
1938d763cef2SBarry Smith 
1939b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1940d763cef2SBarry Smith @*/
19417087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1942d763cef2SBarry Smith {
1943dfbe8321SBarry Smith   PetscErrorCode ierr;
194419fd82e9SBarry Smith   TSType         type;
19452b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
19462d53ad75SBarry Smith   DMTS           sdm;
1947e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1948536b137fSBarry Smith   PetscBool      issaws;
1949f05ece33SBarry Smith #endif
1950d763cef2SBarry Smith 
1951d763cef2SBarry Smith   PetscFunctionBegin;
19520700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
19533050cee2SBarry Smith   if (!viewer) {
1954ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
19553050cee2SBarry Smith   }
19560700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1957c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1958fd16b177SBarry Smith 
1959251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1960251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
196155849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
19622b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1963e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1964536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1965f05ece33SBarry Smith #endif
196632077d6dSBarry Smith   if (iascii) {
1967dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
1968efd4aadfSBarry Smith     if (ts->ops->view) {
1969efd4aadfSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1970efd4aadfSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1971efd4aadfSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1972efd4aadfSBarry Smith     }
1973ef85077eSLisandro Dalcin     if (ts->max_steps < PETSC_MAX_INT) {
197477431f27SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
1975ef85077eSLisandro Dalcin     }
1976ef85077eSLisandro Dalcin     if (ts->max_time < PETSC_MAX_REAL) {
19777c8652ddSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1978ef85077eSLisandro Dalcin     }
1979efd4aadfSBarry Smith     if (ts->usessnes) {
1980efd4aadfSBarry Smith       PetscBool lin;
1981d763cef2SBarry Smith       if (ts->problem_type == TS_NONLINEAR) {
19825ef26d82SJed Brown         ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1983d763cef2SBarry Smith       }
19845ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
19851ef27442SStefano Zampini       ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&lin,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr);
1986efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr);
1987efd4aadfSBarry Smith     }
1988193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
1989a0af407cSBarry Smith     if (ts->vrtol) {
1990a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of relative error tolerances, ");CHKERRQ(ierr);
1991a0af407cSBarry Smith     } else {
1992a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr);
1993a0af407cSBarry Smith     }
1994a0af407cSBarry Smith     if (ts->vatol) {
1995a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of absolute error tolerances\n");CHKERRQ(ierr);
1996a0af407cSBarry Smith     } else {
1997a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr);
1998a0af407cSBarry Smith     }
1999825ab935SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2000efd4aadfSBarry Smith     ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);
2001825ab935SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
20020f5bd95cSBarry Smith   } else if (isstring) {
2003a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
200436a9e3b9SBarry Smith     ierr = PetscViewerStringSPrintf(viewer," TSType: %-7.7s",type);CHKERRQ(ierr);
200536a9e3b9SBarry Smith     if (ts->ops->view) {ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);}
200655849f57SBarry Smith   } else if (isbinary) {
200755849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
200855849f57SBarry Smith     MPI_Comm    comm;
200955849f57SBarry Smith     PetscMPIInt rank;
201055849f57SBarry Smith     char        type[256];
201155849f57SBarry Smith 
201255849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
201355849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
201455849f57SBarry Smith     if (!rank) {
201555849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
201655849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
201755849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
201855849f57SBarry Smith     }
201955849f57SBarry Smith     if (ts->ops->view) {
202055849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
202155849f57SBarry Smith     }
2022efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2023f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
2024f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
20252d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
20262d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
20272b0a91c0SBarry Smith   } else if (isdraw) {
20282b0a91c0SBarry Smith     PetscDraw draw;
20292b0a91c0SBarry Smith     char      str[36];
203089fd9fafSBarry Smith     PetscReal x,y,bottom,h;
20312b0a91c0SBarry Smith 
20322b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
20332b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
20342b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
20352b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
203651fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
203789fd9fafSBarry Smith     bottom = y - h;
20382b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
20392b0a91c0SBarry Smith     if (ts->ops->view) {
20402b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
20412b0a91c0SBarry Smith     }
2042efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2043efd4aadfSBarry Smith     if (ts->snes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
20442b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2045e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2046536b137fSBarry Smith   } else if (issaws) {
2047d45a07a7SBarry Smith     PetscMPIInt rank;
20482657e9d9SBarry Smith     const char  *name;
20492657e9d9SBarry Smith 
20502657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
2051d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
2052d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
2053d45a07a7SBarry Smith       char       dir[1024];
2054d45a07a7SBarry Smith 
2055e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
2056a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
20572657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
20582657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
20592657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
2060d763cef2SBarry Smith     }
20610acecf5bSBarry Smith     if (ts->ops->view) {
20620acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
20630acecf5bSBarry Smith     }
2064f05ece33SBarry Smith #endif
2065f05ece33SBarry Smith   }
206636a9e3b9SBarry Smith   if (ts->snes && ts->usessnes)  {
206736a9e3b9SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
206836a9e3b9SBarry Smith     ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);
206936a9e3b9SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
207036a9e3b9SBarry Smith   }
207136a9e3b9SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
207236a9e3b9SBarry Smith   ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
2073f05ece33SBarry Smith 
2074b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2075251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
2076b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2077d763cef2SBarry Smith   PetscFunctionReturn(0);
2078d763cef2SBarry Smith }
2079d763cef2SBarry Smith 
2080b07ff414SBarry Smith /*@
2081d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2082d763cef2SBarry Smith    the timesteppers.
2083d763cef2SBarry Smith 
20843f9fe445SBarry Smith    Logically Collective on TS
2085d763cef2SBarry Smith 
2086d763cef2SBarry Smith    Input Parameters:
2087d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2088d763cef2SBarry Smith -  usrP - optional user context
2089d763cef2SBarry Smith 
209095452b02SPatrick Sanan    Fortran Notes:
209195452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2092daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2093daf670e6SBarry Smith 
2094d763cef2SBarry Smith    Level: intermediate
2095d763cef2SBarry Smith 
2096d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2097d763cef2SBarry Smith @*/
20987087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2099d763cef2SBarry Smith {
2100d763cef2SBarry Smith   PetscFunctionBegin;
21010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2102d763cef2SBarry Smith   ts->user = usrP;
2103d763cef2SBarry Smith   PetscFunctionReturn(0);
2104d763cef2SBarry Smith }
2105d763cef2SBarry Smith 
2106b07ff414SBarry Smith /*@
2107d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2108d763cef2SBarry Smith     timestepper.
2109d763cef2SBarry Smith 
2110d763cef2SBarry Smith     Not Collective
2111d763cef2SBarry Smith 
2112d763cef2SBarry Smith     Input Parameter:
2113d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2114d763cef2SBarry Smith 
2115d763cef2SBarry Smith     Output Parameter:
2116d763cef2SBarry Smith .   usrP - user context
2117d763cef2SBarry Smith 
211895452b02SPatrick Sanan    Fortran Notes:
211995452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2120daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2121daf670e6SBarry Smith 
2122d763cef2SBarry Smith     Level: intermediate
2123d763cef2SBarry Smith 
2124d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2125d763cef2SBarry Smith @*/
2126e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2127d763cef2SBarry Smith {
2128d763cef2SBarry Smith   PetscFunctionBegin;
21290700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2130e71120c6SJed Brown   *(void**)usrP = ts->user;
2131d763cef2SBarry Smith   PetscFunctionReturn(0);
2132d763cef2SBarry Smith }
2133d763cef2SBarry Smith 
2134d763cef2SBarry Smith /*@
213580275a0aSLisandro Dalcin    TSGetStepNumber - Gets the number of steps completed.
2136d763cef2SBarry Smith 
2137d763cef2SBarry Smith    Not Collective
2138d763cef2SBarry Smith 
2139d763cef2SBarry Smith    Input Parameter:
2140d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2141d763cef2SBarry Smith 
2142d763cef2SBarry Smith    Output Parameter:
214380275a0aSLisandro Dalcin .  steps - number of steps completed so far
2144d763cef2SBarry Smith 
2145d763cef2SBarry Smith    Level: intermediate
2146d763cef2SBarry Smith 
21479be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2148d763cef2SBarry Smith @*/
214980275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps)
2150d763cef2SBarry Smith {
2151d763cef2SBarry Smith   PetscFunctionBegin;
21520700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
215380275a0aSLisandro Dalcin   PetscValidIntPointer(steps,2);
215480275a0aSLisandro Dalcin   *steps = ts->steps;
215580275a0aSLisandro Dalcin   PetscFunctionReturn(0);
215680275a0aSLisandro Dalcin }
215780275a0aSLisandro Dalcin 
215880275a0aSLisandro Dalcin /*@
215980275a0aSLisandro Dalcin    TSSetStepNumber - Sets the number of steps completed.
216080275a0aSLisandro Dalcin 
216180275a0aSLisandro Dalcin    Logically Collective on TS
216280275a0aSLisandro Dalcin 
216380275a0aSLisandro Dalcin    Input Parameters:
216480275a0aSLisandro Dalcin +  ts - the TS context
216580275a0aSLisandro Dalcin -  steps - number of steps completed so far
216680275a0aSLisandro Dalcin 
216780275a0aSLisandro Dalcin    Notes:
216880275a0aSLisandro Dalcin    For most uses of the TS solvers the user need not explicitly call
216980275a0aSLisandro Dalcin    TSSetStepNumber(), as the step counter is appropriately updated in
217080275a0aSLisandro Dalcin    TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to
217180275a0aSLisandro Dalcin    reinitialize timestepping by setting the step counter to zero (and time
217280275a0aSLisandro Dalcin    to the initial time) to solve a similar problem with different initial
217380275a0aSLisandro Dalcin    conditions or parameters. Other possible use case is to continue
217480275a0aSLisandro Dalcin    timestepping from a previously interrupted run in such a way that TS
217580275a0aSLisandro Dalcin    monitors will be called with a initial nonzero step counter.
217680275a0aSLisandro Dalcin 
217780275a0aSLisandro Dalcin    Level: advanced
217880275a0aSLisandro Dalcin 
217980275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution()
218080275a0aSLisandro Dalcin @*/
218180275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps)
218280275a0aSLisandro Dalcin {
218380275a0aSLisandro Dalcin   PetscFunctionBegin;
218480275a0aSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
218580275a0aSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,steps,2);
218680275a0aSLisandro Dalcin   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative");
218780275a0aSLisandro Dalcin   ts->steps = steps;
2188d763cef2SBarry Smith   PetscFunctionReturn(0);
2189d763cef2SBarry Smith }
2190d763cef2SBarry Smith 
2191d763cef2SBarry Smith /*@
2192d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2193d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2194d763cef2SBarry Smith 
21953f9fe445SBarry Smith    Logically Collective on TS
2196d763cef2SBarry Smith 
2197d763cef2SBarry Smith    Input Parameters:
2198d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2199d763cef2SBarry Smith -  time_step - the size of the timestep
2200d763cef2SBarry Smith 
2201d763cef2SBarry Smith    Level: intermediate
2202d763cef2SBarry Smith 
2203aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime()
2204d763cef2SBarry Smith 
2205d763cef2SBarry Smith @*/
22067087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2207d763cef2SBarry Smith {
2208d763cef2SBarry Smith   PetscFunctionBegin;
22090700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2210c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2211d763cef2SBarry Smith   ts->time_step = time_step;
2212d763cef2SBarry Smith   PetscFunctionReturn(0);
2213d763cef2SBarry Smith }
2214d763cef2SBarry Smith 
2215a43b19c4SJed Brown /*@
221649354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
221749354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
221849354f04SShri Abhyankar      or just return at the final time TS computed.
2219a43b19c4SJed Brown 
2220a43b19c4SJed Brown   Logically Collective on TS
2221a43b19c4SJed Brown 
2222a43b19c4SJed Brown    Input Parameter:
2223a43b19c4SJed Brown +   ts - the time-step context
222449354f04SShri Abhyankar -   eftopt - exact final time option
2225a43b19c4SJed Brown 
2226feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2227feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2228feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2229feed9e9dSBarry Smith 
2230feed9e9dSBarry Smith    Options Database:
2231feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2232feed9e9dSBarry Smith 
2233ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2234ee346746SBarry Smith     then the final time you selected.
2235ee346746SBarry Smith 
2236a43b19c4SJed Brown    Level: beginner
2237a43b19c4SJed Brown 
2238f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime()
2239a43b19c4SJed Brown @*/
224049354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2241a43b19c4SJed Brown {
2242a43b19c4SJed Brown   PetscFunctionBegin;
2243a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
224449354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
224549354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2246a43b19c4SJed Brown   PetscFunctionReturn(0);
2247a43b19c4SJed Brown }
2248a43b19c4SJed Brown 
2249d763cef2SBarry Smith /*@
2250f6953c82SLisandro Dalcin    TSGetExactFinalTime - Gets the exact final time option.
2251f6953c82SLisandro Dalcin 
2252f6953c82SLisandro Dalcin    Not Collective
2253f6953c82SLisandro Dalcin 
2254f6953c82SLisandro Dalcin    Input Parameter:
2255f6953c82SLisandro Dalcin .  ts - the TS context
2256f6953c82SLisandro Dalcin 
2257f6953c82SLisandro Dalcin    Output Parameter:
2258f6953c82SLisandro Dalcin .  eftopt - exact final time option
2259f6953c82SLisandro Dalcin 
2260f6953c82SLisandro Dalcin    Level: beginner
2261f6953c82SLisandro Dalcin 
2262f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime()
2263f6953c82SLisandro Dalcin @*/
2264f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt)
2265f6953c82SLisandro Dalcin {
2266f6953c82SLisandro Dalcin   PetscFunctionBegin;
2267f6953c82SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2268f6953c82SLisandro Dalcin   PetscValidPointer(eftopt,2);
2269f6953c82SLisandro Dalcin   *eftopt = ts->exact_final_time;
2270f6953c82SLisandro Dalcin   PetscFunctionReturn(0);
2271f6953c82SLisandro Dalcin }
2272f6953c82SLisandro Dalcin 
2273f6953c82SLisandro Dalcin /*@
2274d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2275d763cef2SBarry Smith 
2276d763cef2SBarry Smith    Not Collective
2277d763cef2SBarry Smith 
2278d763cef2SBarry Smith    Input Parameter:
2279d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2280d763cef2SBarry Smith 
2281d763cef2SBarry Smith    Output Parameter:
2282d763cef2SBarry Smith .  dt - the current timestep size
2283d763cef2SBarry Smith 
2284d763cef2SBarry Smith    Level: intermediate
2285d763cef2SBarry Smith 
2286aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime()
2287d763cef2SBarry Smith 
2288d763cef2SBarry Smith @*/
22897087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2290d763cef2SBarry Smith {
2291d763cef2SBarry Smith   PetscFunctionBegin;
22920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2293f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2294d763cef2SBarry Smith   *dt = ts->time_step;
2295d763cef2SBarry Smith   PetscFunctionReturn(0);
2296d763cef2SBarry Smith }
2297d763cef2SBarry Smith 
2298d8e5e3e6SSatish Balay /*@
2299d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2300d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2301d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2302d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2303d763cef2SBarry Smith 
2304d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2305d763cef2SBarry Smith 
2306d763cef2SBarry Smith    Input Parameter:
2307d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2308d763cef2SBarry Smith 
2309d763cef2SBarry Smith    Output Parameter:
2310d763cef2SBarry Smith .  v - the vector containing the solution
2311d763cef2SBarry Smith 
231263e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
231363e21af5SBarry Smith    final time. It returns the solution at the next timestep.
231463e21af5SBarry Smith 
2315d763cef2SBarry Smith    Level: intermediate
2316d763cef2SBarry Smith 
23170ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction()
2318d763cef2SBarry Smith 
2319d763cef2SBarry Smith @*/
23207087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2321d763cef2SBarry Smith {
2322d763cef2SBarry Smith   PetscFunctionBegin;
23230700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
23244482741eSBarry Smith   PetscValidPointer(v,2);
23258737fe31SLisandro Dalcin   *v = ts->vec_sol;
2326d763cef2SBarry Smith   PetscFunctionReturn(0);
2327d763cef2SBarry Smith }
2328d763cef2SBarry Smith 
232903fe5f5eSDebojyoti Ghosh /*@
2330b2bf4f3aSDebojyoti Ghosh    TSGetSolutionComponents - Returns any solution components at the present
233103fe5f5eSDebojyoti Ghosh    timestep, if available for the time integration method being used.
2332b2bf4f3aSDebojyoti Ghosh    Solution components are quantities that share the same size and
233303fe5f5eSDebojyoti Ghosh    structure as the solution vector.
233403fe5f5eSDebojyoti Ghosh 
233503fe5f5eSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
233603fe5f5eSDebojyoti Ghosh 
233703fe5f5eSDebojyoti Ghosh    Parameters :
2338a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2339b2bf4f3aSDebojyoti Ghosh .  n - If v is PETSC_NULL, then the number of solution components is
2340b2bf4f3aSDebojyoti Ghosh        returned through n, else the n-th solution component is
234103fe5f5eSDebojyoti Ghosh        returned in v.
2342a2b725a8SWilliam Gropp -  v - the vector containing the n-th solution component
234303fe5f5eSDebojyoti Ghosh        (may be PETSC_NULL to use this function to find out
2344b2bf4f3aSDebojyoti Ghosh         the number of solutions components).
234503fe5f5eSDebojyoti Ghosh 
23464cdd57e5SDebojyoti Ghosh    Level: advanced
234703fe5f5eSDebojyoti Ghosh 
234803fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution()
234903fe5f5eSDebojyoti Ghosh 
235003fe5f5eSDebojyoti Ghosh @*/
2351b2bf4f3aSDebojyoti Ghosh PetscErrorCode  TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v)
235203fe5f5eSDebojyoti Ghosh {
235303fe5f5eSDebojyoti Ghosh   PetscErrorCode ierr;
235403fe5f5eSDebojyoti Ghosh 
235503fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
235603fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2357b2bf4f3aSDebojyoti Ghosh   if (!ts->ops->getsolutioncomponents) *n = 0;
235803fe5f5eSDebojyoti Ghosh   else {
2359b2bf4f3aSDebojyoti Ghosh     ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr);
236003fe5f5eSDebojyoti Ghosh   }
236103fe5f5eSDebojyoti Ghosh   PetscFunctionReturn(0);
236203fe5f5eSDebojyoti Ghosh }
236303fe5f5eSDebojyoti Ghosh 
23644cdd57e5SDebojyoti Ghosh /*@
23654cdd57e5SDebojyoti Ghosh    TSGetAuxSolution - Returns an auxiliary solution at the present
23664cdd57e5SDebojyoti Ghosh    timestep, if available for the time integration method being used.
23674cdd57e5SDebojyoti Ghosh 
23684cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
23694cdd57e5SDebojyoti Ghosh 
23704cdd57e5SDebojyoti Ghosh    Parameters :
2371a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2372a2b725a8SWilliam Gropp -  v - the vector containing the auxiliary solution
23734cdd57e5SDebojyoti Ghosh 
23744cdd57e5SDebojyoti Ghosh    Level: intermediate
23754cdd57e5SDebojyoti Ghosh 
23764cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution()
23774cdd57e5SDebojyoti Ghosh 
23784cdd57e5SDebojyoti Ghosh @*/
23794cdd57e5SDebojyoti Ghosh PetscErrorCode  TSGetAuxSolution(TS ts,Vec *v)
23804cdd57e5SDebojyoti Ghosh {
23814cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
23824cdd57e5SDebojyoti Ghosh 
23834cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
23844cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2385f6356ec7SDebojyoti Ghosh   if (ts->ops->getauxsolution) {
23864cdd57e5SDebojyoti Ghosh     ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr);
2387f6356ec7SDebojyoti Ghosh   } else {
2388f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v); CHKERRQ(ierr);
2389f6356ec7SDebojyoti Ghosh   }
23904cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
23914cdd57e5SDebojyoti Ghosh }
23924cdd57e5SDebojyoti Ghosh 
23934cdd57e5SDebojyoti Ghosh /*@
23944cdd57e5SDebojyoti Ghosh    TSGetTimeError - Returns the estimated error vector, if the chosen
23954cdd57e5SDebojyoti Ghosh    TSType has an error estimation functionality.
23964cdd57e5SDebojyoti Ghosh 
23974cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
23984cdd57e5SDebojyoti Ghosh 
23999657682dSDebojyoti Ghosh    Note: MUST call after TSSetUp()
24009657682dSDebojyoti Ghosh 
24014cdd57e5SDebojyoti Ghosh    Parameters :
2402a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2403657c1e31SEmil Constantinescu .  n - current estimate (n=0) or previous one (n=-1)
2404a2b725a8SWilliam Gropp -  v - the vector containing the error (same size as the solution).
24054cdd57e5SDebojyoti Ghosh 
24064cdd57e5SDebojyoti Ghosh    Level: intermediate
24074cdd57e5SDebojyoti Ghosh 
240857df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError()
24094cdd57e5SDebojyoti Ghosh 
24104cdd57e5SDebojyoti Ghosh @*/
24110a01e1b2SEmil Constantinescu PetscErrorCode  TSGetTimeError(TS ts,PetscInt n,Vec *v)
24124cdd57e5SDebojyoti Ghosh {
24134cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
24144cdd57e5SDebojyoti Ghosh 
24154cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
24164cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2417f6356ec7SDebojyoti Ghosh   if (ts->ops->gettimeerror) {
24180a01e1b2SEmil Constantinescu     ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr);
2419f6356ec7SDebojyoti Ghosh   } else {
2420f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v);CHKERRQ(ierr);
2421f6356ec7SDebojyoti Ghosh   }
24224cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
24234cdd57e5SDebojyoti Ghosh }
24244cdd57e5SDebojyoti Ghosh 
242557df6a1bSDebojyoti Ghosh /*@
242657df6a1bSDebojyoti Ghosh    TSSetTimeError - Sets the estimated error vector, if the chosen
242757df6a1bSDebojyoti Ghosh    TSType has an error estimation functionality. This can be used
242857df6a1bSDebojyoti Ghosh    to restart such a time integrator with a given error vector.
242957df6a1bSDebojyoti Ghosh 
243057df6a1bSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
243157df6a1bSDebojyoti Ghosh 
243257df6a1bSDebojyoti Ghosh    Parameters :
2433a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2434a2b725a8SWilliam Gropp -  v - the vector containing the error (same size as the solution).
243557df6a1bSDebojyoti Ghosh 
243657df6a1bSDebojyoti Ghosh    Level: intermediate
243757df6a1bSDebojyoti Ghosh 
243857df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError)
243957df6a1bSDebojyoti Ghosh 
244057df6a1bSDebojyoti Ghosh @*/
244157df6a1bSDebojyoti Ghosh PetscErrorCode  TSSetTimeError(TS ts,Vec v)
244257df6a1bSDebojyoti Ghosh {
244357df6a1bSDebojyoti Ghosh   PetscErrorCode ierr;
244457df6a1bSDebojyoti Ghosh 
244557df6a1bSDebojyoti Ghosh   PetscFunctionBegin;
244657df6a1bSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24479657682dSDebojyoti Ghosh   if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first");
244857df6a1bSDebojyoti Ghosh   if (ts->ops->settimeerror) {
244957df6a1bSDebojyoti Ghosh     ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr);
245057df6a1bSDebojyoti Ghosh   }
245157df6a1bSDebojyoti Ghosh   PetscFunctionReturn(0);
245257df6a1bSDebojyoti Ghosh }
245357df6a1bSDebojyoti Ghosh 
2454bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
2455d8e5e3e6SSatish Balay /*@
2456bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2457d763cef2SBarry Smith 
2458bdad233fSMatthew Knepley   Not collective
2459d763cef2SBarry Smith 
2460bdad233fSMatthew Knepley   Input Parameters:
2461bdad233fSMatthew Knepley + ts   - The TS
2462bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2463d763cef2SBarry Smith .vb
24640910c330SBarry Smith          U_t - A U = 0      (linear)
24650910c330SBarry Smith          U_t - A(t) U = 0   (linear)
24660910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2467d763cef2SBarry Smith .ve
2468d763cef2SBarry Smith 
2469d763cef2SBarry Smith    Level: beginner
2470d763cef2SBarry Smith 
2471bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2472d763cef2SBarry Smith @*/
24737087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2474a7cc72afSBarry Smith {
24759e2a6581SJed Brown   PetscErrorCode ierr;
24769e2a6581SJed Brown 
2477d763cef2SBarry Smith   PetscFunctionBegin;
24780700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2479bdad233fSMatthew Knepley   ts->problem_type = type;
24809e2a6581SJed Brown   if (type == TS_LINEAR) {
24819e2a6581SJed Brown     SNES snes;
24829e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
24839e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
24849e2a6581SJed Brown   }
2485d763cef2SBarry Smith   PetscFunctionReturn(0);
2486d763cef2SBarry Smith }
2487d763cef2SBarry Smith 
2488bdad233fSMatthew Knepley /*@C
2489bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2490bdad233fSMatthew Knepley 
2491bdad233fSMatthew Knepley   Not collective
2492bdad233fSMatthew Knepley 
2493bdad233fSMatthew Knepley   Input Parameter:
2494bdad233fSMatthew Knepley . ts   - The TS
2495bdad233fSMatthew Knepley 
2496bdad233fSMatthew Knepley   Output Parameter:
2497bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2498bdad233fSMatthew Knepley .vb
2499089b2837SJed Brown          M U_t = A U
2500089b2837SJed Brown          M(t) U_t = A(t) U
2501b5abc632SBarry Smith          F(t,U,U_t)
2502bdad233fSMatthew Knepley .ve
2503bdad233fSMatthew Knepley 
2504bdad233fSMatthew Knepley    Level: beginner
2505bdad233fSMatthew Knepley 
2506bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2507bdad233fSMatthew Knepley @*/
25087087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2509a7cc72afSBarry Smith {
2510bdad233fSMatthew Knepley   PetscFunctionBegin;
25110700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
25124482741eSBarry Smith   PetscValidIntPointer(type,2);
2513bdad233fSMatthew Knepley   *type = ts->problem_type;
2514bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2515bdad233fSMatthew Knepley }
2516d763cef2SBarry Smith 
2517d763cef2SBarry Smith /*@
2518d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
2519d763cef2SBarry Smith    of a timestepper.
2520d763cef2SBarry Smith 
2521d763cef2SBarry Smith    Collective on TS
2522d763cef2SBarry Smith 
2523d763cef2SBarry Smith    Input Parameter:
2524d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2525d763cef2SBarry Smith 
2526d763cef2SBarry Smith    Notes:
2527d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2528d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2529141bd67dSStefano Zampini    the call to TSStep() or TSSolve().  However, if one wishes to control this
2530d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2531141bd67dSStefano Zampini    and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve().
2532d763cef2SBarry Smith 
2533d763cef2SBarry Smith    Level: advanced
2534d763cef2SBarry Smith 
2535141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve()
2536d763cef2SBarry Smith @*/
25377087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2538d763cef2SBarry Smith {
2539dfbe8321SBarry Smith   PetscErrorCode ierr;
25406c6b9e74SPeter Brune   DM             dm;
25416c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2542d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2543cd11d68dSLisandro Dalcin   TSIFunction    ifun;
25446c6b9e74SPeter Brune   TSIJacobian    ijac;
2545efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
25466c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
25472ffb9264SLisandro Dalcin   PetscBool      isnone;
2548d763cef2SBarry Smith 
2549d763cef2SBarry Smith   PetscFunctionBegin;
25500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2551277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2552277b19d0SLisandro Dalcin 
25537adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2554cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
2555cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
2556d763cef2SBarry Smith   }
2557277b19d0SLisandro Dalcin 
2558277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
2559277b19d0SLisandro Dalcin 
2560298bade4SHong Zhang   if (!ts->Jacp && ts->Jacprhs) { /* IJacobianP shares the same matrix with RHSJacobianP if only RHSJacobianP is provided */
2561298bade4SHong Zhang     ierr = PetscObjectReference((PetscObject)ts->Jacprhs);CHKERRQ(ierr);
2562298bade4SHong Zhang     ts->Jacp = ts->Jacprhs;
2563298bade4SHong Zhang   }
2564298bade4SHong Zhang 
2565cd4cee2dSHong Zhang   if (ts->quadraturets) {
2566cd4cee2dSHong Zhang     ierr = TSSetUp(ts->quadraturets);CHKERRQ(ierr);
2567ecf68647SHong Zhang     ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2568cd4cee2dSHong Zhang     ierr = VecDuplicate(ts->quadraturets->vec_sol,&ts->vec_costintegrand);CHKERRQ(ierr);
2569cd4cee2dSHong Zhang   }
2570cd4cee2dSHong Zhang 
2571971015bcSStefano Zampini   ierr = TSGetRHSJacobian(ts,NULL,NULL,&rhsjac,NULL);CHKERRQ(ierr);
2572971015bcSStefano Zampini   if (ts->rhsjacobian.reuse && rhsjac == TSComputeRHSJacobianConstant) {
2573e1244c69SJed Brown     Mat Amat,Pmat;
2574e1244c69SJed Brown     SNES snes;
2575e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2576e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2577e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2578e1244c69SJed Brown      * have displaced the RHS matrix */
2579971015bcSStefano Zampini     if (Amat && Amat == ts->Arhs) {
2580abc0d4abSBarry 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 */
2581abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2582e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2583e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2584e1244c69SJed Brown     }
2585971015bcSStefano Zampini     if (Pmat && Pmat == ts->Brhs) {
2586abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2587e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2588e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2589e1244c69SJed Brown     }
2590e1244c69SJed Brown   }
25912ffb9264SLisandro Dalcin 
25922ffb9264SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
25932ffb9264SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
25942ffb9264SLisandro Dalcin 
2595277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2596000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2597277b19d0SLisandro Dalcin   }
2598277b19d0SLisandro Dalcin 
25992ffb9264SLisandro Dalcin   /* Attempt to check/preset a default value for the exact final time option */
26002ffb9264SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr);
26012ffb9264SLisandro Dalcin   if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED)
26022ffb9264SLisandro Dalcin     ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP;
26032ffb9264SLisandro Dalcin 
2604a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
26056c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
26066c6b9e74SPeter Brune    */
26076c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
26080298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
26096c6b9e74SPeter Brune   if (!func) {
26106c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
26116c6b9e74SPeter Brune   }
2612a6772fa2SLisandro 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.
26136c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
26146c6b9e74SPeter Brune    */
26150298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
26160298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
2617efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr);
26180298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
2619efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
26206c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
26216c6b9e74SPeter Brune   }
2622c0517034SDebojyoti Ghosh 
2623c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2624c0517034SDebojyoti Ghosh   if (ts->ops->startingmethod) {
2625c0517034SDebojyoti Ghosh     ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr);
2626c0517034SDebojyoti Ghosh   }
2627c0517034SDebojyoti Ghosh 
2628277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2629277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2630277b19d0SLisandro Dalcin }
2631277b19d0SLisandro Dalcin 
2632f6a906c0SBarry Smith /*@
2633277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2634277b19d0SLisandro Dalcin 
2635277b19d0SLisandro Dalcin    Collective on TS
2636277b19d0SLisandro Dalcin 
2637277b19d0SLisandro Dalcin    Input Parameter:
2638277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2639277b19d0SLisandro Dalcin 
2640277b19d0SLisandro Dalcin    Level: beginner
2641277b19d0SLisandro Dalcin 
2642277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2643277b19d0SLisandro Dalcin @*/
2644277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2645277b19d0SLisandro Dalcin {
26461d06f6b3SHong Zhang   TS_RHSSplitLink ilink = ts->tsrhssplit,next;
2647277b19d0SLisandro Dalcin   PetscErrorCode  ierr;
2648277b19d0SLisandro Dalcin 
2649277b19d0SLisandro Dalcin   PetscFunctionBegin;
2650277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2651b18ea86cSHong Zhang 
2652277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2653277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2654277b19d0SLisandro Dalcin   }
2655277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2656e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2657bbd56ea5SKarl Rupp 
26584e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
26594e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2660214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
26616bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2662efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
2663e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2664e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
266538637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2666bbd56ea5SKarl Rupp 
2667cd4cee2dSHong Zhang   ierr = MatDestroy(&ts->Jacprhs);CHKERRQ(ierr);
2668ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2669ecf68647SHong Zhang   if (ts->forward_solve) {
2670ecf68647SHong Zhang     ierr = TSForwardReset(ts);CHKERRQ(ierr);
2671ecf68647SHong Zhang   }
2672cd4cee2dSHong Zhang   if (ts->quadraturets) {
2673cd4cee2dSHong Zhang     ierr = TSReset(ts->quadraturets);CHKERRQ(ierr);
267436eaed60SHong Zhang     ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2675cd4cee2dSHong Zhang   }
26761d06f6b3SHong Zhang   while (ilink) {
26771d06f6b3SHong Zhang     next = ilink->next;
26781d06f6b3SHong Zhang     ierr = TSDestroy(&ilink->ts);CHKERRQ(ierr);
26791d06f6b3SHong Zhang     ierr = PetscFree(ilink->splitname);CHKERRQ(ierr);
26801d06f6b3SHong Zhang     ierr = ISDestroy(&ilink->is);CHKERRQ(ierr);
26811d06f6b3SHong Zhang     ierr = PetscFree(ilink);CHKERRQ(ierr);
26821d06f6b3SHong Zhang     ilink = next;
268387f4e208SHong Zhang   }
2684545aaa6fSHong Zhang   ts->num_rhs_splits = 0;
2685277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2686d763cef2SBarry Smith   PetscFunctionReturn(0);
2687d763cef2SBarry Smith }
2688d763cef2SBarry Smith 
2689d8e5e3e6SSatish Balay /*@
2690d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2691d763cef2SBarry Smith    with TSCreate().
2692d763cef2SBarry Smith 
2693d763cef2SBarry Smith    Collective on TS
2694d763cef2SBarry Smith 
2695d763cef2SBarry Smith    Input Parameter:
2696d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2697d763cef2SBarry Smith 
2698d763cef2SBarry Smith    Level: beginner
2699d763cef2SBarry Smith 
2700d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2701d763cef2SBarry Smith @*/
27026bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2703d763cef2SBarry Smith {
27046849ba73SBarry Smith   PetscErrorCode ierr;
2705d763cef2SBarry Smith 
2706d763cef2SBarry Smith   PetscFunctionBegin;
27076bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
2708ecf68647SHong Zhang   PetscValidHeaderSpecific(*ts,TS_CLASSID,1);
27096bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2710d763cef2SBarry Smith 
2711ecf68647SHong Zhang   ierr = TSReset(*ts);CHKERRQ(ierr);
2712ecf68647SHong Zhang   ierr = TSAdjointReset(*ts);CHKERRQ(ierr);
2713ecf68647SHong Zhang   if ((*ts)->forward_solve) {
2714ecf68647SHong Zhang     ierr = TSForwardReset(*ts);CHKERRQ(ierr);
2715ecf68647SHong Zhang   }
2716e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2717e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
27186bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
27196d4c513bSLisandro Dalcin 
2720bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2721bc952696SBarry Smith 
272284df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
27236427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
27246427ac75SLisandro Dalcin 
27256bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
27266bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
27276bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
27280dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
27296d4c513bSLisandro Dalcin 
2730cd4cee2dSHong Zhang   ierr = TSDestroy(&(*ts)->quadraturets);CHKERRQ(ierr);
2731a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2732d763cef2SBarry Smith   PetscFunctionReturn(0);
2733d763cef2SBarry Smith }
2734d763cef2SBarry Smith 
2735d8e5e3e6SSatish Balay /*@
2736d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2737d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2738d763cef2SBarry Smith 
2739d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2740d763cef2SBarry Smith 
2741d763cef2SBarry Smith    Input Parameter:
2742d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2743d763cef2SBarry Smith 
2744d763cef2SBarry Smith    Output Parameter:
2745d763cef2SBarry Smith .  snes - the nonlinear solver context
2746d763cef2SBarry Smith 
2747d763cef2SBarry Smith    Notes:
2748d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2749d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
275094b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2751d763cef2SBarry Smith 
2752d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
27530298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2754d763cef2SBarry Smith 
2755d763cef2SBarry Smith    Level: beginner
2756d763cef2SBarry Smith 
2757d763cef2SBarry Smith @*/
27587087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2759d763cef2SBarry Smith {
2760d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2761d372ba47SLisandro Dalcin 
2762d763cef2SBarry Smith   PetscFunctionBegin;
27630700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27644482741eSBarry Smith   PetscValidPointer(snes,2);
2765d372ba47SLisandro Dalcin   if (!ts->snes) {
2766ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
276716413a6aSBarry Smith     ierr = PetscObjectSetOptions((PetscObject)ts->snes,((PetscObject)ts)->options);CHKERRQ(ierr);
27680298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
27693bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2770d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2771496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
27729e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
27739e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
27749e2a6581SJed Brown     }
2775d372ba47SLisandro Dalcin   }
2776d763cef2SBarry Smith   *snes = ts->snes;
2777d763cef2SBarry Smith   PetscFunctionReturn(0);
2778d763cef2SBarry Smith }
2779d763cef2SBarry Smith 
2780deb2cd25SJed Brown /*@
2781deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2782deb2cd25SJed Brown 
2783deb2cd25SJed Brown    Collective
2784deb2cd25SJed Brown 
2785deb2cd25SJed Brown    Input Parameter:
2786deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2787deb2cd25SJed Brown -  snes - the nonlinear solver context
2788deb2cd25SJed Brown 
2789deb2cd25SJed Brown    Notes:
2790deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2791deb2cd25SJed Brown 
2792deb2cd25SJed Brown    Level: developer
2793deb2cd25SJed Brown 
2794deb2cd25SJed Brown @*/
2795deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2796deb2cd25SJed Brown {
2797deb2cd25SJed Brown   PetscErrorCode ierr;
2798d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2799deb2cd25SJed Brown 
2800deb2cd25SJed Brown   PetscFunctionBegin;
2801deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2802deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2803deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2804deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2805bbd56ea5SKarl Rupp 
2806deb2cd25SJed Brown   ts->snes = snes;
2807bbd56ea5SKarl Rupp 
28080298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
28090298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2810740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
28110298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2812740132f1SEmil Constantinescu   }
2813deb2cd25SJed Brown   PetscFunctionReturn(0);
2814deb2cd25SJed Brown }
2815deb2cd25SJed Brown 
2816d8e5e3e6SSatish Balay /*@
281794b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2818d763cef2SBarry Smith    a TS (timestepper) context.
2819d763cef2SBarry Smith 
282094b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2821d763cef2SBarry Smith 
2822d763cef2SBarry Smith    Input Parameter:
2823d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2824d763cef2SBarry Smith 
2825d763cef2SBarry Smith    Output Parameter:
282694b7f48cSBarry Smith .  ksp - the nonlinear solver context
2827d763cef2SBarry Smith 
2828d763cef2SBarry Smith    Notes:
282994b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2830d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2831d763cef2SBarry Smith    KSP and PC contexts as well.
2832d763cef2SBarry Smith 
283394b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
28340298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2835d763cef2SBarry Smith 
2836d763cef2SBarry Smith    Level: beginner
2837d763cef2SBarry Smith 
2838d763cef2SBarry Smith @*/
28397087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2840d763cef2SBarry Smith {
2841d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2842089b2837SJed Brown   SNES           snes;
2843d372ba47SLisandro Dalcin 
2844d763cef2SBarry Smith   PetscFunctionBegin;
28450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28464482741eSBarry Smith   PetscValidPointer(ksp,2);
284717186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2848e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2849089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2850089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2851d763cef2SBarry Smith   PetscFunctionReturn(0);
2852d763cef2SBarry Smith }
2853d763cef2SBarry Smith 
2854d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2855d763cef2SBarry Smith 
2856adb62b0dSMatthew Knepley /*@
2857618ce8baSLisandro Dalcin    TSSetMaxSteps - Sets the maximum number of steps to use.
2858618ce8baSLisandro Dalcin 
2859618ce8baSLisandro Dalcin    Logically Collective on TS
2860618ce8baSLisandro Dalcin 
2861618ce8baSLisandro Dalcin    Input Parameters:
2862618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2863618ce8baSLisandro Dalcin -  maxsteps - maximum number of steps to use
2864618ce8baSLisandro Dalcin 
2865618ce8baSLisandro Dalcin    Options Database Keys:
2866618ce8baSLisandro Dalcin .  -ts_max_steps <maxsteps> - Sets maxsteps
2867618ce8baSLisandro Dalcin 
2868618ce8baSLisandro Dalcin    Notes:
2869618ce8baSLisandro Dalcin    The default maximum number of steps is 5000
2870618ce8baSLisandro Dalcin 
2871618ce8baSLisandro Dalcin    Level: intermediate
2872618ce8baSLisandro Dalcin 
2873618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime()
2874618ce8baSLisandro Dalcin @*/
2875618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps)
2876618ce8baSLisandro Dalcin {
2877618ce8baSLisandro Dalcin   PetscFunctionBegin;
2878618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2879618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2880618ce8baSLisandro Dalcin   if (maxsteps < 0 ) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative");
2881618ce8baSLisandro Dalcin   ts->max_steps = maxsteps;
2882618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2883618ce8baSLisandro Dalcin }
2884618ce8baSLisandro Dalcin 
2885618ce8baSLisandro Dalcin /*@
2886618ce8baSLisandro Dalcin    TSGetMaxSteps - Gets the maximum number of steps to use.
2887618ce8baSLisandro Dalcin 
2888618ce8baSLisandro Dalcin    Not Collective
2889618ce8baSLisandro Dalcin 
2890618ce8baSLisandro Dalcin    Input Parameters:
2891618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2892618ce8baSLisandro Dalcin 
2893618ce8baSLisandro Dalcin    Output Parameter:
2894618ce8baSLisandro Dalcin .  maxsteps - maximum number of steps to use
2895618ce8baSLisandro Dalcin 
2896618ce8baSLisandro Dalcin    Level: advanced
2897618ce8baSLisandro Dalcin 
2898618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime()
2899618ce8baSLisandro Dalcin @*/
2900618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps)
2901618ce8baSLisandro Dalcin {
2902618ce8baSLisandro Dalcin   PetscFunctionBegin;
2903618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2904618ce8baSLisandro Dalcin   PetscValidIntPointer(maxsteps,2);
2905618ce8baSLisandro Dalcin   *maxsteps = ts->max_steps;
2906618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2907618ce8baSLisandro Dalcin }
2908618ce8baSLisandro Dalcin 
2909618ce8baSLisandro Dalcin /*@
2910618ce8baSLisandro Dalcin    TSSetMaxTime - Sets the maximum (or final) time for timestepping.
2911618ce8baSLisandro Dalcin 
2912618ce8baSLisandro Dalcin    Logically Collective on TS
2913618ce8baSLisandro Dalcin 
2914618ce8baSLisandro Dalcin    Input Parameters:
2915618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2916618ce8baSLisandro Dalcin -  maxtime - final time to step to
2917618ce8baSLisandro Dalcin 
2918618ce8baSLisandro Dalcin    Options Database Keys:
2919ef85077eSLisandro Dalcin .  -ts_max_time <maxtime> - Sets maxtime
2920618ce8baSLisandro Dalcin 
2921618ce8baSLisandro Dalcin    Notes:
2922618ce8baSLisandro Dalcin    The default maximum time is 5.0
2923618ce8baSLisandro Dalcin 
2924618ce8baSLisandro Dalcin    Level: intermediate
2925618ce8baSLisandro Dalcin 
2926618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime()
2927618ce8baSLisandro Dalcin @*/
2928618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime)
2929618ce8baSLisandro Dalcin {
2930618ce8baSLisandro Dalcin   PetscFunctionBegin;
2931618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2932618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveReal(ts,maxtime,2);
2933618ce8baSLisandro Dalcin   ts->max_time = maxtime;
2934618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2935618ce8baSLisandro Dalcin }
2936618ce8baSLisandro Dalcin 
2937618ce8baSLisandro Dalcin /*@
2938618ce8baSLisandro Dalcin    TSGetMaxTime - Gets the maximum (or final) time for timestepping.
2939618ce8baSLisandro Dalcin 
2940618ce8baSLisandro Dalcin    Not Collective
2941618ce8baSLisandro Dalcin 
2942618ce8baSLisandro Dalcin    Input Parameters:
2943618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2944618ce8baSLisandro Dalcin 
2945618ce8baSLisandro Dalcin    Output Parameter:
2946618ce8baSLisandro Dalcin .  maxtime - final time to step to
2947618ce8baSLisandro Dalcin 
2948618ce8baSLisandro Dalcin    Level: advanced
2949618ce8baSLisandro Dalcin 
2950618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps()
2951618ce8baSLisandro Dalcin @*/
2952618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime)
2953618ce8baSLisandro Dalcin {
2954618ce8baSLisandro Dalcin   PetscFunctionBegin;
2955618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2956618ce8baSLisandro Dalcin   PetscValidRealPointer(maxtime,2);
2957618ce8baSLisandro Dalcin   *maxtime = ts->max_time;
2958618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2959618ce8baSLisandro Dalcin }
2960618ce8baSLisandro Dalcin 
2961618ce8baSLisandro Dalcin /*@
2962aaa6c58dSLisandro Dalcin    TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep().
2963edc382c3SSatish Balay 
2964edc382c3SSatish Balay    Level: deprecated
2965edc382c3SSatish Balay 
2966aaa6c58dSLisandro Dalcin @*/
2967aaa6c58dSLisandro Dalcin PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
2968aaa6c58dSLisandro Dalcin {
2969aaa6c58dSLisandro Dalcin   PetscErrorCode ierr;
2970aaa6c58dSLisandro Dalcin   PetscFunctionBegin;
2971aaa6c58dSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2972aaa6c58dSLisandro Dalcin   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
2973aaa6c58dSLisandro Dalcin   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
2974aaa6c58dSLisandro Dalcin   PetscFunctionReturn(0);
2975aaa6c58dSLisandro Dalcin }
2976aaa6c58dSLisandro Dalcin 
2977aaa6c58dSLisandro Dalcin /*@
297819eac22cSLisandro Dalcin    TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime().
2979edc382c3SSatish Balay 
2980edc382c3SSatish Balay    Level: deprecated
2981edc382c3SSatish Balay 
2982adb62b0dSMatthew Knepley @*/
29837087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2984adb62b0dSMatthew Knepley {
2985adb62b0dSMatthew Knepley   PetscFunctionBegin;
29860700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2987abc0a331SBarry Smith   if (maxsteps) {
29884482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2989adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2990adb62b0dSMatthew Knepley   }
2991abc0a331SBarry Smith   if (maxtime) {
29924482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2993adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2994adb62b0dSMatthew Knepley   }
2995adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2996adb62b0dSMatthew Knepley }
2997adb62b0dSMatthew Knepley 
2998d763cef2SBarry Smith /*@
299919eac22cSLisandro Dalcin    TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime().
3000edc382c3SSatish Balay 
3001edc382c3SSatish Balay    Level: deprecated
3002edc382c3SSatish Balay 
3003d763cef2SBarry Smith @*/
30047087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
3005d763cef2SBarry Smith {
3006d763cef2SBarry Smith   PetscFunctionBegin;
30070700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3008c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
3009c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
301039b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
301139b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
3012d763cef2SBarry Smith   PetscFunctionReturn(0);
3013d763cef2SBarry Smith }
3014d763cef2SBarry Smith 
3015d763cef2SBarry Smith /*@
30165c5f5948SLisandro Dalcin    TSGetTimeStepNumber - Deprecated, use TSGetStepNumber().
3017edc382c3SSatish Balay 
3018edc382c3SSatish Balay    Level: deprecated
3019edc382c3SSatish Balay 
30205c5f5948SLisandro Dalcin @*/
3021e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
30225c5f5948SLisandro Dalcin 
302319eac22cSLisandro Dalcin /*@
30244f4e0956SLisandro Dalcin    TSGetTotalSteps - Deprecated, use TSGetStepNumber().
3025edc382c3SSatish Balay 
3026edc382c3SSatish Balay    Level: deprecated
3027edc382c3SSatish Balay 
30284f4e0956SLisandro Dalcin @*/
30294f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
30304f4e0956SLisandro Dalcin 
30314f4e0956SLisandro Dalcin /*@
3032d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
3033d763cef2SBarry Smith    for use by the TS routines.
3034d763cef2SBarry Smith 
3035d083f849SBarry Smith    Logically Collective on TS
3036d763cef2SBarry Smith 
3037d763cef2SBarry Smith    Input Parameters:
3038d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
30390910c330SBarry Smith -  u - the solution vector
3040d763cef2SBarry Smith 
3041d763cef2SBarry Smith    Level: beginner
3042d763cef2SBarry Smith 
30430ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate()
3044d763cef2SBarry Smith @*/
30450910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
3046d763cef2SBarry Smith {
30478737fe31SLisandro Dalcin   PetscErrorCode ierr;
3048496e6a7aSJed Brown   DM             dm;
30498737fe31SLisandro Dalcin 
3050d763cef2SBarry Smith   PetscFunctionBegin;
30510700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
30520910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
30530910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
30546bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
30550910c330SBarry Smith   ts->vec_sol = u;
3056bbd56ea5SKarl Rupp 
3057496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
30580910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
3059d763cef2SBarry Smith   PetscFunctionReturn(0);
3060d763cef2SBarry Smith }
3061d763cef2SBarry Smith 
3062ac226902SBarry Smith /*@C
3063000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
30643f2090d5SJed Brown   called once at the beginning of each time step.
3065000e7ae3SMatthew Knepley 
30663f9fe445SBarry Smith   Logically Collective on TS
3067000e7ae3SMatthew Knepley 
3068000e7ae3SMatthew Knepley   Input Parameters:
3069000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3070000e7ae3SMatthew Knepley - func - The function
3071000e7ae3SMatthew Knepley 
3072000e7ae3SMatthew Knepley   Calling sequence of func:
30736bc98fa9SBarry Smith .   PetscErrorCode func (TS ts);
3074000e7ae3SMatthew Knepley 
3075000e7ae3SMatthew Knepley   Level: intermediate
3076000e7ae3SMatthew Knepley 
3077dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep()
3078000e7ae3SMatthew Knepley @*/
30797087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3080000e7ae3SMatthew Knepley {
3081000e7ae3SMatthew Knepley   PetscFunctionBegin;
30820700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3083ae60f76fSBarry Smith   ts->prestep = func;
3084000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3085000e7ae3SMatthew Knepley }
3086000e7ae3SMatthew Knepley 
308709ee8438SJed Brown /*@
30883f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
30893f2090d5SJed Brown 
30903f2090d5SJed Brown   Collective on TS
30913f2090d5SJed Brown 
30923f2090d5SJed Brown   Input Parameters:
30933f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
30943f2090d5SJed Brown 
30953f2090d5SJed Brown   Notes:
30963f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
30973f2090d5SJed Brown   so most users would not generally call this routine themselves.
30983f2090d5SJed Brown 
30993f2090d5SJed Brown   Level: developer
31003f2090d5SJed Brown 
31019be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
31023f2090d5SJed Brown @*/
31037087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
31043f2090d5SJed Brown {
31053f2090d5SJed Brown   PetscErrorCode ierr;
31063f2090d5SJed Brown 
31073f2090d5SJed Brown   PetscFunctionBegin;
31080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3109ae60f76fSBarry Smith   if (ts->prestep) {
31105efd42a4SStefano Zampini     Vec              U;
31115efd42a4SStefano Zampini     PetscObjectState sprev,spost;
31125efd42a4SStefano Zampini 
31135efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
31145efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3115ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
31165efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3117dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3118312ce896SJed Brown   }
31193f2090d5SJed Brown   PetscFunctionReturn(0);
31203f2090d5SJed Brown }
31213f2090d5SJed Brown 
3122b8123daeSJed Brown /*@C
3123b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3124b8123daeSJed Brown   called once at the beginning of each stage.
3125b8123daeSJed Brown 
3126b8123daeSJed Brown   Logically Collective on TS
3127b8123daeSJed Brown 
3128b8123daeSJed Brown   Input Parameters:
3129b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3130b8123daeSJed Brown - func - The function
3131b8123daeSJed Brown 
3132b8123daeSJed Brown   Calling sequence of func:
3133b8123daeSJed Brown .    PetscErrorCode func(TS ts, PetscReal stagetime);
3134b8123daeSJed Brown 
3135b8123daeSJed Brown   Level: intermediate
3136b8123daeSJed Brown 
3137b8123daeSJed Brown   Note:
3138b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
313980275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
3140b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3141b8123daeSJed Brown 
31429be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3143b8123daeSJed Brown @*/
3144b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3145b8123daeSJed Brown {
3146b8123daeSJed Brown   PetscFunctionBegin;
3147b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3148ae60f76fSBarry Smith   ts->prestage = func;
3149b8123daeSJed Brown   PetscFunctionReturn(0);
3150b8123daeSJed Brown }
3151b8123daeSJed Brown 
31529be3e283SDebojyoti Ghosh /*@C
31539be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
31549be3e283SDebojyoti Ghosh   called once at the end of each stage.
31559be3e283SDebojyoti Ghosh 
31569be3e283SDebojyoti Ghosh   Logically Collective on TS
31579be3e283SDebojyoti Ghosh 
31589be3e283SDebojyoti Ghosh   Input Parameters:
31599be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
31609be3e283SDebojyoti Ghosh - func - The function
31619be3e283SDebojyoti Ghosh 
31629be3e283SDebojyoti Ghosh   Calling sequence of func:
31639be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
31649be3e283SDebojyoti Ghosh 
31659be3e283SDebojyoti Ghosh   Level: intermediate
31669be3e283SDebojyoti Ghosh 
31679be3e283SDebojyoti Ghosh   Note:
31689be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
316980275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
31709be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
31719be3e283SDebojyoti Ghosh 
31729be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
31739be3e283SDebojyoti Ghosh @*/
31749be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
31759be3e283SDebojyoti Ghosh {
31769be3e283SDebojyoti Ghosh   PetscFunctionBegin;
31779be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
31789be3e283SDebojyoti Ghosh   ts->poststage = func;
31799be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
31809be3e283SDebojyoti Ghosh }
31819be3e283SDebojyoti Ghosh 
3182c688d042SShri Abhyankar /*@C
3183c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3184c688d042SShri Abhyankar   called once at the end of each step evaluation.
3185c688d042SShri Abhyankar 
3186c688d042SShri Abhyankar   Logically Collective on TS
3187c688d042SShri Abhyankar 
3188c688d042SShri Abhyankar   Input Parameters:
3189c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3190c688d042SShri Abhyankar - func - The function
3191c688d042SShri Abhyankar 
3192c688d042SShri Abhyankar   Calling sequence of func:
3193c688d042SShri Abhyankar . PetscErrorCode func(TS ts);
3194c688d042SShri Abhyankar 
3195c688d042SShri Abhyankar   Level: intermediate
3196c688d042SShri Abhyankar 
3197c688d042SShri Abhyankar   Note:
31981785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
31991785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3200e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3201e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3202e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3203c688d042SShri Abhyankar 
3204c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3205c688d042SShri Abhyankar @*/
3206c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3207c688d042SShri Abhyankar {
3208c688d042SShri Abhyankar   PetscFunctionBegin;
3209c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3210c688d042SShri Abhyankar   ts->postevaluate = func;
3211c688d042SShri Abhyankar   PetscFunctionReturn(0);
3212c688d042SShri Abhyankar }
3213c688d042SShri Abhyankar 
3214b8123daeSJed Brown /*@
3215b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3216b8123daeSJed Brown 
3217b8123daeSJed Brown   Collective on TS
3218b8123daeSJed Brown 
3219b8123daeSJed Brown   Input Parameters:
3220b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
32219be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3222b8123daeSJed Brown 
3223b8123daeSJed Brown   Notes:
3224b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3225b8123daeSJed Brown   most users would not generally call this routine themselves.
3226b8123daeSJed Brown 
3227b8123daeSJed Brown   Level: developer
3228b8123daeSJed Brown 
32299be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3230b8123daeSJed Brown @*/
3231b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3232b8123daeSJed Brown {
3233b8123daeSJed Brown   PetscFunctionBegin;
3234b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3235ae60f76fSBarry Smith   if (ts->prestage) {
3236ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3237b8123daeSJed Brown   }
3238b8123daeSJed Brown   PetscFunctionReturn(0);
3239b8123daeSJed Brown }
3240b8123daeSJed Brown 
32419be3e283SDebojyoti Ghosh /*@
32429be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
32439be3e283SDebojyoti Ghosh 
32449be3e283SDebojyoti Ghosh   Collective on TS
32459be3e283SDebojyoti Ghosh 
32469be3e283SDebojyoti Ghosh   Input Parameters:
32479be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
32489be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
32499be3e283SDebojyoti Ghosh   stageindex  - Stage number
32509be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
32519be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
32529be3e283SDebojyoti Ghosh 
32539be3e283SDebojyoti Ghosh   Notes:
32549be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
32559be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
32569be3e283SDebojyoti Ghosh 
32579be3e283SDebojyoti Ghosh   Level: developer
32589be3e283SDebojyoti Ghosh 
32599be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
32609be3e283SDebojyoti Ghosh @*/
32619be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
32629be3e283SDebojyoti Ghosh {
32639be3e283SDebojyoti Ghosh   PetscFunctionBegin;
32649be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
32654beae5d8SLisandro Dalcin   if (ts->poststage) {
32669be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
32679be3e283SDebojyoti Ghosh   }
32689be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
32699be3e283SDebojyoti Ghosh }
32709be3e283SDebojyoti Ghosh 
3271c688d042SShri Abhyankar /*@
3272c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3273c688d042SShri Abhyankar 
3274c688d042SShri Abhyankar   Collective on TS
3275c688d042SShri Abhyankar 
3276c688d042SShri Abhyankar   Input Parameters:
3277c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3278c688d042SShri Abhyankar 
3279c688d042SShri Abhyankar   Notes:
3280c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3281c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3282c688d042SShri Abhyankar 
3283c688d042SShri Abhyankar   Level: developer
3284c688d042SShri Abhyankar 
3285c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3286c688d042SShri Abhyankar @*/
3287c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3288c688d042SShri Abhyankar {
3289c688d042SShri Abhyankar   PetscErrorCode ierr;
3290c688d042SShri Abhyankar 
3291c688d042SShri Abhyankar   PetscFunctionBegin;
3292c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3293c688d042SShri Abhyankar   if (ts->postevaluate) {
3294dcb233daSLisandro Dalcin     Vec              U;
3295dcb233daSLisandro Dalcin     PetscObjectState sprev,spost;
3296dcb233daSLisandro Dalcin 
3297dcb233daSLisandro Dalcin     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
3298dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3299c688d042SShri Abhyankar     PetscStackCallStandard((*ts->postevaluate),(ts));
3300dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3301dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3302c688d042SShri Abhyankar   }
3303c688d042SShri Abhyankar   PetscFunctionReturn(0);
3304c688d042SShri Abhyankar }
3305c688d042SShri Abhyankar 
3306ac226902SBarry Smith /*@C
3307000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
33083f2090d5SJed Brown   called once at the end of each time step.
3309000e7ae3SMatthew Knepley 
33103f9fe445SBarry Smith   Logically Collective on TS
3311000e7ae3SMatthew Knepley 
3312000e7ae3SMatthew Knepley   Input Parameters:
3313000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3314000e7ae3SMatthew Knepley - func - The function
3315000e7ae3SMatthew Knepley 
3316000e7ae3SMatthew Knepley   Calling sequence of func:
3317b8123daeSJed Brown $ func (TS ts);
3318000e7ae3SMatthew Knepley 
33191785ff2aSShri Abhyankar   Notes:
33201785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
33211785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
33221785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
33231785ff2aSShri Abhyankar 
3324000e7ae3SMatthew Knepley   Level: intermediate
3325000e7ae3SMatthew Knepley 
3326dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep()
3327000e7ae3SMatthew Knepley @*/
33287087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3329000e7ae3SMatthew Knepley {
3330000e7ae3SMatthew Knepley   PetscFunctionBegin;
33310700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3332ae60f76fSBarry Smith   ts->poststep = func;
3333000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3334000e7ae3SMatthew Knepley }
3335000e7ae3SMatthew Knepley 
333609ee8438SJed Brown /*@
33373f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
33383f2090d5SJed Brown 
33393f2090d5SJed Brown   Collective on TS
33403f2090d5SJed Brown 
33413f2090d5SJed Brown   Input Parameters:
33423f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
33433f2090d5SJed Brown 
33443f2090d5SJed Brown   Notes:
33453f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
33463f2090d5SJed Brown   so most users would not generally call this routine themselves.
33473f2090d5SJed Brown 
33483f2090d5SJed Brown   Level: developer
33493f2090d5SJed Brown 
33503f2090d5SJed Brown @*/
33517087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
33523f2090d5SJed Brown {
33533f2090d5SJed Brown   PetscErrorCode ierr;
33543f2090d5SJed Brown 
33553f2090d5SJed Brown   PetscFunctionBegin;
33560700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3357ae60f76fSBarry Smith   if (ts->poststep) {
33585efd42a4SStefano Zampini     Vec              U;
33595efd42a4SStefano Zampini     PetscObjectState sprev,spost;
33605efd42a4SStefano Zampini 
33615efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
33625efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3363ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
33645efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3365dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
336672ac3e02SJed Brown   }
33673f2090d5SJed Brown   PetscFunctionReturn(0);
33683f2090d5SJed Brown }
33693f2090d5SJed Brown 
3370d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3371d763cef2SBarry Smith 
3372d763cef2SBarry Smith /*@C
3373a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3374d763cef2SBarry Smith    timestep to display the iteration's  progress.
3375d763cef2SBarry Smith 
33763f9fe445SBarry Smith    Logically Collective on TS
3377d763cef2SBarry Smith 
3378d763cef2SBarry Smith    Input Parameters:
3379d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3380e213d8f1SJed Brown .  monitor - monitoring routine
3381329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
33820298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3383b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
33840298fd71SBarry Smith           (may be NULL)
3385d763cef2SBarry Smith 
3386e213d8f1SJed Brown    Calling sequence of monitor:
3387dcb233daSLisandro Dalcin $    PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3388d763cef2SBarry Smith 
3389d763cef2SBarry Smith +    ts - the TS context
339063e21af5SBarry 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)
33911f06c33eSBarry Smith .    time - current time
33920910c330SBarry Smith .    u - current iterate
3393d763cef2SBarry Smith -    mctx - [optional] monitoring context
3394d763cef2SBarry Smith 
3395d763cef2SBarry Smith    Notes:
3396d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3397d763cef2SBarry Smith    already has been loaded.
3398d763cef2SBarry Smith 
339995452b02SPatrick Sanan    Fortran Notes:
340095452b02SPatrick Sanan     Only a single monitor function can be set for each TS object
3401025f1a04SBarry Smith 
3402d763cef2SBarry Smith    Level: intermediate
3403d763cef2SBarry Smith 
3404a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3405d763cef2SBarry Smith @*/
3406c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3407d763cef2SBarry Smith {
340878064530SBarry Smith   PetscErrorCode ierr;
340978064530SBarry Smith   PetscInt       i;
341078064530SBarry Smith   PetscBool      identical;
341178064530SBarry Smith 
3412d763cef2SBarry Smith   PetscFunctionBegin;
34130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
341478064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
341578064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
341678064530SBarry Smith     if (identical) PetscFunctionReturn(0);
341778064530SBarry Smith   }
341817186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3419d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
34208704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3421d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3422d763cef2SBarry Smith   PetscFunctionReturn(0);
3423d763cef2SBarry Smith }
3424d763cef2SBarry Smith 
3425d763cef2SBarry Smith /*@C
3426a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3427d763cef2SBarry Smith 
34283f9fe445SBarry Smith    Logically Collective on TS
3429d763cef2SBarry Smith 
3430d763cef2SBarry Smith    Input Parameters:
3431d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3432d763cef2SBarry Smith 
3433d763cef2SBarry Smith    Notes:
3434d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3435d763cef2SBarry Smith 
3436d763cef2SBarry Smith    Level: intermediate
3437d763cef2SBarry Smith 
3438a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3439d763cef2SBarry Smith @*/
34407087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3441d763cef2SBarry Smith {
3442d952e501SBarry Smith   PetscErrorCode ierr;
3443d952e501SBarry Smith   PetscInt       i;
3444d952e501SBarry Smith 
3445d763cef2SBarry Smith   PetscFunctionBegin;
34460700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3447d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
34488704b422SBarry Smith     if (ts->monitordestroy[i]) {
34498704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3450d952e501SBarry Smith     }
3451d952e501SBarry Smith   }
3452d763cef2SBarry Smith   ts->numbermonitors = 0;
3453d763cef2SBarry Smith   PetscFunctionReturn(0);
3454d763cef2SBarry Smith }
3455d763cef2SBarry Smith 
3456721cd6eeSBarry Smith /*@C
3457721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
34585516499fSSatish Balay 
34595516499fSSatish Balay    Level: intermediate
346041251cbbSSatish Balay 
346163e21af5SBarry Smith .seealso:  TSMonitorSet()
346241251cbbSSatish Balay @*/
3463721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3464d763cef2SBarry Smith {
3465dfbe8321SBarry Smith   PetscErrorCode ierr;
3466721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
346741aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3468d132466eSBarry Smith 
3469d763cef2SBarry Smith   PetscFunctionBegin;
34704d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
347141aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
347241aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3473721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
347441aca3d6SBarry Smith   if (iascii) {
3475649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
347663e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
347763e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
347863e21af5SBarry Smith     } else {
34798392e04aSShri 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);
348063e21af5SBarry Smith     }
3481649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
348241aca3d6SBarry Smith   } else if (ibinary) {
348341aca3d6SBarry Smith     PetscMPIInt rank;
348441aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
348541aca3d6SBarry Smith     if (!rank) {
3486450a797fSBarry Smith       PetscBool skipHeader;
3487450a797fSBarry Smith       PetscInt  classid = REAL_FILE_CLASSID;
3488450a797fSBarry Smith 
3489450a797fSBarry Smith       ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr);
3490450a797fSBarry Smith       if (!skipHeader) {
3491450a797fSBarry Smith          ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
3492450a797fSBarry Smith        }
349341aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
349441aca3d6SBarry Smith     } else {
349541aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
349641aca3d6SBarry Smith     }
349741aca3d6SBarry Smith   }
3498721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3499d763cef2SBarry Smith   PetscFunctionReturn(0);
3500d763cef2SBarry Smith }
3501d763cef2SBarry Smith 
3502cc9c3a59SBarry Smith /*@C
3503cc9c3a59SBarry Smith    TSMonitorExtreme - Prints the extreme values of the solution at each timestep
3504cc9c3a59SBarry Smith 
3505cc9c3a59SBarry Smith    Level: intermediate
3506cc9c3a59SBarry Smith 
3507cc9c3a59SBarry Smith .seealso:  TSMonitorSet()
3508cc9c3a59SBarry Smith @*/
3509cc9c3a59SBarry Smith PetscErrorCode TSMonitorExtreme(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3510cc9c3a59SBarry Smith {
3511cc9c3a59SBarry Smith   PetscErrorCode ierr;
3512cc9c3a59SBarry Smith   PetscViewer    viewer =  vf->viewer;
3513cc9c3a59SBarry Smith   PetscBool      iascii;
3514cc9c3a59SBarry Smith   PetscReal      max,min;
3515cc9c3a59SBarry Smith 
3516cc9c3a59SBarry Smith 
3517cc9c3a59SBarry Smith   PetscFunctionBegin;
3518cc9c3a59SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3519cc9c3a59SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
3520cc9c3a59SBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
3521cc9c3a59SBarry Smith   if (iascii) {
3522cc9c3a59SBarry Smith     ierr = VecMax(v,NULL,&max);CHKERRQ(ierr);
3523cc9c3a59SBarry Smith     ierr = VecMin(v,NULL,&min);CHKERRQ(ierr);
3524cc9c3a59SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
35255132926bSBarry 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);
3526cc9c3a59SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3527cc9c3a59SBarry Smith   }
3528cc9c3a59SBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3529cc9c3a59SBarry Smith   PetscFunctionReturn(0);
3530cc9c3a59SBarry Smith }
3531cc9c3a59SBarry Smith 
3532cd652676SJed Brown /*@
3533cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3534cd652676SJed Brown 
3535cd652676SJed Brown    Collective on TS
3536cd652676SJed Brown 
3537cd652676SJed Brown    Input Argument:
3538cd652676SJed Brown +  ts - time stepping context
3539cd652676SJed Brown -  t - time to interpolate to
3540cd652676SJed Brown 
3541cd652676SJed Brown    Output Argument:
35420910c330SBarry Smith .  U - state at given time
3543cd652676SJed Brown 
3544cd652676SJed Brown    Level: intermediate
3545cd652676SJed Brown 
3546cd652676SJed Brown    Developer Notes:
3547cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3548cd652676SJed Brown 
3549874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
3550cd652676SJed Brown @*/
35510910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3552cd652676SJed Brown {
3553cd652676SJed Brown   PetscErrorCode ierr;
3554cd652676SJed Brown 
3555cd652676SJed Brown   PetscFunctionBegin;
3556cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3557b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3558be5899b3SLisandro 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);
3559ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
35600910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3561cd652676SJed Brown   PetscFunctionReturn(0);
3562cd652676SJed Brown }
3563cd652676SJed Brown 
3564d763cef2SBarry Smith /*@
35656d9e5789SSean Farley    TSStep - Steps one time step
3566d763cef2SBarry Smith 
3567d763cef2SBarry Smith    Collective on TS
3568d763cef2SBarry Smith 
3569d763cef2SBarry Smith    Input Parameter:
3570d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3571d763cef2SBarry Smith 
357227829d71SBarry Smith    Level: developer
3573d763cef2SBarry Smith 
3574b8123daeSJed Brown    Notes:
357527829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
357627829d71SBarry Smith 
3577b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3578b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3579b8123daeSJed Brown 
358019eac22cSLisandro Dalcin    This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the
358119eac22cSLisandro Dalcin    time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
358225cb2221SBarry Smith 
35839be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3584d763cef2SBarry Smith @*/
3585193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3586d763cef2SBarry Smith {
3587dfbe8321SBarry Smith   PetscErrorCode   ierr;
3588fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3589be5899b3SLisandro Dalcin   PetscReal        ptime;
3590d763cef2SBarry Smith 
3591d763cef2SBarry Smith   PetscFunctionBegin;
35920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3593fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3594fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3595fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3596fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3597fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3598fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3599302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
3600fffbeea8SBarry Smith 
3601d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
360268bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3603d405a339SMatthew Knepley 
3604*fc8dbba5SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3605ef85077eSLisandro 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>");
3606a6772fa2SLisandro 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()");
3607be5899b3SLisandro 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");
3608a6772fa2SLisandro Dalcin 
3609be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
3610be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
36112808aa04SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3612*fc8dbba5SLisandro Dalcin 
3613d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3614193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3615d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3616*fc8dbba5SLisandro Dalcin 
3617*fc8dbba5SLisandro Dalcin   if (ts->reason >= 0) {
3618be5899b3SLisandro Dalcin     ts->ptime_prev = ptime;
36192808aa04SLisandro Dalcin     ts->steps++;
3620be5899b3SLisandro Dalcin     ts->steprollback = PETSC_FALSE;
362128d5b5d6SLisandro Dalcin     ts->steprestart  = PETSC_FALSE;
3622d2daff3dSHong Zhang   }
3623*fc8dbba5SLisandro Dalcin 
3624*fc8dbba5SLisandro Dalcin   if (!ts->reason) {
362508c7845fSBarry Smith     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
362608c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
362708c7845fSBarry Smith   }
3628*fc8dbba5SLisandro Dalcin 
3629*fc8dbba5SLisandro 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]);
3630*fc8dbba5SLisandro Dalcin   if (ts->reason < 0 && ts->errorifstepfailed) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
363108c7845fSBarry Smith   PetscFunctionReturn(0);
363208c7845fSBarry Smith }
363308c7845fSBarry Smith 
363408c7845fSBarry Smith /*@
36357cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
36367cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
36377cbde773SLisandro Dalcin 
36387cbde773SLisandro Dalcin    Collective on TS
36397cbde773SLisandro Dalcin 
36407cbde773SLisandro Dalcin    Input Arguments:
36417cbde773SLisandro Dalcin +  ts - time stepping context
36427cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
36437cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
36447cbde773SLisandro Dalcin 
36457cbde773SLisandro Dalcin    Output Arguments:
36467cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
36477cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
36487cbde773SLisandro Dalcin 
36497cbde773SLisandro Dalcin    Level: advanced
36507cbde773SLisandro Dalcin 
36517cbde773SLisandro Dalcin    Notes:
36527cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
36537cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
36547cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
36557cbde773SLisandro Dalcin 
36567cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
36577cbde773SLisandro Dalcin @*/
36587cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
36597cbde773SLisandro Dalcin {
36607cbde773SLisandro Dalcin   PetscErrorCode ierr;
36617cbde773SLisandro Dalcin 
36627cbde773SLisandro Dalcin   PetscFunctionBegin;
36637cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
36647cbde773SLisandro Dalcin   PetscValidType(ts,1);
36657cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
36667cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
36677cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
36687cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
36697cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
36707cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
36717cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
36727cbde773SLisandro Dalcin   PetscFunctionReturn(0);
36737cbde773SLisandro Dalcin }
36747cbde773SLisandro Dalcin 
367505175c85SJed Brown /*@
367605175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
367705175c85SJed Brown 
36781c3436cfSJed Brown    Collective on TS
367905175c85SJed Brown 
368005175c85SJed Brown    Input Arguments:
36811c3436cfSJed Brown +  ts - time stepping context
36821c3436cfSJed Brown .  order - desired order of accuracy
36830298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
368405175c85SJed Brown 
368505175c85SJed Brown    Output Arguments:
36860910c330SBarry Smith .  U - state at the end of the current step
368705175c85SJed Brown 
368805175c85SJed Brown    Level: advanced
368905175c85SJed Brown 
3690108c343cSJed Brown    Notes:
3691108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3692108c343cSJed 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.
3693108c343cSJed Brown 
36941c3436cfSJed Brown .seealso: TSStep(), TSAdapt
369505175c85SJed Brown @*/
36960910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
369705175c85SJed Brown {
369805175c85SJed Brown   PetscErrorCode ierr;
369905175c85SJed Brown 
370005175c85SJed Brown   PetscFunctionBegin;
370105175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
370205175c85SJed Brown   PetscValidType(ts,1);
37030910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3704ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
37050910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
370605175c85SJed Brown   PetscFunctionReturn(0);
370705175c85SJed Brown }
370805175c85SJed Brown 
3709aad739acSMatthew G. Knepley /*@C
37102e61be88SMatthew G. Knepley   TSGetComputeInitialCondition - Get the function used to automatically compute an initial condition for the timestepping.
3711aad739acSMatthew G. Knepley 
3712aad739acSMatthew G. Knepley   Not collective
3713aad739acSMatthew G. Knepley 
3714aad739acSMatthew G. Knepley   Input Argument:
3715aad739acSMatthew G. Knepley . ts        - time stepping context
3716aad739acSMatthew G. Knepley 
3717aad739acSMatthew G. Knepley   Output Argument:
37182e61be88SMatthew G. Knepley . initConditions - The function which computes an initial condition
3719aad739acSMatthew G. Knepley 
3720aad739acSMatthew G. Knepley    Level: advanced
3721aad739acSMatthew G. Knepley 
3722aad739acSMatthew G. Knepley    Notes:
3723aad739acSMatthew G. Knepley    The calling sequence for the function is
37242e61be88SMatthew G. Knepley $ initCondition(TS ts, Vec u)
3725aad739acSMatthew G. Knepley $ ts - The timestepping context
37262e61be88SMatthew G. Knepley $ u  - The input vector in which the initial condition is stored
3727aad739acSMatthew G. Knepley 
37282e61be88SMatthew G. Knepley .seealso: TSSetComputeInitialCondition(), TSComputeInitialCondition()
3729aad739acSMatthew G. Knepley @*/
37302e61be88SMatthew G. Knepley PetscErrorCode TSGetComputeInitialCondition(TS ts, PetscErrorCode (**initCondition)(TS, Vec))
3731aad739acSMatthew G. Knepley {
3732aad739acSMatthew G. Knepley   PetscFunctionBegin;
3733aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
37342e61be88SMatthew G. Knepley   PetscValidPointer(initCondition, 2);
37352e61be88SMatthew G. Knepley   *initCondition = ts->ops->initcondition;
3736aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3737aad739acSMatthew G. Knepley }
3738aad739acSMatthew G. Knepley 
3739aad739acSMatthew G. Knepley /*@C
37402e61be88SMatthew G. Knepley   TSSetComputeInitialCondition - Set the function used to automatically compute an initial condition for the timestepping.
3741aad739acSMatthew G. Knepley 
3742aad739acSMatthew G. Knepley   Logically collective on ts
3743aad739acSMatthew G. Knepley 
3744aad739acSMatthew G. Knepley   Input Arguments:
3745aad739acSMatthew G. Knepley + ts        - time stepping context
37462e61be88SMatthew G. Knepley - initCondition - The function which computes an initial condition
3747aad739acSMatthew G. Knepley 
3748aad739acSMatthew G. Knepley   Level: advanced
3749aad739acSMatthew G. Knepley 
3750aad739acSMatthew G. Knepley   Notes:
3751aad739acSMatthew G. Knepley   The calling sequence for the function is
37522e61be88SMatthew G. Knepley $ initCondition(TS ts, Vec u)
3753aad739acSMatthew G. Knepley $ ts - The timestepping context
37542e61be88SMatthew G. Knepley $ u  - The input vector in which the initial condition is stored
3755aad739acSMatthew G. Knepley 
37562e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSComputeInitialCondition()
3757aad739acSMatthew G. Knepley @*/
37582e61be88SMatthew G. Knepley PetscErrorCode TSSetComputeInitialCondition(TS ts, PetscErrorCode (*initCondition)(TS, Vec))
3759aad739acSMatthew G. Knepley {
3760aad739acSMatthew G. Knepley   PetscFunctionBegin;
3761aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
37622e61be88SMatthew G. Knepley   PetscValidFunction(initCondition, 2);
37632e61be88SMatthew G. Knepley   ts->ops->initcondition = initCondition;
3764aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3765aad739acSMatthew G. Knepley }
3766aad739acSMatthew G. Knepley 
3767aad739acSMatthew G. Knepley /*@
37682e61be88SMatthew G. Knepley   TSComputeInitialCondition - Compute an initial condition for the timestepping using the function previously set.
3769aad739acSMatthew G. Knepley 
3770aad739acSMatthew G. Knepley   Collective on ts
3771aad739acSMatthew G. Knepley 
3772aad739acSMatthew G. Knepley   Input Arguments:
3773aad739acSMatthew G. Knepley + ts - time stepping context
37742e61be88SMatthew G. Knepley - u  - The Vec to store the condition in which will be used in TSSolve()
3775aad739acSMatthew G. Knepley 
3776aad739acSMatthew G. Knepley   Level: advanced
3777aad739acSMatthew G. Knepley 
3778aad739acSMatthew G. Knepley   Notes:
3779aad739acSMatthew G. Knepley   The calling sequence for the function is
37802e61be88SMatthew G. Knepley $ initCondition(TS ts, Vec u)
3781aad739acSMatthew G. Knepley $ ts - The timestepping context
37822e61be88SMatthew G. Knepley $ u  - The input vector in which the initial condition is stored
3783aad739acSMatthew G. Knepley 
37842e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve()
3785aad739acSMatthew G. Knepley @*/
37862e61be88SMatthew G. Knepley PetscErrorCode TSComputeInitialCondition(TS ts, Vec u)
3787aad739acSMatthew G. Knepley {
3788aad739acSMatthew G. Knepley   PetscErrorCode ierr;
3789aad739acSMatthew G. Knepley 
3790aad739acSMatthew G. Knepley   PetscFunctionBegin;
3791aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3792aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
37932e61be88SMatthew G. Knepley   if (ts->ops->initcondition) {ierr = (*ts->ops->initcondition)(ts, u);CHKERRQ(ierr);}
3794aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3795aad739acSMatthew G. Knepley }
3796aad739acSMatthew G. Knepley 
3797aad739acSMatthew G. Knepley /*@C
3798aad739acSMatthew G. Knepley   TSGetComputeExactError - Get the function used to automatically compute the exact error for the timestepping.
3799aad739acSMatthew G. Knepley 
3800aad739acSMatthew G. Knepley   Not collective
3801aad739acSMatthew G. Knepley 
3802aad739acSMatthew G. Knepley   Input Argument:
3803aad739acSMatthew G. Knepley . ts         - time stepping context
3804aad739acSMatthew G. Knepley 
3805aad739acSMatthew G. Knepley   Output Argument:
3806aad739acSMatthew G. Knepley . exactError - The function which computes the solution error
3807aad739acSMatthew G. Knepley 
3808aad739acSMatthew G. Knepley   Level: advanced
3809aad739acSMatthew G. Knepley 
3810aad739acSMatthew G. Knepley   Notes:
3811aad739acSMatthew G. Knepley   The calling sequence for the function is
3812aad739acSMatthew G. Knepley $ exactError(TS ts, Vec u)
3813aad739acSMatthew G. Knepley $ ts - The timestepping context
3814aad739acSMatthew G. Knepley $ u  - The approximate solution vector
3815aad739acSMatthew G. Knepley $ e  - The input vector in which the error is stored
3816aad739acSMatthew G. Knepley 
3817aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError()
3818aad739acSMatthew G. Knepley @*/
3819aad739acSMatthew G. Knepley PetscErrorCode TSGetComputeExactError(TS ts, PetscErrorCode (**exactError)(TS, Vec, Vec))
3820aad739acSMatthew G. Knepley {
3821aad739acSMatthew G. Knepley   PetscFunctionBegin;
3822aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3823aad739acSMatthew G. Knepley   PetscValidPointer(exactError, 2);
3824aad739acSMatthew G. Knepley   *exactError = ts->ops->exacterror;
3825aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3826aad739acSMatthew G. Knepley }
3827aad739acSMatthew G. Knepley 
3828aad739acSMatthew G. Knepley /*@C
3829aad739acSMatthew G. Knepley   TSSetComputeExactError - Set the function used to automatically compute the exact error for the timestepping.
3830aad739acSMatthew G. Knepley 
3831aad739acSMatthew G. Knepley   Logically collective on ts
3832aad739acSMatthew G. Knepley 
3833aad739acSMatthew G. Knepley   Input Arguments:
3834aad739acSMatthew G. Knepley + ts         - time stepping context
3835aad739acSMatthew G. Knepley - exactError - The function which computes the solution error
3836aad739acSMatthew G. Knepley 
3837aad739acSMatthew G. Knepley   Level: advanced
3838aad739acSMatthew G. Knepley 
3839aad739acSMatthew G. Knepley   Notes:
3840aad739acSMatthew G. Knepley   The calling sequence for the function is
3841aad739acSMatthew G. Knepley $ exactError(TS ts, Vec u)
3842aad739acSMatthew G. Knepley $ ts - The timestepping context
3843aad739acSMatthew G. Knepley $ u  - The approximate solution vector
3844aad739acSMatthew G. Knepley $ e  - The input vector in which the error is stored
3845aad739acSMatthew G. Knepley 
3846aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError()
3847aad739acSMatthew G. Knepley @*/
3848aad739acSMatthew G. Knepley PetscErrorCode TSSetComputeExactError(TS ts, PetscErrorCode (*exactError)(TS, Vec, Vec))
3849aad739acSMatthew G. Knepley {
3850aad739acSMatthew G. Knepley   PetscFunctionBegin;
3851aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3852f907fdbfSMatthew G. Knepley   PetscValidFunction(exactError, 2);
3853aad739acSMatthew G. Knepley   ts->ops->exacterror = exactError;
3854aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3855aad739acSMatthew G. Knepley }
3856aad739acSMatthew G. Knepley 
3857aad739acSMatthew G. Knepley /*@
3858aad739acSMatthew G. Knepley   TSComputeExactError - Compute the solution error for the timestepping using the function previously set.
3859aad739acSMatthew G. Knepley 
3860aad739acSMatthew G. Knepley   Collective on ts
3861aad739acSMatthew G. Knepley 
3862aad739acSMatthew G. Knepley   Input Arguments:
3863aad739acSMatthew G. Knepley + ts - time stepping context
3864aad739acSMatthew G. Knepley . u  - The approximate solution
3865aad739acSMatthew G. Knepley - e  - The Vec used to store the error
3866aad739acSMatthew G. Knepley 
3867aad739acSMatthew G. Knepley   Level: advanced
3868aad739acSMatthew G. Knepley 
3869aad739acSMatthew G. Knepley   Notes:
3870aad739acSMatthew G. Knepley   The calling sequence for the function is
3871aad739acSMatthew G. Knepley $ exactError(TS ts, Vec u)
3872aad739acSMatthew G. Knepley $ ts - The timestepping context
3873aad739acSMatthew G. Knepley $ u  - The approximate solution vector
3874aad739acSMatthew G. Knepley $ e  - The input vector in which the error is stored
3875aad739acSMatthew G. Knepley 
38762e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve()
3877aad739acSMatthew G. Knepley @*/
3878aad739acSMatthew G. Knepley PetscErrorCode TSComputeExactError(TS ts, Vec u, Vec e)
3879aad739acSMatthew G. Knepley {
3880aad739acSMatthew G. Knepley   PetscErrorCode ierr;
3881aad739acSMatthew G. Knepley 
3882aad739acSMatthew G. Knepley   PetscFunctionBegin;
3883aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3884aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
3885aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(e, VEC_CLASSID, 3);
3886aad739acSMatthew G. Knepley   if (ts->ops->exacterror) {ierr = (*ts->ops->exacterror)(ts, u, e);CHKERRQ(ierr);}
3887aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3888aad739acSMatthew G. Knepley }
3889aad739acSMatthew G. Knepley 
3890b1cb36f3SHong Zhang /*@
38916a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
38926a4d4014SLisandro Dalcin 
38936a4d4014SLisandro Dalcin    Collective on TS
38946a4d4014SLisandro Dalcin 
38956a4d4014SLisandro Dalcin    Input Parameter:
38966a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
389763e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
389863e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
38995a3a76d0SJed Brown 
39006a4d4014SLisandro Dalcin    Level: beginner
39016a4d4014SLisandro Dalcin 
39025a3a76d0SJed Brown    Notes:
39035a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
39045a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
39055a3a76d0SJed Brown    stepped over the final time.
39065a3a76d0SJed Brown 
390763e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
39086a4d4014SLisandro Dalcin @*/
3909cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
39106a4d4014SLisandro Dalcin {
3911b06615a5SLisandro Dalcin   Vec               solution;
39126a4d4014SLisandro Dalcin   PetscErrorCode    ierr;
3913f22f69f0SBarry Smith 
39146a4d4014SLisandro Dalcin   PetscFunctionBegin;
39150700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3916f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3917feed9e9dSBarry Smith 
3918ee41a567SStefano 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 */
39190910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3920b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3921b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3922b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
39235a3a76d0SJed Brown     }
39240910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3925715f1b00SHong Zhang     if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
3926bbd56ea5SKarl Rupp   } else if (u) {
39270910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
39285a3a76d0SJed Brown   }
3929b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
393068bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3931a6772fa2SLisandro Dalcin 
3932ef85077eSLisandro 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>");
3933a6772fa2SLisandro 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()");
3934a6772fa2SLisandro 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");
3935a6772fa2SLisandro Dalcin 
3936715f1b00SHong Zhang   if (ts->forward_solve) {
3937715f1b00SHong Zhang     ierr = TSForwardSetUp(ts);CHKERRQ(ierr);
3938715f1b00SHong Zhang   }
3939715f1b00SHong Zhang 
3940e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
3941715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
3942e7069c78SShri      TSTrajectory to incorrectly save the output files
3943e7069c78SShri   */
3944715f1b00SHong Zhang   /* reset time step and iteration counters */
39452808aa04SLisandro Dalcin   if (!ts->steps) {
39465ef26d82SJed Brown     ts->ksp_its           = 0;
39475ef26d82SJed Brown     ts->snes_its          = 0;
3948c610991cSLisandro Dalcin     ts->num_snes_failures = 0;
3949c610991cSLisandro Dalcin     ts->reject            = 0;
39502808aa04SLisandro Dalcin     ts->steprestart       = PETSC_TRUE;
39512808aa04SLisandro Dalcin     ts->steprollback      = PETSC_FALSE;
39522808aa04SLisandro Dalcin   }
39531a3b9e0cSLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && ts->ptime < ts->max_time && ts->ptime + ts->time_step > ts->max_time) ts->time_step = ts->max_time - ts->ptime;
3954193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
3955193ac0bcSJed Brown 
3956900f6b5bSMatthew G. Knepley   {
3957900f6b5bSMatthew G. Knepley     PetscViewer       viewer;
3958900f6b5bSMatthew G. Knepley     PetscViewerFormat format;
3959900f6b5bSMatthew G. Knepley     PetscBool         flg;
3960900f6b5bSMatthew G. Knepley     static PetscBool  incall = PETSC_FALSE;
3961900f6b5bSMatthew G. Knepley 
3962900f6b5bSMatthew G. Knepley     if (!incall) {
3963900f6b5bSMatthew G. Knepley       /* Estimate the convergence rate of the time discretization */
3964900f6b5bSMatthew G. Knepley       ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) ts),((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_estimate", &viewer, &format, &flg);CHKERRQ(ierr);
3965900f6b5bSMatthew G. Knepley       if (flg) {
3966900f6b5bSMatthew G. Knepley         PetscConvEst conv;
3967900f6b5bSMatthew G. Knepley         DM           dm;
3968900f6b5bSMatthew G. Knepley         PetscReal   *alpha; /* Convergence rate of the solution error for each field in the L_2 norm */
3969900f6b5bSMatthew G. Knepley         PetscInt     Nf;
3970900f6b5bSMatthew G. Knepley 
3971900f6b5bSMatthew G. Knepley         incall = PETSC_TRUE;
3972900f6b5bSMatthew G. Knepley         ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3973900f6b5bSMatthew G. Knepley         ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
3974900f6b5bSMatthew G. Knepley         ierr = PetscCalloc1(PetscMax(Nf, 1), &alpha);CHKERRQ(ierr);
3975900f6b5bSMatthew G. Knepley         ierr = PetscConvEstCreate(PetscObjectComm((PetscObject) ts), &conv);CHKERRQ(ierr);
3976900f6b5bSMatthew G. Knepley         ierr = PetscConvEstUseTS(conv);CHKERRQ(ierr);
3977900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetSolver(conv, (PetscObject) ts);CHKERRQ(ierr);
3978900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetFromOptions(conv);CHKERRQ(ierr);
3979900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetUp(conv);CHKERRQ(ierr);
3980900f6b5bSMatthew G. Knepley         ierr = PetscConvEstGetConvRate(conv, alpha);CHKERRQ(ierr);
3981900f6b5bSMatthew G. Knepley         ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);
3982900f6b5bSMatthew G. Knepley         ierr = PetscConvEstRateView(conv, alpha, viewer);CHKERRQ(ierr);
3983900f6b5bSMatthew G. Knepley         ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3984900f6b5bSMatthew G. Knepley         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
3985900f6b5bSMatthew G. Knepley         ierr = PetscConvEstDestroy(&conv);CHKERRQ(ierr);
3986900f6b5bSMatthew G. Knepley         ierr = PetscFree(alpha);CHKERRQ(ierr);
3987900f6b5bSMatthew G. Knepley         incall = PETSC_FALSE;
3988900f6b5bSMatthew G. Knepley       }
3989900f6b5bSMatthew G. Knepley     }
3990900f6b5bSMatthew G. Knepley   }
3991900f6b5bSMatthew G. Knepley 
3992ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3993f05ece33SBarry Smith 
3994193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
3995193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
3996a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3997cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3998a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
3999be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
4000db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
4001db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
4002e7069c78SShri 
40032808aa04SLisandro Dalcin     if (!ts->steps) {
40042808aa04SLisandro Dalcin       ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
40056427ac75SLisandro Dalcin       ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
40062808aa04SLisandro Dalcin     }
40076427ac75SLisandro Dalcin 
4008e1a7a14fSJed Brown     while (!ts->reason) {
40092808aa04SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
40109687d888SLisandro Dalcin       if (!ts->steprollback) {
40119687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
40129687d888SLisandro Dalcin       }
4013193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
4014f3b1f45cSBarry Smith       if (ts->testjacobian) {
4015f3b1f45cSBarry Smith         ierr = TSRHSJacobianTest(ts,NULL);CHKERRQ(ierr);
4016f3b1f45cSBarry Smith       }
4017f3b1f45cSBarry Smith       if (ts->testjacobiantranspose) {
4018f3b1f45cSBarry Smith         ierr = TSRHSJacobianTestTranspose(ts,NULL);CHKERRQ(ierr);
4019f3b1f45cSBarry Smith       }
4020cd4cee2dSHong Zhang       if (ts->quadraturets && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */
4021b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
4022b1cb36f3SHong Zhang       }
402358818c2dSLisandro Dalcin       if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */
4024715f1b00SHong Zhang         ierr = TSForwardStep(ts);CHKERRQ(ierr);
4025715f1b00SHong Zhang       }
402610b82f12SShri Abhyankar       ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
4027e783b05fSHong 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. */
402858818c2dSLisandro Dalcin       if (ts->steprollback) {
402958818c2dSLisandro Dalcin         ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
403058818c2dSLisandro Dalcin       }
4031e783b05fSHong Zhang       if (!ts->steprollback) {
40322808aa04SLisandro Dalcin         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
40331eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
4034aeb4809dSShri Abhyankar       }
4035193ac0bcSJed Brown     }
40362808aa04SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
40376427ac75SLisandro Dalcin 
403849354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
40390910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
4040cc708dedSBarry Smith       ts->solvetime = ts->max_time;
4041b06615a5SLisandro Dalcin       solution = u;
404263e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
40430574a7fbSJed Brown     } else {
4044ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4045cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4046b06615a5SLisandro Dalcin       solution = ts->vec_sol;
40470574a7fbSJed Brown     }
4048193ac0bcSJed Brown   }
4049d2daff3dSHong Zhang 
4050ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
405163e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
405256f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
4053ef222394SBarry Smith   if (ts->adjoint_solve) {
4054ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
40552b0a91c0SBarry Smith   }
40566a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
40576a4d4014SLisandro Dalcin }
40586a4d4014SLisandro Dalcin 
40597db568b7SBarry Smith /*@C
4060228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4061228d79bcSJed Brown 
4062228d79bcSJed Brown    Collective on TS
4063228d79bcSJed Brown 
4064228d79bcSJed Brown    Input Parameters:
4065228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
4066228d79bcSJed Brown .  step - step number that has just completed
4067228d79bcSJed Brown .  ptime - model time of the state
40680910c330SBarry Smith -  u - state at the current model time
4069228d79bcSJed Brown 
4070228d79bcSJed Brown    Notes:
40717db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
40727db568b7SBarry Smith    Users would almost never call this routine directly.
4073228d79bcSJed Brown 
407463e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
407563e21af5SBarry Smith 
40767db568b7SBarry Smith    Level: developer
4077228d79bcSJed Brown 
4078228d79bcSJed Brown @*/
40790910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4080d763cef2SBarry Smith {
4081d6152f81SLisandro Dalcin   DM             dm;
4082a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
4083d6152f81SLisandro Dalcin   PetscErrorCode ierr;
4084d763cef2SBarry Smith 
4085d763cef2SBarry Smith   PetscFunctionBegin;
4086b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4087b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4088d6152f81SLisandro Dalcin 
4089d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
4090d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
4091d6152f81SLisandro Dalcin 
40928860a134SJunchao Zhang   ierr = VecLockReadPush(u);CHKERRQ(ierr);
4093d763cef2SBarry Smith   for (i=0; i<n; i++) {
40940910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
4095d763cef2SBarry Smith   }
40968860a134SJunchao Zhang   ierr = VecLockReadPop(u);CHKERRQ(ierr);
4097d763cef2SBarry Smith   PetscFunctionReturn(0);
4098d763cef2SBarry Smith }
4099d763cef2SBarry Smith 
4100d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
4101d763cef2SBarry Smith /*@C
41027db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4103a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
4104d763cef2SBarry Smith 
4105d763cef2SBarry Smith    Collective on TS
4106d763cef2SBarry Smith 
4107d763cef2SBarry Smith    Input Parameters:
4108d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
4109d763cef2SBarry Smith .  label - the title to put in the title bar
41107c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
4111a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
4112a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4113d763cef2SBarry Smith 
4114d763cef2SBarry Smith    Output Parameter:
41150b039ecaSBarry Smith .  ctx - the context
4116d763cef2SBarry Smith 
4117d763cef2SBarry Smith    Options Database Key:
41184f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
41198b668821SLisandro Dalcin +  -ts_monitor_lg_timestep_log - automatically sets line graph monitor
41207db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
41217db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
41227db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
41237db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4124b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4125d763cef2SBarry Smith 
4126d763cef2SBarry Smith    Notes:
4127a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
4128d763cef2SBarry Smith 
41297db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
41307db568b7SBarry Smith 
41317db568b7SBarry 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
41327db568b7SBarry 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
41337db568b7SBarry Smith    as the first argument.
41347db568b7SBarry Smith 
41357db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
41367db568b7SBarry Smith 
4137d763cef2SBarry Smith    Level: intermediate
4138d763cef2SBarry Smith 
41397db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
41407db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
41417db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
41427db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
41437db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
41447c922b88SBarry Smith 
4145d763cef2SBarry Smith @*/
4146a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4147d763cef2SBarry Smith {
41487f52daa2SLisandro Dalcin   PetscDraw      draw;
4149dfbe8321SBarry Smith   PetscErrorCode ierr;
4150d763cef2SBarry Smith 
4151d763cef2SBarry Smith   PetscFunctionBegin;
4152b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
41537f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
41547f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
41557f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
4156287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
41577f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
4158a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
4159d763cef2SBarry Smith   PetscFunctionReturn(0);
4160d763cef2SBarry Smith }
4161d763cef2SBarry Smith 
4162b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4163d763cef2SBarry Smith {
41640b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4165c32365f1SBarry Smith   PetscReal      x   = ptime,y;
4166dfbe8321SBarry Smith   PetscErrorCode ierr;
4167d763cef2SBarry Smith 
4168d763cef2SBarry Smith   PetscFunctionBegin;
416963e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
4170b06615a5SLisandro Dalcin   if (!step) {
4171a9f9c1f6SBarry Smith     PetscDrawAxis axis;
41728b668821SLisandro Dalcin     const char *ylabel = ctx->semilogy ? "Log Time Step" : "Time Step";
4173a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
41748b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time",ylabel);CHKERRQ(ierr);
4175a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4176a9f9c1f6SBarry Smith   }
4177c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
41788b668821SLisandro Dalcin   if (ctx->semilogy) y = PetscLog10Real(y);
41790b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
4180b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
41810b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
41826934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
41833923b477SBarry Smith   }
4184d763cef2SBarry Smith   PetscFunctionReturn(0);
4185d763cef2SBarry Smith }
4186d763cef2SBarry Smith 
4187d763cef2SBarry Smith /*@C
4188a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4189a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
4190d763cef2SBarry Smith 
41910b039ecaSBarry Smith    Collective on TSMonitorLGCtx
4192d763cef2SBarry Smith 
4193d763cef2SBarry Smith    Input Parameter:
41940b039ecaSBarry Smith .  ctx - the monitor context
4195d763cef2SBarry Smith 
4196d763cef2SBarry Smith    Level: intermediate
4197d763cef2SBarry Smith 
41984f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
4199d763cef2SBarry Smith @*/
4200a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4201d763cef2SBarry Smith {
4202dfbe8321SBarry Smith   PetscErrorCode ierr;
4203d763cef2SBarry Smith 
4204d763cef2SBarry Smith   PetscFunctionBegin;
42057684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
42067684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
42077684fa3eSBarry Smith   }
42080b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
420931152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
4210387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
4211387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
4212387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
42130b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
4214d763cef2SBarry Smith   PetscFunctionReturn(0);
4215d763cef2SBarry Smith }
4216d763cef2SBarry Smith 
42171b575b74SJoseph Pusztay /*
42181b575b74SJoseph Pusztay 
42191b575b74SJoseph Pusztay   Creates a TS Monitor SPCtx for use with DM Swarm particle visualizations
42201b575b74SJoseph Pusztay 
42211b575b74SJoseph Pusztay */
42221b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorSPCtx *ctx)
42231b575b74SJoseph Pusztay {
42241b575b74SJoseph Pusztay   PetscDraw      draw;
42251b575b74SJoseph Pusztay   PetscErrorCode ierr;
42261b575b74SJoseph Pusztay 
42271b575b74SJoseph Pusztay   PetscFunctionBegin;
42281b575b74SJoseph Pusztay   ierr = PetscNew(ctx);CHKERRQ(ierr);
42291b575b74SJoseph Pusztay   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
42301b575b74SJoseph Pusztay   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
42311b575b74SJoseph Pusztay   ierr = PetscDrawSPCreate(draw,1,&(*ctx)->sp);CHKERRQ(ierr);
42321b575b74SJoseph Pusztay   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
42331b575b74SJoseph Pusztay   (*ctx)->howoften = howoften;
42341b575b74SJoseph Pusztay   PetscFunctionReturn(0);
42351b575b74SJoseph Pusztay 
42361b575b74SJoseph Pusztay }
42371b575b74SJoseph Pusztay 
42381b575b74SJoseph Pusztay /*
42391b575b74SJoseph Pusztay   Destroys a TSMonitorSPCtx that was created with TSMonitorSPCtxCreate
42401b575b74SJoseph Pusztay */
42411b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx *ctx)
42421b575b74SJoseph Pusztay {
42431b575b74SJoseph Pusztay   PetscErrorCode ierr;
42441b575b74SJoseph Pusztay 
42451b575b74SJoseph Pusztay   PetscFunctionBegin;
42461b575b74SJoseph Pusztay 
42471b575b74SJoseph Pusztay   ierr = PetscDrawSPDestroy(&(*ctx)->sp);CHKERRQ(ierr);
42481b575b74SJoseph Pusztay   ierr = PetscFree(*ctx);CHKERRQ(ierr);
42491b575b74SJoseph Pusztay 
42501b575b74SJoseph Pusztay   PetscFunctionReturn(0);
42511b575b74SJoseph Pusztay 
42521b575b74SJoseph Pusztay }
42531b575b74SJoseph Pusztay 
4254d763cef2SBarry Smith /*@
4255b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4256d763cef2SBarry Smith 
4257d763cef2SBarry Smith    Not Collective
4258d763cef2SBarry Smith 
4259d763cef2SBarry Smith    Input Parameter:
4260d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4261d763cef2SBarry Smith 
4262d763cef2SBarry Smith    Output Parameter:
426319eac22cSLisandro Dalcin .  t  - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime().
4264d763cef2SBarry Smith 
4265d763cef2SBarry Smith    Level: beginner
4266d763cef2SBarry Smith 
4267b8123daeSJed Brown    Note:
4268b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
42699be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4270b8123daeSJed Brown 
42718f199f4dSPatrick Sanan .seealso:  TSGetSolveTime(), TSSetTime(), TSGetTimeStep(), TSGetStepNumber()
4272d763cef2SBarry Smith 
4273d763cef2SBarry Smith @*/
42747087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4275d763cef2SBarry Smith {
4276d763cef2SBarry Smith   PetscFunctionBegin;
42770700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4278f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4279d763cef2SBarry Smith   *t = ts->ptime;
4280d763cef2SBarry Smith   PetscFunctionReturn(0);
4281d763cef2SBarry Smith }
4282d763cef2SBarry Smith 
4283e5e524a1SHong Zhang /*@
4284e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4285e5e524a1SHong Zhang 
4286e5e524a1SHong Zhang    Not Collective
4287e5e524a1SHong Zhang 
4288e5e524a1SHong Zhang    Input Parameter:
4289e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4290e5e524a1SHong Zhang 
4291e5e524a1SHong Zhang    Output Parameter:
4292e5e524a1SHong Zhang .  t  - the previous time
4293e5e524a1SHong Zhang 
4294e5e524a1SHong Zhang    Level: beginner
4295e5e524a1SHong Zhang 
4296aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep()
4297e5e524a1SHong Zhang 
4298e5e524a1SHong Zhang @*/
4299e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4300e5e524a1SHong Zhang {
4301e5e524a1SHong Zhang   PetscFunctionBegin;
4302e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4303e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4304e5e524a1SHong Zhang   *t = ts->ptime_prev;
4305e5e524a1SHong Zhang   PetscFunctionReturn(0);
4306e5e524a1SHong Zhang }
4307e5e524a1SHong Zhang 
43086a4d4014SLisandro Dalcin /*@
43096a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
43106a4d4014SLisandro Dalcin 
43113f9fe445SBarry Smith    Logically Collective on TS
43126a4d4014SLisandro Dalcin 
43136a4d4014SLisandro Dalcin    Input Parameters:
43146a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
43156a4d4014SLisandro Dalcin -  time - the time
43166a4d4014SLisandro Dalcin 
43176a4d4014SLisandro Dalcin    Level: intermediate
43186a4d4014SLisandro Dalcin 
431919eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps()
43206a4d4014SLisandro Dalcin 
43216a4d4014SLisandro Dalcin @*/
43227087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
43236a4d4014SLisandro Dalcin {
43246a4d4014SLisandro Dalcin   PetscFunctionBegin;
43250700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4326c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
43276a4d4014SLisandro Dalcin   ts->ptime = t;
43286a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
43296a4d4014SLisandro Dalcin }
43306a4d4014SLisandro Dalcin 
4331d763cef2SBarry Smith /*@C
4332d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4333d763cef2SBarry Smith    TS options in the database.
4334d763cef2SBarry Smith 
43353f9fe445SBarry Smith    Logically Collective on TS
4336d763cef2SBarry Smith 
4337d763cef2SBarry Smith    Input Parameter:
4338d763cef2SBarry Smith +  ts     - The TS context
4339d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4340d763cef2SBarry Smith 
4341d763cef2SBarry Smith    Notes:
4342d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4343d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4344d763cef2SBarry Smith    hyphen.
4345d763cef2SBarry Smith 
4346d763cef2SBarry Smith    Level: advanced
4347d763cef2SBarry Smith 
4348d763cef2SBarry Smith .seealso: TSSetFromOptions()
4349d763cef2SBarry Smith 
4350d763cef2SBarry Smith @*/
43517087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4352d763cef2SBarry Smith {
4353dfbe8321SBarry Smith   PetscErrorCode ierr;
4354089b2837SJed Brown   SNES           snes;
4355d763cef2SBarry Smith 
4356d763cef2SBarry Smith   PetscFunctionBegin;
43570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4358d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4359089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4360089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4361d763cef2SBarry Smith   PetscFunctionReturn(0);
4362d763cef2SBarry Smith }
4363d763cef2SBarry Smith 
4364d763cef2SBarry Smith /*@C
4365d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4366d763cef2SBarry Smith    TS options in the database.
4367d763cef2SBarry Smith 
43683f9fe445SBarry Smith    Logically Collective on TS
4369d763cef2SBarry Smith 
4370d763cef2SBarry Smith    Input Parameter:
4371d763cef2SBarry Smith +  ts     - The TS context
4372d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4373d763cef2SBarry Smith 
4374d763cef2SBarry Smith    Notes:
4375d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4376d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4377d763cef2SBarry Smith    hyphen.
4378d763cef2SBarry Smith 
4379d763cef2SBarry Smith    Level: advanced
4380d763cef2SBarry Smith 
4381d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4382d763cef2SBarry Smith 
4383d763cef2SBarry Smith @*/
43847087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4385d763cef2SBarry Smith {
4386dfbe8321SBarry Smith   PetscErrorCode ierr;
4387089b2837SJed Brown   SNES           snes;
4388d763cef2SBarry Smith 
4389d763cef2SBarry Smith   PetscFunctionBegin;
43900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4391d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4392089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4393089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4394d763cef2SBarry Smith   PetscFunctionReturn(0);
4395d763cef2SBarry Smith }
4396d763cef2SBarry Smith 
4397d763cef2SBarry Smith /*@C
4398d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4399d763cef2SBarry Smith    TS options in the database.
4400d763cef2SBarry Smith 
4401d763cef2SBarry Smith    Not Collective
4402d763cef2SBarry Smith 
4403d763cef2SBarry Smith    Input Parameter:
4404d763cef2SBarry Smith .  ts - The TS context
4405d763cef2SBarry Smith 
4406d763cef2SBarry Smith    Output Parameter:
4407d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4408d763cef2SBarry Smith 
440995452b02SPatrick Sanan    Notes:
441095452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prifix' of
4411d763cef2SBarry Smith    sufficient length to hold the prefix.
4412d763cef2SBarry Smith 
4413d763cef2SBarry Smith    Level: intermediate
4414d763cef2SBarry Smith 
4415d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4416d763cef2SBarry Smith @*/
44177087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4418d763cef2SBarry Smith {
4419dfbe8321SBarry Smith   PetscErrorCode ierr;
4420d763cef2SBarry Smith 
4421d763cef2SBarry Smith   PetscFunctionBegin;
44220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
44234482741eSBarry Smith   PetscValidPointer(prefix,2);
4424d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4425d763cef2SBarry Smith   PetscFunctionReturn(0);
4426d763cef2SBarry Smith }
4427d763cef2SBarry Smith 
4428d763cef2SBarry Smith /*@C
4429d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4430d763cef2SBarry Smith 
4431d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4432d763cef2SBarry Smith 
4433d763cef2SBarry Smith    Input Parameter:
4434d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4435d763cef2SBarry Smith 
4436d763cef2SBarry Smith    Output Parameters:
4437e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4438e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4439e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4440e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4441d763cef2SBarry Smith 
444295452b02SPatrick Sanan    Notes:
444395452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
4444d763cef2SBarry Smith 
4445d763cef2SBarry Smith    Level: intermediate
4446d763cef2SBarry Smith 
444780275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
4448d763cef2SBarry Smith 
4449d763cef2SBarry Smith @*/
4450e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4451d763cef2SBarry Smith {
4452089b2837SJed Brown   PetscErrorCode ierr;
445324989b8cSPeter Brune   DM             dm;
4454089b2837SJed Brown 
4455d763cef2SBarry Smith   PetscFunctionBegin;
445623a57915SBarry Smith   if (Amat || Pmat) {
445723a57915SBarry Smith     SNES snes;
4458089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
445923a57915SBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4460e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
446123a57915SBarry Smith   }
446224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
446324989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4464d763cef2SBarry Smith   PetscFunctionReturn(0);
4465d763cef2SBarry Smith }
4466d763cef2SBarry Smith 
44672eca1d9cSJed Brown /*@C
44682eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
44692eca1d9cSJed Brown 
44702eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
44712eca1d9cSJed Brown 
44722eca1d9cSJed Brown    Input Parameter:
44732eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
44742eca1d9cSJed Brown 
44752eca1d9cSJed Brown    Output Parameters:
4476e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4477e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
44782eca1d9cSJed Brown .  f   - The function to compute the matrices
44792eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
44802eca1d9cSJed Brown 
448195452b02SPatrick Sanan    Notes:
448295452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
44832eca1d9cSJed Brown 
44842eca1d9cSJed Brown    Level: advanced
44852eca1d9cSJed Brown 
448680275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
44872eca1d9cSJed Brown 
44882eca1d9cSJed Brown @*/
4489e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
44902eca1d9cSJed Brown {
4491089b2837SJed Brown   PetscErrorCode ierr;
449224989b8cSPeter Brune   DM             dm;
44930910c330SBarry Smith 
44942eca1d9cSJed Brown   PetscFunctionBegin;
4495c0aab802Sstefano_zampini   if (Amat || Pmat) {
4496c0aab802Sstefano_zampini     SNES snes;
4497089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4498f7d39f7aSBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4499e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
4500c0aab802Sstefano_zampini   }
450124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
450224989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
45032eca1d9cSJed Brown   PetscFunctionReturn(0);
45042eca1d9cSJed Brown }
45052eca1d9cSJed Brown 
45061713a123SBarry Smith /*@C
450783a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
45081713a123SBarry Smith    VecView() for the solution at each timestep
45091713a123SBarry Smith 
45101713a123SBarry Smith    Collective on TS
45111713a123SBarry Smith 
45121713a123SBarry Smith    Input Parameters:
45131713a123SBarry Smith +  ts - the TS context
45141713a123SBarry Smith .  step - current time-step
4515142b95e3SSatish Balay .  ptime - current time
45160298fd71SBarry Smith -  dummy - either a viewer or NULL
45171713a123SBarry Smith 
451899fdda47SBarry Smith    Options Database:
451999fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
452099fdda47SBarry Smith 
452195452b02SPatrick Sanan    Notes:
452295452b02SPatrick Sanan     the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
452399fdda47SBarry Smith        will look bad
452499fdda47SBarry Smith 
45251713a123SBarry Smith    Level: intermediate
45261713a123SBarry Smith 
4527a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
45281713a123SBarry Smith @*/
45290910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
45301713a123SBarry Smith {
4531dfbe8321SBarry Smith   PetscErrorCode   ierr;
453283a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4533473a3ab2SBarry Smith   PetscDraw        draw;
45341713a123SBarry Smith 
45351713a123SBarry Smith   PetscFunctionBegin;
45366083293cSBarry Smith   if (!step && ictx->showinitial) {
45376083293cSBarry Smith     if (!ictx->initialsolution) {
45380910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
45391713a123SBarry Smith     }
45400910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
45416083293cSBarry Smith   }
4542b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
45430dcf80beSBarry Smith 
45446083293cSBarry Smith   if (ictx->showinitial) {
45456083293cSBarry Smith     PetscReal pause;
45466083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
45476083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
45486083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
45496083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
45506083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
45516083293cSBarry Smith   }
45520910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4553473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
455451fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4555473a3ab2SBarry Smith     char      time[32];
4556473a3ab2SBarry Smith 
4557473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
455885b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4559473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4560473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
456151fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4562473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4563473a3ab2SBarry Smith   }
4564473a3ab2SBarry Smith 
45656083293cSBarry Smith   if (ictx->showinitial) {
45666083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
45676083293cSBarry Smith   }
45681713a123SBarry Smith   PetscFunctionReturn(0);
45691713a123SBarry Smith }
45701713a123SBarry Smith 
45719110b2e7SHong Zhang /*@C
45722d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
45732d5ee99bSBarry Smith 
45742d5ee99bSBarry Smith    Collective on TS
45752d5ee99bSBarry Smith 
45762d5ee99bSBarry Smith    Input Parameters:
45772d5ee99bSBarry Smith +  ts - the TS context
45782d5ee99bSBarry Smith .  step - current time-step
45792d5ee99bSBarry Smith .  ptime - current time
45802d5ee99bSBarry Smith -  dummy - either a viewer or NULL
45812d5ee99bSBarry Smith 
45822d5ee99bSBarry Smith    Level: intermediate
45832d5ee99bSBarry Smith 
45842d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
45852d5ee99bSBarry Smith @*/
45862d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
45872d5ee99bSBarry Smith {
45882d5ee99bSBarry Smith   PetscErrorCode    ierr;
45892d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
45902d5ee99bSBarry Smith   PetscDraw         draw;
45916934998bSLisandro Dalcin   PetscDrawAxis     axis;
45922d5ee99bSBarry Smith   PetscInt          n;
45932d5ee99bSBarry Smith   PetscMPIInt       size;
45946934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
45952d5ee99bSBarry Smith   char              time[32];
45962d5ee99bSBarry Smith   const PetscScalar *U;
45972d5ee99bSBarry Smith 
45982d5ee99bSBarry Smith   PetscFunctionBegin;
45996934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
46006934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
46012d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
46026934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
46032d5ee99bSBarry Smith 
46042d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
46056934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
46066934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
46076934998bSLisandro Dalcin   if (!step) {
46086934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
46096934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
46106934998bSLisandro Dalcin   }
46112d5ee99bSBarry Smith 
46122d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
46136934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
46146934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
4615a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
46166934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
46172d5ee99bSBarry Smith 
46186934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
46196934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
46202d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
46214b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
462285b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
46232d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
462451fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
46252d5ee99bSBarry Smith   }
46266934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
46272d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
462856d62c8fSLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
46296934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
46302d5ee99bSBarry Smith   PetscFunctionReturn(0);
46312d5ee99bSBarry Smith }
46322d5ee99bSBarry Smith 
46336083293cSBarry Smith /*@C
463483a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
46356083293cSBarry Smith 
46366083293cSBarry Smith    Collective on TS
46376083293cSBarry Smith 
46386083293cSBarry Smith    Input Parameters:
46396083293cSBarry Smith .    ctx - the monitor context
46406083293cSBarry Smith 
46416083293cSBarry Smith    Level: intermediate
46426083293cSBarry Smith 
464383a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
46446083293cSBarry Smith @*/
464583a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
46466083293cSBarry Smith {
46476083293cSBarry Smith   PetscErrorCode ierr;
46486083293cSBarry Smith 
46496083293cSBarry Smith   PetscFunctionBegin;
465083a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
465183a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
465283a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
46536083293cSBarry Smith   PetscFunctionReturn(0);
46546083293cSBarry Smith }
46556083293cSBarry Smith 
46566083293cSBarry Smith /*@C
465783a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
46586083293cSBarry Smith 
46596083293cSBarry Smith    Collective on TS
46606083293cSBarry Smith 
46616083293cSBarry Smith    Input Parameter:
46626083293cSBarry Smith .    ts - time-step context
46636083293cSBarry Smith 
46646083293cSBarry Smith    Output Patameter:
46656083293cSBarry Smith .    ctx - the monitor context
46666083293cSBarry Smith 
466799fdda47SBarry Smith    Options Database:
466899fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
466999fdda47SBarry Smith 
46706083293cSBarry Smith    Level: intermediate
46716083293cSBarry Smith 
467283a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
46736083293cSBarry Smith @*/
467483a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
46756083293cSBarry Smith {
46766083293cSBarry Smith   PetscErrorCode   ierr;
46776083293cSBarry Smith 
46786083293cSBarry Smith   PetscFunctionBegin;
4679b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
468083a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4681e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4682bbd56ea5SKarl Rupp 
468383a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4684473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
4685c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4686473a3ab2SBarry Smith 
4687473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
4688c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
46896083293cSBarry Smith   PetscFunctionReturn(0);
46906083293cSBarry Smith }
46916083293cSBarry Smith 
46923a471f94SBarry Smith /*@C
46930ed3bfb6SBarry Smith    TSMonitorDrawSolutionFunction - Monitors progress of the TS solvers by calling
46940ed3bfb6SBarry Smith    VecView() for the solution provided by TSSetSolutionFunction() at each timestep
46950ed3bfb6SBarry Smith 
46960ed3bfb6SBarry Smith    Collective on TS
46970ed3bfb6SBarry Smith 
46980ed3bfb6SBarry Smith    Input Parameters:
46990ed3bfb6SBarry Smith +  ts - the TS context
47000ed3bfb6SBarry Smith .  step - current time-step
47010ed3bfb6SBarry Smith .  ptime - current time
47020ed3bfb6SBarry Smith -  dummy - either a viewer or NULL
47030ed3bfb6SBarry Smith 
47040ed3bfb6SBarry Smith    Options Database:
47050ed3bfb6SBarry Smith .  -ts_monitor_draw_solution_function - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
47060ed3bfb6SBarry Smith 
47070ed3bfb6SBarry Smith    Level: intermediate
47080ed3bfb6SBarry Smith 
47090ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
47100ed3bfb6SBarry Smith @*/
47110ed3bfb6SBarry Smith PetscErrorCode  TSMonitorDrawSolutionFunction(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
47120ed3bfb6SBarry Smith {
47130ed3bfb6SBarry Smith   PetscErrorCode   ierr;
47140ed3bfb6SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
47150ed3bfb6SBarry Smith   PetscViewer      viewer = ctx->viewer;
47160ed3bfb6SBarry Smith   Vec              work;
47170ed3bfb6SBarry Smith 
47180ed3bfb6SBarry Smith   PetscFunctionBegin;
47190ed3bfb6SBarry Smith   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
47200ed3bfb6SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
47210ed3bfb6SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
47220ed3bfb6SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
47230ed3bfb6SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
47240ed3bfb6SBarry Smith   PetscFunctionReturn(0);
47250ed3bfb6SBarry Smith }
47260ed3bfb6SBarry Smith 
47270ed3bfb6SBarry Smith /*@C
472883a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
47293a471f94SBarry Smith    VecView() for the error at each timestep
47303a471f94SBarry Smith 
47313a471f94SBarry Smith    Collective on TS
47323a471f94SBarry Smith 
47333a471f94SBarry Smith    Input Parameters:
47343a471f94SBarry Smith +  ts - the TS context
47353a471f94SBarry Smith .  step - current time-step
47363a471f94SBarry Smith .  ptime - current time
47370298fd71SBarry Smith -  dummy - either a viewer or NULL
47383a471f94SBarry Smith 
47390ed3bfb6SBarry Smith    Options Database:
47400ed3bfb6SBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
47410ed3bfb6SBarry Smith 
47423a471f94SBarry Smith    Level: intermediate
47433a471f94SBarry Smith 
47440ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
47453a471f94SBarry Smith @*/
47460910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
47473a471f94SBarry Smith {
47483a471f94SBarry Smith   PetscErrorCode   ierr;
474983a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
475083a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
47513a471f94SBarry Smith   Vec              work;
47523a471f94SBarry Smith 
47533a471f94SBarry Smith   PetscFunctionBegin;
4754b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
47550910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
47563a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
47570910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
47583a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
47593a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
47603a471f94SBarry Smith   PetscFunctionReturn(0);
47613a471f94SBarry Smith }
47623a471f94SBarry Smith 
4763af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
47646c699258SBarry Smith /*@
47652a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
47666c699258SBarry Smith 
4767d083f849SBarry Smith    Logically Collective on ts
47686c699258SBarry Smith 
47696c699258SBarry Smith    Input Parameters:
47702a808120SBarry Smith +  ts - the ODE integrator object
47712a808120SBarry Smith -  dm - the dm, cannot be NULL
47726c699258SBarry Smith 
4773e03a659cSJed Brown    Notes:
4774e03a659cSJed Brown    A DM can only be used for solving one problem at a time because information about the problem is stored on the DM,
4775e03a659cSJed Brown    even when not using interfaces like DMTSSetIFunction().  Use DMClone() to get a distinct DM when solving
4776e03a659cSJed Brown    different problems using the same function space.
4777e03a659cSJed Brown 
47786c699258SBarry Smith    Level: intermediate
47796c699258SBarry Smith 
47806c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
47816c699258SBarry Smith @*/
47827087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
47836c699258SBarry Smith {
47846c699258SBarry Smith   PetscErrorCode ierr;
4785089b2837SJed Brown   SNES           snes;
4786942e3340SBarry Smith   DMTS           tsdm;
47876c699258SBarry Smith 
47886c699258SBarry Smith   PetscFunctionBegin;
47890700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
47902a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
479170663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4792942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
47932a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4794942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4795942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
479624989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
479724989b8cSPeter Brune         tsdm->originaldm = dm;
479824989b8cSPeter Brune       }
479924989b8cSPeter Brune     }
48006bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
480124989b8cSPeter Brune   }
48026c699258SBarry Smith   ts->dm = dm;
4803bbd56ea5SKarl Rupp 
4804089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4805089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
48066c699258SBarry Smith   PetscFunctionReturn(0);
48076c699258SBarry Smith }
48086c699258SBarry Smith 
48096c699258SBarry Smith /*@
48106c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
48116c699258SBarry Smith 
48123f9fe445SBarry Smith    Not Collective
48136c699258SBarry Smith 
48146c699258SBarry Smith    Input Parameter:
48156c699258SBarry Smith . ts - the preconditioner context
48166c699258SBarry Smith 
48176c699258SBarry Smith    Output Parameter:
48186c699258SBarry Smith .  dm - the dm
48196c699258SBarry Smith 
48206c699258SBarry Smith    Level: intermediate
48216c699258SBarry Smith 
48226c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
48236c699258SBarry Smith @*/
48247087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
48256c699258SBarry Smith {
4826496e6a7aSJed Brown   PetscErrorCode ierr;
4827496e6a7aSJed Brown 
48286c699258SBarry Smith   PetscFunctionBegin;
48290700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4830496e6a7aSJed Brown   if (!ts->dm) {
4831ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4832496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4833496e6a7aSJed Brown   }
48346c699258SBarry Smith   *dm = ts->dm;
48356c699258SBarry Smith   PetscFunctionReturn(0);
48366c699258SBarry Smith }
48371713a123SBarry Smith 
48380f5c6efeSJed Brown /*@
48390f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
48400f5c6efeSJed Brown 
48413f9fe445SBarry Smith    Logically Collective on SNES
48420f5c6efeSJed Brown 
48430f5c6efeSJed Brown    Input Parameter:
4844d42a1c89SJed Brown + snes - nonlinear solver
48450910c330SBarry Smith . U - the current state at which to evaluate the residual
4846d42a1c89SJed Brown - ctx - user context, must be a TS
48470f5c6efeSJed Brown 
48480f5c6efeSJed Brown    Output Parameter:
48490f5c6efeSJed Brown . F - the nonlinear residual
48500f5c6efeSJed Brown 
48510f5c6efeSJed Brown    Notes:
48520f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
48530f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
48540f5c6efeSJed Brown 
48550f5c6efeSJed Brown    Level: advanced
48560f5c6efeSJed Brown 
48570f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
48580f5c6efeSJed Brown @*/
48590910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
48600f5c6efeSJed Brown {
48610f5c6efeSJed Brown   TS             ts = (TS)ctx;
48620f5c6efeSJed Brown   PetscErrorCode ierr;
48630f5c6efeSJed Brown 
48640f5c6efeSJed Brown   PetscFunctionBegin;
48650f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
48660910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
48670f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
48680f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
48690910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
48700f5c6efeSJed Brown   PetscFunctionReturn(0);
48710f5c6efeSJed Brown }
48720f5c6efeSJed Brown 
48730f5c6efeSJed Brown /*@
48740f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
48750f5c6efeSJed Brown 
48760f5c6efeSJed Brown    Collective on SNES
48770f5c6efeSJed Brown 
48780f5c6efeSJed Brown    Input Parameter:
48790f5c6efeSJed Brown + snes - nonlinear solver
48800910c330SBarry Smith . U - the current state at which to evaluate the residual
48810f5c6efeSJed Brown - ctx - user context, must be a TS
48820f5c6efeSJed Brown 
48830f5c6efeSJed Brown    Output Parameter:
48840f5c6efeSJed Brown + A - the Jacobian
48850f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
48860f5c6efeSJed Brown - flag - indicates any structure change in the matrix
48870f5c6efeSJed Brown 
48880f5c6efeSJed Brown    Notes:
48890f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
48900f5c6efeSJed Brown 
48910f5c6efeSJed Brown    Level: developer
48920f5c6efeSJed Brown 
48930f5c6efeSJed Brown .seealso: SNESSetJacobian()
48940f5c6efeSJed Brown @*/
4895d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
48960f5c6efeSJed Brown {
48970f5c6efeSJed Brown   TS             ts = (TS)ctx;
48980f5c6efeSJed Brown   PetscErrorCode ierr;
48990f5c6efeSJed Brown 
49000f5c6efeSJed Brown   PetscFunctionBegin;
49010f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
49020910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
49030f5c6efeSJed Brown   PetscValidPointer(A,3);
490494ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
49050f5c6efeSJed Brown   PetscValidPointer(B,4);
490694ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
49070f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4908d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
49090f5c6efeSJed Brown   PetscFunctionReturn(0);
49100f5c6efeSJed Brown }
4911325fc9f4SBarry Smith 
49120e4ef248SJed Brown /*@C
49139ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
49140e4ef248SJed Brown 
49150e4ef248SJed Brown    Collective on TS
49160e4ef248SJed Brown 
49170e4ef248SJed Brown    Input Arguments:
49180e4ef248SJed Brown +  ts - time stepping context
49190e4ef248SJed Brown .  t - time at which to evaluate
49200910c330SBarry Smith .  U - state at which to evaluate
49210e4ef248SJed Brown -  ctx - context
49220e4ef248SJed Brown 
49230e4ef248SJed Brown    Output Arguments:
49240e4ef248SJed Brown .  F - right hand side
49250e4ef248SJed Brown 
49260e4ef248SJed Brown    Level: intermediate
49270e4ef248SJed Brown 
49280e4ef248SJed Brown    Notes:
49290e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
49300e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
49310e4ef248SJed Brown 
49320e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
49330e4ef248SJed Brown @*/
49340910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
49350e4ef248SJed Brown {
49360e4ef248SJed Brown   PetscErrorCode ierr;
49370e4ef248SJed Brown   Mat            Arhs,Brhs;
49380e4ef248SJed Brown 
49390e4ef248SJed Brown   PetscFunctionBegin;
49400e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4941d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
49420910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
49430e4ef248SJed Brown   PetscFunctionReturn(0);
49440e4ef248SJed Brown }
49450e4ef248SJed Brown 
49460e4ef248SJed Brown /*@C
49470e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
49480e4ef248SJed Brown 
49490e4ef248SJed Brown    Collective on TS
49500e4ef248SJed Brown 
49510e4ef248SJed Brown    Input Arguments:
49520e4ef248SJed Brown +  ts - time stepping context
49530e4ef248SJed Brown .  t - time at which to evaluate
49540910c330SBarry Smith .  U - state at which to evaluate
49550e4ef248SJed Brown -  ctx - context
49560e4ef248SJed Brown 
49570e4ef248SJed Brown    Output Arguments:
49580e4ef248SJed Brown +  A - pointer to operator
49590e4ef248SJed Brown .  B - pointer to preconditioning matrix
49600e4ef248SJed Brown -  flg - matrix structure flag
49610e4ef248SJed Brown 
49620e4ef248SJed Brown    Level: intermediate
49630e4ef248SJed Brown 
49640e4ef248SJed Brown    Notes:
49650e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
49660e4ef248SJed Brown 
49670e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
49680e4ef248SJed Brown @*/
4969d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
49700e4ef248SJed Brown {
49710e4ef248SJed Brown   PetscFunctionBegin;
49720e4ef248SJed Brown   PetscFunctionReturn(0);
49730e4ef248SJed Brown }
49740e4ef248SJed Brown 
49750026cea9SSean Farley /*@C
49760026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
49770026cea9SSean Farley 
49780026cea9SSean Farley    Collective on TS
49790026cea9SSean Farley 
49800026cea9SSean Farley    Input Arguments:
49810026cea9SSean Farley +  ts - time stepping context
49820026cea9SSean Farley .  t - time at which to evaluate
49830910c330SBarry Smith .  U - state at which to evaluate
49840910c330SBarry Smith .  Udot - time derivative of state vector
49850026cea9SSean Farley -  ctx - context
49860026cea9SSean Farley 
49870026cea9SSean Farley    Output Arguments:
49880026cea9SSean Farley .  F - left hand side
49890026cea9SSean Farley 
49900026cea9SSean Farley    Level: intermediate
49910026cea9SSean Farley 
49920026cea9SSean Farley    Notes:
49930910c330SBarry 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
49940026cea9SSean Farley    user is required to write their own TSComputeIFunction.
49950026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
49960026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
49970026cea9SSean Farley 
49989ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
49999ae8fd06SBarry Smith 
50009ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
50010026cea9SSean Farley @*/
50020910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
50030026cea9SSean Farley {
50040026cea9SSean Farley   PetscErrorCode ierr;
50050026cea9SSean Farley   Mat            A,B;
50060026cea9SSean Farley 
50070026cea9SSean Farley   PetscFunctionBegin;
50080298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
5009d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
50100910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
50110026cea9SSean Farley   PetscFunctionReturn(0);
50120026cea9SSean Farley }
50130026cea9SSean Farley 
50140026cea9SSean Farley /*@C
5015b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
50160026cea9SSean Farley 
50170026cea9SSean Farley    Collective on TS
50180026cea9SSean Farley 
50190026cea9SSean Farley    Input Arguments:
50200026cea9SSean Farley +  ts - time stepping context
50210026cea9SSean Farley .  t - time at which to evaluate
50220910c330SBarry Smith .  U - state at which to evaluate
50230910c330SBarry Smith .  Udot - time derivative of state vector
50240026cea9SSean Farley .  shift - shift to apply
50250026cea9SSean Farley -  ctx - context
50260026cea9SSean Farley 
50270026cea9SSean Farley    Output Arguments:
50280026cea9SSean Farley +  A - pointer to operator
50290026cea9SSean Farley .  B - pointer to preconditioning matrix
50300026cea9SSean Farley -  flg - matrix structure flag
50310026cea9SSean Farley 
5032b41af12eSJed Brown    Level: advanced
50330026cea9SSean Farley 
50340026cea9SSean Farley    Notes:
50350026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
50360026cea9SSean Farley 
5037b41af12eSJed Brown    It is only appropriate for problems of the form
5038b41af12eSJed Brown 
5039b41af12eSJed Brown $     M Udot = F(U,t)
5040b41af12eSJed Brown 
5041b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
5042b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5043b41af12eSJed Brown   an implicit operator of the form
5044b41af12eSJed Brown 
5045b41af12eSJed Brown $    shift*M + J
5046b41af12eSJed Brown 
5047b41af12eSJed 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
5048b41af12eSJed Brown   a copy of M or reassemble it when requested.
5049b41af12eSJed Brown 
50500026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
50510026cea9SSean Farley @*/
5052d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
50530026cea9SSean Farley {
5054b41af12eSJed Brown   PetscErrorCode ierr;
5055b41af12eSJed Brown 
50560026cea9SSean Farley   PetscFunctionBegin;
505794ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
5058b41af12eSJed Brown   ts->ijacobian.shift = shift;
50590026cea9SSean Farley   PetscFunctionReturn(0);
50600026cea9SSean Farley }
5061b41af12eSJed Brown 
5062e817cc15SEmil Constantinescu /*@
5063e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
5064e817cc15SEmil Constantinescu 
5065e817cc15SEmil Constantinescu    Not Collective
5066e817cc15SEmil Constantinescu 
5067e817cc15SEmil Constantinescu    Input Parameter:
5068e817cc15SEmil Constantinescu .  ts - the TS context
5069e817cc15SEmil Constantinescu 
5070e817cc15SEmil Constantinescu    Output Parameter:
50714e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
5072e817cc15SEmil Constantinescu 
5073e817cc15SEmil Constantinescu    Level: beginner
5074e817cc15SEmil Constantinescu 
5075e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
5076e817cc15SEmil Constantinescu @*/
5077e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
5078e817cc15SEmil Constantinescu {
5079e817cc15SEmil Constantinescu   PetscFunctionBegin;
5080e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5081e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
5082e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
5083e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5084e817cc15SEmil Constantinescu }
5085e817cc15SEmil Constantinescu 
5086e817cc15SEmil Constantinescu /*@
5087e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
5088e817cc15SEmil Constantinescu 
5089e817cc15SEmil Constantinescu    Not Collective
5090e817cc15SEmil Constantinescu 
5091e817cc15SEmil Constantinescu    Input Parameter:
5092e817cc15SEmil Constantinescu +  ts - the TS context
50931297b224SEmil Constantinescu -  equation_type - see TSEquationType
5094e817cc15SEmil Constantinescu 
5095e817cc15SEmil Constantinescu    Level: advanced
5096e817cc15SEmil Constantinescu 
5097e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
5098e817cc15SEmil Constantinescu @*/
5099e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
5100e817cc15SEmil Constantinescu {
5101e817cc15SEmil Constantinescu   PetscFunctionBegin;
5102e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5103e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
5104e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5105e817cc15SEmil Constantinescu }
51060026cea9SSean Farley 
51074af1b03aSJed Brown /*@
51084af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
51094af1b03aSJed Brown 
51104af1b03aSJed Brown    Not Collective
51114af1b03aSJed Brown 
51124af1b03aSJed Brown    Input Parameter:
51134af1b03aSJed Brown .  ts - the TS context
51144af1b03aSJed Brown 
51154af1b03aSJed Brown    Output Parameter:
51164af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
51174af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
51184af1b03aSJed Brown 
5119487e0bb9SJed Brown    Level: beginner
51204af1b03aSJed Brown 
5121cd652676SJed Brown    Notes:
5122cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
51234af1b03aSJed Brown 
51244af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
51254af1b03aSJed Brown @*/
51264af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
51274af1b03aSJed Brown {
51284af1b03aSJed Brown   PetscFunctionBegin;
51294af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
51304af1b03aSJed Brown   PetscValidPointer(reason,2);
51314af1b03aSJed Brown   *reason = ts->reason;
51324af1b03aSJed Brown   PetscFunctionReturn(0);
51334af1b03aSJed Brown }
51344af1b03aSJed Brown 
5135d6ad946cSShri Abhyankar /*@
5136d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5137d6ad946cSShri Abhyankar 
51386b221cbeSPatrick Sanan    Logically Collective; reason must contain common value
5139d6ad946cSShri Abhyankar 
51406b221cbeSPatrick Sanan    Input Parameters:
5141d6ad946cSShri Abhyankar +  ts - the TS context
51426b221cbeSPatrick Sanan -  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5143d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
5144d6ad946cSShri Abhyankar 
5145f5abba47SShri Abhyankar    Level: advanced
5146d6ad946cSShri Abhyankar 
5147d6ad946cSShri Abhyankar    Notes:
51486b221cbeSPatrick Sanan    Can only be called while TSSolve() is active.
5149d6ad946cSShri Abhyankar 
5150d6ad946cSShri Abhyankar .seealso: TSConvergedReason
5151d6ad946cSShri Abhyankar @*/
5152d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
5153d6ad946cSShri Abhyankar {
5154d6ad946cSShri Abhyankar   PetscFunctionBegin;
5155d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5156d6ad946cSShri Abhyankar   ts->reason = reason;
5157d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
5158d6ad946cSShri Abhyankar }
5159d6ad946cSShri Abhyankar 
5160cc708dedSBarry Smith /*@
5161cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
5162cc708dedSBarry Smith 
5163cc708dedSBarry Smith    Not Collective
5164cc708dedSBarry Smith 
5165cc708dedSBarry Smith    Input Parameter:
5166cc708dedSBarry Smith .  ts - the TS context
5167cc708dedSBarry Smith 
5168cc708dedSBarry Smith    Output Parameter:
516919eac22cSLisandro Dalcin .  ftime - the final time. This time corresponds to the final time set with TSSetMaxTime()
5170cc708dedSBarry Smith 
5171487e0bb9SJed Brown    Level: beginner
5172cc708dedSBarry Smith 
5173cc708dedSBarry Smith    Notes:
5174cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
5175cc708dedSBarry Smith 
5176cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
5177cc708dedSBarry Smith @*/
5178cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
5179cc708dedSBarry Smith {
5180cc708dedSBarry Smith   PetscFunctionBegin;
5181cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5182cc708dedSBarry Smith   PetscValidPointer(ftime,2);
5183cc708dedSBarry Smith   *ftime = ts->solvetime;
5184cc708dedSBarry Smith   PetscFunctionReturn(0);
5185cc708dedSBarry Smith }
5186cc708dedSBarry Smith 
51872c18e0fdSBarry Smith /*@
51885ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
51899f67acb7SJed Brown    used by the time integrator.
51909f67acb7SJed Brown 
51919f67acb7SJed Brown    Not Collective
51929f67acb7SJed Brown 
51939f67acb7SJed Brown    Input Parameter:
51949f67acb7SJed Brown .  ts - TS context
51959f67acb7SJed Brown 
51969f67acb7SJed Brown    Output Parameter:
51979f67acb7SJed Brown .  nits - number of nonlinear iterations
51989f67acb7SJed Brown 
51999f67acb7SJed Brown    Notes:
52009f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
52019f67acb7SJed Brown 
52029f67acb7SJed Brown    Level: intermediate
52039f67acb7SJed Brown 
52045ef26d82SJed Brown .seealso:  TSGetKSPIterations()
52059f67acb7SJed Brown @*/
52065ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
52079f67acb7SJed Brown {
52089f67acb7SJed Brown   PetscFunctionBegin;
52099f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
52109f67acb7SJed Brown   PetscValidIntPointer(nits,2);
52115ef26d82SJed Brown   *nits = ts->snes_its;
52129f67acb7SJed Brown   PetscFunctionReturn(0);
52139f67acb7SJed Brown }
52149f67acb7SJed Brown 
52159f67acb7SJed Brown /*@
52165ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
52179f67acb7SJed Brown    used by the time integrator.
52189f67acb7SJed Brown 
52199f67acb7SJed Brown    Not Collective
52209f67acb7SJed Brown 
52219f67acb7SJed Brown    Input Parameter:
52229f67acb7SJed Brown .  ts - TS context
52239f67acb7SJed Brown 
52249f67acb7SJed Brown    Output Parameter:
52259f67acb7SJed Brown .  lits - number of linear iterations
52269f67acb7SJed Brown 
52279f67acb7SJed Brown    Notes:
52289f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
52299f67acb7SJed Brown 
52309f67acb7SJed Brown    Level: intermediate
52319f67acb7SJed Brown 
52325ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
52339f67acb7SJed Brown @*/
52345ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
52359f67acb7SJed Brown {
52369f67acb7SJed Brown   PetscFunctionBegin;
52379f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
52389f67acb7SJed Brown   PetscValidIntPointer(lits,2);
52395ef26d82SJed Brown   *lits = ts->ksp_its;
52409f67acb7SJed Brown   PetscFunctionReturn(0);
52419f67acb7SJed Brown }
52429f67acb7SJed Brown 
5243cef5090cSJed Brown /*@
5244cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5245cef5090cSJed Brown 
5246cef5090cSJed Brown    Not Collective
5247cef5090cSJed Brown 
5248cef5090cSJed Brown    Input Parameter:
5249cef5090cSJed Brown .  ts - TS context
5250cef5090cSJed Brown 
5251cef5090cSJed Brown    Output Parameter:
5252cef5090cSJed Brown .  rejects - number of steps rejected
5253cef5090cSJed Brown 
5254cef5090cSJed Brown    Notes:
5255cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5256cef5090cSJed Brown 
5257cef5090cSJed Brown    Level: intermediate
5258cef5090cSJed Brown 
52595ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5260cef5090cSJed Brown @*/
5261cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5262cef5090cSJed Brown {
5263cef5090cSJed Brown   PetscFunctionBegin;
5264cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5265cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5266cef5090cSJed Brown   *rejects = ts->reject;
5267cef5090cSJed Brown   PetscFunctionReturn(0);
5268cef5090cSJed Brown }
5269cef5090cSJed Brown 
5270cef5090cSJed Brown /*@
5271cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5272cef5090cSJed Brown 
5273cef5090cSJed Brown    Not Collective
5274cef5090cSJed Brown 
5275cef5090cSJed Brown    Input Parameter:
5276cef5090cSJed Brown .  ts - TS context
5277cef5090cSJed Brown 
5278cef5090cSJed Brown    Output Parameter:
5279cef5090cSJed Brown .  fails - number of failed nonlinear solves
5280cef5090cSJed Brown 
5281cef5090cSJed Brown    Notes:
5282cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5283cef5090cSJed Brown 
5284cef5090cSJed Brown    Level: intermediate
5285cef5090cSJed Brown 
52865ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5287cef5090cSJed Brown @*/
5288cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5289cef5090cSJed Brown {
5290cef5090cSJed Brown   PetscFunctionBegin;
5291cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5292cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5293cef5090cSJed Brown   *fails = ts->num_snes_failures;
5294cef5090cSJed Brown   PetscFunctionReturn(0);
5295cef5090cSJed Brown }
5296cef5090cSJed Brown 
5297cef5090cSJed Brown /*@
5298cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5299cef5090cSJed Brown 
5300cef5090cSJed Brown    Not Collective
5301cef5090cSJed Brown 
5302cef5090cSJed Brown    Input Parameter:
5303cef5090cSJed Brown +  ts - TS context
5304cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5305cef5090cSJed Brown 
5306cef5090cSJed Brown    Notes:
5307cef5090cSJed Brown    The counter is reset to zero for each step
5308cef5090cSJed Brown 
5309cef5090cSJed Brown    Options Database Key:
5310cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5311cef5090cSJed Brown 
5312cef5090cSJed Brown    Level: intermediate
5313cef5090cSJed Brown 
53145ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5315cef5090cSJed Brown @*/
5316cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5317cef5090cSJed Brown {
5318cef5090cSJed Brown   PetscFunctionBegin;
5319cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5320cef5090cSJed Brown   ts->max_reject = rejects;
5321cef5090cSJed Brown   PetscFunctionReturn(0);
5322cef5090cSJed Brown }
5323cef5090cSJed Brown 
5324cef5090cSJed Brown /*@
5325cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5326cef5090cSJed Brown 
5327cef5090cSJed Brown    Not Collective
5328cef5090cSJed Brown 
5329cef5090cSJed Brown    Input Parameter:
5330cef5090cSJed Brown +  ts - TS context
5331cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5332cef5090cSJed Brown 
5333cef5090cSJed Brown    Notes:
5334cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5335cef5090cSJed Brown 
5336cef5090cSJed Brown    Options Database Key:
5337cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5338cef5090cSJed Brown 
5339cef5090cSJed Brown    Level: intermediate
5340cef5090cSJed Brown 
53415ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5342cef5090cSJed Brown @*/
5343cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5344cef5090cSJed Brown {
5345cef5090cSJed Brown   PetscFunctionBegin;
5346cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5347cef5090cSJed Brown   ts->max_snes_failures = fails;
5348cef5090cSJed Brown   PetscFunctionReturn(0);
5349cef5090cSJed Brown }
5350cef5090cSJed Brown 
5351cef5090cSJed Brown /*@
5352cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5353cef5090cSJed Brown 
5354cef5090cSJed Brown    Not Collective
5355cef5090cSJed Brown 
5356cef5090cSJed Brown    Input Parameter:
5357cef5090cSJed Brown +  ts - TS context
5358cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5359cef5090cSJed Brown 
5360cef5090cSJed Brown    Options Database Key:
5361cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5362cef5090cSJed Brown 
5363cef5090cSJed Brown    Level: intermediate
5364cef5090cSJed Brown 
53655ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5366cef5090cSJed Brown @*/
5367cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5368cef5090cSJed Brown {
5369cef5090cSJed Brown   PetscFunctionBegin;
5370cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5371cef5090cSJed Brown   ts->errorifstepfailed = err;
5372cef5090cSJed Brown   PetscFunctionReturn(0);
5373cef5090cSJed Brown }
5374cef5090cSJed Brown 
5375fb1732b5SBarry Smith /*@C
5376fde5950dSBarry 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
5377fb1732b5SBarry Smith 
5378fb1732b5SBarry Smith    Collective on TS
5379fb1732b5SBarry Smith 
5380fb1732b5SBarry Smith    Input Parameters:
5381fb1732b5SBarry Smith +  ts - the TS context
5382fb1732b5SBarry Smith .  step - current time-step
5383fb1732b5SBarry Smith .  ptime - current time
53840910c330SBarry Smith .  u - current state
5385721cd6eeSBarry Smith -  vf - viewer and its format
5386fb1732b5SBarry Smith 
5387fb1732b5SBarry Smith    Level: intermediate
5388fb1732b5SBarry Smith 
5389fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5390fb1732b5SBarry Smith @*/
5391721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5392fb1732b5SBarry Smith {
5393fb1732b5SBarry Smith   PetscErrorCode ierr;
5394fb1732b5SBarry Smith 
5395fb1732b5SBarry Smith   PetscFunctionBegin;
5396721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5397721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5398721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5399ed81e22dSJed Brown   PetscFunctionReturn(0);
5400ed81e22dSJed Brown }
5401ed81e22dSJed Brown 
5402ed81e22dSJed Brown /*@C
5403ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5404ed81e22dSJed Brown 
5405ed81e22dSJed Brown    Collective on TS
5406ed81e22dSJed Brown 
5407ed81e22dSJed Brown    Input Parameters:
5408ed81e22dSJed Brown +  ts - the TS context
5409ed81e22dSJed Brown .  step - current time-step
5410ed81e22dSJed Brown .  ptime - current time
54110910c330SBarry Smith .  u - current state
5412ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5413ed81e22dSJed Brown 
5414ed81e22dSJed Brown    Level: intermediate
5415ed81e22dSJed Brown 
5416ed81e22dSJed Brown    Notes:
5417ed81e22dSJed 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.
5418ed81e22dSJed Brown    These are named according to the file name template.
5419ed81e22dSJed Brown 
5420ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5421ed81e22dSJed Brown 
5422ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5423ed81e22dSJed Brown @*/
54240910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5425ed81e22dSJed Brown {
5426ed81e22dSJed Brown   PetscErrorCode ierr;
5427ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5428ed81e22dSJed Brown   PetscViewer    viewer;
5429ed81e22dSJed Brown 
5430ed81e22dSJed Brown   PetscFunctionBegin;
543163e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
54328caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5433ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
54340910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5435ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5436ed81e22dSJed Brown   PetscFunctionReturn(0);
5437ed81e22dSJed Brown }
5438ed81e22dSJed Brown 
5439ed81e22dSJed Brown /*@C
5440ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5441ed81e22dSJed Brown 
5442ed81e22dSJed Brown    Collective on TS
5443ed81e22dSJed Brown 
5444ed81e22dSJed Brown    Input Parameters:
5445ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5446ed81e22dSJed Brown 
5447ed81e22dSJed Brown    Level: intermediate
5448ed81e22dSJed Brown 
5449ed81e22dSJed Brown    Note:
5450ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5451ed81e22dSJed Brown 
5452ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5453ed81e22dSJed Brown @*/
5454ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5455ed81e22dSJed Brown {
5456ed81e22dSJed Brown   PetscErrorCode ierr;
5457ed81e22dSJed Brown 
5458ed81e22dSJed Brown   PetscFunctionBegin;
5459ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5460fb1732b5SBarry Smith   PetscFunctionReturn(0);
5461fb1732b5SBarry Smith }
5462fb1732b5SBarry Smith 
546384df9cb4SJed Brown /*@
5464552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
546584df9cb4SJed Brown 
5466ed81e22dSJed Brown    Collective on TS if controller has not been created yet
546784df9cb4SJed Brown 
546884df9cb4SJed Brown    Input Arguments:
5469ed81e22dSJed Brown .  ts - time stepping context
547084df9cb4SJed Brown 
547184df9cb4SJed Brown    Output Arguments:
5472ed81e22dSJed Brown .  adapt - adaptive controller
547384df9cb4SJed Brown 
547484df9cb4SJed Brown    Level: intermediate
547584df9cb4SJed Brown 
5476ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
547784df9cb4SJed Brown @*/
5478552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
547984df9cb4SJed Brown {
548084df9cb4SJed Brown   PetscErrorCode ierr;
548184df9cb4SJed Brown 
548284df9cb4SJed Brown   PetscFunctionBegin;
548384df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5484bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
548584df9cb4SJed Brown   if (!ts->adapt) {
5486ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
54873bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
54881c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
548984df9cb4SJed Brown   }
5490bec58848SLisandro Dalcin   *adapt = ts->adapt;
549184df9cb4SJed Brown   PetscFunctionReturn(0);
549284df9cb4SJed Brown }
5493d6ebe24aSShri Abhyankar 
54941c3436cfSJed Brown /*@
54951c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
54961c3436cfSJed Brown 
54971c3436cfSJed Brown    Logically Collective
54981c3436cfSJed Brown 
54991c3436cfSJed Brown    Input Arguments:
55001c3436cfSJed Brown +  ts - time integration context
55011c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
55020298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
55031c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
55040298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
55051c3436cfSJed Brown 
5506a3cdaa26SBarry Smith    Options Database keys:
5507a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5508a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5509a3cdaa26SBarry Smith 
55103ff766beSShri Abhyankar    Notes:
55113ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
55123ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
55133ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
55143ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
55153ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
55163ff766beSShri Abhyankar    differential variables.
55173ff766beSShri Abhyankar 
55181c3436cfSJed Brown    Level: beginner
55191c3436cfSJed Brown 
5520c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
55211c3436cfSJed Brown @*/
55221c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
55231c3436cfSJed Brown {
55241c3436cfSJed Brown   PetscErrorCode ierr;
55251c3436cfSJed Brown 
55261c3436cfSJed Brown   PetscFunctionBegin;
5527c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
55281c3436cfSJed Brown   if (vatol) {
55291c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
55301c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
55311c3436cfSJed Brown     ts->vatol = vatol;
55321c3436cfSJed Brown   }
5533c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
55341c3436cfSJed Brown   if (vrtol) {
55351c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
55361c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
55371c3436cfSJed Brown     ts->vrtol = vrtol;
55381c3436cfSJed Brown   }
55391c3436cfSJed Brown   PetscFunctionReturn(0);
55401c3436cfSJed Brown }
55411c3436cfSJed Brown 
5542c5033834SJed Brown /*@
5543c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5544c5033834SJed Brown 
5545c5033834SJed Brown    Logically Collective
5546c5033834SJed Brown 
5547c5033834SJed Brown    Input Arguments:
5548c5033834SJed Brown .  ts - time integration context
5549c5033834SJed Brown 
5550c5033834SJed Brown    Output Arguments:
55510298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
55520298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
55530298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
55540298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5555c5033834SJed Brown 
5556c5033834SJed Brown    Level: beginner
5557c5033834SJed Brown 
5558c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5559c5033834SJed Brown @*/
5560c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5561c5033834SJed Brown {
5562c5033834SJed Brown   PetscFunctionBegin;
5563c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5564c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5565c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5566c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5567c5033834SJed Brown   PetscFunctionReturn(0);
5568c5033834SJed Brown }
5569c5033834SJed Brown 
55709c6b16b5SShri Abhyankar /*@
5571a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
55729c6b16b5SShri Abhyankar 
55739c6b16b5SShri Abhyankar    Collective on TS
55749c6b16b5SShri Abhyankar 
55759c6b16b5SShri Abhyankar    Input Arguments:
55769c6b16b5SShri Abhyankar +  ts - time stepping context
5577a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5578a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
55799c6b16b5SShri Abhyankar 
55809c6b16b5SShri Abhyankar    Output Arguments:
5581a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
55827453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5583a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
55849c6b16b5SShri Abhyankar 
55859c6b16b5SShri Abhyankar    Level: developer
55869c6b16b5SShri Abhyankar 
5587deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
55889c6b16b5SShri Abhyankar @*/
55897453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
55909c6b16b5SShri Abhyankar {
55919c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
55929c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
55937453f775SEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
55947453f775SEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
55959c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
55967453f775SEmil Constantinescu   PetscReal         sum,suma,sumr,gsum,gsuma,gsumr,diff;
55977453f775SEmil Constantinescu   PetscReal         tol,tola,tolr;
55987453f775SEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
55999c6b16b5SShri Abhyankar 
56009c6b16b5SShri Abhyankar   PetscFunctionBegin;
56019c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5602a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5603a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5604a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5605a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5606a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5607a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
56088a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
56098a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
5610a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
56119c6b16b5SShri Abhyankar 
56129c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
56139c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
56149c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
56159c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
56169c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
56177453f775SEmil Constantinescu   sum  = 0.; n_loc  = 0;
56187453f775SEmil Constantinescu   suma = 0.; na_loc = 0;
56197453f775SEmil Constantinescu   sumr = 0.; nr_loc = 0;
56209c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
56219c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
56229c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
56239c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
56249c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
562576cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
56267453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
56277453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
56287453f775SEmil Constantinescu       if(tola>0.){
56297453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
56307453f775SEmil Constantinescu         na_loc++;
56317453f775SEmil Constantinescu       }
56327453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
56337453f775SEmil Constantinescu       if(tolr>0.){
56347453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
56357453f775SEmil Constantinescu         nr_loc++;
56367453f775SEmil Constantinescu       }
56377453f775SEmil Constantinescu       tol=tola+tolr;
56387453f775SEmil Constantinescu       if(tol>0.){
56397453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
56407453f775SEmil Constantinescu         n_loc++;
56417453f775SEmil Constantinescu       }
56429c6b16b5SShri Abhyankar     }
56439c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
56449c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
56459c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
56469c6b16b5SShri Abhyankar     const PetscScalar *atol;
56479c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
56489c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
564976cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
56507453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
56517453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
56527453f775SEmil Constantinescu       if(tola>0.){
56537453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
56547453f775SEmil Constantinescu         na_loc++;
56557453f775SEmil Constantinescu       }
56567453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
56577453f775SEmil Constantinescu       if(tolr>0.){
56587453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
56597453f775SEmil Constantinescu         nr_loc++;
56607453f775SEmil Constantinescu       }
56617453f775SEmil Constantinescu       tol=tola+tolr;
56627453f775SEmil Constantinescu       if(tol>0.){
56637453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
56647453f775SEmil Constantinescu         n_loc++;
56657453f775SEmil Constantinescu       }
56669c6b16b5SShri Abhyankar     }
56679c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
56689c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
56699c6b16b5SShri Abhyankar     const PetscScalar *rtol;
56709c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
56719c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
567276cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
56737453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
56747453f775SEmil Constantinescu       tola = ts->atol;
56757453f775SEmil Constantinescu       if(tola>0.){
56767453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
56777453f775SEmil Constantinescu         na_loc++;
56787453f775SEmil Constantinescu       }
56797453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
56807453f775SEmil Constantinescu       if(tolr>0.){
56817453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
56827453f775SEmil Constantinescu         nr_loc++;
56837453f775SEmil Constantinescu       }
56847453f775SEmil Constantinescu       tol=tola+tolr;
56857453f775SEmil Constantinescu       if(tol>0.){
56867453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
56877453f775SEmil Constantinescu         n_loc++;
56887453f775SEmil Constantinescu       }
56899c6b16b5SShri Abhyankar     }
56909c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
56919c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
56929c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
569376cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
56947453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
56957453f775SEmil Constantinescu       tola = ts->atol;
56967453f775SEmil Constantinescu       if(tola>0.){
56977453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
56987453f775SEmil Constantinescu         na_loc++;
56997453f775SEmil Constantinescu       }
57007453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
57017453f775SEmil Constantinescu       if(tolr>0.){
57027453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
57037453f775SEmil Constantinescu         nr_loc++;
57047453f775SEmil Constantinescu       }
57057453f775SEmil Constantinescu       tol=tola+tolr;
57067453f775SEmil Constantinescu       if(tol>0.){
57077453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
57087453f775SEmil Constantinescu         n_loc++;
57097453f775SEmil Constantinescu       }
57109c6b16b5SShri Abhyankar     }
57119c6b16b5SShri Abhyankar   }
57129c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
57139c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
57149c6b16b5SShri Abhyankar 
57157453f775SEmil Constantinescu   err_loc[0] = sum;
57167453f775SEmil Constantinescu   err_loc[1] = suma;
57177453f775SEmil Constantinescu   err_loc[2] = sumr;
57187453f775SEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
57197453f775SEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
57207453f775SEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
57217453f775SEmil Constantinescu 
5722a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
57237453f775SEmil Constantinescu 
57247453f775SEmil Constantinescu   gsum   = err_glb[0];
57257453f775SEmil Constantinescu   gsuma  = err_glb[1];
57267453f775SEmil Constantinescu   gsumr  = err_glb[2];
57277453f775SEmil Constantinescu   n_glb  = err_glb[3];
57287453f775SEmil Constantinescu   na_glb = err_glb[4];
57297453f775SEmil Constantinescu   nr_glb = err_glb[5];
57307453f775SEmil Constantinescu 
5731b1316ef9SEmil Constantinescu   *norm  = 0.;
5732b1316ef9SEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
5733b1316ef9SEmil Constantinescu   *norma = 0.;
5734b1316ef9SEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
5735b1316ef9SEmil Constantinescu   *normr = 0.;
5736b1316ef9SEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
57379c6b16b5SShri Abhyankar 
57389c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
57397453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
57407453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
57419c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
57429c6b16b5SShri Abhyankar }
57439c6b16b5SShri Abhyankar 
57449c6b16b5SShri Abhyankar /*@
5745a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
57469c6b16b5SShri Abhyankar 
57479c6b16b5SShri Abhyankar    Collective on TS
57489c6b16b5SShri Abhyankar 
57499c6b16b5SShri Abhyankar    Input Arguments:
57509c6b16b5SShri Abhyankar +  ts - time stepping context
5751a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5752a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
57539c6b16b5SShri Abhyankar 
57549c6b16b5SShri Abhyankar    Output Arguments:
5755a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
57567453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5757a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
57589c6b16b5SShri Abhyankar 
57599c6b16b5SShri Abhyankar    Level: developer
57609c6b16b5SShri Abhyankar 
5761deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
57629c6b16b5SShri Abhyankar @*/
57637453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
57649c6b16b5SShri Abhyankar {
57659c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
57667453f775SEmil Constantinescu   PetscInt          i,n,N,rstart;
57679c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
57687453f775SEmil Constantinescu   PetscReal         max,gmax,maxa,gmaxa,maxr,gmaxr;
57697453f775SEmil Constantinescu   PetscReal         tol,tola,tolr,diff;
57707453f775SEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
57719c6b16b5SShri Abhyankar 
57729c6b16b5SShri Abhyankar   PetscFunctionBegin;
57739c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5774a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5775a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5776a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5777a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5778a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5779a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
57808a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
57818a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
5782a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
57839c6b16b5SShri Abhyankar 
57849c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
57859c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
57869c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
57879c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
57889c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
57897453f775SEmil Constantinescu 
57907453f775SEmil Constantinescu   max=0.;
57917453f775SEmil Constantinescu   maxa=0.;
57927453f775SEmil Constantinescu   maxr=0.;
57937453f775SEmil Constantinescu 
57947453f775SEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
57959c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
57969c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
57979c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
57987453f775SEmil Constantinescu 
57997453f775SEmil Constantinescu     for (i=0; i<n; i++) {
580076cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
58017453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
58027453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
58037453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58047453f775SEmil Constantinescu       tol  = tola+tolr;
58057453f775SEmil Constantinescu       if(tola>0.){
58067453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
58077453f775SEmil Constantinescu       }
58087453f775SEmil Constantinescu       if(tolr>0.){
58097453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
58107453f775SEmil Constantinescu       }
58117453f775SEmil Constantinescu       if(tol>0.){
58127453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
58137453f775SEmil Constantinescu       }
58149c6b16b5SShri Abhyankar     }
58159c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58169c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58179c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
58189c6b16b5SShri Abhyankar     const PetscScalar *atol;
58199c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58207453f775SEmil Constantinescu     for (i=0; i<n; i++) {
582176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
58227453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
58237453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
58247453f775SEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58257453f775SEmil Constantinescu       tol  = tola+tolr;
58267453f775SEmil Constantinescu       if(tola>0.){
58277453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
58287453f775SEmil Constantinescu       }
58297453f775SEmil Constantinescu       if(tolr>0.){
58307453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
58317453f775SEmil Constantinescu       }
58327453f775SEmil Constantinescu       if(tol>0.){
58337453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
58347453f775SEmil Constantinescu       }
58359c6b16b5SShri Abhyankar     }
58369c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58379c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
58389c6b16b5SShri Abhyankar     const PetscScalar *rtol;
58399c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58407453f775SEmil Constantinescu 
58417453f775SEmil Constantinescu     for (i=0; i<n; i++) {
584276cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
58437453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
58447453f775SEmil Constantinescu       tola = ts->atol;
58457453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58467453f775SEmil Constantinescu       tol  = tola+tolr;
58477453f775SEmil Constantinescu       if(tola>0.){
58487453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
58497453f775SEmil Constantinescu       }
58507453f775SEmil Constantinescu       if(tolr>0.){
58517453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
58527453f775SEmil Constantinescu       }
58537453f775SEmil Constantinescu       if(tol>0.){
58547453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
58557453f775SEmil Constantinescu       }
58569c6b16b5SShri Abhyankar     }
58579c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58589c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
58597453f775SEmil Constantinescu 
58607453f775SEmil Constantinescu     for (i=0; i<n; i++) {
586176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
58627453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
58637453f775SEmil Constantinescu       tola = ts->atol;
58647453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58657453f775SEmil Constantinescu       tol  = tola+tolr;
58667453f775SEmil Constantinescu       if(tola>0.){
58677453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
58687453f775SEmil Constantinescu       }
58697453f775SEmil Constantinescu       if(tolr>0.){
58707453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
58717453f775SEmil Constantinescu       }
58727453f775SEmil Constantinescu       if(tol>0.){
58737453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
58747453f775SEmil Constantinescu       }
58759c6b16b5SShri Abhyankar     }
58769c6b16b5SShri Abhyankar   }
58779c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
58789c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
58797453f775SEmil Constantinescu   err_loc[0] = max;
58807453f775SEmil Constantinescu   err_loc[1] = maxa;
58817453f775SEmil Constantinescu   err_loc[2] = maxr;
5882a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
58837453f775SEmil Constantinescu   gmax   = err_glb[0];
58847453f775SEmil Constantinescu   gmaxa  = err_glb[1];
58857453f775SEmil Constantinescu   gmaxr  = err_glb[2];
58869c6b16b5SShri Abhyankar 
58879c6b16b5SShri Abhyankar   *norm = gmax;
58887453f775SEmil Constantinescu   *norma = gmaxa;
58897453f775SEmil Constantinescu   *normr = gmaxr;
58909c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
58917453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
58927453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
58939c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
58949c6b16b5SShri Abhyankar }
58959c6b16b5SShri Abhyankar 
58961c3436cfSJed Brown /*@
58978a175baeSEmil Constantinescu    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
58981c3436cfSJed Brown 
58991c3436cfSJed Brown    Collective on TS
59001c3436cfSJed Brown 
59011c3436cfSJed Brown    Input Arguments:
59021c3436cfSJed Brown +  ts - time stepping context
5903a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5904a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
5905a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
59067619abb3SShri 
59071c3436cfSJed Brown    Output Arguments:
5908a2b725a8SWilliam Gropp +  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
59098a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
5910a2b725a8SWilliam Gropp -  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
5911a4868fbcSLisandro Dalcin 
5912a4868fbcSLisandro Dalcin    Options Database Keys:
5913a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5914a4868fbcSLisandro Dalcin 
59151c3436cfSJed Brown    Level: developer
59161c3436cfSJed Brown 
59178a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm
59181c3436cfSJed Brown @*/
59197453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
59201c3436cfSJed Brown {
59218beabaa1SBarry Smith   PetscErrorCode ierr;
59221c3436cfSJed Brown 
59231c3436cfSJed Brown   PetscFunctionBegin;
5924a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
59257453f775SEmil Constantinescu     ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
5926a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
59277453f775SEmil Constantinescu     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
5928a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
59291c3436cfSJed Brown   PetscFunctionReturn(0);
59301c3436cfSJed Brown }
59311c3436cfSJed Brown 
59328a175baeSEmil Constantinescu 
59338a175baeSEmil Constantinescu /*@
59348a175baeSEmil Constantinescu    TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances
59358a175baeSEmil Constantinescu 
59368a175baeSEmil Constantinescu    Collective on TS
59378a175baeSEmil Constantinescu 
59388a175baeSEmil Constantinescu    Input Arguments:
59398a175baeSEmil Constantinescu +  ts - time stepping context
59408a175baeSEmil Constantinescu .  E - error vector
59418a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
59428a175baeSEmil Constantinescu -  Y - state vector, previous time step
59438a175baeSEmil Constantinescu 
59448a175baeSEmil Constantinescu    Output Arguments:
5945a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
59468a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5947a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
59488a175baeSEmil Constantinescu 
59498a175baeSEmil Constantinescu    Level: developer
59508a175baeSEmil Constantinescu 
59518a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity()
59528a175baeSEmil Constantinescu @*/
59538a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
59548a175baeSEmil Constantinescu {
59558a175baeSEmil Constantinescu   PetscErrorCode    ierr;
59568a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
59578a175baeSEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
59588a175baeSEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
59598a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
59608a175baeSEmil Constantinescu   PetscReal         err,sum,suma,sumr,gsum,gsuma,gsumr;
59618a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
59628a175baeSEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
59638a175baeSEmil Constantinescu 
59648a175baeSEmil Constantinescu   PetscFunctionBegin;
59658a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
59668a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
59678a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
59688a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
59698a175baeSEmil Constantinescu   PetscValidType(E,2);
59708a175baeSEmil Constantinescu   PetscValidType(U,3);
59718a175baeSEmil Constantinescu   PetscValidType(Y,4);
59728a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
59738a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
59748a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
59758a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
59768a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
59778a175baeSEmil Constantinescu 
59788a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
59798a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
59808a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
59818a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
59828a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
59838a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
59848a175baeSEmil Constantinescu   sum  = 0.; n_loc  = 0;
59858a175baeSEmil Constantinescu   suma = 0.; na_loc = 0;
59868a175baeSEmil Constantinescu   sumr = 0.; nr_loc = 0;
59878a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {
59888a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
59898a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59908a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59918a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
599276cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59938a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
59948a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
59958a175baeSEmil Constantinescu       if(tola>0.){
59968a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
59978a175baeSEmil Constantinescu         na_loc++;
59988a175baeSEmil Constantinescu       }
59998a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60008a175baeSEmil Constantinescu       if(tolr>0.){
60018a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
60028a175baeSEmil Constantinescu         nr_loc++;
60038a175baeSEmil Constantinescu       }
60048a175baeSEmil Constantinescu       tol=tola+tolr;
60058a175baeSEmil Constantinescu       if(tol>0.){
60068a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
60078a175baeSEmil Constantinescu         n_loc++;
60088a175baeSEmil Constantinescu       }
60098a175baeSEmil Constantinescu     }
60108a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60118a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60128a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
60138a175baeSEmil Constantinescu     const PetscScalar *atol;
60148a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60158a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
601676cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
60178a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
60188a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
60198a175baeSEmil Constantinescu       if(tola>0.){
60208a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
60218a175baeSEmil Constantinescu         na_loc++;
60228a175baeSEmil Constantinescu       }
60238a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60248a175baeSEmil Constantinescu       if(tolr>0.){
60258a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
60268a175baeSEmil Constantinescu         nr_loc++;
60278a175baeSEmil Constantinescu       }
60288a175baeSEmil Constantinescu       tol=tola+tolr;
60298a175baeSEmil Constantinescu       if(tol>0.){
60308a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
60318a175baeSEmil Constantinescu         n_loc++;
60328a175baeSEmil Constantinescu       }
60338a175baeSEmil Constantinescu     }
60348a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60358a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
60368a175baeSEmil Constantinescu     const PetscScalar *rtol;
60378a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60388a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
603976cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
60408a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
60418a175baeSEmil Constantinescu       tola = ts->atol;
60428a175baeSEmil Constantinescu       if(tola>0.){
60438a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
60448a175baeSEmil Constantinescu         na_loc++;
60458a175baeSEmil Constantinescu       }
60468a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60478a175baeSEmil Constantinescu       if(tolr>0.){
60488a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
60498a175baeSEmil Constantinescu         nr_loc++;
60508a175baeSEmil Constantinescu       }
60518a175baeSEmil Constantinescu       tol=tola+tolr;
60528a175baeSEmil Constantinescu       if(tol>0.){
60538a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
60548a175baeSEmil Constantinescu         n_loc++;
60558a175baeSEmil Constantinescu       }
60568a175baeSEmil Constantinescu     }
60578a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60588a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
60598a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
606076cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
60618a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
60628a175baeSEmil Constantinescu       tola = ts->atol;
60638a175baeSEmil Constantinescu       if(tola>0.){
60648a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
60658a175baeSEmil Constantinescu         na_loc++;
60668a175baeSEmil Constantinescu       }
60678a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60688a175baeSEmil Constantinescu       if(tolr>0.){
60698a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
60708a175baeSEmil Constantinescu         nr_loc++;
60718a175baeSEmil Constantinescu       }
60728a175baeSEmil Constantinescu       tol=tola+tolr;
60738a175baeSEmil Constantinescu       if(tol>0.){
60748a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
60758a175baeSEmil Constantinescu         n_loc++;
60768a175baeSEmil Constantinescu       }
60778a175baeSEmil Constantinescu     }
60788a175baeSEmil Constantinescu   }
60798a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
60808a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
60818a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
60828a175baeSEmil Constantinescu 
60838a175baeSEmil Constantinescu   err_loc[0] = sum;
60848a175baeSEmil Constantinescu   err_loc[1] = suma;
60858a175baeSEmil Constantinescu   err_loc[2] = sumr;
60868a175baeSEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
60878a175baeSEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
60888a175baeSEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
60898a175baeSEmil Constantinescu 
6090a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
60918a175baeSEmil Constantinescu 
60928a175baeSEmil Constantinescu   gsum   = err_glb[0];
60938a175baeSEmil Constantinescu   gsuma  = err_glb[1];
60948a175baeSEmil Constantinescu   gsumr  = err_glb[2];
60958a175baeSEmil Constantinescu   n_glb  = err_glb[3];
60968a175baeSEmil Constantinescu   na_glb = err_glb[4];
60978a175baeSEmil Constantinescu   nr_glb = err_glb[5];
60988a175baeSEmil Constantinescu 
60998a175baeSEmil Constantinescu   *norm  = 0.;
61008a175baeSEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
61018a175baeSEmil Constantinescu   *norma = 0.;
61028a175baeSEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
61038a175baeSEmil Constantinescu   *normr = 0.;
61048a175baeSEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
61058a175baeSEmil Constantinescu 
61068a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
61078a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
61088a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
61098a175baeSEmil Constantinescu   PetscFunctionReturn(0);
61108a175baeSEmil Constantinescu }
61118a175baeSEmil Constantinescu 
61128a175baeSEmil Constantinescu /*@
61138a175baeSEmil Constantinescu    TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances
61148a175baeSEmil Constantinescu    Collective on TS
61158a175baeSEmil Constantinescu 
61168a175baeSEmil Constantinescu    Input Arguments:
61178a175baeSEmil Constantinescu +  ts - time stepping context
61188a175baeSEmil Constantinescu .  E - error vector
61198a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
61208a175baeSEmil Constantinescu -  Y - state vector, previous time step
61218a175baeSEmil Constantinescu 
61228a175baeSEmil Constantinescu    Output Arguments:
6123a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
61248a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
6125a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
61268a175baeSEmil Constantinescu 
61278a175baeSEmil Constantinescu    Level: developer
61288a175baeSEmil Constantinescu 
61298a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2()
61308a175baeSEmil Constantinescu @*/
61318a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
61328a175baeSEmil Constantinescu {
61338a175baeSEmil Constantinescu   PetscErrorCode    ierr;
61348a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
61358a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
61368a175baeSEmil Constantinescu   PetscReal         err,max,gmax,maxa,gmaxa,maxr,gmaxr;
61378a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
61388a175baeSEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
61398a175baeSEmil Constantinescu 
61408a175baeSEmil Constantinescu   PetscFunctionBegin;
61418a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
61428a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
61438a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
61448a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
61458a175baeSEmil Constantinescu   PetscValidType(E,2);
61468a175baeSEmil Constantinescu   PetscValidType(U,3);
61478a175baeSEmil Constantinescu   PetscValidType(Y,4);
61488a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
61498a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
61508a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
61518a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
61528a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
61538a175baeSEmil Constantinescu 
61548a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
61558a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
61568a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
61578a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
61588a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
61598a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
61608a175baeSEmil Constantinescu 
61618a175baeSEmil Constantinescu   max=0.;
61628a175baeSEmil Constantinescu   maxa=0.;
61638a175baeSEmil Constantinescu   maxr=0.;
61648a175baeSEmil Constantinescu 
61658a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
61668a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
61678a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61688a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61698a175baeSEmil Constantinescu 
61708a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
617176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61728a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61738a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
61748a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61758a175baeSEmil Constantinescu       tol  = tola+tolr;
61768a175baeSEmil Constantinescu       if(tola>0.){
61778a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
61788a175baeSEmil Constantinescu       }
61798a175baeSEmil Constantinescu       if(tolr>0.){
61808a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
61818a175baeSEmil Constantinescu       }
61828a175baeSEmil Constantinescu       if(tol>0.){
61838a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
61848a175baeSEmil Constantinescu       }
61858a175baeSEmil Constantinescu     }
61868a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61878a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61888a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
61898a175baeSEmil Constantinescu     const PetscScalar *atol;
61908a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61918a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
619276cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61938a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61948a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
61958a175baeSEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61968a175baeSEmil Constantinescu       tol  = tola+tolr;
61978a175baeSEmil Constantinescu       if(tola>0.){
61988a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
61998a175baeSEmil Constantinescu       }
62008a175baeSEmil Constantinescu       if(tolr>0.){
62018a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
62028a175baeSEmil Constantinescu       }
62038a175baeSEmil Constantinescu       if(tol>0.){
62048a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
62058a175baeSEmil Constantinescu       }
62068a175baeSEmil Constantinescu     }
62078a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
62088a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
62098a175baeSEmil Constantinescu     const PetscScalar *rtol;
62108a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62118a175baeSEmil Constantinescu 
62128a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
621376cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
62148a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
62158a175baeSEmil Constantinescu       tola = ts->atol;
62168a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62178a175baeSEmil Constantinescu       tol  = tola+tolr;
62188a175baeSEmil Constantinescu       if(tola>0.){
62198a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
62208a175baeSEmil Constantinescu       }
62218a175baeSEmil Constantinescu       if(tolr>0.){
62228a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
62238a175baeSEmil Constantinescu       }
62248a175baeSEmil Constantinescu       if(tol>0.){
62258a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
62268a175baeSEmil Constantinescu       }
62278a175baeSEmil Constantinescu     }
62288a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62298a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
62308a175baeSEmil Constantinescu 
62318a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
623276cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
62338a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
62348a175baeSEmil Constantinescu       tola = ts->atol;
62358a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62368a175baeSEmil Constantinescu       tol  = tola+tolr;
62378a175baeSEmil Constantinescu       if(tola>0.){
62388a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
62398a175baeSEmil Constantinescu       }
62408a175baeSEmil Constantinescu       if(tolr>0.){
62418a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
62428a175baeSEmil Constantinescu       }
62438a175baeSEmil Constantinescu       if(tol>0.){
62448a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
62458a175baeSEmil Constantinescu       }
62468a175baeSEmil Constantinescu     }
62478a175baeSEmil Constantinescu   }
62488a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
62498a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
62508a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
62518a175baeSEmil Constantinescu   err_loc[0] = max;
62528a175baeSEmil Constantinescu   err_loc[1] = maxa;
62538a175baeSEmil Constantinescu   err_loc[2] = maxr;
6254a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
62558a175baeSEmil Constantinescu   gmax   = err_glb[0];
62568a175baeSEmil Constantinescu   gmaxa  = err_glb[1];
62578a175baeSEmil Constantinescu   gmaxr  = err_glb[2];
62588a175baeSEmil Constantinescu 
62598a175baeSEmil Constantinescu   *norm = gmax;
62608a175baeSEmil Constantinescu   *norma = gmaxa;
62618a175baeSEmil Constantinescu   *normr = gmaxr;
62628a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
62638a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
62648a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
62658a175baeSEmil Constantinescu   PetscFunctionReturn(0);
62668a175baeSEmil Constantinescu }
62678a175baeSEmil Constantinescu 
62688a175baeSEmil Constantinescu /*@
62698a175baeSEmil Constantinescu    TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
62708a175baeSEmil Constantinescu 
62718a175baeSEmil Constantinescu    Collective on TS
62728a175baeSEmil Constantinescu 
62738a175baeSEmil Constantinescu    Input Arguments:
62748a175baeSEmil Constantinescu +  ts - time stepping context
62758a175baeSEmil Constantinescu .  E - error vector
62768a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
62778a175baeSEmil Constantinescu .  Y - state vector, previous time step
62788a175baeSEmil Constantinescu -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
62798a175baeSEmil Constantinescu 
62808a175baeSEmil Constantinescu    Output Arguments:
6281a2b725a8SWilliam Gropp +  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
62828a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
6283a2b725a8SWilliam Gropp -  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
62848a175baeSEmil Constantinescu 
62858a175baeSEmil Constantinescu    Options Database Keys:
62868a175baeSEmil Constantinescu .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
62878a175baeSEmil Constantinescu 
62888a175baeSEmil Constantinescu    Level: developer
62898a175baeSEmil Constantinescu 
62908a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
62918a175baeSEmil Constantinescu @*/
62928a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
62938a175baeSEmil Constantinescu {
62948a175baeSEmil Constantinescu   PetscErrorCode ierr;
62958a175baeSEmil Constantinescu 
62968a175baeSEmil Constantinescu   PetscFunctionBegin;
62978a175baeSEmil Constantinescu   if (wnormtype == NORM_2) {
62988a175baeSEmil Constantinescu     ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
62998a175baeSEmil Constantinescu   } else if(wnormtype == NORM_INFINITY) {
63008a175baeSEmil Constantinescu     ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
63018a175baeSEmil Constantinescu   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
63028a175baeSEmil Constantinescu   PetscFunctionReturn(0);
63038a175baeSEmil Constantinescu }
63048a175baeSEmil Constantinescu 
63058a175baeSEmil Constantinescu 
63068d59e960SJed Brown /*@
63078d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
63088d59e960SJed Brown 
63098d59e960SJed Brown    Logically Collective on TS
63108d59e960SJed Brown 
63118d59e960SJed Brown    Input Arguments:
63128d59e960SJed Brown +  ts - time stepping context
63138d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
63148d59e960SJed Brown 
63158d59e960SJed Brown    Note:
63168d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
63178d59e960SJed Brown 
63188d59e960SJed Brown    Level: intermediate
63198d59e960SJed Brown 
63208d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
63218d59e960SJed Brown @*/
63228d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
63238d59e960SJed Brown {
63248d59e960SJed Brown   PetscFunctionBegin;
63258d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
63268d59e960SJed Brown   ts->cfltime_local = cfltime;
63278d59e960SJed Brown   ts->cfltime       = -1.;
63288d59e960SJed Brown   PetscFunctionReturn(0);
63298d59e960SJed Brown }
63308d59e960SJed Brown 
63318d59e960SJed Brown /*@
63328d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
63338d59e960SJed Brown 
63348d59e960SJed Brown    Collective on TS
63358d59e960SJed Brown 
63368d59e960SJed Brown    Input Arguments:
63378d59e960SJed Brown .  ts - time stepping context
63388d59e960SJed Brown 
63398d59e960SJed Brown    Output Arguments:
63408d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
63418d59e960SJed Brown 
63428d59e960SJed Brown    Level: advanced
63438d59e960SJed Brown 
63448d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
63458d59e960SJed Brown @*/
63468d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
63478d59e960SJed Brown {
63488d59e960SJed Brown   PetscErrorCode ierr;
63498d59e960SJed Brown 
63508d59e960SJed Brown   PetscFunctionBegin;
63518d59e960SJed Brown   if (ts->cfltime < 0) {
6352b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
63538d59e960SJed Brown   }
63548d59e960SJed Brown   *cfltime = ts->cfltime;
63558d59e960SJed Brown   PetscFunctionReturn(0);
63568d59e960SJed Brown }
63578d59e960SJed Brown 
6358d6ebe24aSShri Abhyankar /*@
6359d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6360d6ebe24aSShri Abhyankar 
6361d6ebe24aSShri Abhyankar    Input Parameters:
6362a2b725a8SWilliam Gropp +  ts   - the TS context.
6363d6ebe24aSShri Abhyankar .  xl   - lower bound.
6364a2b725a8SWilliam Gropp -  xu   - upper bound.
6365d6ebe24aSShri Abhyankar 
6366d6ebe24aSShri Abhyankar    Notes:
6367d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6368e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6369d6ebe24aSShri Abhyankar 
63702bd2b0e6SSatish Balay    Level: advanced
63712bd2b0e6SSatish Balay 
6372d6ebe24aSShri Abhyankar @*/
6373d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6374d6ebe24aSShri Abhyankar {
6375d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6376d6ebe24aSShri Abhyankar   SNES           snes;
6377d6ebe24aSShri Abhyankar 
6378d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6379d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6380d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6381d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6382d6ebe24aSShri Abhyankar }
6383d6ebe24aSShri Abhyankar 
6384b3603a34SBarry Smith /*@C
63854f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
6386b3603a34SBarry Smith        in a time based line graph
6387b3603a34SBarry Smith 
6388b3603a34SBarry Smith    Collective on TS
6389b3603a34SBarry Smith 
6390b3603a34SBarry Smith    Input Parameters:
6391b3603a34SBarry Smith +  ts - the TS context
6392b3603a34SBarry Smith .  step - current time-step
6393b3603a34SBarry Smith .  ptime - current time
63947db568b7SBarry Smith .  u - current solution
63957db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
6396b3603a34SBarry Smith 
6397b3d3934dSBarry Smith    Options Database:
63989ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
6399b3d3934dSBarry Smith 
6400b3603a34SBarry Smith    Level: intermediate
6401b3603a34SBarry Smith 
640295452b02SPatrick Sanan    Notes:
640395452b02SPatrick Sanan     Each process in a parallel run displays its component solutions in a separate window
6404b3603a34SBarry Smith 
64057db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
64067db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
64077db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
64087db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
6409b3603a34SBarry Smith @*/
64107db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6411b3603a34SBarry Smith {
6412b3603a34SBarry Smith   PetscErrorCode    ierr;
64137db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
6414b3603a34SBarry Smith   const PetscScalar *yy;
641580666b62SBarry Smith   Vec               v;
6416b3603a34SBarry Smith 
6417b3603a34SBarry Smith   PetscFunctionBegin;
641863e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
641958ff32f7SBarry Smith   if (!step) {
6420a9f9c1f6SBarry Smith     PetscDrawAxis axis;
64216934998bSLisandro Dalcin     PetscInt      dim;
6422a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
64230ec8ee2bSJoseph Pusztay     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
6424bab0a581SBarry Smith     if (!ctx->names) {
6425bab0a581SBarry Smith       PetscBool flg;
6426bab0a581SBarry Smith       /* user provides names of variables to plot but no names has been set so assume names are integer values */
6427bab0a581SBarry Smith       ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr);
6428bab0a581SBarry Smith       if (flg) {
6429bab0a581SBarry Smith         PetscInt i,n;
6430bab0a581SBarry Smith         char     **names;
6431bab0a581SBarry Smith         ierr = VecGetSize(u,&n);CHKERRQ(ierr);
6432bab0a581SBarry Smith         ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr);
6433bab0a581SBarry Smith         for (i=0; i<n; i++) {
6434bab0a581SBarry Smith           ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr);
6435bab0a581SBarry Smith           ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr);
6436bab0a581SBarry Smith         }
6437bab0a581SBarry Smith         names[n] = NULL;
6438bab0a581SBarry Smith         ctx->names = names;
6439bab0a581SBarry Smith       }
6440bab0a581SBarry Smith     }
6441387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
6442387f4636SBarry Smith       char      **displaynames;
6443387f4636SBarry Smith       PetscBool flg;
6444387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6445580bdb30SBarry Smith       ierr = PetscCalloc1(dim+1,&displaynames);CHKERRQ(ierr);
6446c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
6447387f4636SBarry Smith       if (flg) {
6448a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
6449387f4636SBarry Smith       }
6450387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
6451387f4636SBarry Smith     }
6452387f4636SBarry Smith     if (ctx->displaynames) {
6453387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
6454387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
6455387f4636SBarry Smith     } else if (ctx->names) {
64560910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
64570b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6458387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
6459b0bc92c6SBarry Smith     } else {
6460b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6461b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6462387f4636SBarry Smith     }
64630b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
646458ff32f7SBarry Smith   }
64656934998bSLisandro Dalcin 
64666934998bSLisandro Dalcin   if (!ctx->transform) v = u;
64676934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
646880666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
64696934998bSLisandro Dalcin   if (ctx->displaynames) {
64706934998bSLisandro Dalcin     PetscInt i;
64716934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
64726934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
64736934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
64746934998bSLisandro Dalcin   } else {
6475e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6476e3efe391SJed Brown     PetscInt  i,n;
64776934998bSLisandro Dalcin     PetscReal *yreal;
647880666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
6479785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6480e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
64810b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6482e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6483e3efe391SJed Brown #else
64840b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6485e3efe391SJed Brown #endif
648680666b62SBarry Smith   }
64876934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
64886934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
64896934998bSLisandro Dalcin 
6490b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
64910b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
64926934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
64933923b477SBarry Smith   }
6494b3603a34SBarry Smith   PetscFunctionReturn(0);
6495b3603a34SBarry Smith }
6496b3603a34SBarry Smith 
6497b037adc7SBarry Smith /*@C
649831152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6499b037adc7SBarry Smith 
6500b037adc7SBarry Smith    Collective on TS
6501b037adc7SBarry Smith 
6502b037adc7SBarry Smith    Input Parameters:
6503b037adc7SBarry Smith +  ts - the TS context
6504b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
6505b037adc7SBarry Smith 
6506b037adc7SBarry Smith    Level: intermediate
6507b037adc7SBarry Smith 
650895452b02SPatrick Sanan    Notes:
650995452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
65107db568b7SBarry Smith 
6511a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
6512b037adc7SBarry Smith @*/
651331152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
6514b037adc7SBarry Smith {
6515b037adc7SBarry Smith   PetscErrorCode    ierr;
6516b037adc7SBarry Smith   PetscInt          i;
6517b037adc7SBarry Smith 
6518b037adc7SBarry Smith   PetscFunctionBegin;
6519b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6520b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
65215537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
6522b3d3934dSBarry Smith       break;
6523b3d3934dSBarry Smith     }
6524b3d3934dSBarry Smith   }
6525b3d3934dSBarry Smith   PetscFunctionReturn(0);
6526b3d3934dSBarry Smith }
6527b3d3934dSBarry Smith 
6528e673d494SBarry Smith /*@C
6529e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6530e673d494SBarry Smith 
6531e673d494SBarry Smith    Collective on TS
6532e673d494SBarry Smith 
6533e673d494SBarry Smith    Input Parameters:
6534e673d494SBarry Smith +  ts - the TS context
6535e673d494SBarry Smith -  names - the names of the components, final string must be NULL
6536e673d494SBarry Smith 
6537e673d494SBarry Smith    Level: intermediate
6538e673d494SBarry Smith 
6539a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
6540e673d494SBarry Smith @*/
6541e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
6542e673d494SBarry Smith {
6543e673d494SBarry Smith   PetscErrorCode    ierr;
6544e673d494SBarry Smith 
6545e673d494SBarry Smith   PetscFunctionBegin;
6546e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
6547e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
6548e673d494SBarry Smith   PetscFunctionReturn(0);
6549e673d494SBarry Smith }
6550e673d494SBarry Smith 
6551b3d3934dSBarry Smith /*@C
6552b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
6553b3d3934dSBarry Smith 
6554b3d3934dSBarry Smith    Collective on TS
6555b3d3934dSBarry Smith 
6556b3d3934dSBarry Smith    Input Parameter:
6557b3d3934dSBarry Smith .  ts - the TS context
6558b3d3934dSBarry Smith 
6559b3d3934dSBarry Smith    Output Parameter:
6560b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
6561b3d3934dSBarry Smith 
6562b3d3934dSBarry Smith    Level: intermediate
6563b3d3934dSBarry Smith 
656495452b02SPatrick Sanan    Notes:
656595452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
65667db568b7SBarry Smith 
6567b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6568b3d3934dSBarry Smith @*/
6569b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
6570b3d3934dSBarry Smith {
6571b3d3934dSBarry Smith   PetscInt       i;
6572b3d3934dSBarry Smith 
6573b3d3934dSBarry Smith   PetscFunctionBegin;
6574b3d3934dSBarry Smith   *names = NULL;
6575b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6576b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
65775537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
6578b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
6579b3d3934dSBarry Smith       break;
6580387f4636SBarry Smith     }
6581387f4636SBarry Smith   }
6582387f4636SBarry Smith   PetscFunctionReturn(0);
6583387f4636SBarry Smith }
6584387f4636SBarry Smith 
6585a66092f1SBarry Smith /*@C
6586a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
6587a66092f1SBarry Smith 
6588a66092f1SBarry Smith    Collective on TS
6589a66092f1SBarry Smith 
6590a66092f1SBarry Smith    Input Parameters:
6591a66092f1SBarry Smith +  ctx - the TSMonitorLG context
6592a2b725a8SWilliam Gropp -  displaynames - the names of the components, final string must be NULL
6593a66092f1SBarry Smith 
6594a66092f1SBarry Smith    Level: intermediate
6595a66092f1SBarry Smith 
6596a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6597a66092f1SBarry Smith @*/
6598a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6599a66092f1SBarry Smith {
6600a66092f1SBarry Smith   PetscInt          j = 0,k;
6601a66092f1SBarry Smith   PetscErrorCode    ierr;
6602a66092f1SBarry Smith 
6603a66092f1SBarry Smith   PetscFunctionBegin;
6604a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6605a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6606a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6607a66092f1SBarry Smith   while (displaynames[j]) j++;
6608a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6609a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6610a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6611a66092f1SBarry Smith   j = 0;
6612a66092f1SBarry Smith   while (displaynames[j]) {
6613a66092f1SBarry Smith     k = 0;
6614a66092f1SBarry Smith     while (ctx->names[k]) {
6615a66092f1SBarry Smith       PetscBool flg;
6616a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6617a66092f1SBarry Smith       if (flg) {
6618a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6619a66092f1SBarry Smith         break;
6620a66092f1SBarry Smith       }
6621a66092f1SBarry Smith       k++;
6622a66092f1SBarry Smith     }
6623a66092f1SBarry Smith     j++;
6624a66092f1SBarry Smith   }
6625a66092f1SBarry Smith   PetscFunctionReturn(0);
6626a66092f1SBarry Smith }
6627a66092f1SBarry Smith 
6628387f4636SBarry Smith /*@C
6629387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6630387f4636SBarry Smith 
6631387f4636SBarry Smith    Collective on TS
6632387f4636SBarry Smith 
6633387f4636SBarry Smith    Input Parameters:
6634387f4636SBarry Smith +  ts - the TS context
6635a2b725a8SWilliam Gropp -  displaynames - the names of the components, final string must be NULL
6636387f4636SBarry Smith 
663795452b02SPatrick Sanan    Notes:
663895452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66397db568b7SBarry Smith 
6640387f4636SBarry Smith    Level: intermediate
6641387f4636SBarry Smith 
6642387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6643387f4636SBarry Smith @*/
6644387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6645387f4636SBarry Smith {
6646a66092f1SBarry Smith   PetscInt          i;
6647387f4636SBarry Smith   PetscErrorCode    ierr;
6648387f4636SBarry Smith 
6649387f4636SBarry Smith   PetscFunctionBegin;
6650387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6651387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
66525537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6653b3d3934dSBarry Smith       break;
6654b037adc7SBarry Smith     }
6655b037adc7SBarry Smith   }
6656b037adc7SBarry Smith   PetscFunctionReturn(0);
6657b037adc7SBarry Smith }
6658b037adc7SBarry Smith 
665980666b62SBarry Smith /*@C
666080666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
666180666b62SBarry Smith 
666280666b62SBarry Smith    Collective on TS
666380666b62SBarry Smith 
666480666b62SBarry Smith    Input Parameters:
666580666b62SBarry Smith +  ts - the TS context
666680666b62SBarry Smith .  transform - the transform function
66677684fa3eSBarry Smith .  destroy - function to destroy the optional context
666880666b62SBarry Smith -  ctx - optional context used by transform function
666980666b62SBarry Smith 
667095452b02SPatrick Sanan    Notes:
667195452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66727db568b7SBarry Smith 
667380666b62SBarry Smith    Level: intermediate
667480666b62SBarry Smith 
6675a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
667680666b62SBarry Smith @*/
66777684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
667880666b62SBarry Smith {
667980666b62SBarry Smith   PetscInt          i;
6680a66092f1SBarry Smith   PetscErrorCode    ierr;
668180666b62SBarry Smith 
668280666b62SBarry Smith   PetscFunctionBegin;
668380666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
668480666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
66855537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
668680666b62SBarry Smith     }
668780666b62SBarry Smith   }
668880666b62SBarry Smith   PetscFunctionReturn(0);
668980666b62SBarry Smith }
669080666b62SBarry Smith 
6691e673d494SBarry Smith /*@C
6692e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6693e673d494SBarry Smith 
6694e673d494SBarry Smith    Collective on TSLGCtx
6695e673d494SBarry Smith 
6696e673d494SBarry Smith    Input Parameters:
6697e673d494SBarry Smith +  ts - the TS context
6698e673d494SBarry Smith .  transform - the transform function
66997684fa3eSBarry Smith .  destroy - function to destroy the optional context
6700e673d494SBarry Smith -  ctx - optional context used by transform function
6701e673d494SBarry Smith 
6702e673d494SBarry Smith    Level: intermediate
6703e673d494SBarry Smith 
6704a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6705e673d494SBarry Smith @*/
67067684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6707e673d494SBarry Smith {
6708e673d494SBarry Smith   PetscFunctionBegin;
6709e673d494SBarry Smith   ctx->transform    = transform;
67107684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6711e673d494SBarry Smith   ctx->transformctx = tctx;
6712e673d494SBarry Smith   PetscFunctionReturn(0);
6713e673d494SBarry Smith }
6714e673d494SBarry Smith 
6715ef20d060SBarry Smith /*@C
67168b668821SLisandro Dalcin    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the error
6717ef20d060SBarry Smith        in a time based line graph
6718ef20d060SBarry Smith 
6719ef20d060SBarry Smith    Collective on TS
6720ef20d060SBarry Smith 
6721ef20d060SBarry Smith    Input Parameters:
6722ef20d060SBarry Smith +  ts - the TS context
6723ef20d060SBarry Smith .  step - current time-step
6724ef20d060SBarry Smith .  ptime - current time
67257db568b7SBarry Smith .  u - current solution
67267db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6727ef20d060SBarry Smith 
6728ef20d060SBarry Smith    Level: intermediate
6729ef20d060SBarry Smith 
673095452b02SPatrick Sanan    Notes:
673195452b02SPatrick Sanan     Each process in a parallel run displays its component errors in a separate window
6732abd5a294SJed Brown 
6733abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6734abd5a294SJed Brown 
6735abd5a294SJed Brown    Options Database Keys:
67364f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6737ef20d060SBarry Smith 
6738abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6739ef20d060SBarry Smith @*/
67400910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6741ef20d060SBarry Smith {
6742ef20d060SBarry Smith   PetscErrorCode    ierr;
67430b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6744ef20d060SBarry Smith   const PetscScalar *yy;
6745ef20d060SBarry Smith   Vec               y;
6746ef20d060SBarry Smith 
6747ef20d060SBarry Smith   PetscFunctionBegin;
6748a9f9c1f6SBarry Smith   if (!step) {
6749a9f9c1f6SBarry Smith     PetscDrawAxis axis;
67506934998bSLisandro Dalcin     PetscInt      dim;
6751a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
67528b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Error");CHKERRQ(ierr);
67530910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6754a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6755a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6756a9f9c1f6SBarry Smith   }
67570910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6758ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
67590910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6760ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6761e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6762e3efe391SJed Brown   {
6763e3efe391SJed Brown     PetscReal *yreal;
6764e3efe391SJed Brown     PetscInt  i,n;
6765e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6766785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6767e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
67680b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6769e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6770e3efe391SJed Brown   }
6771e3efe391SJed Brown #else
67720b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6773e3efe391SJed Brown #endif
6774ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6775ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6776b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
67770b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
67786934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
67793923b477SBarry Smith   }
6780ef20d060SBarry Smith   PetscFunctionReturn(0);
6781ef20d060SBarry Smith }
6782ef20d060SBarry Smith 
67835e3b7effSJoseph Pusztay /*@C
67845e3b7effSJoseph Pusztay    TSMonitorSPSwarmSolution - Graphically displays phase plots of DMSwarm particles on a scatter plot
67855e3b7effSJoseph Pusztay 
67865e3b7effSJoseph Pusztay    Input Parameters:
67875e3b7effSJoseph Pusztay +  ts - the TS context
67885e3b7effSJoseph Pusztay .  step - current time-step
67895e3b7effSJoseph Pusztay .  ptime - current time
67905e3b7effSJoseph Pusztay .  u - current solution
67915e3b7effSJoseph Pusztay -  dctx - the TSMonitorSPCtx object that contains all the options for the monitoring, this is created with TSMonitorSPCtxCreate()
67925e3b7effSJoseph Pusztay 
67935e3b7effSJoseph Pusztay    Options Database:
6794918b1d10SJoseph Pusztay .   -ts_monitor_sp_swarm
67955e3b7effSJoseph Pusztay 
67965e3b7effSJoseph Pusztay    Level: intermediate
67975e3b7effSJoseph Pusztay 
67985e3b7effSJoseph Pusztay @*/
67990ec8ee2bSJoseph Pusztay PetscErrorCode TSMonitorSPSwarmSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
68001b575b74SJoseph Pusztay {
68011b575b74SJoseph Pusztay   PetscErrorCode    ierr;
68021b575b74SJoseph Pusztay   TSMonitorSPCtx    ctx = (TSMonitorSPCtx)dctx;
68031b575b74SJoseph Pusztay   const PetscScalar *yy;
6804b1670a61SJoseph Pusztay   PetscReal       *y,*x;
68051b575b74SJoseph Pusztay   PetscInt          Np, p, dim=2;
68061b575b74SJoseph Pusztay   DM                dm;
68071b575b74SJoseph Pusztay 
68081b575b74SJoseph Pusztay   PetscFunctionBegin;
68091b575b74SJoseph Pusztay 
68101b575b74SJoseph Pusztay   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
68111b575b74SJoseph Pusztay   if (!step) {
68121b575b74SJoseph Pusztay     PetscDrawAxis axis;
68131b575b74SJoseph Pusztay     ierr = PetscDrawSPGetAxis(ctx->sp,&axis);CHKERRQ(ierr);
68141b575b74SJoseph Pusztay     ierr = PetscDrawAxisSetLabels(axis,"Particles","X","Y");CHKERRQ(ierr);
6815895f37d5SJoseph Pusztay     ierr = PetscDrawAxisSetLimits(axis, -5, 5, -5, 5);CHKERRQ(ierr);
6816895f37d5SJoseph Pusztay     ierr = PetscDrawAxisSetHoldLimits(axis, PETSC_TRUE);CHKERRQ(ierr);
68171b575b74SJoseph Pusztay     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
68181b575b74SJoseph Pusztay     ierr = DMGetDimension(dm, &dim);
68191b575b74SJoseph Pusztay     if(dim!=2) SETERRQ(PETSC_COMM_SELF, ierr, "Dimensions improper for monitor arguments! Current support: two dimensions.");CHKERRQ(ierr);
68201b575b74SJoseph Pusztay     ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr);
68211b575b74SJoseph Pusztay     Np /= 2*dim;
68221b575b74SJoseph Pusztay     ierr = PetscDrawSPSetDimension(ctx->sp, Np);CHKERRQ(ierr);
68231b575b74SJoseph Pusztay     ierr = PetscDrawSPReset(ctx->sp);CHKERRQ(ierr);
68241b575b74SJoseph Pusztay   }
68251b575b74SJoseph Pusztay 
68261b575b74SJoseph Pusztay   ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr);
68271b575b74SJoseph Pusztay   Np /= 2*dim;
68281b575b74SJoseph Pusztay   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
6829895f37d5SJoseph Pusztay   ierr = PetscMalloc2(Np, &x, Np, &y);CHKERRQ(ierr);
68301b575b74SJoseph Pusztay   /* get points from solution vector */
68311b575b74SJoseph Pusztay   for (p=0; p<Np; ++p){
6832b1670a61SJoseph Pusztay     x[p] = PetscRealPart(yy[2*dim*p]);
6833b1670a61SJoseph Pusztay     y[p] = PetscRealPart(yy[2*dim*p+1]);
6834895f37d5SJoseph Pusztay   }
68351b575b74SJoseph Pusztay   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
68361b575b74SJoseph Pusztay 
68371b575b74SJoseph Pusztay   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
68381b575b74SJoseph Pusztay     ierr = PetscDrawSPAddPoint(ctx->sp,x,y);CHKERRQ(ierr);
68391b575b74SJoseph Pusztay     ierr = PetscDrawSPDraw(ctx->sp,PETSC_FALSE);CHKERRQ(ierr);
68401b575b74SJoseph Pusztay     ierr = PetscDrawSPSave(ctx->sp);CHKERRQ(ierr);
68411b575b74SJoseph Pusztay   }
68421b575b74SJoseph Pusztay 
6843918b1d10SJoseph Pusztay   ierr = PetscFree2(x, y);CHKERRQ(ierr);
6844918b1d10SJoseph Pusztay 
68451b575b74SJoseph Pusztay   PetscFunctionReturn(0);
68461b575b74SJoseph Pusztay }
68471b575b74SJoseph Pusztay 
68481b575b74SJoseph Pusztay 
68491b575b74SJoseph Pusztay 
68507cf37e64SBarry Smith /*@C
68517cf37e64SBarry Smith    TSMonitorError - Monitors progress of the TS solvers by printing the 2 norm of the error at each timestep
68527cf37e64SBarry Smith 
68537cf37e64SBarry Smith    Collective on TS
68547cf37e64SBarry Smith 
68557cf37e64SBarry Smith    Input Parameters:
68567cf37e64SBarry Smith +  ts - the TS context
68577cf37e64SBarry Smith .  step - current time-step
68587cf37e64SBarry Smith .  ptime - current time
68597cf37e64SBarry Smith .  u - current solution
68607cf37e64SBarry Smith -  dctx - unused context
68617cf37e64SBarry Smith 
68627cf37e64SBarry Smith    Level: intermediate
68637cf37e64SBarry Smith 
68647cf37e64SBarry Smith    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
68657cf37e64SBarry Smith 
68667cf37e64SBarry Smith    Options Database Keys:
68677cf37e64SBarry Smith .  -ts_monitor_error - create a graphical monitor of error history
68687cf37e64SBarry Smith 
68697cf37e64SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
68707cf37e64SBarry Smith @*/
6871edbaebb3SBarry Smith PetscErrorCode  TSMonitorError(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
68727cf37e64SBarry Smith {
68737cf37e64SBarry Smith   PetscErrorCode    ierr;
68747cf37e64SBarry Smith   Vec               y;
68757cf37e64SBarry Smith   PetscReal         nrm;
6876edbaebb3SBarry Smith   PetscBool         flg;
68777cf37e64SBarry Smith 
68787cf37e64SBarry Smith   PetscFunctionBegin;
68797cf37e64SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
68807cf37e64SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
68817cf37e64SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6882edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERASCII,&flg);CHKERRQ(ierr);
6883edbaebb3SBarry Smith   if (flg) {
68847cf37e64SBarry Smith     ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
6885edbaebb3SBarry Smith     ierr = PetscViewerASCIIPrintf(vf->viewer,"2-norm of error %g\n",(double)nrm);CHKERRQ(ierr);
6886edbaebb3SBarry Smith   }
6887edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERDRAW,&flg);CHKERRQ(ierr);
6888edbaebb3SBarry Smith   if (flg) {
6889edbaebb3SBarry Smith     ierr = VecView(y,vf->viewer);CHKERRQ(ierr);
6890edbaebb3SBarry Smith   }
6891edbaebb3SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
68927cf37e64SBarry Smith   PetscFunctionReturn(0);
68937cf37e64SBarry Smith }
68947cf37e64SBarry Smith 
6895201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6896201da799SBarry Smith {
6897201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6898201da799SBarry Smith   PetscReal      x   = ptime,y;
6899201da799SBarry Smith   PetscErrorCode ierr;
6900201da799SBarry Smith   PetscInt       its;
6901201da799SBarry Smith 
6902201da799SBarry Smith   PetscFunctionBegin;
690363e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
6904201da799SBarry Smith   if (!n) {
6905201da799SBarry Smith     PetscDrawAxis axis;
6906201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6907201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
6908201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6909201da799SBarry Smith     ctx->snes_its = 0;
6910201da799SBarry Smith   }
6911201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
6912201da799SBarry Smith   y    = its - ctx->snes_its;
6913201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
69143fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6915201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
69166934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
6917201da799SBarry Smith   }
6918201da799SBarry Smith   ctx->snes_its = its;
6919201da799SBarry Smith   PetscFunctionReturn(0);
6920201da799SBarry Smith }
6921201da799SBarry Smith 
6922201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6923201da799SBarry Smith {
6924201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6925201da799SBarry Smith   PetscReal      x   = ptime,y;
6926201da799SBarry Smith   PetscErrorCode ierr;
6927201da799SBarry Smith   PetscInt       its;
6928201da799SBarry Smith 
6929201da799SBarry Smith   PetscFunctionBegin;
693063e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
6931201da799SBarry Smith   if (!n) {
6932201da799SBarry Smith     PetscDrawAxis axis;
6933201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6934201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
6935201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6936201da799SBarry Smith     ctx->ksp_its = 0;
6937201da799SBarry Smith   }
6938201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
6939201da799SBarry Smith   y    = its - ctx->ksp_its;
6940201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
694199fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6942201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
69436934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
6944201da799SBarry Smith   }
6945201da799SBarry Smith   ctx->ksp_its = its;
6946201da799SBarry Smith   PetscFunctionReturn(0);
6947201da799SBarry Smith }
6948f9c1d6abSBarry Smith 
6949f9c1d6abSBarry Smith /*@
6950f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
6951f9c1d6abSBarry Smith 
6952d083f849SBarry Smith    Collective on TS
6953f9c1d6abSBarry Smith 
6954f9c1d6abSBarry Smith    Input Parameters:
6955f9c1d6abSBarry Smith +  ts - the TS context
6956f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
6957f9c1d6abSBarry Smith 
6958f9c1d6abSBarry Smith    Output Parameters:
6959f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
6960f9c1d6abSBarry Smith 
6961f9c1d6abSBarry Smith    Level: developer
6962f9c1d6abSBarry Smith 
6963f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
6964f9c1d6abSBarry Smith @*/
6965f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
6966f9c1d6abSBarry Smith {
6967f9c1d6abSBarry Smith   PetscErrorCode ierr;
6968f9c1d6abSBarry Smith 
6969f9c1d6abSBarry Smith   PetscFunctionBegin;
6970f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6971ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
6972f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
6973f9c1d6abSBarry Smith   PetscFunctionReturn(0);
6974f9c1d6abSBarry Smith }
697524655328SShri 
6976b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
6977b3d3934dSBarry Smith /*@C
6978b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
6979b3d3934dSBarry Smith 
6980b3d3934dSBarry Smith    Collective on TS
6981b3d3934dSBarry Smith 
6982b3d3934dSBarry Smith    Input Parameters:
6983b3d3934dSBarry Smith .  ts  - the ODE solver object
6984b3d3934dSBarry Smith 
6985b3d3934dSBarry Smith    Output Parameter:
6986b3d3934dSBarry Smith .  ctx - the context
6987b3d3934dSBarry Smith 
6988b3d3934dSBarry Smith    Level: intermediate
6989b3d3934dSBarry Smith 
6990b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
6991b3d3934dSBarry Smith 
6992b3d3934dSBarry Smith @*/
6993b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
6994b3d3934dSBarry Smith {
6995b3d3934dSBarry Smith   PetscErrorCode ierr;
6996b3d3934dSBarry Smith 
6997b3d3934dSBarry Smith   PetscFunctionBegin;
6998a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
6999b3d3934dSBarry Smith   PetscFunctionReturn(0);
7000b3d3934dSBarry Smith }
7001b3d3934dSBarry Smith 
7002b3d3934dSBarry Smith /*@C
7003b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
7004b3d3934dSBarry Smith 
7005b3d3934dSBarry Smith    Collective on TS
7006b3d3934dSBarry Smith 
7007b3d3934dSBarry Smith    Input Parameters:
7008b3d3934dSBarry Smith +  ts - the TS context
7009b3d3934dSBarry Smith .  step - current time-step
7010b3d3934dSBarry Smith .  ptime - current time
70117db568b7SBarry Smith .  u  - current solution
70127db568b7SBarry Smith -  dctx - the envelope context
7013b3d3934dSBarry Smith 
7014b3d3934dSBarry Smith    Options Database:
7015b3d3934dSBarry Smith .  -ts_monitor_envelope
7016b3d3934dSBarry Smith 
7017b3d3934dSBarry Smith    Level: intermediate
7018b3d3934dSBarry Smith 
701995452b02SPatrick Sanan    Notes:
702095452b02SPatrick Sanan     after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
7021b3d3934dSBarry Smith 
70227db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
7023b3d3934dSBarry Smith @*/
70247db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7025b3d3934dSBarry Smith {
7026b3d3934dSBarry Smith   PetscErrorCode       ierr;
70277db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
7028b3d3934dSBarry Smith 
7029b3d3934dSBarry Smith   PetscFunctionBegin;
7030b3d3934dSBarry Smith   if (!ctx->max) {
7031b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
7032b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
7033b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
7034b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
7035b3d3934dSBarry Smith   } else {
7036b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
7037b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
7038b3d3934dSBarry Smith   }
7039b3d3934dSBarry Smith   PetscFunctionReturn(0);
7040b3d3934dSBarry Smith }
7041b3d3934dSBarry Smith 
7042b3d3934dSBarry Smith /*@C
7043b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
7044b3d3934dSBarry Smith 
7045b3d3934dSBarry Smith    Collective on TS
7046b3d3934dSBarry Smith 
7047b3d3934dSBarry Smith    Input Parameter:
7048b3d3934dSBarry Smith .  ts - the TS context
7049b3d3934dSBarry Smith 
7050b3d3934dSBarry Smith    Output Parameter:
7051b3d3934dSBarry Smith +  max - the maximum values
7052b3d3934dSBarry Smith -  min - the minimum values
7053b3d3934dSBarry Smith 
705495452b02SPatrick Sanan    Notes:
705595452b02SPatrick Sanan     If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
70567db568b7SBarry Smith 
7057b3d3934dSBarry Smith    Level: intermediate
7058b3d3934dSBarry Smith 
7059b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7060b3d3934dSBarry Smith @*/
7061b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
7062b3d3934dSBarry Smith {
7063b3d3934dSBarry Smith   PetscInt i;
7064b3d3934dSBarry Smith 
7065b3d3934dSBarry Smith   PetscFunctionBegin;
7066b3d3934dSBarry Smith   if (max) *max = NULL;
7067b3d3934dSBarry Smith   if (min) *min = NULL;
7068b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7069b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
70705537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7071b3d3934dSBarry Smith       if (max) *max = ctx->max;
7072b3d3934dSBarry Smith       if (min) *min = ctx->min;
7073b3d3934dSBarry Smith       break;
7074b3d3934dSBarry Smith     }
7075b3d3934dSBarry Smith   }
7076b3d3934dSBarry Smith   PetscFunctionReturn(0);
7077b3d3934dSBarry Smith }
7078b3d3934dSBarry Smith 
7079b3d3934dSBarry Smith /*@C
7080b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7081b3d3934dSBarry Smith 
7082b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7083b3d3934dSBarry Smith 
7084b3d3934dSBarry Smith    Input Parameter:
7085b3d3934dSBarry Smith .  ctx - the monitor context
7086b3d3934dSBarry Smith 
7087b3d3934dSBarry Smith    Level: intermediate
7088b3d3934dSBarry Smith 
70897db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7090b3d3934dSBarry Smith @*/
7091b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7092b3d3934dSBarry Smith {
7093b3d3934dSBarry Smith   PetscErrorCode ierr;
7094b3d3934dSBarry Smith 
7095b3d3934dSBarry Smith   PetscFunctionBegin;
7096b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7097b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7098b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7099b3d3934dSBarry Smith   PetscFunctionReturn(0);
7100b3d3934dSBarry Smith }
7101f2dee214SBarry Smith 
710224655328SShri /*@
7103dcb233daSLisandro Dalcin    TSRestartStep - Flags the solver to restart the next step
7104dcb233daSLisandro Dalcin 
7105dcb233daSLisandro Dalcin    Collective on TS
7106dcb233daSLisandro Dalcin 
7107dcb233daSLisandro Dalcin    Input Parameter:
7108dcb233daSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
7109dcb233daSLisandro Dalcin 
7110dcb233daSLisandro Dalcin    Level: advanced
7111dcb233daSLisandro Dalcin 
7112dcb233daSLisandro Dalcin    Notes:
7113dcb233daSLisandro Dalcin    Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of
7114dcb233daSLisandro Dalcin    discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution
7115dcb233daSLisandro Dalcin    vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For
7116dcb233daSLisandro Dalcin    the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce
7117dcb233daSLisandro Dalcin    discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with
7118dcb233daSLisandro Dalcin    discontinuous source terms).
7119dcb233daSLisandro Dalcin 
7120dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep()
7121dcb233daSLisandro Dalcin @*/
7122dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts)
7123dcb233daSLisandro Dalcin {
7124dcb233daSLisandro Dalcin   PetscFunctionBegin;
7125dcb233daSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7126dcb233daSLisandro Dalcin   ts->steprestart = PETSC_TRUE;
7127dcb233daSLisandro Dalcin   PetscFunctionReturn(0);
7128dcb233daSLisandro Dalcin }
7129dcb233daSLisandro Dalcin 
7130dcb233daSLisandro Dalcin /*@
713124655328SShri    TSRollBack - Rolls back one time step
713224655328SShri 
713324655328SShri    Collective on TS
713424655328SShri 
713524655328SShri    Input Parameter:
713624655328SShri .  ts - the TS context obtained from TSCreate()
713724655328SShri 
713824655328SShri    Level: advanced
713924655328SShri 
714024655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
714124655328SShri @*/
714224655328SShri PetscErrorCode  TSRollBack(TS ts)
714324655328SShri {
714424655328SShri   PetscErrorCode ierr;
714524655328SShri 
714624655328SShri   PetscFunctionBegin;
714724655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7148b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
714924655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
715024655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
715124655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
715224655328SShri   ts->ptime = ts->ptime_prev;
7153be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
71542808aa04SLisandro Dalcin   ts->steps--;
7155b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
715624655328SShri   PetscFunctionReturn(0);
715724655328SShri }
7158aeb4809dSShri Abhyankar 
7159ff22ae23SHong Zhang /*@
7160ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7161ff22ae23SHong Zhang 
7162ff22ae23SHong Zhang    Input Parameter:
7163ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7164ff22ae23SHong Zhang 
71650429704eSStefano Zampini    Output Parameters:
71660429704eSStefano Zampini +  ns - the number of stages
71670429704eSStefano Zampini -  Y - the current stage vectors
71680429704eSStefano Zampini 
7169ff22ae23SHong Zhang    Level: advanced
7170ff22ae23SHong Zhang 
71710429704eSStefano Zampini    Notes: Both ns and Y can be NULL.
71720429704eSStefano Zampini 
7173ff22ae23SHong Zhang .seealso: TSCreate()
7174ff22ae23SHong Zhang @*/
7175ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7176ff22ae23SHong Zhang {
7177ff22ae23SHong Zhang   PetscErrorCode ierr;
7178ff22ae23SHong Zhang 
7179ff22ae23SHong Zhang   PetscFunctionBegin;
7180ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
71810429704eSStefano Zampini   if (ns) PetscValidPointer(ns,2);
71820429704eSStefano Zampini   if (Y) PetscValidPointer(Y,3);
71830429704eSStefano Zampini   if (!ts->ops->getstages) {
71840429704eSStefano Zampini     if (ns) *ns = 0;
71850429704eSStefano Zampini     if (Y) *Y = NULL;
71860429704eSStefano Zampini   } else {
7187ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7188ff22ae23SHong Zhang   }
7189ff22ae23SHong Zhang   PetscFunctionReturn(0);
7190ff22ae23SHong Zhang }
7191ff22ae23SHong Zhang 
7192847ff0e1SMatthew G. Knepley /*@C
7193847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7194847ff0e1SMatthew G. Knepley 
7195847ff0e1SMatthew G. Knepley   Collective on SNES
7196847ff0e1SMatthew G. Knepley 
7197847ff0e1SMatthew G. Knepley   Input Parameters:
7198847ff0e1SMatthew G. Knepley + ts - the TS context
7199847ff0e1SMatthew G. Knepley . t - current timestep
7200847ff0e1SMatthew G. Knepley . U - state vector
7201847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7202847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7203847ff0e1SMatthew G. Knepley - ctx - an optional user context
7204847ff0e1SMatthew G. Knepley 
7205847ff0e1SMatthew G. Knepley   Output Parameters:
7206847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7207847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7208847ff0e1SMatthew G. Knepley 
7209847ff0e1SMatthew G. Knepley   Level: intermediate
7210847ff0e1SMatthew G. Knepley 
7211847ff0e1SMatthew G. Knepley   Notes:
7212847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7213847ff0e1SMatthew G. Knepley 
7214847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7215847ff0e1SMatthew G. Knepley 
7216847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7217847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7218847ff0e1SMatthew G. Knepley 
7219847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7220847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7221847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7222847ff0e1SMatthew G. Knepley 
7223847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7224847ff0e1SMatthew G. Knepley @*/
7225847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7226847ff0e1SMatthew G. Knepley {
7227847ff0e1SMatthew G. Knepley   SNES           snes;
7228847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7229847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7230847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
7231847ff0e1SMatthew G. Knepley 
7232847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
7233c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
7234847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
7235847ff0e1SMatthew G. Knepley   if (!color) {
7236847ff0e1SMatthew G. Knepley     DM         dm;
7237847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
7238847ff0e1SMatthew G. Knepley 
7239847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
7240847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
7241847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
7242847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
7243847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7244847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7245847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7246847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7247847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7248847ff0e1SMatthew G. Knepley     } else {
7249847ff0e1SMatthew G. Knepley       MatColoring mc;
7250847ff0e1SMatthew G. Knepley 
7251847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
7252847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
7253847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
7254847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
7255847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
7256847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
7257847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7258847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7259847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7260847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7261847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7262847ff0e1SMatthew G. Knepley     }
7263847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
7264847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
7265847ff0e1SMatthew G. Knepley   }
7266847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
7267847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
7268847ff0e1SMatthew G. Knepley   if (J != B) {
7269847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7270847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7271847ff0e1SMatthew G. Knepley   }
7272847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
7273847ff0e1SMatthew G. Knepley }
727493b34091SDebojyoti Ghosh 
7275cb9d8021SPierre Barbier de Reuille /*@
72766bc98fa9SBarry Smith     TSSetFunctionDomainError - Set a function that tests if the current state vector is valid
7277cb9d8021SPierre Barbier de Reuille 
7278cb9d8021SPierre Barbier de Reuille     Input Parameters:
72796bc98fa9SBarry Smith +    ts - the TS context
72806bc98fa9SBarry Smith -    func - function called within TSFunctionDomainError
72816bc98fa9SBarry Smith 
72826bc98fa9SBarry Smith     Calling sequence of func:
72836bc98fa9SBarry Smith $     PetscErrorCode func(TS ts,PetscReal time,Vec state,PetscBool reject)
72846bc98fa9SBarry Smith 
72856bc98fa9SBarry Smith +   ts - the TS context
72866bc98fa9SBarry Smith .   time - the current time (of the stage)
72876bc98fa9SBarry Smith .   state - the state to check if it is valid
72886bc98fa9SBarry Smith -   reject - (output parameter) PETSC_FALSE if the state is acceptable, PETSC_TRUE if not acceptable
7289cb9d8021SPierre Barbier de Reuille 
7290cb9d8021SPierre Barbier de Reuille     Level: intermediate
7291cb9d8021SPierre Barbier de Reuille 
72926bc98fa9SBarry Smith     Notes:
72936bc98fa9SBarry Smith       If an implicit ODE solver is being used then, in addition to providing this routine, the
72946bc98fa9SBarry Smith       user's code should call SNESSetFunctionDomainError() when domain errors occur during
72956bc98fa9SBarry Smith       function evaluations where the functions are provided by TSSetIFunction() or TSSetRHSFunction().
72966bc98fa9SBarry Smith       Use TSGetSNES() to obtain the SNES object
72976bc98fa9SBarry Smith 
72986bc98fa9SBarry Smith     Developer Notes:
72996bc98fa9SBarry Smith       The naming of this function is inconsistent with the SNESSetFunctionDomainError()
73006bc98fa9SBarry Smith       since one takes a function pointer and the other does not.
73016bc98fa9SBarry Smith 
73026bc98fa9SBarry Smith .seealso: TSAdaptCheckStage(), TSFunctionDomainError(), SNESSetFunctionDomainError(), TSGetSNES()
7303cb9d8021SPierre Barbier de Reuille @*/
7304cb9d8021SPierre Barbier de Reuille 
7305d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
7306cb9d8021SPierre Barbier de Reuille {
7307cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7308cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7309cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
7310cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7311cb9d8021SPierre Barbier de Reuille }
7312cb9d8021SPierre Barbier de Reuille 
7313cb9d8021SPierre Barbier de Reuille /*@
73146bc98fa9SBarry Smith     TSFunctionDomainError - Checks if the current state is valid
7315cb9d8021SPierre Barbier de Reuille 
7316cb9d8021SPierre Barbier de Reuille     Input Parameters:
73176bc98fa9SBarry Smith +    ts - the TS context
73186bc98fa9SBarry Smith .    stagetime - time of the simulation
73196bc98fa9SBarry Smith -    Y - state vector to check.
7320cb9d8021SPierre Barbier de Reuille 
7321cb9d8021SPierre Barbier de Reuille     Output Parameter:
73226bc98fa9SBarry Smith .    accept - Set to PETSC_FALSE if the current state vector is valid.
7323cb9d8021SPierre Barbier de Reuille 
7324cb9d8021SPierre Barbier de Reuille     Note:
73256bc98fa9SBarry Smith     This function is called by the TS integration routines and calls the user provided function (set with TSSetFunctionDomainError())
73266bc98fa9SBarry Smith     to check if the current state is valid.
732796a0c994SBarry Smith 
73286bc98fa9SBarry Smith     Level: developer
73296bc98fa9SBarry Smith 
73306bc98fa9SBarry Smith .seealso: TSSetFunctionDomainError()
7331cb9d8021SPierre Barbier de Reuille @*/
7332d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
7333cb9d8021SPierre Barbier de Reuille {
7334cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7335cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7336cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
7337cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
7338d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
7339cb9d8021SPierre Barbier de Reuille   }
7340cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7341cb9d8021SPierre Barbier de Reuille }
73421ceb14c0SBarry Smith 
734393b34091SDebojyoti Ghosh /*@C
7344e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
734593b34091SDebojyoti Ghosh 
7346d083f849SBarry Smith   Collective
734793b34091SDebojyoti Ghosh 
734893b34091SDebojyoti Ghosh   Input Parameter:
734993b34091SDebojyoti Ghosh . tsin    - The input TS
735093b34091SDebojyoti Ghosh 
735193b34091SDebojyoti Ghosh   Output Parameter:
7352e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
735393b34091SDebojyoti Ghosh 
73545eca1a21SEmil Constantinescu   Notes:
73555eca1a21SEmil 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.
73565eca1a21SEmil Constantinescu 
7357928bb9adSStefano 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);
73585eca1a21SEmil Constantinescu 
73595eca1a21SEmil Constantinescu   Level: developer
736093b34091SDebojyoti Ghosh 
7361e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
736293b34091SDebojyoti Ghosh @*/
7363baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
736493b34091SDebojyoti Ghosh {
736593b34091SDebojyoti Ghosh   TS             t;
736693b34091SDebojyoti Ghosh   PetscErrorCode ierr;
7367dc846ba4SSatish Balay   SNES           snes_start;
7368dc846ba4SSatish Balay   DM             dm;
7369dc846ba4SSatish Balay   TSType         type;
737093b34091SDebojyoti Ghosh 
737193b34091SDebojyoti Ghosh   PetscFunctionBegin;
737293b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
737393b34091SDebojyoti Ghosh   *tsout = NULL;
737493b34091SDebojyoti Ghosh 
73757a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
737693b34091SDebojyoti Ghosh 
737793b34091SDebojyoti Ghosh   /* General TS description */
737893b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
737993b34091SDebojyoti Ghosh   t->setupcalled       = 0;
738093b34091SDebojyoti Ghosh   t->ksp_its           = 0;
738193b34091SDebojyoti Ghosh   t->snes_its          = 0;
738293b34091SDebojyoti Ghosh   t->nwork             = 0;
738393b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
738493b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
738593b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
738693b34091SDebojyoti Ghosh 
738734561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
738834561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
7389d15a3a53SEmil Constantinescu 
739093b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
739193b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
739293b34091SDebojyoti Ghosh 
739393b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
739451699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
739593b34091SDebojyoti Ghosh 
7396e7069c78SShri   t->trajectory = tsin->trajectory;
7397e7069c78SShri   ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr);
7398e7069c78SShri 
7399e7069c78SShri   t->event = tsin->event;
74006b10a48eSSatish Balay   if (t->event) t->event->refct++;
7401e7069c78SShri 
740293b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
740393b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
7404e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
740593b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
740693b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
740793b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
740893b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
740993b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
741093b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
741193b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
741293b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
741393b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
741493b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
741593b34091SDebojyoti Ghosh 
741693b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
741793b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
741893b34091SDebojyoti Ghosh 
741993b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
742093b34091SDebojyoti Ghosh 
742193b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
742293b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
742393b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
742493b34091SDebojyoti Ghosh 
742593b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
742693b34091SDebojyoti Ghosh 
74270d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
74280d4fed19SBarry Smith     PetscInt i;
74290d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
74300d4fed19SBarry Smith     for (i=0; i<10; i++) {
74310d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
74320d4fed19SBarry Smith     }
74330d4fed19SBarry Smith   }
743493b34091SDebojyoti Ghosh   *tsout = t;
743593b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
743693b34091SDebojyoti Ghosh }
7437f3b1f45cSBarry Smith 
7438f3b1f45cSBarry Smith static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void* ctx,Vec x,Vec y)
7439f3b1f45cSBarry Smith {
7440f3b1f45cSBarry Smith   PetscErrorCode ierr;
7441f3b1f45cSBarry Smith   TS             ts = (TS) ctx;
7442f3b1f45cSBarry Smith 
7443f3b1f45cSBarry Smith   PetscFunctionBegin;
7444f3b1f45cSBarry Smith   ierr = TSComputeRHSFunction(ts,0,x,y);CHKERRQ(ierr);
7445f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7446f3b1f45cSBarry Smith }
7447f3b1f45cSBarry Smith 
7448f3b1f45cSBarry Smith /*@
7449f3b1f45cSBarry Smith     TSRHSJacobianTest - Compares the multiply routine provided to the MATSHELL with differencing on the TS given RHS function.
7450f3b1f45cSBarry Smith 
7451d083f849SBarry Smith    Logically Collective on TS
7452f3b1f45cSBarry Smith 
7453f3b1f45cSBarry Smith     Input Parameters:
7454f3b1f45cSBarry Smith     TS - the time stepping routine
7455f3b1f45cSBarry Smith 
7456f3b1f45cSBarry Smith    Output Parameter:
7457f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
7458f3b1f45cSBarry Smith 
7459f3b1f45cSBarry Smith    Options Database:
7460f3b1f45cSBarry Smith  .   -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator
7461f3b1f45cSBarry Smith 
7462f3b1f45cSBarry Smith    Level: advanced
7463f3b1f45cSBarry Smith 
746495452b02SPatrick Sanan    Notes:
746595452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
7466f3b1f45cSBarry Smith 
7467f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTestTranspose()
7468f3b1f45cSBarry Smith @*/
7469f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTest(TS ts,PetscBool *flg)
7470f3b1f45cSBarry Smith {
7471f3b1f45cSBarry Smith   Mat            J,B;
7472f3b1f45cSBarry Smith   PetscErrorCode ierr;
7473f3b1f45cSBarry Smith   TSRHSJacobian  func;
7474f3b1f45cSBarry Smith   void*          ctx;
7475f3b1f45cSBarry Smith 
7476f3b1f45cSBarry Smith   PetscFunctionBegin;
7477f3b1f45cSBarry Smith   ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr);
7478f3b1f45cSBarry Smith   ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr);
7479f3b1f45cSBarry Smith   ierr = MatShellTestMult(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr);
7480f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7481f3b1f45cSBarry Smith }
7482f3b1f45cSBarry Smith 
7483f3b1f45cSBarry Smith /*@C
7484f3b1f45cSBarry Smith     TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the MATSHELL with differencing on the TS given RHS function.
7485f3b1f45cSBarry Smith 
7486d083f849SBarry Smith    Logically Collective on TS
7487f3b1f45cSBarry Smith 
7488f3b1f45cSBarry Smith     Input Parameters:
7489f3b1f45cSBarry Smith     TS - the time stepping routine
7490f3b1f45cSBarry Smith 
7491f3b1f45cSBarry Smith    Output Parameter:
7492f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
7493f3b1f45cSBarry Smith 
7494f3b1f45cSBarry Smith    Options Database:
7495f3b1f45cSBarry Smith .   -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator
7496f3b1f45cSBarry Smith 
749795452b02SPatrick Sanan    Notes:
749895452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
7499f3b1f45cSBarry Smith 
7500f3b1f45cSBarry Smith    Level: advanced
7501f3b1f45cSBarry Smith 
7502f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTest()
7503f3b1f45cSBarry Smith @*/
7504f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTestTranspose(TS ts,PetscBool *flg)
7505f3b1f45cSBarry Smith {
7506f3b1f45cSBarry Smith   Mat            J,B;
7507f3b1f45cSBarry Smith   PetscErrorCode ierr;
7508f3b1f45cSBarry Smith   void           *ctx;
7509f3b1f45cSBarry Smith   TSRHSJacobian  func;
7510f3b1f45cSBarry Smith 
7511f3b1f45cSBarry Smith   PetscFunctionBegin;
7512f3b1f45cSBarry Smith   ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr);
7513f3b1f45cSBarry Smith   ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr);
7514f3b1f45cSBarry Smith   ierr = MatShellTestMultTranspose(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr);
7515f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7516f3b1f45cSBarry Smith }
75170fe4d17eSHong Zhang 
75180fe4d17eSHong Zhang /*@
75190fe4d17eSHong Zhang   TSSetUseSplitRHSFunction - Use the split RHSFunction when a multirate method is used.
75200fe4d17eSHong Zhang 
75210fe4d17eSHong Zhang   Logically collective
75220fe4d17eSHong Zhang 
75230fe4d17eSHong Zhang   Input Parameter:
75240fe4d17eSHong Zhang +  ts - timestepping context
75250fe4d17eSHong Zhang -  use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used
75260fe4d17eSHong Zhang 
75270fe4d17eSHong Zhang   Options Database:
75280fe4d17eSHong Zhang .   -ts_use_splitrhsfunction - <true,false>
75290fe4d17eSHong Zhang 
75300fe4d17eSHong Zhang   Notes:
75310fe4d17eSHong Zhang     This is only useful for multirate methods
75320fe4d17eSHong Zhang 
75330fe4d17eSHong Zhang   Level: intermediate
75340fe4d17eSHong Zhang 
75350fe4d17eSHong Zhang .seealso: TSGetUseSplitRHSFunction()
75360fe4d17eSHong Zhang @*/
75370fe4d17eSHong Zhang PetscErrorCode TSSetUseSplitRHSFunction(TS ts, PetscBool use_splitrhsfunction)
75380fe4d17eSHong Zhang {
75390fe4d17eSHong Zhang   PetscFunctionBegin;
75400fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
75410fe4d17eSHong Zhang   ts->use_splitrhsfunction = use_splitrhsfunction;
75420fe4d17eSHong Zhang   PetscFunctionReturn(0);
75430fe4d17eSHong Zhang }
75440fe4d17eSHong Zhang 
75450fe4d17eSHong Zhang /*@
75460fe4d17eSHong Zhang   TSGetUseSplitRHSFunction - Gets whether to use the split RHSFunction when a multirate method is used.
75470fe4d17eSHong Zhang 
75480fe4d17eSHong Zhang   Not collective
75490fe4d17eSHong Zhang 
75500fe4d17eSHong Zhang   Input Parameter:
75510fe4d17eSHong Zhang .  ts - timestepping context
75520fe4d17eSHong Zhang 
75530fe4d17eSHong Zhang   Output Parameter:
75540fe4d17eSHong Zhang .  use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used
75550fe4d17eSHong Zhang 
75560fe4d17eSHong Zhang   Level: intermediate
75570fe4d17eSHong Zhang 
75580fe4d17eSHong Zhang .seealso: TSSetUseSplitRHSFunction()
75590fe4d17eSHong Zhang @*/
75600fe4d17eSHong Zhang PetscErrorCode TSGetUseSplitRHSFunction(TS ts, PetscBool *use_splitrhsfunction)
75610fe4d17eSHong Zhang {
75620fe4d17eSHong Zhang   PetscFunctionBegin;
75630fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
75640fe4d17eSHong Zhang   *use_splitrhsfunction = ts->use_splitrhsfunction;
75650fe4d17eSHong Zhang   PetscFunctionReturn(0);
75660fe4d17eSHong Zhang }
7567