xref: /petsc/src/ts/interface/ts.c (revision 595c91d4f3df6e7f1f4e7c2ec1dc1a12f6cb4124)
1af0996ceSBarry Smith #include <petsc/private/tsimpl.h>        /*I "petscts.h"  I*/
2496e6a7aSJed Brown #include <petscdmshell.h>
31e25c274SJed Brown #include <petscdmda.h>
42d5ee99bSBarry Smith #include <petscviewer.h>
52d5ee99bSBarry Smith #include <petscdraw.h>
6900f6b5bSMatthew G. Knepley #include <petscconvest.h>
7d763cef2SBarry Smith 
81c167fc2SEmil Constantinescu #define SkipSmallValue(a,b,tol) if (PetscAbsScalar(a)< tol || PetscAbsScalar(b)< tol) continue;
91c167fc2SEmil Constantinescu 
10d5ba7fb7SMatthew Knepley /* Logging support */
11d74926cbSBarry Smith PetscClassId  TS_CLASSID, DMTS_CLASSID;
12a05bf03eSHong Zhang PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
13d405a339SMatthew Knepley 
14c793f718SLisandro Dalcin const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",NULL};
1549354f04SShri Abhyankar 
161c167fc2SEmil Constantinescu 
17fde5950dSBarry Smith /*@C
18fde5950dSBarry Smith    TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
19fde5950dSBarry Smith 
20fde5950dSBarry Smith    Collective on TS
21fde5950dSBarry Smith 
22fde5950dSBarry Smith    Input Parameters:
23fde5950dSBarry Smith +  ts - TS object you wish to monitor
24fde5950dSBarry Smith .  name - the monitor type one is seeking
25fde5950dSBarry Smith .  help - message indicating what monitoring is done
26fde5950dSBarry Smith .  manual - manual page for the monitor
27fde5950dSBarry Smith .  monitor - the monitor function
28fde5950dSBarry Smith -  monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects
29fde5950dSBarry Smith 
30fde5950dSBarry Smith    Level: developer
31fde5950dSBarry Smith 
32fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
33fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
34fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
35fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
36fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
37fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
38fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
39fde5950dSBarry Smith @*/
40721cd6eeSBarry Smith PetscErrorCode  TSMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*))
41fde5950dSBarry Smith {
42fde5950dSBarry Smith   PetscErrorCode    ierr;
43fde5950dSBarry Smith   PetscViewer       viewer;
44fde5950dSBarry Smith   PetscViewerFormat format;
45fde5950dSBarry Smith   PetscBool         flg;
46fde5950dSBarry Smith 
47fde5950dSBarry Smith   PetscFunctionBegin;
4816413a6aSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject) ts)->options,((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
49fde5950dSBarry Smith   if (flg) {
50721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
51721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
52721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
53fde5950dSBarry Smith     if (monitorsetup) {
54721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
55fde5950dSBarry Smith     }
56721cd6eeSBarry Smith     ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr);
57fde5950dSBarry Smith   }
58fde5950dSBarry Smith   PetscFunctionReturn(0);
59fde5950dSBarry Smith }
60fde5950dSBarry Smith 
612ffb9264SLisandro Dalcin static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt,TSAdaptType default_type)
622ffb9264SLisandro Dalcin {
632ffb9264SLisandro Dalcin   PetscErrorCode ierr;
642ffb9264SLisandro Dalcin 
652ffb9264SLisandro Dalcin   PetscFunctionBegin;
66b92453a8SLisandro Dalcin   PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1);
67b92453a8SLisandro Dalcin   PetscValidCharPointer(default_type,2);
682ffb9264SLisandro Dalcin   if (!((PetscObject)adapt)->type_name) {
692ffb9264SLisandro Dalcin     ierr = TSAdaptSetType(adapt,default_type);CHKERRQ(ierr);
702ffb9264SLisandro Dalcin   }
712ffb9264SLisandro Dalcin   PetscFunctionReturn(0);
722ffb9264SLisandro Dalcin }
732ffb9264SLisandro Dalcin 
74bdad233fSMatthew Knepley /*@
75bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
76bdad233fSMatthew Knepley 
77bdad233fSMatthew Knepley    Collective on TS
78bdad233fSMatthew Knepley 
79bdad233fSMatthew Knepley    Input Parameter:
80bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
81bdad233fSMatthew Knepley 
82bdad233fSMatthew Knepley    Options Database Keys:
83e49d4f37SHong Zhang +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE, TSBSYMP
84ef222394SBarry Smith .  -ts_save_trajectory - checkpoint the solution at each time-step
85ef85077eSLisandro Dalcin .  -ts_max_time <time> - maximum time to compute to
86ef85077eSLisandro Dalcin .  -ts_max_steps <steps> - maximum number of time-steps to take
87ef85077eSLisandro Dalcin .  -ts_init_time <time> - initial time to start computation
884dc72f7fSBarry Smith .  -ts_final_time <time> - final time to compute to (deprecated: use -ts_max_time)
893e4cdcaaSBarry Smith .  -ts_dt <dt> - initial time step
906c51df0eSBarry Smith .  -ts_exact_final_time <stepover,interpolate,matchstep> - whether to stop at the exact given final time and how to compute the solution at that ti,e
91a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
92a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
93a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
94a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
95a3cdaa26SBarry Smith .  -ts_atol <atol> Absolute tolerance for local truncation error
96f3b1f45cSBarry Smith .  -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - test the Jacobian at each iteration against finite difference with RHS function
97f3b1f45cSBarry Smith .  -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - test the Jacobian at each iteration against finite difference with RHS function
98ef222394SBarry Smith .  -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
99847ff0e1SMatthew G. Knepley .  -ts_fd_color - Use finite differences with coloring to compute IJacobian
100bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
101de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
102de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
1037cf37e64SBarry Smith .  -ts_monitor_error - Monitors norm of error
1046934998bSLisandro Dalcin .  -ts_monitor_lg_timestep - Monitor timestep size graphically
1058b668821SLisandro Dalcin .  -ts_monitor_lg_timestep_log - Monitor log timestep size graphically
106de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
107de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
108de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
109de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
1103e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
1113e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
112fde5950dSBarry Smith .  -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep
113e4160dc7SJulian Andrej .  -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu)
1149e336e28SPatrick Sanan -  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
11553ea634cSHong Zhang 
1163d5a8a6aSBarry Smith    Notes:
1173d5a8a6aSBarry Smith      See SNESSetFromOptions() and KSPSetFromOptions() for how to control the nonlinear and linear solves used by the time-stepper.
1183d5a8a6aSBarry Smith 
1193d5a8a6aSBarry Smith      Certain SNES options get reset for each new nonlinear solver, for example -snes_lag_jacobian <its> and -snes_lag_preconditioner <its>, in order
1203d5a8a6aSBarry Smith      to retain them over the multiple nonlinear solves that TS uses you mush also provide -snes_lag_jacobian_persists true and
1213d5a8a6aSBarry Smith      -snes_lag_preconditioner_persists true
1223d5a8a6aSBarry Smith 
1239e336e28SPatrick Sanan    Developer Note:
1249e336e28SPatrick Sanan      We should unify all the -ts_monitor options in the way that -xxx_view has been unified
125bdad233fSMatthew Knepley 
126bdad233fSMatthew Knepley    Level: beginner
127bdad233fSMatthew Knepley 
128a313700dSBarry Smith .seealso: TSGetType()
129bdad233fSMatthew Knepley @*/
1307087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
131bdad233fSMatthew Knepley {
132bc952696SBarry Smith   PetscBool              opt,flg,tflg;
133dfbe8321SBarry Smith   PetscErrorCode         ierr;
134eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
13531748224SBarry Smith   PetscReal              time_step;
13649354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
137d1212d36SBarry Smith   char                   dir[16];
138cd11d68dSLisandro Dalcin   TSIFunction            ifun;
1396991f827SBarry Smith   const char             *defaultType;
1406991f827SBarry Smith   char                   typeName[256];
141bdad233fSMatthew Knepley 
142bdad233fSMatthew Knepley   PetscFunctionBegin;
1430700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1446991f827SBarry Smith 
1456991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
146cd11d68dSLisandro Dalcin   ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
147cd11d68dSLisandro Dalcin 
148cd11d68dSLisandro Dalcin   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
1491ef27442SStefano Zampini   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
1501ef27442SStefano Zampini   else defaultType = ifun ? TSBEULER : TSEULER;
1516991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr);
1526991f827SBarry Smith   if (opt) {
1536991f827SBarry Smith     ierr = TSSetType(ts,typeName);CHKERRQ(ierr);
1546991f827SBarry Smith   } else {
1556991f827SBarry Smith     ierr = TSSetType(ts,defaultType);CHKERRQ(ierr);
1566991f827SBarry Smith   }
157bdad233fSMatthew Knepley 
158bdad233fSMatthew Knepley   /* Handle generic TS options */
1594dc72f7fSBarry Smith   ierr = PetscOptionsDeprecated("-ts_final_time","-ts_max_time","3.10",NULL);CHKERRQ(ierr);
160ef85077eSLisandro Dalcin   ierr = PetscOptionsReal("-ts_max_time","Maximum time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
16119eac22cSLisandro Dalcin   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetMaxSteps",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1620298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
16331748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
164cd11d68dSLisandro Dalcin   if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);}
16549354f04SShri 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);
16649354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
1670298fd71SBarry 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);
1680298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
1690298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
1700298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
1710298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
172bdad233fSMatthew Knepley 
173f3b1f45cSBarry 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);
174f3b1f45cSBarry 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);
1750fe4d17eSHong Zhang   ierr = PetscOptionsBool("-ts_use_splitrhsfunction","Use the split RHS function for multirate solvers ","TSSetUseSplitRHSFunction",ts->use_splitrhsfunction,&ts->use_splitrhsfunction,NULL);CHKERRQ(ierr);
17656f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
17756f85f32SBarry Smith   {
17856f85f32SBarry Smith     PetscBool set;
17956f85f32SBarry Smith     flg  = PETSC_FALSE;
18056f85f32SBarry Smith     ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
18156f85f32SBarry Smith     if (set) {
18256f85f32SBarry Smith       ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
18356f85f32SBarry Smith     }
18456f85f32SBarry Smith   }
18556f85f32SBarry Smith #endif
18656f85f32SBarry Smith 
187bdad233fSMatthew Knepley   /* Monitor options */
188cd11d68dSLisandro Dalcin   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr);
189cc9c3a59SBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_extreme","Monitor extreme values of the solution","TSMonitorExtreme",TSMonitorExtreme,NULL);CHKERRQ(ierr);
190fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr);
191fde5950dSBarry Smith 
192589a23caSBarry Smith   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",NULL,monfilename,sizeof(monfilename),&flg);CHKERRQ(ierr);
1935180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1945180491cSLisandro Dalcin 
1954f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
196b3603a34SBarry Smith   if (opt) {
1973923b477SBarry Smith     PetscInt       howoften = 1;
198e669de00SBarry Smith     DM             dm;
199e669de00SBarry Smith     PetscBool      net;
200b3603a34SBarry Smith 
2010298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
202e669de00SBarry Smith     ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
203e669de00SBarry Smith     ierr = PetscObjectTypeCompare((PetscObject)dm,DMNETWORK,&net);CHKERRQ(ierr);
204e669de00SBarry Smith     if (net) {
205e669de00SBarry Smith       TSMonitorLGCtxNetwork ctx;
206e669de00SBarry Smith       ierr = TSMonitorLGCtxNetworkCreate(ts,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
207e669de00SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorLGCtxNetworkSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxNetworkDestroy);CHKERRQ(ierr);
208e669de00SBarry Smith       ierr = PetscOptionsBool("-ts_monitor_lg_solution_semilogy","Plot the solution with a semi-log axis","",ctx->semilogy,&ctx->semilogy,NULL);CHKERRQ(ierr);
209e669de00SBarry Smith     } else {
210e669de00SBarry Smith       TSMonitorLGCtx ctx;
211c793f718SLisandro Dalcin       ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2124f09c107SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
213bdad233fSMatthew Knepley     }
214e669de00SBarry Smith   }
2156ba87a44SLisandro Dalcin 
2164f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
217ef20d060SBarry Smith   if (opt) {
2180b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2193923b477SBarry Smith     PetscInt       howoften = 1;
220ef20d060SBarry Smith 
2210298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
222c793f718SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2234f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
224ef20d060SBarry Smith   }
225edbaebb3SBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_error","View the error at each timestep","TSMonitorError",TSMonitorError,NULL);CHKERRQ(ierr);
2267cf37e64SBarry Smith 
2276934998bSLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2286934998bSLisandro Dalcin   if (opt) {
2296934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
2306934998bSLisandro Dalcin     PetscInt       howoften = 1;
2316934998bSLisandro Dalcin 
2326934998bSLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2336ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2346934998bSLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2356934998bSLisandro Dalcin   }
2368b668821SLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2378b668821SLisandro Dalcin   if (opt) {
2388b668821SLisandro Dalcin     TSMonitorLGCtx ctx;
2398b668821SLisandro Dalcin     PetscInt       howoften = 1;
2408b668821SLisandro Dalcin 
2418b668821SLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2428b668821SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2438b668821SLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2448b668821SLisandro Dalcin     ctx->semilogy = PETSC_TRUE;
2458b668821SLisandro Dalcin   }
2468b668821SLisandro Dalcin 
247201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
248201da799SBarry Smith   if (opt) {
249201da799SBarry Smith     TSMonitorLGCtx ctx;
250201da799SBarry Smith     PetscInt       howoften = 1;
251201da799SBarry Smith 
2520298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2536ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
254201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
255201da799SBarry Smith   }
256201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
257201da799SBarry Smith   if (opt) {
258201da799SBarry Smith     TSMonitorLGCtx ctx;
259201da799SBarry Smith     PetscInt       howoften = 1;
260201da799SBarry Smith 
2610298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2626ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
263201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
264201da799SBarry Smith   }
2658189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
2668189c53fSBarry Smith   if (opt) {
2678189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2688189c53fSBarry Smith     PetscInt          howoften = 1;
2698189c53fSBarry Smith 
2700298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
271c793f718SLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2728189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
2738189c53fSBarry Smith   }
2740ec8ee2bSJoseph Pusztay   ierr = PetscOptionsName("-ts_monitor_sp_swarm","Display particle phase from the DMSwarm","TSMonitorSPSwarm",&opt);CHKERRQ(ierr);
2751b575b74SJoseph Pusztay   if (opt) {
2761b575b74SJoseph Pusztay     TSMonitorSPCtx  ctx;
2771b575b74SJoseph Pusztay     PetscInt        howoften = 1;
2780ec8ee2bSJoseph Pusztay     ierr = PetscOptionsInt("-ts_monitor_sp_swarm","Display particles phase from the DMSwarm","TSMonitorSPSwarm",howoften,&howoften,NULL);CHKERRQ(ierr);
2791b575b74SJoseph Pusztay     ierr = TSMonitorSPCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx);CHKERRQ(ierr);
2800ec8ee2bSJoseph Pusztay     ierr = TSMonitorSet(ts, TSMonitorSPSwarmSolution, ctx, (PetscErrorCode (*)(void**))TSMonitorSPCtxDestroy);CHKERRQ(ierr);
2811b575b74SJoseph Pusztay   }
282ef20d060SBarry Smith   opt  = PETSC_FALSE;
2830dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
284a7cc72afSBarry Smith   if (opt) {
28583a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
28683a4ac43SBarry Smith     PetscInt         howoften = 1;
287a80ad3e0SBarry Smith 
2880298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
289c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
29083a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
291bdad233fSMatthew Knepley   }
292fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2932d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
2942d5ee99bSBarry Smith   if (opt) {
2952d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2962d5ee99bSBarry Smith     PetscReal        bounds[4];
2972d5ee99bSBarry Smith     PetscInt         n = 4;
2982d5ee99bSBarry Smith     PetscDraw        draw;
2996934998bSLisandro Dalcin     PetscDrawAxis    axis;
3002d5ee99bSBarry Smith 
3012d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
3022d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
303c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr);
3042d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
3056934998bSLisandro Dalcin     ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr);
3066934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
3076934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
3082d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3092d5ee99bSBarry Smith   }
3102d5ee99bSBarry Smith   opt  = PETSC_FALSE;
3110dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
3123a471f94SBarry Smith   if (opt) {
31383a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
31483a4ac43SBarry Smith     PetscInt         howoften = 1;
3153a471f94SBarry Smith 
3160298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
317c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
31883a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3193a471f94SBarry Smith   }
3200ed3bfb6SBarry Smith   opt  = PETSC_FALSE;
3210ed3bfb6SBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt);CHKERRQ(ierr);
3220ed3bfb6SBarry Smith   if (opt) {
3230ed3bfb6SBarry Smith     TSMonitorDrawCtx ctx;
3240ed3bfb6SBarry Smith     PetscInt         howoften = 1;
3250ed3bfb6SBarry Smith 
3260ed3bfb6SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL);CHKERRQ(ierr);
327c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3280ed3bfb6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3290ed3bfb6SBarry Smith   }
330fde5950dSBarry Smith 
331ed81e22dSJed Brown   opt  = PETSC_FALSE;
332589a23caSBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",NULL,monfilename,sizeof(monfilename),&flg);CHKERRQ(ierr);
333ed81e22dSJed Brown   if (flg) {
334ed81e22dSJed Brown     const char *ptr,*ptr2;
335ed81e22dSJed Brown     char       *filetemplate;
336ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
337ed81e22dSJed Brown     /* Do some cursory validation of the input. */
338ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
339ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
340ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
341ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
342ce94432eSBarry 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");
343ed81e22dSJed Brown       if (ptr2) break;
344ed81e22dSJed Brown     }
345ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
346ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
347ed81e22dSJed Brown   }
348bdad233fSMatthew Knepley 
349589a23caSBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,sizeof(dir),&flg);CHKERRQ(ierr);
350d1212d36SBarry Smith   if (flg) {
351d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
352d1212d36SBarry Smith     int                  ray = 0;
3533ee9839eSMatthew G. Knepley     DMDirection          ddir;
354d1212d36SBarry Smith     DM                   da;
355d1212d36SBarry Smith     PetscMPIInt          rank;
356d1212d36SBarry Smith 
357ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
3583ee9839eSMatthew G. Knepley     if (dir[0] == 'x') ddir = DM_X;
3593ee9839eSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DM_Y;
360ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
361d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
362d1212d36SBarry Smith 
3635bd1e576SStefano Zampini     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %d\n",dir[0],ray);CHKERRQ(ierr);
364b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
365d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
366d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
367ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
368d1212d36SBarry Smith     if (!rank) {
369c793f718SLisandro Dalcin       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,NULL,NULL,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
370d1212d36SBarry Smith     }
37151b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
372d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
373d1212d36SBarry Smith   }
374589a23caSBarry Smith   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,sizeof(dir),&flg);CHKERRQ(ierr);
37551b4a12fSMatthew G. Knepley   if (flg) {
37651b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
37751b4a12fSMatthew G. Knepley     int                 ray = 0;
3783ee9839eSMatthew G. Knepley     DMDirection         ddir;
37951b4a12fSMatthew G. Knepley     DM                  da;
38051b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
381d1212d36SBarry Smith 
38251b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
3833ee9839eSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DM_X;
3843ee9839eSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DM_Y;
38551b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
38651b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3871c3436cfSJed Brown 
3885bd1e576SStefano Zampini     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %d\n", dir[0], ray);CHKERRQ(ierr);
389b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
39051b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
39151b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
392c793f718SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
39351b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
39451b4a12fSMatthew G. Knepley   }
395a7a1495cSBarry Smith 
396b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
397b3d3934dSBarry Smith   if (opt) {
398b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
399b3d3934dSBarry Smith 
400b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
401b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
402b3d3934dSBarry Smith   }
403b3d3934dSBarry Smith 
404847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
405847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
406847ff0e1SMatthew G. Knepley   if (flg) {
407847ff0e1SMatthew G. Knepley     DM   dm;
408847ff0e1SMatthew G. Knepley     DMTS tdm;
409847ff0e1SMatthew G. Knepley 
410847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
411847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
412847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
413c793f718SLisandro Dalcin     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, NULL);CHKERRQ(ierr);
414847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
415847ff0e1SMatthew G. Knepley   }
416847ff0e1SMatthew G. Knepley 
417d763cef2SBarry Smith   /* Handle specific TS options */
418d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
4196991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
420d763cef2SBarry Smith   }
421fbc52257SHong Zhang 
422a7bdc993SLisandro Dalcin   /* Handle TSAdapt options */
423a7bdc993SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
424a7bdc993SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
425a7bdc993SLisandro Dalcin   ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr);
426a7bdc993SLisandro Dalcin 
42768bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
4284f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
42968bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
43068bece0bSHong Zhang   if (tflg) {
43168bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
43268bece0bSHong Zhang   }
433a05bf03eSHong Zhang 
434a05bf03eSHong Zhang   ierr = TSAdjointSetFromOptions(PetscOptionsObject,ts);CHKERRQ(ierr);
435d763cef2SBarry Smith 
436d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
4370633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
438fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
439d763cef2SBarry Smith 
4404f122a70SLisandro Dalcin   if (ts->trajectory) {
4414f122a70SLisandro Dalcin     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
442d763cef2SBarry Smith   }
44368bece0bSHong Zhang 
4441ef27442SStefano Zampini   /* why do we have to do this here and not during TSSetUp? */
4454f122a70SLisandro Dalcin   ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr);
4461ef27442SStefano Zampini   if (ts->problem_type == TS_LINEAR) {
4471ef27442SStefano Zampini     ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&flg,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr);
4481ef27442SStefano Zampini     if (!flg) { ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); }
4491ef27442SStefano Zampini   }
4504f122a70SLisandro Dalcin   ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
451d763cef2SBarry Smith   PetscFunctionReturn(0);
452d763cef2SBarry Smith }
453d763cef2SBarry Smith 
454d2daff3dSHong Zhang /*@
45578fbdcc8SBarry Smith    TSGetTrajectory - Gets the trajectory from a TS if it exists
45678fbdcc8SBarry Smith 
45778fbdcc8SBarry Smith    Collective on TS
45878fbdcc8SBarry Smith 
45978fbdcc8SBarry Smith    Input Parameters:
46078fbdcc8SBarry Smith .  ts - the TS context obtained from TSCreate()
46178fbdcc8SBarry Smith 
4627a7aea1fSJed Brown    Output Parameters:
46378fbdcc8SBarry Smith .  tr - the TSTrajectory object, if it exists
46478fbdcc8SBarry Smith 
46578fbdcc8SBarry Smith    Note: This routine should be called after all TS options have been set
46678fbdcc8SBarry Smith 
46778fbdcc8SBarry Smith    Level: advanced
46878fbdcc8SBarry Smith 
46978fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate()
47078fbdcc8SBarry Smith 
47178fbdcc8SBarry Smith @*/
47278fbdcc8SBarry Smith PetscErrorCode  TSGetTrajectory(TS ts,TSTrajectory *tr)
47378fbdcc8SBarry Smith {
47478fbdcc8SBarry Smith   PetscFunctionBegin;
47578fbdcc8SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
47678fbdcc8SBarry Smith   *tr = ts->trajectory;
47778fbdcc8SBarry Smith   PetscFunctionReturn(0);
47878fbdcc8SBarry Smith }
47978fbdcc8SBarry Smith 
48078fbdcc8SBarry Smith /*@
481bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
482d2daff3dSHong Zhang 
483d2daff3dSHong Zhang    Collective on TS
484d2daff3dSHong Zhang 
485d2daff3dSHong Zhang    Input Parameters:
486bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
487bc952696SBarry Smith 
48878fbdcc8SBarry Smith    Options Database:
48978fbdcc8SBarry Smith +  -ts_save_trajectory - saves the trajectory to a file
49078fbdcc8SBarry Smith -  -ts_trajectory_type type
49178fbdcc8SBarry Smith 
49268bece0bSHong Zhang Note: This routine should be called after all TS options have been set
493d2daff3dSHong Zhang 
494c3a89c15SBarry Smith     The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/lib/petsc/bin/PetscBinaryIOTrajectory.py and
49578fbdcc8SBarry Smith    MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m
49678fbdcc8SBarry Smith 
497d2daff3dSHong Zhang    Level: intermediate
498d2daff3dSHong Zhang 
4992d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve()
500d2daff3dSHong Zhang 
501d2daff3dSHong Zhang @*/
502bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
503d2daff3dSHong Zhang {
504bc952696SBarry Smith   PetscErrorCode ierr;
505bc952696SBarry Smith 
506d2daff3dSHong Zhang   PetscFunctionBegin;
507d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
508bc952696SBarry Smith   if (!ts->trajectory) {
509bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
510bc952696SBarry Smith   }
511d2daff3dSHong Zhang   PetscFunctionReturn(0);
512d2daff3dSHong Zhang }
513d2daff3dSHong Zhang 
514a7a1495cSBarry Smith /*@
5152d29f1f2SStefano Zampini    TSResetTrajectory - Destroys and recreates the internal TSTrajectory object
5162d29f1f2SStefano Zampini 
5172d29f1f2SStefano Zampini    Collective on TS
5182d29f1f2SStefano Zampini 
5192d29f1f2SStefano Zampini    Input Parameters:
5202d29f1f2SStefano Zampini .  ts - the TS context obtained from TSCreate()
5212d29f1f2SStefano Zampini 
5222d29f1f2SStefano Zampini    Level: intermediate
5232d29f1f2SStefano Zampini 
5242d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve()
5252d29f1f2SStefano Zampini 
5262d29f1f2SStefano Zampini @*/
5272d29f1f2SStefano Zampini PetscErrorCode  TSResetTrajectory(TS ts)
5282d29f1f2SStefano Zampini {
5292d29f1f2SStefano Zampini   PetscErrorCode ierr;
5302d29f1f2SStefano Zampini 
5312d29f1f2SStefano Zampini   PetscFunctionBegin;
5322d29f1f2SStefano Zampini   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5332d29f1f2SStefano Zampini   if (ts->trajectory) {
5342d29f1f2SStefano Zampini     ierr = TSTrajectoryDestroy(&ts->trajectory);CHKERRQ(ierr);
5352d29f1f2SStefano Zampini     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
5362d29f1f2SStefano Zampini   }
5372d29f1f2SStefano Zampini   PetscFunctionReturn(0);
5382d29f1f2SStefano Zampini }
5392d29f1f2SStefano Zampini 
5402d29f1f2SStefano Zampini /*@
541a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
542a7a1495cSBarry Smith       set with TSSetRHSJacobian().
543a7a1495cSBarry Smith 
544d083f849SBarry Smith    Collective on TS
545a7a1495cSBarry Smith 
546a7a1495cSBarry Smith    Input Parameters:
547316643e7SJed Brown +  ts - the TS context
548a7a1495cSBarry Smith .  t - current timestep
5490910c330SBarry Smith -  U - input vector
550a7a1495cSBarry Smith 
551a7a1495cSBarry Smith    Output Parameters:
552a7a1495cSBarry Smith +  A - Jacobian matrix
553a7a1495cSBarry Smith .  B - optional preconditioning matrix
554a7a1495cSBarry Smith -  flag - flag indicating matrix structure
555a7a1495cSBarry Smith 
556a7a1495cSBarry Smith    Notes:
557a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
558a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
559a7a1495cSBarry Smith 
56094b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
561a7a1495cSBarry Smith    flag parameter.
562a7a1495cSBarry Smith 
563a7a1495cSBarry Smith    Level: developer
564a7a1495cSBarry Smith 
56594b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
566a7a1495cSBarry Smith @*/
567d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
568a7a1495cSBarry Smith {
569dfbe8321SBarry Smith   PetscErrorCode   ierr;
570270bf2e7SJed Brown   PetscObjectState Ustate;
5716c1e1eecSBarry Smith   PetscObjectId    Uid;
57224989b8cSPeter Brune   DM               dm;
573942e3340SBarry Smith   DMTS             tsdm;
57424989b8cSPeter Brune   TSRHSJacobian    rhsjacobianfunc;
57524989b8cSPeter Brune   void             *ctx;
576b2df71adSDebojyoti Ghosh   TSRHSFunction    rhsfunction;
577a7a1495cSBarry Smith 
578a7a1495cSBarry Smith   PetscFunctionBegin;
5790700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5800910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5810910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
58224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
583942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
5846374d434SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
5852663174eSHong Zhang   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
58659e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
5876c1e1eecSBarry Smith   ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr);
588971015bcSStefano Zampini 
5892663174eSHong Zhang   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) PetscFunctionReturn(0);
590d90be118SSean Farley 
591ae692cf2SHong Zhang   if (ts->rhsjacobian.shift && ts->rhsjacobian.reuse) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Should not call TSComputeRHSJacobian() on a shifted matrix (shift=%lf) when RHSJacobian is reusable.",ts->rhsjacobian.shift);
59224989b8cSPeter Brune   if (rhsjacobianfunc) {
59394ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
594a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
595d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
596a7a1495cSBarry Smith     PetscStackPop;
59794ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
598ef66eb69SBarry Smith   } else {
59994ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
600971015bcSStefano Zampini     if (B && A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
601ef66eb69SBarry Smith   }
6020e4ef248SJed Brown   ts->rhsjacobian.time  = t;
603971015bcSStefano Zampini   ts->rhsjacobian.shift = 0;
604971015bcSStefano Zampini   ts->rhsjacobian.scale = 1.;
6057f79407eSBarry Smith   ierr                  = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr);
60659e4f3c8SBarry Smith   ierr                  = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
607a7a1495cSBarry Smith   PetscFunctionReturn(0);
608a7a1495cSBarry Smith }
609a7a1495cSBarry Smith 
610316643e7SJed Brown /*@
611d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
612d763cef2SBarry Smith 
613d083f849SBarry Smith    Collective on TS
614316643e7SJed Brown 
615316643e7SJed Brown    Input Parameters:
616316643e7SJed Brown +  ts - the TS context
617316643e7SJed Brown .  t - current time
6180910c330SBarry Smith -  U - state vector
619316643e7SJed Brown 
620316643e7SJed Brown    Output Parameter:
621316643e7SJed Brown .  y - right hand side
622316643e7SJed Brown 
623316643e7SJed Brown    Note:
624316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
625316643e7SJed Brown    is used internally within the nonlinear solvers.
626316643e7SJed Brown 
627316643e7SJed Brown    Level: developer
628316643e7SJed Brown 
629316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
630316643e7SJed Brown @*/
6310910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
632d763cef2SBarry Smith {
633dfbe8321SBarry Smith   PetscErrorCode ierr;
63424989b8cSPeter Brune   TSRHSFunction  rhsfunction;
63524989b8cSPeter Brune   TSIFunction    ifunction;
63624989b8cSPeter Brune   void           *ctx;
63724989b8cSPeter Brune   DM             dm;
63824989b8cSPeter Brune 
639d763cef2SBarry Smith   PetscFunctionBegin;
6400700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6410910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6420700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
64324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
64424989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
6450298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
646d763cef2SBarry Smith 
647ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
648d763cef2SBarry Smith 
6490910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
65024989b8cSPeter Brune   if (rhsfunction) {
6511be370b1SHong Zhang     ierr = VecLockReadPush(U);CHKERRQ(ierr);
652d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
6530910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
654d763cef2SBarry Smith     PetscStackPop;
6551be370b1SHong Zhang     ierr = VecLockReadPop(U);CHKERRQ(ierr);
656214bc6a2SJed Brown   } else {
657214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
658b2cd27e8SJed Brown   }
65944a41b28SSean Farley 
6600910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
661d763cef2SBarry Smith   PetscFunctionReturn(0);
662d763cef2SBarry Smith }
663d763cef2SBarry Smith 
664ef20d060SBarry Smith /*@
665ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
666ef20d060SBarry Smith 
667d083f849SBarry Smith    Collective on TS
668ef20d060SBarry Smith 
669ef20d060SBarry Smith    Input Parameters:
670ef20d060SBarry Smith +  ts - the TS context
671ef20d060SBarry Smith -  t - current time
672ef20d060SBarry Smith 
673ef20d060SBarry Smith    Output Parameter:
6740910c330SBarry Smith .  U - the solution
675ef20d060SBarry Smith 
676ef20d060SBarry Smith    Note:
677ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
678ef20d060SBarry Smith    is used internally within the nonlinear solvers.
679ef20d060SBarry Smith 
680ef20d060SBarry Smith    Level: developer
681ef20d060SBarry Smith 
682abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
683ef20d060SBarry Smith @*/
6840910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
685ef20d060SBarry Smith {
686ef20d060SBarry Smith   PetscErrorCode     ierr;
687ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
688ef20d060SBarry Smith   void               *ctx;
689ef20d060SBarry Smith   DM                 dm;
690ef20d060SBarry Smith 
691ef20d060SBarry Smith   PetscFunctionBegin;
692ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6930910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
694ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
695ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
696ef20d060SBarry Smith 
697ef20d060SBarry Smith   if (solutionfunction) {
6989b7cd975SBarry Smith     PetscStackPush("TS user solution function");
6990910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
700ef20d060SBarry Smith     PetscStackPop;
701ef20d060SBarry Smith   }
702ef20d060SBarry Smith   PetscFunctionReturn(0);
703ef20d060SBarry Smith }
7049b7cd975SBarry Smith /*@
7059b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
7069b7cd975SBarry Smith 
707d083f849SBarry Smith    Collective on TS
7089b7cd975SBarry Smith 
7099b7cd975SBarry Smith    Input Parameters:
7109b7cd975SBarry Smith +  ts - the TS context
7119b7cd975SBarry Smith -  t - current time
7129b7cd975SBarry Smith 
7139b7cd975SBarry Smith    Output Parameter:
7149b7cd975SBarry Smith .  U - the function value
7159b7cd975SBarry Smith 
7169b7cd975SBarry Smith    Note:
7179b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
7189b7cd975SBarry Smith    is used internally within the nonlinear solvers.
7199b7cd975SBarry Smith 
7209b7cd975SBarry Smith    Level: developer
7219b7cd975SBarry Smith 
7229b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7239b7cd975SBarry Smith @*/
7249b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7259b7cd975SBarry Smith {
7269b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7279b7cd975SBarry Smith   void               *ctx;
7289b7cd975SBarry Smith   DM                 dm;
7299b7cd975SBarry Smith 
7309b7cd975SBarry Smith   PetscFunctionBegin;
7319b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7329b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7339b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7349b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7359b7cd975SBarry Smith 
7369b7cd975SBarry Smith   if (forcing) {
7379b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
7389b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
7399b7cd975SBarry Smith     PetscStackPop;
7409b7cd975SBarry Smith   }
7419b7cd975SBarry Smith   PetscFunctionReturn(0);
7429b7cd975SBarry Smith }
743ef20d060SBarry Smith 
744214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
745214bc6a2SJed Brown {
7462dd45cf8SJed Brown   Vec            F;
747214bc6a2SJed Brown   PetscErrorCode ierr;
748214bc6a2SJed Brown 
749214bc6a2SJed Brown   PetscFunctionBegin;
7500298fd71SBarry Smith   *Frhs = NULL;
7510298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
752214bc6a2SJed Brown   if (!ts->Frhs) {
7532dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
754214bc6a2SJed Brown   }
755214bc6a2SJed Brown   *Frhs = ts->Frhs;
756214bc6a2SJed Brown   PetscFunctionReturn(0);
757214bc6a2SJed Brown }
758214bc6a2SJed Brown 
759971015bcSStefano Zampini PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
760214bc6a2SJed Brown {
761214bc6a2SJed Brown   Mat            A,B;
7622dd45cf8SJed Brown   PetscErrorCode ierr;
76341a1d4d2SBarry Smith   TSIJacobian    ijacobian;
764214bc6a2SJed Brown 
765214bc6a2SJed Brown   PetscFunctionBegin;
766c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
767c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
76841a1d4d2SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr);
769214bc6a2SJed Brown   if (Arhs) {
770214bc6a2SJed Brown     if (!ts->Arhs) {
77141a1d4d2SBarry Smith       if (ijacobian) {
772214bc6a2SJed Brown         ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
77341a1d4d2SBarry Smith       } else {
77441a1d4d2SBarry Smith         ts->Arhs = A;
77541a1d4d2SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
77641a1d4d2SBarry Smith       }
7773565c898SBarry Smith     } else {
7783565c898SBarry Smith       PetscBool flg;
7793565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
7803565c898SBarry Smith       /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */
7813565c898SBarry Smith       if (flg && !ijacobian && ts->Arhs == ts->Brhs){
7823565c898SBarry Smith         ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr);
7833565c898SBarry Smith         ts->Arhs = A;
7843565c898SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
7853565c898SBarry Smith       }
786214bc6a2SJed Brown     }
787214bc6a2SJed Brown     *Arhs = ts->Arhs;
788214bc6a2SJed Brown   }
789214bc6a2SJed Brown   if (Brhs) {
790214bc6a2SJed Brown     if (!ts->Brhs) {
791bdb70873SJed Brown       if (A != B) {
79241a1d4d2SBarry Smith         if (ijacobian) {
793214bc6a2SJed Brown           ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
794bdb70873SJed Brown         } else {
79541a1d4d2SBarry Smith           ts->Brhs = B;
79641a1d4d2SBarry Smith           ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
79741a1d4d2SBarry Smith         }
79841a1d4d2SBarry Smith       } else {
799bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
80051699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
801bdb70873SJed Brown       }
802214bc6a2SJed Brown     }
803214bc6a2SJed Brown     *Brhs = ts->Brhs;
804214bc6a2SJed Brown   }
805214bc6a2SJed Brown   PetscFunctionReturn(0);
806214bc6a2SJed Brown }
807214bc6a2SJed Brown 
808316643e7SJed Brown /*@
8090910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
810316643e7SJed Brown 
811d083f849SBarry Smith    Collective on TS
812316643e7SJed Brown 
813316643e7SJed Brown    Input Parameters:
814316643e7SJed Brown +  ts - the TS context
815316643e7SJed Brown .  t - current time
8160910c330SBarry Smith .  U - state vector
8170910c330SBarry Smith .  Udot - time derivative of state vector
818214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
819316643e7SJed Brown 
820316643e7SJed Brown    Output Parameter:
821316643e7SJed Brown .  Y - right hand side
822316643e7SJed Brown 
823316643e7SJed Brown    Note:
824316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
825316643e7SJed Brown    is used internally within the nonlinear solvers.
826316643e7SJed Brown 
827316643e7SJed Brown    If the user did did not write their equations in implicit form, this
828316643e7SJed Brown    function recasts them in implicit form.
829316643e7SJed Brown 
830316643e7SJed Brown    Level: developer
831316643e7SJed Brown 
832316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
833316643e7SJed Brown @*/
8340910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
835316643e7SJed Brown {
836316643e7SJed Brown   PetscErrorCode ierr;
83724989b8cSPeter Brune   TSIFunction    ifunction;
83824989b8cSPeter Brune   TSRHSFunction  rhsfunction;
83924989b8cSPeter Brune   void           *ctx;
84024989b8cSPeter Brune   DM             dm;
841316643e7SJed Brown 
842316643e7SJed Brown   PetscFunctionBegin;
8430700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8440910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8450910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
8460700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
847316643e7SJed Brown 
84824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
84924989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
8500298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
85124989b8cSPeter Brune 
852ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
853d90be118SSean Farley 
8540910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
85524989b8cSPeter Brune   if (ifunction) {
856316643e7SJed Brown     PetscStackPush("TS user implicit function");
8570910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
858316643e7SJed Brown     PetscStackPop;
859214bc6a2SJed Brown   }
860214bc6a2SJed Brown   if (imex) {
86124989b8cSPeter Brune     if (!ifunction) {
8620910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
8632dd45cf8SJed Brown     }
86424989b8cSPeter Brune   } else if (rhsfunction) {
86524989b8cSPeter Brune     if (ifunction) {
866214bc6a2SJed Brown       Vec Frhs;
867214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
8680910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
869214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
8702dd45cf8SJed Brown     } else {
8710910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
8720910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
873316643e7SJed Brown     }
8744a6899ffSJed Brown   }
8750910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
876316643e7SJed Brown   PetscFunctionReturn(0);
877316643e7SJed Brown }
878316643e7SJed Brown 
879cfa8a9a2SHong Zhang /*
880cfa8a9a2SHong Zhang    TSRecoverRHSJacobian - Recover the Jacobian matrix so that one can call TSComputeRHSJacobian() on it.
881cfa8a9a2SHong Zhang 
882cfa8a9a2SHong Zhang    Note:
883cfa8a9a2SHong Zhang    This routine is needed when one switches from TSComputeIJacobian() to TSComputeRHSJacobian() because the Jacobian matrix may be shifted or scaled in TSComputeIJacobian().
884cfa8a9a2SHong Zhang 
885cfa8a9a2SHong Zhang */
886cfa8a9a2SHong Zhang static PetscErrorCode TSRecoverRHSJacobian(TS ts,Mat A,Mat B)
887cfa8a9a2SHong Zhang {
888cfa8a9a2SHong Zhang   PetscErrorCode   ierr;
889cfa8a9a2SHong Zhang 
890cfa8a9a2SHong Zhang   PetscFunctionBegin;
891cfa8a9a2SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
89203c97d52SHong Zhang   if (A != ts->Arhs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Invalid Amat");
89303c97d52SHong Zhang   if (B != ts->Brhs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Invalid Bmat");
894cfa8a9a2SHong Zhang 
895cfa8a9a2SHong Zhang   if (ts->rhsjacobian.shift) {
896cfa8a9a2SHong Zhang     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
897cfa8a9a2SHong Zhang   }
898cfa8a9a2SHong Zhang   if (ts->rhsjacobian.scale == -1.) {
899cfa8a9a2SHong Zhang     ierr = MatScale(A,-1);CHKERRQ(ierr);
900cfa8a9a2SHong Zhang   }
901cfa8a9a2SHong Zhang   if (B && B == ts->Brhs && A != B) {
902cfa8a9a2SHong Zhang     if (ts->rhsjacobian.shift) {
903cfa8a9a2SHong Zhang       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
904cfa8a9a2SHong Zhang     }
905cfa8a9a2SHong Zhang     if (ts->rhsjacobian.scale == -1.) {
906cfa8a9a2SHong Zhang       ierr = MatScale(B,-1);CHKERRQ(ierr);
907cfa8a9a2SHong Zhang     }
908cfa8a9a2SHong Zhang   }
909cfa8a9a2SHong Zhang   ts->rhsjacobian.shift = 0;
910cfa8a9a2SHong Zhang   ts->rhsjacobian.scale = 1.;
911cfa8a9a2SHong Zhang   PetscFunctionReturn(0);
912cfa8a9a2SHong Zhang }
913cfa8a9a2SHong Zhang 
914316643e7SJed Brown /*@
915316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
916316643e7SJed Brown 
917d083f849SBarry Smith    Collective on TS
918316643e7SJed Brown 
919316643e7SJed Brown    Input
920316643e7SJed Brown       Input Parameters:
921316643e7SJed Brown +  ts - the TS context
922316643e7SJed Brown .  t - current timestep
9230910c330SBarry Smith .  U - state vector
9240910c330SBarry Smith .  Udot - time derivative of state vector
925214bc6a2SJed Brown .  shift - shift to apply, see note below
926214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
927316643e7SJed Brown 
928316643e7SJed Brown    Output Parameters:
929316643e7SJed Brown +  A - Jacobian matrix
9303565c898SBarry Smith -  B - matrix from which the preconditioner is constructed; often the same as A
931316643e7SJed Brown 
932316643e7SJed Brown    Notes:
9330910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
934316643e7SJed Brown 
9350910c330SBarry Smith    dF/dU + shift*dF/dUdot
936316643e7SJed Brown 
937316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
938316643e7SJed Brown    is used internally within the nonlinear solvers.
939316643e7SJed Brown 
940316643e7SJed Brown    Level: developer
941316643e7SJed Brown 
942316643e7SJed Brown .seealso:  TSSetIJacobian()
94363495f91SJed Brown @*/
944d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
945316643e7SJed Brown {
946316643e7SJed Brown   PetscErrorCode ierr;
94724989b8cSPeter Brune   TSIJacobian    ijacobian;
94824989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
94924989b8cSPeter Brune   DM             dm;
95024989b8cSPeter Brune   void           *ctx;
951316643e7SJed Brown 
952316643e7SJed Brown   PetscFunctionBegin;
9530700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9540910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9550910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
956316643e7SJed Brown   PetscValidPointer(A,6);
95794ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
958316643e7SJed Brown   PetscValidPointer(B,7);
95994ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
96024989b8cSPeter Brune 
96124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
96224989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
9630298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
96424989b8cSPeter Brune 
965ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
966316643e7SJed Brown 
96794ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
96824989b8cSPeter Brune   if (ijacobian) {
969316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
970d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
971316643e7SJed Brown     PetscStackPop;
9724a6899ffSJed Brown   }
973214bc6a2SJed Brown   if (imex) {
974b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
9754c26be97Sstefano_zampini       PetscBool assembled;
976971015bcSStefano Zampini       if (rhsjacobian) {
977971015bcSStefano Zampini         Mat Arhs = NULL;
978971015bcSStefano Zampini         ierr = TSGetRHSMats_Private(ts,&Arhs,NULL);CHKERRQ(ierr);
979971015bcSStefano Zampini         if (A == Arhs) {
980e8b1e424SHong Zhang           if (rhsjacobian == TSComputeRHSJacobianConstant) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Unsupported operation! cannot use TSComputeRHSJacobianConstant"); /* there is no way to reconstruct shift*M-J since J cannot be reevaluated */
981971015bcSStefano Zampini           ts->rhsjacobian.time = PETSC_MIN_REAL;
982971015bcSStefano Zampini         }
983971015bcSStefano Zampini       }
98494ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
9854c26be97Sstefano_zampini       ierr = MatAssembled(A,&assembled);CHKERRQ(ierr);
9864c26be97Sstefano_zampini       if (!assembled) {
9874c26be97Sstefano_zampini         ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9884c26be97Sstefano_zampini         ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9894c26be97Sstefano_zampini       }
99094ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
99194ab13aaSBarry Smith       if (A != B) {
99294ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
9934c26be97Sstefano_zampini         ierr = MatAssembled(B,&assembled);CHKERRQ(ierr);
9944c26be97Sstefano_zampini         if (!assembled) {
9954c26be97Sstefano_zampini           ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9964c26be97Sstefano_zampini           ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9974c26be97Sstefano_zampini         }
99894ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
999214bc6a2SJed Brown       }
1000214bc6a2SJed Brown     }
1001214bc6a2SJed Brown   } else {
1002e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
1003e8b1e424SHong Zhang     if (rhsjacobian) { /* RHSJacobian needs to be converted to part of IJacobian if exists */
1004214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
1005e1244c69SJed Brown     }
1006e8b1e424SHong Zhang     if (Arhs == A) { /* No IJacobian matrix, so we only have the RHS matrix */
1007e8b1e424SHong Zhang       PetscObjectState Ustate;
1008e8b1e424SHong Zhang       PetscObjectId    Uid;
1009e8b1e424SHong Zhang       TSRHSFunction    rhsfunction;
1010e8b1e424SHong Zhang 
1011e8b1e424SHong Zhang       ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
1012e8b1e424SHong Zhang       ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
1013e8b1e424SHong Zhang       ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr);
1014097a96a2SHong Zhang       if ((rhsjacobian == TSComputeRHSJacobianConstant || (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && rhsfunction != TSComputeRHSFunctionLinear)) && ts->rhsjacobian.scale == -1.) { /* No need to recompute RHSJacobian */
1015e8b1e424SHong Zhang         ierr = MatShift(A,shift-ts->rhsjacobian.shift);CHKERRQ(ierr); /* revert the old shift and add the new shift with a single call to MatShift */
101634d322a1SHong Zhang         if (A != B) {
101734d322a1SHong Zhang           ierr = MatShift(B,shift-ts->rhsjacobian.shift);CHKERRQ(ierr);
101834d322a1SHong Zhang         }
1019e8b1e424SHong Zhang       } else {
10203565c898SBarry Smith         PetscBool flg;
1021e8b1e424SHong Zhang 
1022e8b1e424SHong Zhang         if (ts->rhsjacobian.reuse) { /* Undo the damage */
1023e8b1e424SHong Zhang           /* MatScale has a short path for this case.
1024e8b1e424SHong Zhang              However, this code path is taken the first time TSComputeRHSJacobian is called
1025e8b1e424SHong Zhang              and the matrices have not been assembled yet */
1026cfa8a9a2SHong Zhang           ierr = TSRecoverRHSJacobian(ts,A,B);CHKERRQ(ierr);
1027e8b1e424SHong Zhang         }
1028e8b1e424SHong Zhang         ierr = TSComputeRHSJacobian(ts,t,U,A,B);CHKERRQ(ierr);
10293565c898SBarry Smith         ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
10303565c898SBarry Smith         /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */
10313565c898SBarry Smith         if (!flg) {
103294ab13aaSBarry Smith           ierr = MatScale(A,-1);CHKERRQ(ierr);
103394ab13aaSBarry Smith           ierr = MatShift(A,shift);CHKERRQ(ierr);
10343565c898SBarry Smith         }
103594ab13aaSBarry Smith         if (A != B) {
103694ab13aaSBarry Smith           ierr = MatScale(B,-1);CHKERRQ(ierr);
103794ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
1038316643e7SJed Brown         }
1039e8b1e424SHong Zhang       }
1040e8b1e424SHong Zhang       ts->rhsjacobian.scale = -1;
1041e8b1e424SHong Zhang       ts->rhsjacobian.shift = shift;
1042e8b1e424SHong Zhang     } else if (Arhs) {  /* Both IJacobian and RHSJacobian exist or the RHS matrix provided (A) is different from the internal RHS matrix (Arhs) */
1043e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1044e8b1e424SHong Zhang 
1045e1244c69SJed Brown       if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */
104694ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
104794ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
104894ab13aaSBarry Smith         if (A != B) {
104994ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
105094ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
1051214bc6a2SJed Brown         }
1052316643e7SJed Brown       }
1053e8b1e424SHong Zhang       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
105494ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
105594ab13aaSBarry Smith       if (A != B) {
105694ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
1057316643e7SJed Brown       }
1058316643e7SJed Brown     }
1059316643e7SJed Brown   }
106094ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
1061316643e7SJed Brown   PetscFunctionReturn(0);
1062316643e7SJed Brown }
1063316643e7SJed Brown 
1064d763cef2SBarry Smith /*@C
1065d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
1066b5abc632SBarry Smith     where U_t = G(t,u).
1067d763cef2SBarry Smith 
10683f9fe445SBarry Smith     Logically Collective on TS
1069d763cef2SBarry Smith 
1070d763cef2SBarry Smith     Input Parameters:
1071d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
10720298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
1073d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
1074d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
10750298fd71SBarry Smith           function evaluation routine (may be NULL)
1076d763cef2SBarry Smith 
1077a96d6ef6SBarry Smith     Calling sequence of f:
1078a96d6ef6SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,Vec F,void *ctx);
1079d763cef2SBarry Smith 
1080a96d6ef6SBarry Smith +   ts - timestep context
1081a96d6ef6SBarry Smith .   t - current timestep
1082d763cef2SBarry Smith .   u - input vector
1083d763cef2SBarry Smith .   F - function vector
1084d763cef2SBarry Smith -   ctx - [optional] user-defined function context
1085d763cef2SBarry Smith 
1086d763cef2SBarry Smith     Level: beginner
1087d763cef2SBarry Smith 
108895452b02SPatrick Sanan     Notes:
108995452b02SPatrick Sanan     You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
10902bbac0d3SBarry Smith 
1091ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
1092d763cef2SBarry Smith @*/
1093089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
1094d763cef2SBarry Smith {
1095089b2837SJed Brown   PetscErrorCode ierr;
1096089b2837SJed Brown   SNES           snes;
10970298fd71SBarry Smith   Vec            ralloc = NULL;
109824989b8cSPeter Brune   DM             dm;
1099d763cef2SBarry Smith 
1100089b2837SJed Brown   PetscFunctionBegin;
11010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1102ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
110324989b8cSPeter Brune 
110424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
110524989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1106089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1107e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1108e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1109e856ceecSJed Brown     r = ralloc;
1110e856ceecSJed Brown   }
1111089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1112e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1113d763cef2SBarry Smith   PetscFunctionReturn(0);
1114d763cef2SBarry Smith }
1115d763cef2SBarry Smith 
1116ef20d060SBarry Smith /*@C
1117abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1118ef20d060SBarry Smith 
1119ef20d060SBarry Smith     Logically Collective on TS
1120ef20d060SBarry Smith 
1121ef20d060SBarry Smith     Input Parameters:
1122ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1123ef20d060SBarry Smith .   f - routine for evaluating the solution
1124ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
11250298fd71SBarry Smith           function evaluation routine (may be NULL)
1126ef20d060SBarry Smith 
1127a96d6ef6SBarry Smith     Calling sequence of f:
1128a96d6ef6SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,void *ctx);
1129ef20d060SBarry Smith 
1130ef20d060SBarry Smith +   t - current timestep
1131ef20d060SBarry Smith .   u - output vector
1132ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1133ef20d060SBarry Smith 
11340ed3bfb6SBarry Smith     Options Database:
11350ed3bfb6SBarry Smith +  -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction()
11360ed3bfb6SBarry Smith -  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
11370ed3bfb6SBarry Smith 
1138abd5a294SJed Brown     Notes:
1139abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1140abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1141abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1142abd5a294SJed Brown 
11434f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1144abd5a294SJed Brown 
1145ef20d060SBarry Smith     Level: beginner
1146ef20d060SBarry Smith 
11470ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError()
1148ef20d060SBarry Smith @*/
1149ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1150ef20d060SBarry Smith {
1151ef20d060SBarry Smith   PetscErrorCode ierr;
1152ef20d060SBarry Smith   DM             dm;
1153ef20d060SBarry Smith 
1154ef20d060SBarry Smith   PetscFunctionBegin;
1155ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1156ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1157ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1158ef20d060SBarry Smith   PetscFunctionReturn(0);
1159ef20d060SBarry Smith }
1160ef20d060SBarry Smith 
11619b7cd975SBarry Smith /*@C
11629b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
11639b7cd975SBarry Smith 
11649b7cd975SBarry Smith     Logically Collective on TS
11659b7cd975SBarry Smith 
11669b7cd975SBarry Smith     Input Parameters:
11679b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
1168e162b725SBarry Smith .   func - routine for evaluating the forcing function
11699b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
11700298fd71SBarry Smith           function evaluation routine (may be NULL)
11719b7cd975SBarry Smith 
11729b7cd975SBarry Smith     Calling sequence of func:
11736bc98fa9SBarry Smith $     PetscErrorCode func (TS ts,PetscReal t,Vec f,void *ctx);
11749b7cd975SBarry Smith 
11759b7cd975SBarry Smith +   t - current timestep
1176e162b725SBarry Smith .   f - output vector
11779b7cd975SBarry Smith -   ctx - [optional] user-defined function context
11789b7cd975SBarry Smith 
11799b7cd975SBarry Smith     Notes:
11809b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
1181e162b725SBarry 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
1182e162b725SBarry Smith     definition of the problem you are solving and hence possibly introducing bugs.
1183e162b725SBarry Smith 
1184e162b725SBarry Smith     This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0
1185e162b725SBarry Smith 
1186e162b725SBarry 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
1187e162b725SBarry Smith     parameters can be passed in the ctx variable.
11889b7cd975SBarry Smith 
11899b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
11909b7cd975SBarry Smith 
11919b7cd975SBarry Smith     Level: beginner
11929b7cd975SBarry Smith 
11939b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
11949b7cd975SBarry Smith @*/
1195e162b725SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx)
11969b7cd975SBarry Smith {
11979b7cd975SBarry Smith   PetscErrorCode ierr;
11989b7cd975SBarry Smith   DM             dm;
11999b7cd975SBarry Smith 
12009b7cd975SBarry Smith   PetscFunctionBegin;
12019b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
12029b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1203e162b725SBarry Smith   ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr);
12049b7cd975SBarry Smith   PetscFunctionReturn(0);
12059b7cd975SBarry Smith }
12069b7cd975SBarry Smith 
1207d763cef2SBarry Smith /*@C
1208f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1209b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1210d763cef2SBarry Smith 
12113f9fe445SBarry Smith    Logically Collective on TS
1212d763cef2SBarry Smith 
1213d763cef2SBarry Smith    Input Parameters:
1214d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1215e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1216e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1217d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1218d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
12190298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1220d763cef2SBarry Smith 
1221f7ab8db6SBarry Smith    Calling sequence of f:
1222a96d6ef6SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1223d763cef2SBarry Smith 
1224d763cef2SBarry Smith +  t - current timestep
1225d763cef2SBarry Smith .  u - input vector
1226e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1227e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1228d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1229d763cef2SBarry Smith 
12306cd88445SBarry Smith    Notes:
12316cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
12326cd88445SBarry Smith 
12336cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1234ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1235d763cef2SBarry Smith 
1236d763cef2SBarry Smith    Level: beginner
1237d763cef2SBarry Smith 
1238ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1239d763cef2SBarry Smith 
1240d763cef2SBarry Smith @*/
1241e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1242d763cef2SBarry Smith {
1243277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1244089b2837SJed Brown   SNES           snes;
124524989b8cSPeter Brune   DM             dm;
124624989b8cSPeter Brune   TSIJacobian    ijacobian;
1247277b19d0SLisandro Dalcin 
1248d763cef2SBarry Smith   PetscFunctionBegin;
12490700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1250e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1251e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1252e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1253e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1254d763cef2SBarry Smith 
125524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
125624989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
12570298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1258089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12595f659677SPeter Brune   if (!ijacobian) {
1260e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
12610e4ef248SJed Brown   }
1262e5d3d808SBarry Smith   if (Amat) {
1263e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
12640e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1265e5d3d808SBarry Smith     ts->Arhs = Amat;
12660e4ef248SJed Brown   }
1267e5d3d808SBarry Smith   if (Pmat) {
1268e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
12690e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1270e5d3d808SBarry Smith     ts->Brhs = Pmat;
12710e4ef248SJed Brown   }
1272d763cef2SBarry Smith   PetscFunctionReturn(0);
1273d763cef2SBarry Smith }
1274d763cef2SBarry Smith 
1275316643e7SJed Brown /*@C
1276b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1277316643e7SJed Brown 
12783f9fe445SBarry Smith    Logically Collective on TS
1279316643e7SJed Brown 
1280316643e7SJed Brown    Input Parameters:
1281316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
12820298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1283316643e7SJed Brown .  f   - the function evaluation routine
12840298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1285316643e7SJed Brown 
1286316643e7SJed Brown    Calling sequence of f:
12876bc98fa9SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1288316643e7SJed Brown 
1289316643e7SJed Brown +  t   - time at step/stage being solved
1290316643e7SJed Brown .  u   - state vector
1291316643e7SJed Brown .  u_t - time derivative of state vector
1292316643e7SJed Brown .  F   - function vector
1293316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1294316643e7SJed Brown 
1295316643e7SJed Brown    Important:
12962bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1297316643e7SJed Brown 
1298316643e7SJed Brown    Level: beginner
1299316643e7SJed Brown 
1300d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1301316643e7SJed Brown @*/
130251699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1303316643e7SJed Brown {
1304089b2837SJed Brown   PetscErrorCode ierr;
1305089b2837SJed Brown   SNES           snes;
130651699248SLisandro Dalcin   Vec            ralloc = NULL;
130724989b8cSPeter Brune   DM             dm;
1308316643e7SJed Brown 
1309316643e7SJed Brown   PetscFunctionBegin;
13100700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
131151699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
131224989b8cSPeter Brune 
131324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
131424989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
131524989b8cSPeter Brune 
1316089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
131751699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
131851699248SLisandro Dalcin     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
131951699248SLisandro Dalcin     r  = ralloc;
1320e856ceecSJed Brown   }
132151699248SLisandro Dalcin   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
132251699248SLisandro Dalcin   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1323089b2837SJed Brown   PetscFunctionReturn(0);
1324089b2837SJed Brown }
1325089b2837SJed Brown 
1326089b2837SJed Brown /*@C
1327089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1328089b2837SJed Brown 
1329089b2837SJed Brown    Not Collective
1330089b2837SJed Brown 
1331089b2837SJed Brown    Input Parameter:
1332089b2837SJed Brown .  ts - the TS context
1333089b2837SJed Brown 
1334089b2837SJed Brown    Output Parameter:
13350298fd71SBarry Smith +  r - vector to hold residual (or NULL)
13360298fd71SBarry Smith .  func - the function to compute residual (or NULL)
13370298fd71SBarry Smith -  ctx - the function context (or NULL)
1338089b2837SJed Brown 
1339089b2837SJed Brown    Level: advanced
1340089b2837SJed Brown 
1341089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1342089b2837SJed Brown @*/
1343089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1344089b2837SJed Brown {
1345089b2837SJed Brown   PetscErrorCode ierr;
1346089b2837SJed Brown   SNES           snes;
134724989b8cSPeter Brune   DM             dm;
1348089b2837SJed Brown 
1349089b2837SJed Brown   PetscFunctionBegin;
1350089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1351089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13520298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
135324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
135424989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1355089b2837SJed Brown   PetscFunctionReturn(0);
1356089b2837SJed Brown }
1357089b2837SJed Brown 
1358089b2837SJed Brown /*@C
1359089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1360089b2837SJed Brown 
1361089b2837SJed Brown    Not Collective
1362089b2837SJed Brown 
1363089b2837SJed Brown    Input Parameter:
1364089b2837SJed Brown .  ts - the TS context
1365089b2837SJed Brown 
1366089b2837SJed Brown    Output Parameter:
13670298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
13680298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
13690298fd71SBarry Smith -  ctx - the function context (or NULL)
1370089b2837SJed Brown 
1371089b2837SJed Brown    Level: advanced
1372089b2837SJed Brown 
13732bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1374089b2837SJed Brown @*/
1375089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1376089b2837SJed Brown {
1377089b2837SJed Brown   PetscErrorCode ierr;
1378089b2837SJed Brown   SNES           snes;
137924989b8cSPeter Brune   DM             dm;
1380089b2837SJed Brown 
1381089b2837SJed Brown   PetscFunctionBegin;
1382089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1383089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13840298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
138524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
138624989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1387316643e7SJed Brown   PetscFunctionReturn(0);
1388316643e7SJed Brown }
1389316643e7SJed Brown 
1390316643e7SJed Brown /*@C
1391a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1392ae8867d6SBarry Smith         provided with TSSetIFunction().
1393316643e7SJed Brown 
13943f9fe445SBarry Smith    Logically Collective on TS
1395316643e7SJed Brown 
1396316643e7SJed Brown    Input Parameters:
1397316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1398e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1399e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1400316643e7SJed Brown .  f   - the Jacobian evaluation routine
14010298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1402316643e7SJed Brown 
1403316643e7SJed Brown    Calling sequence of f:
14046bc98fa9SBarry Smith $    PetscErrorCode f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1405316643e7SJed Brown 
1406316643e7SJed Brown +  t    - time at step/stage being solved
14071b4a444bSJed Brown .  U    - state vector
14081b4a444bSJed Brown .  U_t  - time derivative of state vector
1409316643e7SJed Brown .  a    - shift
1410e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1411e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1412316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1413316643e7SJed Brown 
1414316643e7SJed Brown    Notes:
1415e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1416316643e7SJed Brown 
1417895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1418895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1419895c21f2SBarry Smith 
1420a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1421b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1422a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1423a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1424a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1425a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1426a4f0a591SBarry Smith 
14276cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
14286cd88445SBarry Smith 
14296cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1430ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1431ca5f011dSBarry Smith 
1432316643e7SJed Brown    Level: beginner
1433316643e7SJed Brown 
1434ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1435316643e7SJed Brown 
1436316643e7SJed Brown @*/
1437e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1438316643e7SJed Brown {
1439316643e7SJed Brown   PetscErrorCode ierr;
1440089b2837SJed Brown   SNES           snes;
144124989b8cSPeter Brune   DM             dm;
1442316643e7SJed Brown 
1443316643e7SJed Brown   PetscFunctionBegin;
14440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1445e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1446e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1447e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1448e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
144924989b8cSPeter Brune 
145024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
145124989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
145224989b8cSPeter Brune 
1453089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1454e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1455316643e7SJed Brown   PetscFunctionReturn(0);
1456316643e7SJed Brown }
1457316643e7SJed Brown 
1458e1244c69SJed Brown /*@
1459e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1460e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1461e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1462e1244c69SJed Brown    not been changed by the TS.
1463e1244c69SJed Brown 
1464e1244c69SJed Brown    Logically Collective
1465e1244c69SJed Brown 
1466e1244c69SJed Brown    Input Arguments:
1467e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1468e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1469e1244c69SJed Brown 
1470e1244c69SJed Brown    Level: intermediate
1471e1244c69SJed Brown 
1472e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1473e1244c69SJed Brown @*/
1474e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1475e1244c69SJed Brown {
1476e1244c69SJed Brown   PetscFunctionBegin;
1477e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1478e1244c69SJed Brown   PetscFunctionReturn(0);
1479e1244c69SJed Brown }
1480e1244c69SJed Brown 
1481efe9872eSLisandro Dalcin /*@C
1482efe9872eSLisandro Dalcin    TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1483efe9872eSLisandro Dalcin 
1484efe9872eSLisandro Dalcin    Logically Collective on TS
1485efe9872eSLisandro Dalcin 
1486efe9872eSLisandro Dalcin    Input Parameters:
1487efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1488efe9872eSLisandro Dalcin .  F   - vector to hold the residual (or NULL to have it created internally)
1489efe9872eSLisandro Dalcin .  fun - the function evaluation routine
1490efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1491efe9872eSLisandro Dalcin 
1492efe9872eSLisandro Dalcin    Calling sequence of fun:
14936bc98fa9SBarry Smith $     PetscErrorCode fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx);
1494efe9872eSLisandro Dalcin 
1495efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1496efe9872eSLisandro Dalcin .  U    - state vector
1497efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1498efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1499efe9872eSLisandro Dalcin .  F    - function vector
1500efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine (may be NULL)
1501efe9872eSLisandro Dalcin 
1502efe9872eSLisandro Dalcin    Level: beginner
1503efe9872eSLisandro Dalcin 
1504a96d6ef6SBarry Smith .seealso: TSSetI2Jacobian(), TSSetIFunction(), TSCreate(), TSSetRHSFunction()
1505efe9872eSLisandro Dalcin @*/
1506efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx)
1507efe9872eSLisandro Dalcin {
1508efe9872eSLisandro Dalcin   DM             dm;
1509efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1510efe9872eSLisandro Dalcin 
1511efe9872eSLisandro Dalcin   PetscFunctionBegin;
1512efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1513efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2);
1514efe9872eSLisandro Dalcin   ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr);
1515efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1516efe9872eSLisandro Dalcin   ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1517efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1518efe9872eSLisandro Dalcin }
1519efe9872eSLisandro Dalcin 
1520efe9872eSLisandro Dalcin /*@C
1521efe9872eSLisandro Dalcin   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1522efe9872eSLisandro Dalcin 
1523efe9872eSLisandro Dalcin   Not Collective
1524efe9872eSLisandro Dalcin 
1525efe9872eSLisandro Dalcin   Input Parameter:
1526efe9872eSLisandro Dalcin . ts - the TS context
1527efe9872eSLisandro Dalcin 
1528efe9872eSLisandro Dalcin   Output Parameter:
1529efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL)
1530efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL)
1531efe9872eSLisandro Dalcin - ctx - the function context (or NULL)
1532efe9872eSLisandro Dalcin 
1533efe9872eSLisandro Dalcin   Level: advanced
1534efe9872eSLisandro Dalcin 
1535a96d6ef6SBarry Smith .seealso: TSSetIFunction(), SNESGetFunction(), TSCreate()
1536efe9872eSLisandro Dalcin @*/
1537efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1538efe9872eSLisandro Dalcin {
1539efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1540efe9872eSLisandro Dalcin   SNES           snes;
1541efe9872eSLisandro Dalcin   DM             dm;
1542efe9872eSLisandro Dalcin 
1543efe9872eSLisandro Dalcin   PetscFunctionBegin;
1544efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1545efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1546efe9872eSLisandro Dalcin   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1547efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1548efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1549efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1550efe9872eSLisandro Dalcin }
1551efe9872eSLisandro Dalcin 
1552efe9872eSLisandro Dalcin /*@C
1553bc77d74cSLisandro Dalcin    TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1554efe9872eSLisandro Dalcin         where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1555efe9872eSLisandro Dalcin 
1556efe9872eSLisandro Dalcin    Logically Collective on TS
1557efe9872eSLisandro Dalcin 
1558efe9872eSLisandro Dalcin    Input Parameters:
1559efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1560efe9872eSLisandro Dalcin .  J   - Jacobian matrix
1561efe9872eSLisandro Dalcin .  P   - preconditioning matrix for J (may be same as J)
1562efe9872eSLisandro Dalcin .  jac - the Jacobian evaluation routine
1563efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1564efe9872eSLisandro Dalcin 
1565efe9872eSLisandro Dalcin    Calling sequence of jac:
15666bc98fa9SBarry 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);
1567efe9872eSLisandro Dalcin 
1568efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1569efe9872eSLisandro Dalcin .  U    - state vector
1570efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1571efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1572efe9872eSLisandro Dalcin .  v    - shift for U_t
1573efe9872eSLisandro Dalcin .  a    - shift for U_tt
1574efe9872eSLisandro 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
1575efe9872eSLisandro Dalcin .  P    - preconditioning matrix for J, may be same as J
1576efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine
1577efe9872eSLisandro Dalcin 
1578efe9872eSLisandro Dalcin    Notes:
1579efe9872eSLisandro Dalcin    The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1580efe9872eSLisandro Dalcin 
1581efe9872eSLisandro Dalcin    The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1582efe9872eSLisandro 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.
1583efe9872eSLisandro Dalcin    The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1584bc77d74cSLisandro Dalcin    parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1585efe9872eSLisandro Dalcin 
1586efe9872eSLisandro Dalcin    Level: beginner
1587efe9872eSLisandro Dalcin 
1588a96d6ef6SBarry Smith .seealso: TSSetI2Function(), TSGetI2Jacobian()
1589efe9872eSLisandro Dalcin @*/
1590efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1591efe9872eSLisandro Dalcin {
1592efe9872eSLisandro Dalcin   DM             dm;
1593efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1594efe9872eSLisandro Dalcin 
1595efe9872eSLisandro Dalcin   PetscFunctionBegin;
1596efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1597efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2);
1598efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3);
1599efe9872eSLisandro Dalcin   ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr);
1600efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1601efe9872eSLisandro Dalcin   ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1602efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1603efe9872eSLisandro Dalcin }
1604efe9872eSLisandro Dalcin 
1605efe9872eSLisandro Dalcin /*@C
1606efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1607efe9872eSLisandro Dalcin 
1608efe9872eSLisandro Dalcin   Not Collective, but parallel objects are returned if TS is parallel
1609efe9872eSLisandro Dalcin 
1610efe9872eSLisandro Dalcin   Input Parameter:
1611efe9872eSLisandro Dalcin . ts  - The TS context obtained from TSCreate()
1612efe9872eSLisandro Dalcin 
1613efe9872eSLisandro Dalcin   Output Parameters:
1614efe9872eSLisandro Dalcin + J  - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1615efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J
1616efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1617efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1618efe9872eSLisandro Dalcin 
161995452b02SPatrick Sanan   Notes:
162095452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
1621efe9872eSLisandro Dalcin 
1622efe9872eSLisandro Dalcin   Level: advanced
1623efe9872eSLisandro Dalcin 
1624a96d6ef6SBarry Smith .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber(), TSSetI2Jacobian(), TSGetI2Function(), TSCreate()
1625efe9872eSLisandro Dalcin 
1626efe9872eSLisandro Dalcin @*/
1627efe9872eSLisandro Dalcin PetscErrorCode  TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1628efe9872eSLisandro Dalcin {
1629efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1630efe9872eSLisandro Dalcin   SNES           snes;
1631efe9872eSLisandro Dalcin   DM             dm;
1632efe9872eSLisandro Dalcin 
1633efe9872eSLisandro Dalcin   PetscFunctionBegin;
1634efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1635efe9872eSLisandro Dalcin   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
1636efe9872eSLisandro Dalcin   ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr);
1637efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1638efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1639efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1640efe9872eSLisandro Dalcin }
1641efe9872eSLisandro Dalcin 
1642efe9872eSLisandro Dalcin /*@
1643efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1644efe9872eSLisandro Dalcin 
1645d083f849SBarry Smith   Collective on TS
1646efe9872eSLisandro Dalcin 
1647efe9872eSLisandro Dalcin   Input Parameters:
1648efe9872eSLisandro Dalcin + ts - the TS context
1649efe9872eSLisandro Dalcin . t - current time
1650efe9872eSLisandro Dalcin . U - state vector
1651efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t)
1652efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt)
1653efe9872eSLisandro Dalcin 
1654efe9872eSLisandro Dalcin   Output Parameter:
1655efe9872eSLisandro Dalcin . F - the residual vector
1656efe9872eSLisandro Dalcin 
1657efe9872eSLisandro Dalcin   Note:
1658efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1659efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1660efe9872eSLisandro Dalcin 
1661efe9872eSLisandro Dalcin   Level: developer
1662efe9872eSLisandro Dalcin 
1663a96d6ef6SBarry Smith .seealso: TSSetI2Function(), TSGetI2Function()
1664efe9872eSLisandro Dalcin @*/
1665efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1666efe9872eSLisandro Dalcin {
1667efe9872eSLisandro Dalcin   DM             dm;
1668efe9872eSLisandro Dalcin   TSI2Function   I2Function;
1669efe9872eSLisandro Dalcin   void           *ctx;
1670efe9872eSLisandro Dalcin   TSRHSFunction  rhsfunction;
1671efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1672efe9872eSLisandro Dalcin 
1673efe9872eSLisandro Dalcin   PetscFunctionBegin;
1674efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1675efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1676efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1677efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1678efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F,VEC_CLASSID,6);
1679efe9872eSLisandro Dalcin 
1680efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1681efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr);
1682efe9872eSLisandro Dalcin   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
1683efe9872eSLisandro Dalcin 
1684efe9872eSLisandro Dalcin   if (!I2Function) {
1685efe9872eSLisandro Dalcin     ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr);
1686efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1687efe9872eSLisandro Dalcin   }
1688efe9872eSLisandro Dalcin 
1689efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1690efe9872eSLisandro Dalcin 
1691efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit function");
1692efe9872eSLisandro Dalcin   ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr);
1693efe9872eSLisandro Dalcin   PetscStackPop;
1694efe9872eSLisandro Dalcin 
1695efe9872eSLisandro Dalcin   if (rhsfunction) {
1696efe9872eSLisandro Dalcin     Vec Frhs;
1697efe9872eSLisandro Dalcin     ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
1698efe9872eSLisandro Dalcin     ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
1699efe9872eSLisandro Dalcin     ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr);
1700efe9872eSLisandro Dalcin   }
1701efe9872eSLisandro Dalcin 
1702efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1703efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1704efe9872eSLisandro Dalcin }
1705efe9872eSLisandro Dalcin 
1706efe9872eSLisandro Dalcin /*@
1707efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1708efe9872eSLisandro Dalcin 
1709d083f849SBarry Smith   Collective on TS
1710efe9872eSLisandro Dalcin 
1711efe9872eSLisandro Dalcin   Input Parameters:
1712efe9872eSLisandro Dalcin + ts - the TS context
1713efe9872eSLisandro Dalcin . t - current timestep
1714efe9872eSLisandro Dalcin . U - state vector
1715efe9872eSLisandro Dalcin . V - time derivative of state vector
1716efe9872eSLisandro Dalcin . A - second time derivative of state vector
1717efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1718efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1719efe9872eSLisandro Dalcin 
1720efe9872eSLisandro Dalcin   Output Parameters:
1721efe9872eSLisandro Dalcin + J - Jacobian matrix
1722efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1723efe9872eSLisandro Dalcin 
1724efe9872eSLisandro Dalcin   Notes:
1725efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1726efe9872eSLisandro Dalcin 
1727efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1728efe9872eSLisandro Dalcin 
1729efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1730efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1731efe9872eSLisandro Dalcin 
1732efe9872eSLisandro Dalcin   Level: developer
1733efe9872eSLisandro Dalcin 
1734efe9872eSLisandro Dalcin .seealso:  TSSetI2Jacobian()
1735efe9872eSLisandro Dalcin @*/
1736efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1737efe9872eSLisandro Dalcin {
1738efe9872eSLisandro Dalcin   DM             dm;
1739efe9872eSLisandro Dalcin   TSI2Jacobian   I2Jacobian;
1740efe9872eSLisandro Dalcin   void           *ctx;
1741efe9872eSLisandro Dalcin   TSRHSJacobian  rhsjacobian;
1742efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1743efe9872eSLisandro Dalcin 
1744efe9872eSLisandro Dalcin   PetscFunctionBegin;
1745efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1746efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1747efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1748efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1749efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J,MAT_CLASSID,8);
1750efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P,MAT_CLASSID,9);
1751efe9872eSLisandro Dalcin 
1752efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1753efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr);
1754efe9872eSLisandro Dalcin   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
1755efe9872eSLisandro Dalcin 
1756efe9872eSLisandro Dalcin   if (!I2Jacobian) {
1757efe9872eSLisandro Dalcin     ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr);
1758efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1759efe9872eSLisandro Dalcin   }
1760efe9872eSLisandro Dalcin 
1761efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1762efe9872eSLisandro Dalcin 
1763efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit Jacobian");
1764efe9872eSLisandro Dalcin   ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr);
1765efe9872eSLisandro Dalcin   PetscStackPop;
1766efe9872eSLisandro Dalcin 
1767efe9872eSLisandro Dalcin   if (rhsjacobian) {
1768efe9872eSLisandro Dalcin     Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1769efe9872eSLisandro Dalcin     ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr);
1770efe9872eSLisandro Dalcin     ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr);
1771efe9872eSLisandro Dalcin     ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr);
1772efe9872eSLisandro Dalcin     if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);}
1773efe9872eSLisandro Dalcin   }
1774efe9872eSLisandro Dalcin 
1775efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1776efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1777efe9872eSLisandro Dalcin }
1778efe9872eSLisandro Dalcin 
1779438f35afSJed Brown /*@C
1780438f35afSJed Brown    TSSetTransientVariable - sets function to transform from state to transient variables
1781438f35afSJed Brown 
1782438f35afSJed Brown    Logically Collective
1783438f35afSJed Brown 
1784438f35afSJed Brown    Input Arguments:
1785438f35afSJed Brown +  ts - time stepping context on which to change the transient variable
1786a96d6ef6SBarry Smith .  tvar - a function that transforms to transient variables
1787438f35afSJed Brown -  ctx - a context for tvar
1788438f35afSJed Brown 
1789a96d6ef6SBarry Smith     Calling sequence of tvar:
1790a96d6ef6SBarry Smith $     PetscErrorCode tvar(TS ts,Vec p,Vec c,void *ctx);
1791a96d6ef6SBarry Smith 
1792a96d6ef6SBarry Smith +   ts - timestep context
1793a96d6ef6SBarry Smith .   p - input vector (primative form)
1794a96d6ef6SBarry Smith .   c - output vector, transient variables (conservative form)
1795a96d6ef6SBarry Smith -   ctx - [optional] user-defined function context
1796a96d6ef6SBarry Smith 
1797438f35afSJed Brown    Level: advanced
1798438f35afSJed Brown 
1799438f35afSJed Brown    Notes:
1800438f35afSJed Brown    This is typically used to transform from primitive to conservative variables so that a time integrator (e.g., TSBDF)
1801438f35afSJed Brown    can be conservative.  In this context, primitive variables P are used to model the state (e.g., because they lead to
1802438f35afSJed Brown    well-conditioned formulations even in limiting cases such as low-Mach or zero porosity).  The transient variable is
1803438f35afSJed Brown    C(P), specified by calling this function.  An IFunction thus receives arguments (P, Cdot) and the IJacobian must be
1804438f35afSJed Brown    evaluated via the chain rule, as in
1805438f35afSJed Brown 
1806438f35afSJed Brown      dF/dP + shift * dF/dCdot dC/dP.
1807438f35afSJed Brown 
1808438f35afSJed Brown .seealso: DMTSSetTransientVariable(), DMTSGetTransientVariable(), TSSetIFunction(), TSSetIJacobian()
1809438f35afSJed Brown @*/
1810438f35afSJed Brown PetscErrorCode TSSetTransientVariable(TS ts,TSTransientVariable tvar,void *ctx)
1811438f35afSJed Brown {
1812438f35afSJed Brown   PetscErrorCode ierr;
1813438f35afSJed Brown   DM             dm;
1814438f35afSJed Brown 
1815438f35afSJed Brown   PetscFunctionBegin;
1816438f35afSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1817438f35afSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1818438f35afSJed Brown   ierr = DMTSSetTransientVariable(dm,tvar,ctx);CHKERRQ(ierr);
1819438f35afSJed Brown   PetscFunctionReturn(0);
1820438f35afSJed Brown }
1821438f35afSJed Brown 
1822efe9872eSLisandro Dalcin /*@
1823e3c11fc1SJed Brown    TSComputeTransientVariable - transforms state (primitive) variables to transient (conservative) variables
1824e3c11fc1SJed Brown 
1825e3c11fc1SJed Brown    Logically Collective
1826e3c11fc1SJed Brown 
1827e3c11fc1SJed Brown    Input Parameters:
1828e3c11fc1SJed Brown +  ts - TS on which to compute
1829e3c11fc1SJed Brown -  U - state vector to be transformed to transient variables
1830e3c11fc1SJed Brown 
1831e3c11fc1SJed Brown    Output Parameters:
1832e3c11fc1SJed Brown .  C - transient (conservative) variable
1833e3c11fc1SJed Brown 
1834e3c11fc1SJed Brown    Developer Notes:
1835e3c11fc1SJed Brown    If DMTSSetTransientVariable() has not been called, then C is not modified in this routine and C=NULL is allowed.
1836e3c11fc1SJed Brown    This makes it safe to call without a guard.  One can use TSHasTransientVariable() to check if transient variables are
1837e3c11fc1SJed Brown    being used.
1838e3c11fc1SJed Brown 
1839e3c11fc1SJed Brown    Level: developer
1840e3c11fc1SJed Brown 
1841e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeIFunction(), TSComputeIJacobian()
1842e3c11fc1SJed Brown @*/
1843e3c11fc1SJed Brown PetscErrorCode TSComputeTransientVariable(TS ts,Vec U,Vec C)
1844e3c11fc1SJed Brown {
1845e3c11fc1SJed Brown   PetscErrorCode ierr;
1846e3c11fc1SJed Brown   DM             dm;
1847e3c11fc1SJed Brown   DMTS           dmts;
1848e3c11fc1SJed Brown 
1849e3c11fc1SJed Brown   PetscFunctionBegin;
1850e3c11fc1SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1851e3c11fc1SJed Brown   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
1852e3c11fc1SJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1853e3c11fc1SJed Brown   ierr = DMGetDMTS(dm,&dmts);CHKERRQ(ierr);
1854e3c11fc1SJed Brown   if (dmts->ops->transientvar) {
1855e3c11fc1SJed Brown     PetscValidHeaderSpecific(C,VEC_CLASSID,3);
1856e3c11fc1SJed Brown     ierr = (*dmts->ops->transientvar)(ts,U,C,dmts->transientvarctx);CHKERRQ(ierr);
1857e3c11fc1SJed Brown   }
1858e3c11fc1SJed Brown   PetscFunctionReturn(0);
1859e3c11fc1SJed Brown }
1860e3c11fc1SJed Brown 
1861e3c11fc1SJed Brown /*@
1862e3c11fc1SJed Brown    TSHasTransientVariable - determine whether transient variables have been set
1863e3c11fc1SJed Brown 
1864e3c11fc1SJed Brown    Logically Collective
1865e3c11fc1SJed Brown 
1866e3c11fc1SJed Brown    Input Parameters:
1867e3c11fc1SJed Brown .  ts - TS on which to compute
1868e3c11fc1SJed Brown 
1869e3c11fc1SJed Brown    Output Parameters:
1870e3c11fc1SJed Brown .  has - PETSC_TRUE if transient variables have been set
1871e3c11fc1SJed Brown 
1872e3c11fc1SJed Brown    Level: developer
1873e3c11fc1SJed Brown 
1874e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeTransientVariable()
1875e3c11fc1SJed Brown @*/
1876e3c11fc1SJed Brown PetscErrorCode TSHasTransientVariable(TS ts,PetscBool *has)
1877e3c11fc1SJed Brown {
1878e3c11fc1SJed Brown   PetscErrorCode ierr;
1879e3c11fc1SJed Brown   DM             dm;
1880e3c11fc1SJed Brown   DMTS           dmts;
1881e3c11fc1SJed Brown 
1882e3c11fc1SJed Brown   PetscFunctionBegin;
1883e3c11fc1SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1884e3c11fc1SJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1885e3c11fc1SJed Brown   ierr = DMGetDMTS(dm,&dmts);CHKERRQ(ierr);
1886e3c11fc1SJed Brown   *has = dmts->ops->transientvar ? PETSC_TRUE : PETSC_FALSE;
1887e3c11fc1SJed Brown   PetscFunctionReturn(0);
1888e3c11fc1SJed Brown }
1889e3c11fc1SJed Brown 
1890e3c11fc1SJed Brown /*@
1891efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1892efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1893efe9872eSLisandro Dalcin 
1894d083f849SBarry Smith    Logically Collective on TS
1895efe9872eSLisandro Dalcin 
1896efe9872eSLisandro Dalcin    Input Parameters:
1897efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1898efe9872eSLisandro Dalcin .  u - the solution vector
1899efe9872eSLisandro Dalcin -  v - the time derivative vector
1900efe9872eSLisandro Dalcin 
1901efe9872eSLisandro Dalcin    Level: beginner
1902efe9872eSLisandro Dalcin 
1903efe9872eSLisandro Dalcin @*/
1904efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1905efe9872eSLisandro Dalcin {
1906efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1907efe9872eSLisandro Dalcin 
1908efe9872eSLisandro Dalcin   PetscFunctionBegin;
1909efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1910efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1911efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1912efe9872eSLisandro Dalcin   ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
1913efe9872eSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr);
1914efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
1915efe9872eSLisandro Dalcin   ts->vec_dot = v;
1916efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1917efe9872eSLisandro Dalcin }
1918efe9872eSLisandro Dalcin 
1919efe9872eSLisandro Dalcin /*@
1920efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1921efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1922efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1923efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1924efe9872eSLisandro Dalcin 
1925efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1926efe9872eSLisandro Dalcin 
1927efe9872eSLisandro Dalcin    Input Parameter:
1928efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1929efe9872eSLisandro Dalcin 
1930efe9872eSLisandro Dalcin    Output Parameter:
1931efe9872eSLisandro Dalcin +  u - the vector containing the solution
1932efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1933efe9872eSLisandro Dalcin 
1934efe9872eSLisandro Dalcin    Level: intermediate
1935efe9872eSLisandro Dalcin 
1936efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1937efe9872eSLisandro Dalcin 
1938efe9872eSLisandro Dalcin @*/
1939efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1940efe9872eSLisandro Dalcin {
1941efe9872eSLisandro Dalcin   PetscFunctionBegin;
1942efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1943efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1944efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1945efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1946efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1947efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1948efe9872eSLisandro Dalcin }
1949efe9872eSLisandro Dalcin 
195055849f57SBarry Smith /*@C
195155849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
195255849f57SBarry Smith 
195355849f57SBarry Smith   Collective on PetscViewer
195455849f57SBarry Smith 
195555849f57SBarry Smith   Input Parameters:
195655849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
195755849f57SBarry Smith            some related function before a call to TSLoad().
195855849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
195955849f57SBarry Smith 
196055849f57SBarry Smith    Level: intermediate
196155849f57SBarry Smith 
196255849f57SBarry Smith   Notes:
196355849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
196455849f57SBarry Smith 
196555849f57SBarry Smith   Notes for advanced users:
196655849f57SBarry Smith   Most users should not need to know the details of the binary storage
196755849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
196855849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
196955849f57SBarry Smith   format is
197055849f57SBarry Smith .vb
197155849f57SBarry Smith      has not yet been determined
197255849f57SBarry Smith .ve
197355849f57SBarry Smith 
197455849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
197555849f57SBarry Smith @*/
1976f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
197755849f57SBarry Smith {
197855849f57SBarry Smith   PetscErrorCode ierr;
197955849f57SBarry Smith   PetscBool      isbinary;
198055849f57SBarry Smith   PetscInt       classid;
198155849f57SBarry Smith   char           type[256];
19822d53ad75SBarry Smith   DMTS           sdm;
1983ad6bc421SBarry Smith   DM             dm;
198455849f57SBarry Smith 
198555849f57SBarry Smith   PetscFunctionBegin;
1986f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
198755849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
198855849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
198955849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
199055849f57SBarry Smith 
1991060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1992ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1993060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1994f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1995f2c2a1b9SBarry Smith   if (ts->ops->load) {
1996f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1997f2c2a1b9SBarry Smith   }
1998ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1999ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
2000ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
2001f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
2002f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
20032d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
20042d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
200555849f57SBarry Smith   PetscFunctionReturn(0);
200655849f57SBarry Smith }
200755849f57SBarry Smith 
20089804daf3SBarry Smith #include <petscdraw.h>
2009e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2010e04113cfSBarry Smith #include <petscviewersaws.h>
2011f05ece33SBarry Smith #endif
2012fe2efc57SMark 
2013fe2efc57SMark /*@C
2014fe2efc57SMark    TSViewFromOptions - View from Options
2015fe2efc57SMark 
2016fe2efc57SMark    Collective on TS
2017fe2efc57SMark 
2018fe2efc57SMark    Input Parameters:
2019fe2efc57SMark +  A - the application ordering context
2020736c3998SJose E. Roman .  obj - Optional object
2021736c3998SJose E. Roman -  name - command line option
2022fe2efc57SMark 
2023fe2efc57SMark    Level: intermediate
2024fe2efc57SMark .seealso:  TS, TSView, PetscObjectViewFromOptions(), TSCreate()
2025fe2efc57SMark @*/
2026fe2efc57SMark PetscErrorCode  TSViewFromOptions(TS A,PetscObject obj,const char name[])
2027fe2efc57SMark {
2028fe2efc57SMark   PetscErrorCode ierr;
2029fe2efc57SMark 
2030fe2efc57SMark   PetscFunctionBegin;
2031fe2efc57SMark   PetscValidHeaderSpecific(A,TS_CLASSID,1);
2032fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)A,obj,name);CHKERRQ(ierr);
2033fe2efc57SMark   PetscFunctionReturn(0);
2034fe2efc57SMark }
2035fe2efc57SMark 
20367e2c5f70SBarry Smith /*@C
2037d763cef2SBarry Smith     TSView - Prints the TS data structure.
2038d763cef2SBarry Smith 
20394c49b128SBarry Smith     Collective on TS
2040d763cef2SBarry Smith 
2041d763cef2SBarry Smith     Input Parameters:
2042d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
2043d763cef2SBarry Smith -   viewer - visualization context
2044d763cef2SBarry Smith 
2045d763cef2SBarry Smith     Options Database Key:
2046d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
2047d763cef2SBarry Smith 
2048d763cef2SBarry Smith     Notes:
2049d763cef2SBarry Smith     The available visualization contexts include
2050b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
2051b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
2052d763cef2SBarry Smith          output where only the first processor opens
2053d763cef2SBarry Smith          the file.  All other processors send their
2054d763cef2SBarry Smith          data to the first processor to print.
2055d763cef2SBarry Smith 
2056d763cef2SBarry Smith     The user can open an alternative visualization context with
2057b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
2058d763cef2SBarry Smith 
2059*595c91d4SBarry Smith     In the debugger you can do "call TSView(ts,0)" to display the TS solver. (The same holds for any PETSc object viewer).
2060*595c91d4SBarry Smith 
2061d763cef2SBarry Smith     Level: beginner
2062d763cef2SBarry Smith 
2063b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
2064d763cef2SBarry Smith @*/
20657087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
2066d763cef2SBarry Smith {
2067dfbe8321SBarry Smith   PetscErrorCode ierr;
206819fd82e9SBarry Smith   TSType         type;
20692b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
20702d53ad75SBarry Smith   DMTS           sdm;
2071e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2072536b137fSBarry Smith   PetscBool      issaws;
2073f05ece33SBarry Smith #endif
2074d763cef2SBarry Smith 
2075d763cef2SBarry Smith   PetscFunctionBegin;
20760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20773050cee2SBarry Smith   if (!viewer) {
2078ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
20793050cee2SBarry Smith   }
20800700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
2081c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
2082fd16b177SBarry Smith 
2083251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
2084251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
208555849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
20862b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
2087e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2088536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
2089f05ece33SBarry Smith #endif
209032077d6dSBarry Smith   if (iascii) {
2091dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
2092efd4aadfSBarry Smith     if (ts->ops->view) {
2093efd4aadfSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2094efd4aadfSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
2095efd4aadfSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2096efd4aadfSBarry Smith     }
2097ef85077eSLisandro Dalcin     if (ts->max_steps < PETSC_MAX_INT) {
209877431f27SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
2099ef85077eSLisandro Dalcin     }
2100ef85077eSLisandro Dalcin     if (ts->max_time < PETSC_MAX_REAL) {
21017c8652ddSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
2102ef85077eSLisandro Dalcin     }
2103efd4aadfSBarry Smith     if (ts->usessnes) {
2104efd4aadfSBarry Smith       PetscBool lin;
2105d763cef2SBarry Smith       if (ts->problem_type == TS_NONLINEAR) {
21065ef26d82SJed Brown         ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
2107d763cef2SBarry Smith       }
21085ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
21091ef27442SStefano Zampini       ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&lin,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr);
2110efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr);
2111efd4aadfSBarry Smith     }
2112193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
2113a0af407cSBarry Smith     if (ts->vrtol) {
2114a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of relative error tolerances, ");CHKERRQ(ierr);
2115a0af407cSBarry Smith     } else {
2116a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr);
2117a0af407cSBarry Smith     }
2118a0af407cSBarry Smith     if (ts->vatol) {
2119a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of absolute error tolerances\n");CHKERRQ(ierr);
2120a0af407cSBarry Smith     } else {
2121a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr);
2122a0af407cSBarry Smith     }
2123825ab935SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2124efd4aadfSBarry Smith     ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);
2125825ab935SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21260f5bd95cSBarry Smith   } else if (isstring) {
2127a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
212836a9e3b9SBarry Smith     ierr = PetscViewerStringSPrintf(viewer," TSType: %-7.7s",type);CHKERRQ(ierr);
212936a9e3b9SBarry Smith     if (ts->ops->view) {ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);}
213055849f57SBarry Smith   } else if (isbinary) {
213155849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
213255849f57SBarry Smith     MPI_Comm    comm;
213355849f57SBarry Smith     PetscMPIInt rank;
213455849f57SBarry Smith     char        type[256];
213555849f57SBarry Smith 
213655849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
213755849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
213855849f57SBarry Smith     if (!rank) {
2139f253e43cSLisandro Dalcin       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
214055849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
2141f253e43cSLisandro Dalcin       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
214255849f57SBarry Smith     }
214355849f57SBarry Smith     if (ts->ops->view) {
214455849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
214555849f57SBarry Smith     }
2146efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2147f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
2148f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
21492d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
21502d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
21512b0a91c0SBarry Smith   } else if (isdraw) {
21522b0a91c0SBarry Smith     PetscDraw draw;
21532b0a91c0SBarry Smith     char      str[36];
215489fd9fafSBarry Smith     PetscReal x,y,bottom,h;
21552b0a91c0SBarry Smith 
21562b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
21572b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
21582b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
21592b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
216051fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
216189fd9fafSBarry Smith     bottom = y - h;
21622b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
21632b0a91c0SBarry Smith     if (ts->ops->view) {
21642b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
21652b0a91c0SBarry Smith     }
2166efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2167efd4aadfSBarry Smith     if (ts->snes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
21682b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2169e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2170536b137fSBarry Smith   } else if (issaws) {
2171d45a07a7SBarry Smith     PetscMPIInt rank;
21722657e9d9SBarry Smith     const char  *name;
21732657e9d9SBarry Smith 
21742657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
2175d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
2176d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
2177d45a07a7SBarry Smith       char       dir[1024];
2178d45a07a7SBarry Smith 
2179e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
2180a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
21812657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
21822657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
21832657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
2184d763cef2SBarry Smith     }
21850acecf5bSBarry Smith     if (ts->ops->view) {
21860acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
21870acecf5bSBarry Smith     }
2188f05ece33SBarry Smith #endif
2189f05ece33SBarry Smith   }
219036a9e3b9SBarry Smith   if (ts->snes && ts->usessnes)  {
219136a9e3b9SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
219236a9e3b9SBarry Smith     ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);
219336a9e3b9SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
219436a9e3b9SBarry Smith   }
219536a9e3b9SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
219636a9e3b9SBarry Smith   ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
2197f05ece33SBarry Smith 
2198b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2199251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
2200b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2201d763cef2SBarry Smith   PetscFunctionReturn(0);
2202d763cef2SBarry Smith }
2203d763cef2SBarry Smith 
2204b07ff414SBarry Smith /*@
2205d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2206d763cef2SBarry Smith    the timesteppers.
2207d763cef2SBarry Smith 
22083f9fe445SBarry Smith    Logically Collective on TS
2209d763cef2SBarry Smith 
2210d763cef2SBarry Smith    Input Parameters:
2211d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2212d763cef2SBarry Smith -  usrP - optional user context
2213d763cef2SBarry Smith 
221495452b02SPatrick Sanan    Fortran Notes:
221595452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2216daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2217daf670e6SBarry Smith 
2218d763cef2SBarry Smith    Level: intermediate
2219d763cef2SBarry Smith 
2220d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2221d763cef2SBarry Smith @*/
22227087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2223d763cef2SBarry Smith {
2224d763cef2SBarry Smith   PetscFunctionBegin;
22250700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2226d763cef2SBarry Smith   ts->user = usrP;
2227d763cef2SBarry Smith   PetscFunctionReturn(0);
2228d763cef2SBarry Smith }
2229d763cef2SBarry Smith 
2230b07ff414SBarry Smith /*@
2231d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2232d763cef2SBarry Smith     timestepper.
2233d763cef2SBarry Smith 
2234d763cef2SBarry Smith     Not Collective
2235d763cef2SBarry Smith 
2236d763cef2SBarry Smith     Input Parameter:
2237d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2238d763cef2SBarry Smith 
2239d763cef2SBarry Smith     Output Parameter:
2240d763cef2SBarry Smith .   usrP - user context
2241d763cef2SBarry Smith 
224295452b02SPatrick Sanan    Fortran Notes:
224395452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2244daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2245daf670e6SBarry Smith 
2246d763cef2SBarry Smith     Level: intermediate
2247d763cef2SBarry Smith 
2248d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2249d763cef2SBarry Smith @*/
2250e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2251d763cef2SBarry Smith {
2252d763cef2SBarry Smith   PetscFunctionBegin;
22530700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2254e71120c6SJed Brown   *(void**)usrP = ts->user;
2255d763cef2SBarry Smith   PetscFunctionReturn(0);
2256d763cef2SBarry Smith }
2257d763cef2SBarry Smith 
2258d763cef2SBarry Smith /*@
225980275a0aSLisandro Dalcin    TSGetStepNumber - Gets the number of steps completed.
2260d763cef2SBarry Smith 
2261d763cef2SBarry Smith    Not Collective
2262d763cef2SBarry Smith 
2263d763cef2SBarry Smith    Input Parameter:
2264d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2265d763cef2SBarry Smith 
2266d763cef2SBarry Smith    Output Parameter:
226780275a0aSLisandro Dalcin .  steps - number of steps completed so far
2268d763cef2SBarry Smith 
2269d763cef2SBarry Smith    Level: intermediate
2270d763cef2SBarry Smith 
22719be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2272d763cef2SBarry Smith @*/
227380275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps)
2274d763cef2SBarry Smith {
2275d763cef2SBarry Smith   PetscFunctionBegin;
22760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
227780275a0aSLisandro Dalcin   PetscValidIntPointer(steps,2);
227880275a0aSLisandro Dalcin   *steps = ts->steps;
227980275a0aSLisandro Dalcin   PetscFunctionReturn(0);
228080275a0aSLisandro Dalcin }
228180275a0aSLisandro Dalcin 
228280275a0aSLisandro Dalcin /*@
228380275a0aSLisandro Dalcin    TSSetStepNumber - Sets the number of steps completed.
228480275a0aSLisandro Dalcin 
228580275a0aSLisandro Dalcin    Logically Collective on TS
228680275a0aSLisandro Dalcin 
228780275a0aSLisandro Dalcin    Input Parameters:
228880275a0aSLisandro Dalcin +  ts - the TS context
228980275a0aSLisandro Dalcin -  steps - number of steps completed so far
229080275a0aSLisandro Dalcin 
229180275a0aSLisandro Dalcin    Notes:
229280275a0aSLisandro Dalcin    For most uses of the TS solvers the user need not explicitly call
229380275a0aSLisandro Dalcin    TSSetStepNumber(), as the step counter is appropriately updated in
229480275a0aSLisandro Dalcin    TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to
229580275a0aSLisandro Dalcin    reinitialize timestepping by setting the step counter to zero (and time
229680275a0aSLisandro Dalcin    to the initial time) to solve a similar problem with different initial
229780275a0aSLisandro Dalcin    conditions or parameters. Other possible use case is to continue
229880275a0aSLisandro Dalcin    timestepping from a previously interrupted run in such a way that TS
229980275a0aSLisandro Dalcin    monitors will be called with a initial nonzero step counter.
230080275a0aSLisandro Dalcin 
230180275a0aSLisandro Dalcin    Level: advanced
230280275a0aSLisandro Dalcin 
230380275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution()
230480275a0aSLisandro Dalcin @*/
230580275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps)
230680275a0aSLisandro Dalcin {
230780275a0aSLisandro Dalcin   PetscFunctionBegin;
230880275a0aSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
230980275a0aSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,steps,2);
231080275a0aSLisandro Dalcin   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative");
231180275a0aSLisandro Dalcin   ts->steps = steps;
2312d763cef2SBarry Smith   PetscFunctionReturn(0);
2313d763cef2SBarry Smith }
2314d763cef2SBarry Smith 
2315d763cef2SBarry Smith /*@
2316d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2317d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2318d763cef2SBarry Smith 
23193f9fe445SBarry Smith    Logically Collective on TS
2320d763cef2SBarry Smith 
2321d763cef2SBarry Smith    Input Parameters:
2322d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2323d763cef2SBarry Smith -  time_step - the size of the timestep
2324d763cef2SBarry Smith 
2325d763cef2SBarry Smith    Level: intermediate
2326d763cef2SBarry Smith 
2327aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime()
2328d763cef2SBarry Smith 
2329d763cef2SBarry Smith @*/
23307087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2331d763cef2SBarry Smith {
2332d763cef2SBarry Smith   PetscFunctionBegin;
23330700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2334c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2335d763cef2SBarry Smith   ts->time_step = time_step;
2336d763cef2SBarry Smith   PetscFunctionReturn(0);
2337d763cef2SBarry Smith }
2338d763cef2SBarry Smith 
2339a43b19c4SJed Brown /*@
234049354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
234149354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
234249354f04SShri Abhyankar      or just return at the final time TS computed.
2343a43b19c4SJed Brown 
2344a43b19c4SJed Brown   Logically Collective on TS
2345a43b19c4SJed Brown 
2346a43b19c4SJed Brown    Input Parameter:
2347a43b19c4SJed Brown +   ts - the time-step context
234849354f04SShri Abhyankar -   eftopt - exact final time option
2349a43b19c4SJed Brown 
2350feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2351feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2352feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2353feed9e9dSBarry Smith 
2354feed9e9dSBarry Smith    Options Database:
2355feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2356feed9e9dSBarry Smith 
2357ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2358ee346746SBarry Smith     then the final time you selected.
2359ee346746SBarry Smith 
2360a43b19c4SJed Brown    Level: beginner
2361a43b19c4SJed Brown 
2362f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime()
2363a43b19c4SJed Brown @*/
236449354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2365a43b19c4SJed Brown {
2366a43b19c4SJed Brown   PetscFunctionBegin;
2367a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
236849354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
236949354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2370a43b19c4SJed Brown   PetscFunctionReturn(0);
2371a43b19c4SJed Brown }
2372a43b19c4SJed Brown 
2373d763cef2SBarry Smith /*@
2374f6953c82SLisandro Dalcin    TSGetExactFinalTime - Gets the exact final time option.
2375f6953c82SLisandro Dalcin 
2376f6953c82SLisandro Dalcin    Not Collective
2377f6953c82SLisandro Dalcin 
2378f6953c82SLisandro Dalcin    Input Parameter:
2379f6953c82SLisandro Dalcin .  ts - the TS context
2380f6953c82SLisandro Dalcin 
2381f6953c82SLisandro Dalcin    Output Parameter:
2382f6953c82SLisandro Dalcin .  eftopt - exact final time option
2383f6953c82SLisandro Dalcin 
2384f6953c82SLisandro Dalcin    Level: beginner
2385f6953c82SLisandro Dalcin 
2386f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime()
2387f6953c82SLisandro Dalcin @*/
2388f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt)
2389f6953c82SLisandro Dalcin {
2390f6953c82SLisandro Dalcin   PetscFunctionBegin;
2391f6953c82SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2392f6953c82SLisandro Dalcin   PetscValidPointer(eftopt,2);
2393f6953c82SLisandro Dalcin   *eftopt = ts->exact_final_time;
2394f6953c82SLisandro Dalcin   PetscFunctionReturn(0);
2395f6953c82SLisandro Dalcin }
2396f6953c82SLisandro Dalcin 
2397f6953c82SLisandro Dalcin /*@
2398d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2399d763cef2SBarry Smith 
2400d763cef2SBarry Smith    Not Collective
2401d763cef2SBarry Smith 
2402d763cef2SBarry Smith    Input Parameter:
2403d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2404d763cef2SBarry Smith 
2405d763cef2SBarry Smith    Output Parameter:
2406d763cef2SBarry Smith .  dt - the current timestep size
2407d763cef2SBarry Smith 
2408d763cef2SBarry Smith    Level: intermediate
2409d763cef2SBarry Smith 
2410aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime()
2411d763cef2SBarry Smith 
2412d763cef2SBarry Smith @*/
24137087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2414d763cef2SBarry Smith {
2415d763cef2SBarry Smith   PetscFunctionBegin;
24160700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2417f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2418d763cef2SBarry Smith   *dt = ts->time_step;
2419d763cef2SBarry Smith   PetscFunctionReturn(0);
2420d763cef2SBarry Smith }
2421d763cef2SBarry Smith 
2422d8e5e3e6SSatish Balay /*@
2423d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2424d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2425d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2426d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2427d763cef2SBarry Smith 
2428d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2429d763cef2SBarry Smith 
2430d763cef2SBarry Smith    Input Parameter:
2431d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2432d763cef2SBarry Smith 
2433d763cef2SBarry Smith    Output Parameter:
2434d763cef2SBarry Smith .  v - the vector containing the solution
2435d763cef2SBarry Smith 
243663e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
243763e21af5SBarry Smith    final time. It returns the solution at the next timestep.
243863e21af5SBarry Smith 
2439d763cef2SBarry Smith    Level: intermediate
2440d763cef2SBarry Smith 
24410ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction()
2442d763cef2SBarry Smith 
2443d763cef2SBarry Smith @*/
24447087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2445d763cef2SBarry Smith {
2446d763cef2SBarry Smith   PetscFunctionBegin;
24470700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24484482741eSBarry Smith   PetscValidPointer(v,2);
24498737fe31SLisandro Dalcin   *v = ts->vec_sol;
2450d763cef2SBarry Smith   PetscFunctionReturn(0);
2451d763cef2SBarry Smith }
2452d763cef2SBarry Smith 
245303fe5f5eSDebojyoti Ghosh /*@
2454b2bf4f3aSDebojyoti Ghosh    TSGetSolutionComponents - Returns any solution components at the present
245503fe5f5eSDebojyoti Ghosh    timestep, if available for the time integration method being used.
2456b2bf4f3aSDebojyoti Ghosh    Solution components are quantities that share the same size and
245703fe5f5eSDebojyoti Ghosh    structure as the solution vector.
245803fe5f5eSDebojyoti Ghosh 
245903fe5f5eSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
246003fe5f5eSDebojyoti Ghosh 
246103fe5f5eSDebojyoti Ghosh    Parameters :
2462a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2463b2bf4f3aSDebojyoti Ghosh .  n - If v is PETSC_NULL, then the number of solution components is
2464b2bf4f3aSDebojyoti Ghosh        returned through n, else the n-th solution component is
246503fe5f5eSDebojyoti Ghosh        returned in v.
2466a2b725a8SWilliam Gropp -  v - the vector containing the n-th solution component
246703fe5f5eSDebojyoti Ghosh        (may be PETSC_NULL to use this function to find out
2468b2bf4f3aSDebojyoti Ghosh         the number of solutions components).
246903fe5f5eSDebojyoti Ghosh 
24704cdd57e5SDebojyoti Ghosh    Level: advanced
247103fe5f5eSDebojyoti Ghosh 
247203fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution()
247303fe5f5eSDebojyoti Ghosh 
247403fe5f5eSDebojyoti Ghosh @*/
2475b2bf4f3aSDebojyoti Ghosh PetscErrorCode  TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v)
247603fe5f5eSDebojyoti Ghosh {
247703fe5f5eSDebojyoti Ghosh   PetscErrorCode ierr;
247803fe5f5eSDebojyoti Ghosh 
247903fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
248003fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2481b2bf4f3aSDebojyoti Ghosh   if (!ts->ops->getsolutioncomponents) *n = 0;
248203fe5f5eSDebojyoti Ghosh   else {
2483b2bf4f3aSDebojyoti Ghosh     ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr);
248403fe5f5eSDebojyoti Ghosh   }
248503fe5f5eSDebojyoti Ghosh   PetscFunctionReturn(0);
248603fe5f5eSDebojyoti Ghosh }
248703fe5f5eSDebojyoti Ghosh 
24884cdd57e5SDebojyoti Ghosh /*@
24894cdd57e5SDebojyoti Ghosh    TSGetAuxSolution - Returns an auxiliary solution at the present
24904cdd57e5SDebojyoti Ghosh    timestep, if available for the time integration method being used.
24914cdd57e5SDebojyoti Ghosh 
24924cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
24934cdd57e5SDebojyoti Ghosh 
24944cdd57e5SDebojyoti Ghosh    Parameters :
2495a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2496a2b725a8SWilliam Gropp -  v - the vector containing the auxiliary solution
24974cdd57e5SDebojyoti Ghosh 
24984cdd57e5SDebojyoti Ghosh    Level: intermediate
24994cdd57e5SDebojyoti Ghosh 
25004cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution()
25014cdd57e5SDebojyoti Ghosh 
25024cdd57e5SDebojyoti Ghosh @*/
25034cdd57e5SDebojyoti Ghosh PetscErrorCode  TSGetAuxSolution(TS ts,Vec *v)
25044cdd57e5SDebojyoti Ghosh {
25054cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
25064cdd57e5SDebojyoti Ghosh 
25074cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
25084cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2509f6356ec7SDebojyoti Ghosh   if (ts->ops->getauxsolution) {
25104cdd57e5SDebojyoti Ghosh     ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr);
2511f6356ec7SDebojyoti Ghosh   } else {
2512f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v);CHKERRQ(ierr);
2513f6356ec7SDebojyoti Ghosh   }
25144cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
25154cdd57e5SDebojyoti Ghosh }
25164cdd57e5SDebojyoti Ghosh 
25174cdd57e5SDebojyoti Ghosh /*@
25184cdd57e5SDebojyoti Ghosh    TSGetTimeError - Returns the estimated error vector, if the chosen
25194cdd57e5SDebojyoti Ghosh    TSType has an error estimation functionality.
25204cdd57e5SDebojyoti Ghosh 
25214cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
25224cdd57e5SDebojyoti Ghosh 
25239657682dSDebojyoti Ghosh    Note: MUST call after TSSetUp()
25249657682dSDebojyoti Ghosh 
25254cdd57e5SDebojyoti Ghosh    Parameters :
2526a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2527657c1e31SEmil Constantinescu .  n - current estimate (n=0) or previous one (n=-1)
2528a2b725a8SWilliam Gropp -  v - the vector containing the error (same size as the solution).
25294cdd57e5SDebojyoti Ghosh 
25304cdd57e5SDebojyoti Ghosh    Level: intermediate
25314cdd57e5SDebojyoti Ghosh 
253257df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError()
25334cdd57e5SDebojyoti Ghosh 
25344cdd57e5SDebojyoti Ghosh @*/
25350a01e1b2SEmil Constantinescu PetscErrorCode  TSGetTimeError(TS ts,PetscInt n,Vec *v)
25364cdd57e5SDebojyoti Ghosh {
25374cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
25384cdd57e5SDebojyoti Ghosh 
25394cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
25404cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2541f6356ec7SDebojyoti Ghosh   if (ts->ops->gettimeerror) {
25420a01e1b2SEmil Constantinescu     ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr);
2543f6356ec7SDebojyoti Ghosh   } else {
2544f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v);CHKERRQ(ierr);
2545f6356ec7SDebojyoti Ghosh   }
25464cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
25474cdd57e5SDebojyoti Ghosh }
25484cdd57e5SDebojyoti Ghosh 
254957df6a1bSDebojyoti Ghosh /*@
255057df6a1bSDebojyoti Ghosh    TSSetTimeError - Sets the estimated error vector, if the chosen
255157df6a1bSDebojyoti Ghosh    TSType has an error estimation functionality. This can be used
255257df6a1bSDebojyoti Ghosh    to restart such a time integrator with a given error vector.
255357df6a1bSDebojyoti Ghosh 
255457df6a1bSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
255557df6a1bSDebojyoti Ghosh 
255657df6a1bSDebojyoti Ghosh    Parameters :
2557a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2558a2b725a8SWilliam Gropp -  v - the vector containing the error (same size as the solution).
255957df6a1bSDebojyoti Ghosh 
256057df6a1bSDebojyoti Ghosh    Level: intermediate
256157df6a1bSDebojyoti Ghosh 
256257df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError)
256357df6a1bSDebojyoti Ghosh 
256457df6a1bSDebojyoti Ghosh @*/
256557df6a1bSDebojyoti Ghosh PetscErrorCode  TSSetTimeError(TS ts,Vec v)
256657df6a1bSDebojyoti Ghosh {
256757df6a1bSDebojyoti Ghosh   PetscErrorCode ierr;
256857df6a1bSDebojyoti Ghosh 
256957df6a1bSDebojyoti Ghosh   PetscFunctionBegin;
257057df6a1bSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25719657682dSDebojyoti Ghosh   if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first");
257257df6a1bSDebojyoti Ghosh   if (ts->ops->settimeerror) {
257357df6a1bSDebojyoti Ghosh     ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr);
257457df6a1bSDebojyoti Ghosh   }
257557df6a1bSDebojyoti Ghosh   PetscFunctionReturn(0);
257657df6a1bSDebojyoti Ghosh }
257757df6a1bSDebojyoti Ghosh 
2578bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
2579d8e5e3e6SSatish Balay /*@
2580bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2581d763cef2SBarry Smith 
2582bdad233fSMatthew Knepley   Not collective
2583d763cef2SBarry Smith 
2584bdad233fSMatthew Knepley   Input Parameters:
2585bdad233fSMatthew Knepley + ts   - The TS
2586bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2587d763cef2SBarry Smith .vb
25880910c330SBarry Smith          U_t - A U = 0      (linear)
25890910c330SBarry Smith          U_t - A(t) U = 0   (linear)
25900910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2591d763cef2SBarry Smith .ve
2592d763cef2SBarry Smith 
2593d763cef2SBarry Smith    Level: beginner
2594d763cef2SBarry Smith 
2595bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2596d763cef2SBarry Smith @*/
25977087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2598a7cc72afSBarry Smith {
25999e2a6581SJed Brown   PetscErrorCode ierr;
26009e2a6581SJed Brown 
2601d763cef2SBarry Smith   PetscFunctionBegin;
26020700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2603bdad233fSMatthew Knepley   ts->problem_type = type;
26049e2a6581SJed Brown   if (type == TS_LINEAR) {
26059e2a6581SJed Brown     SNES snes;
26069e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
26079e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
26089e2a6581SJed Brown   }
2609d763cef2SBarry Smith   PetscFunctionReturn(0);
2610d763cef2SBarry Smith }
2611d763cef2SBarry Smith 
2612bdad233fSMatthew Knepley /*@C
2613bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2614bdad233fSMatthew Knepley 
2615bdad233fSMatthew Knepley   Not collective
2616bdad233fSMatthew Knepley 
2617bdad233fSMatthew Knepley   Input Parameter:
2618bdad233fSMatthew Knepley . ts   - The TS
2619bdad233fSMatthew Knepley 
2620bdad233fSMatthew Knepley   Output Parameter:
2621bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2622bdad233fSMatthew Knepley .vb
2623089b2837SJed Brown          M U_t = A U
2624089b2837SJed Brown          M(t) U_t = A(t) U
2625b5abc632SBarry Smith          F(t,U,U_t)
2626bdad233fSMatthew Knepley .ve
2627bdad233fSMatthew Knepley 
2628bdad233fSMatthew Knepley    Level: beginner
2629bdad233fSMatthew Knepley 
2630bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2631bdad233fSMatthew Knepley @*/
26327087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2633a7cc72afSBarry Smith {
2634bdad233fSMatthew Knepley   PetscFunctionBegin;
26350700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
26364482741eSBarry Smith   PetscValidIntPointer(type,2);
2637bdad233fSMatthew Knepley   *type = ts->problem_type;
2638bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2639bdad233fSMatthew Knepley }
2640d763cef2SBarry Smith 
2641303a5415SBarry Smith /*
2642303a5415SBarry Smith     Attempt to check/preset a default value for the exact final time option. This is needed at the beginning of TSSolve() and in TSSetUp()
2643303a5415SBarry Smith */
2644303a5415SBarry Smith static PetscErrorCode TSSetExactFinalTimeDefault(TS ts)
2645303a5415SBarry Smith {
2646303a5415SBarry Smith   PetscErrorCode ierr;
2647303a5415SBarry Smith   PetscBool      isnone;
2648303a5415SBarry Smith 
2649303a5415SBarry Smith   PetscFunctionBegin;
2650303a5415SBarry Smith   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
2651303a5415SBarry Smith   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
2652303a5415SBarry Smith 
2653303a5415SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr);
2654303a5415SBarry Smith   if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) {
2655303a5415SBarry Smith     ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP;
2656303a5415SBarry Smith   } else if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) {
2657303a5415SBarry Smith     ts->exact_final_time = TS_EXACTFINALTIME_INTERPOLATE;
2658303a5415SBarry Smith   }
2659303a5415SBarry Smith   PetscFunctionReturn(0);
2660303a5415SBarry Smith }
2661303a5415SBarry Smith 
2662303a5415SBarry Smith 
2663d763cef2SBarry Smith /*@
2664303a5415SBarry Smith    TSSetUp - Sets up the internal data structures for the later use of a timestepper.
2665d763cef2SBarry Smith 
2666d763cef2SBarry Smith    Collective on TS
2667d763cef2SBarry Smith 
2668d763cef2SBarry Smith    Input Parameter:
2669d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2670d763cef2SBarry Smith 
2671d763cef2SBarry Smith    Notes:
2672d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2673d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2674141bd67dSStefano Zampini    the call to TSStep() or TSSolve().  However, if one wishes to control this
2675d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2676141bd67dSStefano Zampini    and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve().
2677d763cef2SBarry Smith 
2678d763cef2SBarry Smith    Level: advanced
2679d763cef2SBarry Smith 
2680141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve()
2681d763cef2SBarry Smith @*/
26827087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2683d763cef2SBarry Smith {
2684dfbe8321SBarry Smith   PetscErrorCode ierr;
26856c6b9e74SPeter Brune   DM             dm;
26866c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2687d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2688cd11d68dSLisandro Dalcin   TSIFunction    ifun;
26896c6b9e74SPeter Brune   TSIJacobian    ijac;
2690efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
26916c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
2692d763cef2SBarry Smith 
2693d763cef2SBarry Smith   PetscFunctionBegin;
26940700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2695277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2696277b19d0SLisandro Dalcin 
26977adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2698cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
2699cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
2700d763cef2SBarry Smith   }
2701277b19d0SLisandro Dalcin 
27021a638600SStefano Zampini   if (!ts->vec_sol) {
27031a638600SStefano Zampini     if (ts->dm) {
27041a638600SStefano Zampini       ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
27051a638600SStefano Zampini     } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
27061a638600SStefano Zampini   }
2707277b19d0SLisandro Dalcin 
2708298bade4SHong Zhang   if (!ts->Jacp && ts->Jacprhs) { /* IJacobianP shares the same matrix with RHSJacobianP if only RHSJacobianP is provided */
2709298bade4SHong Zhang     ierr = PetscObjectReference((PetscObject)ts->Jacprhs);CHKERRQ(ierr);
2710298bade4SHong Zhang     ts->Jacp = ts->Jacprhs;
2711298bade4SHong Zhang   }
2712298bade4SHong Zhang 
2713cd4cee2dSHong Zhang   if (ts->quadraturets) {
2714cd4cee2dSHong Zhang     ierr = TSSetUp(ts->quadraturets);CHKERRQ(ierr);
2715ecf68647SHong Zhang     ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2716cd4cee2dSHong Zhang     ierr = VecDuplicate(ts->quadraturets->vec_sol,&ts->vec_costintegrand);CHKERRQ(ierr);
2717cd4cee2dSHong Zhang   }
2718cd4cee2dSHong Zhang 
2719971015bcSStefano Zampini   ierr = TSGetRHSJacobian(ts,NULL,NULL,&rhsjac,NULL);CHKERRQ(ierr);
2720f23ba4b3SHong Zhang   if (rhsjac == TSComputeRHSJacobianConstant) {
2721e1244c69SJed Brown     Mat Amat,Pmat;
2722e1244c69SJed Brown     SNES snes;
2723e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2724e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2725e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2726e1244c69SJed Brown      * have displaced the RHS matrix */
2727971015bcSStefano Zampini     if (Amat && Amat == ts->Arhs) {
2728abc0d4abSBarry 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 */
2729abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2730e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2731e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2732e1244c69SJed Brown     }
2733971015bcSStefano Zampini     if (Pmat && Pmat == ts->Brhs) {
2734abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2735e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2736e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2737e1244c69SJed Brown     }
2738e1244c69SJed Brown   }
27392ffb9264SLisandro Dalcin 
27402ffb9264SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
27412ffb9264SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
27422ffb9264SLisandro Dalcin 
2743277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2744000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2745277b19d0SLisandro Dalcin   }
2746277b19d0SLisandro Dalcin 
2747303a5415SBarry Smith   ierr = TSSetExactFinalTimeDefault(ts);CHKERRQ(ierr);
27482ffb9264SLisandro Dalcin 
2749a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
27506c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
27516c6b9e74SPeter Brune    */
27526c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
27530298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
27546c6b9e74SPeter Brune   if (!func) {
27556c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
27566c6b9e74SPeter Brune   }
2757a6772fa2SLisandro 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.
27586c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
27596c6b9e74SPeter Brune    */
27600298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
27610298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
2762efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr);
27630298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
2764efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
27656c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
27666c6b9e74SPeter Brune   }
2767c0517034SDebojyoti Ghosh 
2768c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2769c0517034SDebojyoti Ghosh   if (ts->ops->startingmethod) {
2770c0517034SDebojyoti Ghosh     ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr);
2771c0517034SDebojyoti Ghosh   }
2772c0517034SDebojyoti Ghosh 
2773277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2774277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2775277b19d0SLisandro Dalcin }
2776277b19d0SLisandro Dalcin 
2777f6a906c0SBarry Smith /*@
2778277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2779277b19d0SLisandro Dalcin 
2780277b19d0SLisandro Dalcin    Collective on TS
2781277b19d0SLisandro Dalcin 
2782277b19d0SLisandro Dalcin    Input Parameter:
2783277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2784277b19d0SLisandro Dalcin 
2785277b19d0SLisandro Dalcin    Level: beginner
2786277b19d0SLisandro Dalcin 
2787277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2788277b19d0SLisandro Dalcin @*/
2789277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2790277b19d0SLisandro Dalcin {
27911d06f6b3SHong Zhang   TS_RHSSplitLink ilink = ts->tsrhssplit,next;
2792277b19d0SLisandro Dalcin   PetscErrorCode  ierr;
2793277b19d0SLisandro Dalcin 
2794277b19d0SLisandro Dalcin   PetscFunctionBegin;
2795277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2796b18ea86cSHong Zhang 
2797277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2798277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2799277b19d0SLisandro Dalcin   }
2800277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2801e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2802bbd56ea5SKarl Rupp 
28034e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
28044e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2805214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
28066bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2807efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
2808e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2809e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
281038637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2811bbd56ea5SKarl Rupp 
2812cd4cee2dSHong Zhang   ierr = MatDestroy(&ts->Jacprhs);CHKERRQ(ierr);
2813ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2814ecf68647SHong Zhang   if (ts->forward_solve) {
2815ecf68647SHong Zhang     ierr = TSForwardReset(ts);CHKERRQ(ierr);
2816ecf68647SHong Zhang   }
2817cd4cee2dSHong Zhang   if (ts->quadraturets) {
2818cd4cee2dSHong Zhang     ierr = TSReset(ts->quadraturets);CHKERRQ(ierr);
281936eaed60SHong Zhang     ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2820cd4cee2dSHong Zhang   }
28211d06f6b3SHong Zhang   while (ilink) {
28221d06f6b3SHong Zhang     next = ilink->next;
28231d06f6b3SHong Zhang     ierr = TSDestroy(&ilink->ts);CHKERRQ(ierr);
28241d06f6b3SHong Zhang     ierr = PetscFree(ilink->splitname);CHKERRQ(ierr);
28251d06f6b3SHong Zhang     ierr = ISDestroy(&ilink->is);CHKERRQ(ierr);
28261d06f6b3SHong Zhang     ierr = PetscFree(ilink);CHKERRQ(ierr);
28271d06f6b3SHong Zhang     ilink = next;
282887f4e208SHong Zhang   }
2829545aaa6fSHong Zhang   ts->num_rhs_splits = 0;
2830277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2831d763cef2SBarry Smith   PetscFunctionReturn(0);
2832d763cef2SBarry Smith }
2833d763cef2SBarry Smith 
2834d8e5e3e6SSatish Balay /*@
2835d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2836d763cef2SBarry Smith    with TSCreate().
2837d763cef2SBarry Smith 
2838d763cef2SBarry Smith    Collective on TS
2839d763cef2SBarry Smith 
2840d763cef2SBarry Smith    Input Parameter:
2841d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2842d763cef2SBarry Smith 
2843d763cef2SBarry Smith    Level: beginner
2844d763cef2SBarry Smith 
2845d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2846d763cef2SBarry Smith @*/
28476bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2848d763cef2SBarry Smith {
28496849ba73SBarry Smith   PetscErrorCode ierr;
2850d763cef2SBarry Smith 
2851d763cef2SBarry Smith   PetscFunctionBegin;
28526bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
2853ecf68647SHong Zhang   PetscValidHeaderSpecific(*ts,TS_CLASSID,1);
2854c793f718SLisandro Dalcin   if (--((PetscObject)(*ts))->refct > 0) {*ts = NULL; PetscFunctionReturn(0);}
2855d763cef2SBarry Smith 
2856ecf68647SHong Zhang   ierr = TSReset(*ts);CHKERRQ(ierr);
2857ecf68647SHong Zhang   ierr = TSAdjointReset(*ts);CHKERRQ(ierr);
2858ecf68647SHong Zhang   if ((*ts)->forward_solve) {
2859ecf68647SHong Zhang     ierr = TSForwardReset(*ts);CHKERRQ(ierr);
2860ecf68647SHong Zhang   }
2861e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2862e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
28636bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
28646d4c513bSLisandro Dalcin 
2865bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2866bc952696SBarry Smith 
286784df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
28686427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
28696427ac75SLisandro Dalcin 
28706bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
28716bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
28726bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
28730dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
28746d4c513bSLisandro Dalcin 
2875cd4cee2dSHong Zhang   ierr = TSDestroy(&(*ts)->quadraturets);CHKERRQ(ierr);
2876a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2877d763cef2SBarry Smith   PetscFunctionReturn(0);
2878d763cef2SBarry Smith }
2879d763cef2SBarry Smith 
2880d8e5e3e6SSatish Balay /*@
2881d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2882d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2883d763cef2SBarry Smith 
2884d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2885d763cef2SBarry Smith 
2886d763cef2SBarry Smith    Input Parameter:
2887d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2888d763cef2SBarry Smith 
2889d763cef2SBarry Smith    Output Parameter:
2890d763cef2SBarry Smith .  snes - the nonlinear solver context
2891d763cef2SBarry Smith 
2892d763cef2SBarry Smith    Notes:
2893d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2894d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
289594b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2896d763cef2SBarry Smith 
2897d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
28980298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2899d763cef2SBarry Smith 
2900d763cef2SBarry Smith    Level: beginner
2901d763cef2SBarry Smith 
2902d763cef2SBarry Smith @*/
29037087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2904d763cef2SBarry Smith {
2905d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2906d372ba47SLisandro Dalcin 
2907d763cef2SBarry Smith   PetscFunctionBegin;
29080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29094482741eSBarry Smith   PetscValidPointer(snes,2);
2910d372ba47SLisandro Dalcin   if (!ts->snes) {
2911ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
291216413a6aSBarry Smith     ierr = PetscObjectSetOptions((PetscObject)ts->snes,((PetscObject)ts)->options);CHKERRQ(ierr);
29130298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
29143bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2915d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2916496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
29179e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
29189e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
29199e2a6581SJed Brown     }
2920d372ba47SLisandro Dalcin   }
2921d763cef2SBarry Smith   *snes = ts->snes;
2922d763cef2SBarry Smith   PetscFunctionReturn(0);
2923d763cef2SBarry Smith }
2924d763cef2SBarry Smith 
2925deb2cd25SJed Brown /*@
2926deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2927deb2cd25SJed Brown 
2928deb2cd25SJed Brown    Collective
2929deb2cd25SJed Brown 
2930deb2cd25SJed Brown    Input Parameter:
2931deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2932deb2cd25SJed Brown -  snes - the nonlinear solver context
2933deb2cd25SJed Brown 
2934deb2cd25SJed Brown    Notes:
2935deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2936deb2cd25SJed Brown 
2937deb2cd25SJed Brown    Level: developer
2938deb2cd25SJed Brown 
2939deb2cd25SJed Brown @*/
2940deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2941deb2cd25SJed Brown {
2942deb2cd25SJed Brown   PetscErrorCode ierr;
2943d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2944deb2cd25SJed Brown 
2945deb2cd25SJed Brown   PetscFunctionBegin;
2946deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2947deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2948deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2949deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2950bbd56ea5SKarl Rupp 
2951deb2cd25SJed Brown   ts->snes = snes;
2952bbd56ea5SKarl Rupp 
29530298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
29540298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2955740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
29560298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2957740132f1SEmil Constantinescu   }
2958deb2cd25SJed Brown   PetscFunctionReturn(0);
2959deb2cd25SJed Brown }
2960deb2cd25SJed Brown 
2961d8e5e3e6SSatish Balay /*@
296294b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2963d763cef2SBarry Smith    a TS (timestepper) context.
2964d763cef2SBarry Smith 
296594b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2966d763cef2SBarry Smith 
2967d763cef2SBarry Smith    Input Parameter:
2968d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2969d763cef2SBarry Smith 
2970d763cef2SBarry Smith    Output Parameter:
297194b7f48cSBarry Smith .  ksp - the nonlinear solver context
2972d763cef2SBarry Smith 
2973d763cef2SBarry Smith    Notes:
297494b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2975d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2976d763cef2SBarry Smith    KSP and PC contexts as well.
2977d763cef2SBarry Smith 
297894b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
29790298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2980d763cef2SBarry Smith 
2981d763cef2SBarry Smith    Level: beginner
2982d763cef2SBarry Smith 
2983d763cef2SBarry Smith @*/
29847087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2985d763cef2SBarry Smith {
2986d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2987089b2837SJed Brown   SNES           snes;
2988d372ba47SLisandro Dalcin 
2989d763cef2SBarry Smith   PetscFunctionBegin;
29900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29914482741eSBarry Smith   PetscValidPointer(ksp,2);
299217186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2993e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2994089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2995089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2996d763cef2SBarry Smith   PetscFunctionReturn(0);
2997d763cef2SBarry Smith }
2998d763cef2SBarry Smith 
2999d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
3000d763cef2SBarry Smith 
3001adb62b0dSMatthew Knepley /*@
3002618ce8baSLisandro Dalcin    TSSetMaxSteps - Sets the maximum number of steps to use.
3003618ce8baSLisandro Dalcin 
3004618ce8baSLisandro Dalcin    Logically Collective on TS
3005618ce8baSLisandro Dalcin 
3006618ce8baSLisandro Dalcin    Input Parameters:
3007618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
3008618ce8baSLisandro Dalcin -  maxsteps - maximum number of steps to use
3009618ce8baSLisandro Dalcin 
3010618ce8baSLisandro Dalcin    Options Database Keys:
3011618ce8baSLisandro Dalcin .  -ts_max_steps <maxsteps> - Sets maxsteps
3012618ce8baSLisandro Dalcin 
3013618ce8baSLisandro Dalcin    Notes:
3014618ce8baSLisandro Dalcin    The default maximum number of steps is 5000
3015618ce8baSLisandro Dalcin 
3016618ce8baSLisandro Dalcin    Level: intermediate
3017618ce8baSLisandro Dalcin 
3018618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime()
3019618ce8baSLisandro Dalcin @*/
3020618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps)
3021618ce8baSLisandro Dalcin {
3022618ce8baSLisandro Dalcin   PetscFunctionBegin;
3023618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3024618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
3025618ce8baSLisandro Dalcin   if (maxsteps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative");
3026618ce8baSLisandro Dalcin   ts->max_steps = maxsteps;
3027618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3028618ce8baSLisandro Dalcin }
3029618ce8baSLisandro Dalcin 
3030618ce8baSLisandro Dalcin /*@
3031618ce8baSLisandro Dalcin    TSGetMaxSteps - Gets the maximum number of steps to use.
3032618ce8baSLisandro Dalcin 
3033618ce8baSLisandro Dalcin    Not Collective
3034618ce8baSLisandro Dalcin 
3035618ce8baSLisandro Dalcin    Input Parameters:
3036618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
3037618ce8baSLisandro Dalcin 
3038618ce8baSLisandro Dalcin    Output Parameter:
3039618ce8baSLisandro Dalcin .  maxsteps - maximum number of steps to use
3040618ce8baSLisandro Dalcin 
3041618ce8baSLisandro Dalcin    Level: advanced
3042618ce8baSLisandro Dalcin 
3043618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime()
3044618ce8baSLisandro Dalcin @*/
3045618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps)
3046618ce8baSLisandro Dalcin {
3047618ce8baSLisandro Dalcin   PetscFunctionBegin;
3048618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3049618ce8baSLisandro Dalcin   PetscValidIntPointer(maxsteps,2);
3050618ce8baSLisandro Dalcin   *maxsteps = ts->max_steps;
3051618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3052618ce8baSLisandro Dalcin }
3053618ce8baSLisandro Dalcin 
3054618ce8baSLisandro Dalcin /*@
3055618ce8baSLisandro Dalcin    TSSetMaxTime - Sets the maximum (or final) time for timestepping.
3056618ce8baSLisandro Dalcin 
3057618ce8baSLisandro Dalcin    Logically Collective on TS
3058618ce8baSLisandro Dalcin 
3059618ce8baSLisandro Dalcin    Input Parameters:
3060618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
3061618ce8baSLisandro Dalcin -  maxtime - final time to step to
3062618ce8baSLisandro Dalcin 
3063618ce8baSLisandro Dalcin    Options Database Keys:
3064ef85077eSLisandro Dalcin .  -ts_max_time <maxtime> - Sets maxtime
3065618ce8baSLisandro Dalcin 
3066618ce8baSLisandro Dalcin    Notes:
3067618ce8baSLisandro Dalcin    The default maximum time is 5.0
3068618ce8baSLisandro Dalcin 
3069618ce8baSLisandro Dalcin    Level: intermediate
3070618ce8baSLisandro Dalcin 
3071618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime()
3072618ce8baSLisandro Dalcin @*/
3073618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime)
3074618ce8baSLisandro Dalcin {
3075618ce8baSLisandro Dalcin   PetscFunctionBegin;
3076618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3077618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveReal(ts,maxtime,2);
3078618ce8baSLisandro Dalcin   ts->max_time = maxtime;
3079618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3080618ce8baSLisandro Dalcin }
3081618ce8baSLisandro Dalcin 
3082618ce8baSLisandro Dalcin /*@
3083618ce8baSLisandro Dalcin    TSGetMaxTime - Gets the maximum (or final) time for timestepping.
3084618ce8baSLisandro Dalcin 
3085618ce8baSLisandro Dalcin    Not Collective
3086618ce8baSLisandro Dalcin 
3087618ce8baSLisandro Dalcin    Input Parameters:
3088618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
3089618ce8baSLisandro Dalcin 
3090618ce8baSLisandro Dalcin    Output Parameter:
3091618ce8baSLisandro Dalcin .  maxtime - final time to step to
3092618ce8baSLisandro Dalcin 
3093618ce8baSLisandro Dalcin    Level: advanced
3094618ce8baSLisandro Dalcin 
3095618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps()
3096618ce8baSLisandro Dalcin @*/
3097618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime)
3098618ce8baSLisandro Dalcin {
3099618ce8baSLisandro Dalcin   PetscFunctionBegin;
3100618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3101618ce8baSLisandro Dalcin   PetscValidRealPointer(maxtime,2);
3102618ce8baSLisandro Dalcin   *maxtime = ts->max_time;
3103618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3104618ce8baSLisandro Dalcin }
3105618ce8baSLisandro Dalcin 
3106618ce8baSLisandro Dalcin /*@
3107aaa6c58dSLisandro Dalcin    TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep().
3108edc382c3SSatish Balay 
3109edc382c3SSatish Balay    Level: deprecated
3110edc382c3SSatish Balay 
3111aaa6c58dSLisandro Dalcin @*/
3112aaa6c58dSLisandro Dalcin PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
3113aaa6c58dSLisandro Dalcin {
3114aaa6c58dSLisandro Dalcin   PetscErrorCode ierr;
3115aaa6c58dSLisandro Dalcin   PetscFunctionBegin;
3116aaa6c58dSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3117aaa6c58dSLisandro Dalcin   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
3118aaa6c58dSLisandro Dalcin   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
3119aaa6c58dSLisandro Dalcin   PetscFunctionReturn(0);
3120aaa6c58dSLisandro Dalcin }
3121aaa6c58dSLisandro Dalcin 
3122aaa6c58dSLisandro Dalcin /*@
312319eac22cSLisandro Dalcin    TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime().
3124edc382c3SSatish Balay 
3125edc382c3SSatish Balay    Level: deprecated
3126edc382c3SSatish Balay 
3127adb62b0dSMatthew Knepley @*/
31287087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
3129adb62b0dSMatthew Knepley {
3130adb62b0dSMatthew Knepley   PetscFunctionBegin;
31310700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3132abc0a331SBarry Smith   if (maxsteps) {
31334482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
3134adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
3135adb62b0dSMatthew Knepley   }
3136abc0a331SBarry Smith   if (maxtime) {
31374482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
3138adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
3139adb62b0dSMatthew Knepley   }
3140adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
3141adb62b0dSMatthew Knepley }
3142adb62b0dSMatthew Knepley 
3143d763cef2SBarry Smith /*@
314419eac22cSLisandro Dalcin    TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime().
3145edc382c3SSatish Balay 
3146edc382c3SSatish Balay    Level: deprecated
3147edc382c3SSatish Balay 
3148d763cef2SBarry Smith @*/
31497087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
3150d763cef2SBarry Smith {
3151d763cef2SBarry Smith   PetscFunctionBegin;
31520700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3153c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
3154c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
315539b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
315639b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
3157d763cef2SBarry Smith   PetscFunctionReturn(0);
3158d763cef2SBarry Smith }
3159d763cef2SBarry Smith 
3160d763cef2SBarry Smith /*@
31615c5f5948SLisandro Dalcin    TSGetTimeStepNumber - Deprecated, use TSGetStepNumber().
3162edc382c3SSatish Balay 
3163edc382c3SSatish Balay    Level: deprecated
3164edc382c3SSatish Balay 
31655c5f5948SLisandro Dalcin @*/
3166e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31675c5f5948SLisandro Dalcin 
316819eac22cSLisandro Dalcin /*@
31694f4e0956SLisandro Dalcin    TSGetTotalSteps - Deprecated, use TSGetStepNumber().
3170edc382c3SSatish Balay 
3171edc382c3SSatish Balay    Level: deprecated
3172edc382c3SSatish Balay 
31734f4e0956SLisandro Dalcin @*/
31744f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31754f4e0956SLisandro Dalcin 
31764f4e0956SLisandro Dalcin /*@
3177d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
3178d763cef2SBarry Smith    for use by the TS routines.
3179d763cef2SBarry Smith 
3180d083f849SBarry Smith    Logically Collective on TS
3181d763cef2SBarry Smith 
3182d763cef2SBarry Smith    Input Parameters:
3183d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
31840910c330SBarry Smith -  u - the solution vector
3185d763cef2SBarry Smith 
3186d763cef2SBarry Smith    Level: beginner
3187d763cef2SBarry Smith 
31880ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate()
3189d763cef2SBarry Smith @*/
31900910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
3191d763cef2SBarry Smith {
31928737fe31SLisandro Dalcin   PetscErrorCode ierr;
3193496e6a7aSJed Brown   DM             dm;
31948737fe31SLisandro Dalcin 
3195d763cef2SBarry Smith   PetscFunctionBegin;
31960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31970910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
31980910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
31996bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
32000910c330SBarry Smith   ts->vec_sol = u;
3201bbd56ea5SKarl Rupp 
3202496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
32030910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
3204d763cef2SBarry Smith   PetscFunctionReturn(0);
3205d763cef2SBarry Smith }
3206d763cef2SBarry Smith 
3207ac226902SBarry Smith /*@C
3208000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
32093f2090d5SJed Brown   called once at the beginning of each time step.
3210000e7ae3SMatthew Knepley 
32113f9fe445SBarry Smith   Logically Collective on TS
3212000e7ae3SMatthew Knepley 
3213000e7ae3SMatthew Knepley   Input Parameters:
3214000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3215000e7ae3SMatthew Knepley - func - The function
3216000e7ae3SMatthew Knepley 
3217000e7ae3SMatthew Knepley   Calling sequence of func:
32186bc98fa9SBarry Smith .   PetscErrorCode func (TS ts);
3219000e7ae3SMatthew Knepley 
3220000e7ae3SMatthew Knepley   Level: intermediate
3221000e7ae3SMatthew Knepley 
3222dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep()
3223000e7ae3SMatthew Knepley @*/
32247087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3225000e7ae3SMatthew Knepley {
3226000e7ae3SMatthew Knepley   PetscFunctionBegin;
32270700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3228ae60f76fSBarry Smith   ts->prestep = func;
3229000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3230000e7ae3SMatthew Knepley }
3231000e7ae3SMatthew Knepley 
323209ee8438SJed Brown /*@
32333f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
32343f2090d5SJed Brown 
32353f2090d5SJed Brown   Collective on TS
32363f2090d5SJed Brown 
32373f2090d5SJed Brown   Input Parameters:
32383f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
32393f2090d5SJed Brown 
32403f2090d5SJed Brown   Notes:
32413f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
32423f2090d5SJed Brown   so most users would not generally call this routine themselves.
32433f2090d5SJed Brown 
32443f2090d5SJed Brown   Level: developer
32453f2090d5SJed Brown 
32469be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
32473f2090d5SJed Brown @*/
32487087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
32493f2090d5SJed Brown {
32503f2090d5SJed Brown   PetscErrorCode ierr;
32513f2090d5SJed Brown 
32523f2090d5SJed Brown   PetscFunctionBegin;
32530700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3254ae60f76fSBarry Smith   if (ts->prestep) {
32555efd42a4SStefano Zampini     Vec              U;
32565efd42a4SStefano Zampini     PetscObjectState sprev,spost;
32575efd42a4SStefano Zampini 
32585efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
32595efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3260ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
32615efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3262dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3263312ce896SJed Brown   }
32643f2090d5SJed Brown   PetscFunctionReturn(0);
32653f2090d5SJed Brown }
32663f2090d5SJed Brown 
3267b8123daeSJed Brown /*@C
3268b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3269b8123daeSJed Brown   called once at the beginning of each stage.
3270b8123daeSJed Brown 
3271b8123daeSJed Brown   Logically Collective on TS
3272b8123daeSJed Brown 
3273b8123daeSJed Brown   Input Parameters:
3274b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3275b8123daeSJed Brown - func - The function
3276b8123daeSJed Brown 
3277b8123daeSJed Brown   Calling sequence of func:
3278b8123daeSJed Brown .    PetscErrorCode func(TS ts, PetscReal stagetime);
3279b8123daeSJed Brown 
3280b8123daeSJed Brown   Level: intermediate
3281b8123daeSJed Brown 
3282b8123daeSJed Brown   Note:
3283b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
328480275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
3285b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3286b8123daeSJed Brown 
32879be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3288b8123daeSJed Brown @*/
3289b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3290b8123daeSJed Brown {
3291b8123daeSJed Brown   PetscFunctionBegin;
3292b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3293ae60f76fSBarry Smith   ts->prestage = func;
3294b8123daeSJed Brown   PetscFunctionReturn(0);
3295b8123daeSJed Brown }
3296b8123daeSJed Brown 
32979be3e283SDebojyoti Ghosh /*@C
32989be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
32999be3e283SDebojyoti Ghosh   called once at the end of each stage.
33009be3e283SDebojyoti Ghosh 
33019be3e283SDebojyoti Ghosh   Logically Collective on TS
33029be3e283SDebojyoti Ghosh 
33039be3e283SDebojyoti Ghosh   Input Parameters:
33049be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
33059be3e283SDebojyoti Ghosh - func - The function
33069be3e283SDebojyoti Ghosh 
33079be3e283SDebojyoti Ghosh   Calling sequence of func:
33089be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
33099be3e283SDebojyoti Ghosh 
33109be3e283SDebojyoti Ghosh   Level: intermediate
33119be3e283SDebojyoti Ghosh 
33129be3e283SDebojyoti Ghosh   Note:
33139be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
331480275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
33159be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
33169be3e283SDebojyoti Ghosh 
33179be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
33189be3e283SDebojyoti Ghosh @*/
33199be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
33209be3e283SDebojyoti Ghosh {
33219be3e283SDebojyoti Ghosh   PetscFunctionBegin;
33229be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
33239be3e283SDebojyoti Ghosh   ts->poststage = func;
33249be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
33259be3e283SDebojyoti Ghosh }
33269be3e283SDebojyoti Ghosh 
3327c688d042SShri Abhyankar /*@C
3328c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3329c688d042SShri Abhyankar   called once at the end of each step evaluation.
3330c688d042SShri Abhyankar 
3331c688d042SShri Abhyankar   Logically Collective on TS
3332c688d042SShri Abhyankar 
3333c688d042SShri Abhyankar   Input Parameters:
3334c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3335c688d042SShri Abhyankar - func - The function
3336c688d042SShri Abhyankar 
3337c688d042SShri Abhyankar   Calling sequence of func:
3338c688d042SShri Abhyankar . PetscErrorCode func(TS ts);
3339c688d042SShri Abhyankar 
3340c688d042SShri Abhyankar   Level: intermediate
3341c688d042SShri Abhyankar 
3342c688d042SShri Abhyankar   Note:
33431785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
33441785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3345e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3346e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3347e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3348c688d042SShri Abhyankar 
3349c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3350c688d042SShri Abhyankar @*/
3351c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3352c688d042SShri Abhyankar {
3353c688d042SShri Abhyankar   PetscFunctionBegin;
3354c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3355c688d042SShri Abhyankar   ts->postevaluate = func;
3356c688d042SShri Abhyankar   PetscFunctionReturn(0);
3357c688d042SShri Abhyankar }
3358c688d042SShri Abhyankar 
3359b8123daeSJed Brown /*@
3360b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3361b8123daeSJed Brown 
3362b8123daeSJed Brown   Collective on TS
3363b8123daeSJed Brown 
3364b8123daeSJed Brown   Input Parameters:
3365b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
33669be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3367b8123daeSJed Brown 
3368b8123daeSJed Brown   Notes:
3369b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3370b8123daeSJed Brown   most users would not generally call this routine themselves.
3371b8123daeSJed Brown 
3372b8123daeSJed Brown   Level: developer
3373b8123daeSJed Brown 
33749be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3375b8123daeSJed Brown @*/
3376b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3377b8123daeSJed Brown {
3378b8123daeSJed Brown   PetscFunctionBegin;
3379b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3380ae60f76fSBarry Smith   if (ts->prestage) {
3381ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3382b8123daeSJed Brown   }
3383b8123daeSJed Brown   PetscFunctionReturn(0);
3384b8123daeSJed Brown }
3385b8123daeSJed Brown 
33869be3e283SDebojyoti Ghosh /*@
33879be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
33889be3e283SDebojyoti Ghosh 
33899be3e283SDebojyoti Ghosh   Collective on TS
33909be3e283SDebojyoti Ghosh 
33919be3e283SDebojyoti Ghosh   Input Parameters:
33929be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
33939be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
33949be3e283SDebojyoti Ghosh   stageindex  - Stage number
33959be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
33969be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
33979be3e283SDebojyoti Ghosh 
33989be3e283SDebojyoti Ghosh   Notes:
33999be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
34009be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
34019be3e283SDebojyoti Ghosh 
34029be3e283SDebojyoti Ghosh   Level: developer
34039be3e283SDebojyoti Ghosh 
34049be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
34059be3e283SDebojyoti Ghosh @*/
34069be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
34079be3e283SDebojyoti Ghosh {
34089be3e283SDebojyoti Ghosh   PetscFunctionBegin;
34099be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34104beae5d8SLisandro Dalcin   if (ts->poststage) {
34119be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
34129be3e283SDebojyoti Ghosh   }
34139be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
34149be3e283SDebojyoti Ghosh }
34159be3e283SDebojyoti Ghosh 
3416c688d042SShri Abhyankar /*@
3417c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3418c688d042SShri Abhyankar 
3419c688d042SShri Abhyankar   Collective on TS
3420c688d042SShri Abhyankar 
3421c688d042SShri Abhyankar   Input Parameters:
3422c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3423c688d042SShri Abhyankar 
3424c688d042SShri Abhyankar   Notes:
3425c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3426c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3427c688d042SShri Abhyankar 
3428c688d042SShri Abhyankar   Level: developer
3429c688d042SShri Abhyankar 
3430c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3431c688d042SShri Abhyankar @*/
3432c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3433c688d042SShri Abhyankar {
3434c688d042SShri Abhyankar   PetscErrorCode ierr;
3435c688d042SShri Abhyankar 
3436c688d042SShri Abhyankar   PetscFunctionBegin;
3437c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3438c688d042SShri Abhyankar   if (ts->postevaluate) {
3439dcb233daSLisandro Dalcin     Vec              U;
3440dcb233daSLisandro Dalcin     PetscObjectState sprev,spost;
3441dcb233daSLisandro Dalcin 
3442dcb233daSLisandro Dalcin     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
3443dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3444c688d042SShri Abhyankar     PetscStackCallStandard((*ts->postevaluate),(ts));
3445dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3446dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3447c688d042SShri Abhyankar   }
3448c688d042SShri Abhyankar   PetscFunctionReturn(0);
3449c688d042SShri Abhyankar }
3450c688d042SShri Abhyankar 
3451ac226902SBarry Smith /*@C
3452000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
34533f2090d5SJed Brown   called once at the end of each time step.
3454000e7ae3SMatthew Knepley 
34553f9fe445SBarry Smith   Logically Collective on TS
3456000e7ae3SMatthew Knepley 
3457000e7ae3SMatthew Knepley   Input Parameters:
3458000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3459000e7ae3SMatthew Knepley - func - The function
3460000e7ae3SMatthew Knepley 
3461000e7ae3SMatthew Knepley   Calling sequence of func:
3462b8123daeSJed Brown $ func (TS ts);
3463000e7ae3SMatthew Knepley 
34641785ff2aSShri Abhyankar   Notes:
34651785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
34661785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
34671785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
34681785ff2aSShri Abhyankar 
3469000e7ae3SMatthew Knepley   Level: intermediate
3470000e7ae3SMatthew Knepley 
3471dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep()
3472000e7ae3SMatthew Knepley @*/
34737087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3474000e7ae3SMatthew Knepley {
3475000e7ae3SMatthew Knepley   PetscFunctionBegin;
34760700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3477ae60f76fSBarry Smith   ts->poststep = func;
3478000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3479000e7ae3SMatthew Knepley }
3480000e7ae3SMatthew Knepley 
348109ee8438SJed Brown /*@
34823f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
34833f2090d5SJed Brown 
34843f2090d5SJed Brown   Collective on TS
34853f2090d5SJed Brown 
34863f2090d5SJed Brown   Input Parameters:
34873f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
34883f2090d5SJed Brown 
34893f2090d5SJed Brown   Notes:
34903f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
34913f2090d5SJed Brown   so most users would not generally call this routine themselves.
34923f2090d5SJed Brown 
34933f2090d5SJed Brown   Level: developer
34943f2090d5SJed Brown 
34953f2090d5SJed Brown @*/
34967087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
34973f2090d5SJed Brown {
34983f2090d5SJed Brown   PetscErrorCode ierr;
34993f2090d5SJed Brown 
35003f2090d5SJed Brown   PetscFunctionBegin;
35010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3502ae60f76fSBarry Smith   if (ts->poststep) {
35035efd42a4SStefano Zampini     Vec              U;
35045efd42a4SStefano Zampini     PetscObjectState sprev,spost;
35055efd42a4SStefano Zampini 
35065efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
35075efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3508ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
35095efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3510dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
351172ac3e02SJed Brown   }
35123f2090d5SJed Brown   PetscFunctionReturn(0);
35133f2090d5SJed Brown }
35143f2090d5SJed Brown 
3515d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3516d763cef2SBarry Smith 
3517d763cef2SBarry Smith /*@C
3518a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3519d763cef2SBarry Smith    timestep to display the iteration's  progress.
3520d763cef2SBarry Smith 
35213f9fe445SBarry Smith    Logically Collective on TS
3522d763cef2SBarry Smith 
3523d763cef2SBarry Smith    Input Parameters:
3524d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3525e213d8f1SJed Brown .  monitor - monitoring routine
3526329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
35270298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3528b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
35290298fd71SBarry Smith           (may be NULL)
3530d763cef2SBarry Smith 
3531e213d8f1SJed Brown    Calling sequence of monitor:
3532dcb233daSLisandro Dalcin $    PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3533d763cef2SBarry Smith 
3534d763cef2SBarry Smith +    ts - the TS context
353563e21af5SBarry 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)
35361f06c33eSBarry Smith .    time - current time
35370910c330SBarry Smith .    u - current iterate
3538d763cef2SBarry Smith -    mctx - [optional] monitoring context
3539d763cef2SBarry Smith 
3540d763cef2SBarry Smith    Notes:
3541d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3542d763cef2SBarry Smith    already has been loaded.
3543d763cef2SBarry Smith 
354495452b02SPatrick Sanan    Fortran Notes:
354595452b02SPatrick Sanan     Only a single monitor function can be set for each TS object
3546025f1a04SBarry Smith 
3547d763cef2SBarry Smith    Level: intermediate
3548d763cef2SBarry Smith 
3549a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3550d763cef2SBarry Smith @*/
3551c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3552d763cef2SBarry Smith {
355378064530SBarry Smith   PetscErrorCode ierr;
355478064530SBarry Smith   PetscInt       i;
355578064530SBarry Smith   PetscBool      identical;
355678064530SBarry Smith 
3557d763cef2SBarry Smith   PetscFunctionBegin;
35580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
355978064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
356078064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
356178064530SBarry Smith     if (identical) PetscFunctionReturn(0);
356278064530SBarry Smith   }
356317186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3564d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
35658704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3566d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3567d763cef2SBarry Smith   PetscFunctionReturn(0);
3568d763cef2SBarry Smith }
3569d763cef2SBarry Smith 
3570d763cef2SBarry Smith /*@C
3571a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3572d763cef2SBarry Smith 
35733f9fe445SBarry Smith    Logically Collective on TS
3574d763cef2SBarry Smith 
3575d763cef2SBarry Smith    Input Parameters:
3576d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3577d763cef2SBarry Smith 
3578d763cef2SBarry Smith    Notes:
3579d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3580d763cef2SBarry Smith 
3581d763cef2SBarry Smith    Level: intermediate
3582d763cef2SBarry Smith 
3583a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3584d763cef2SBarry Smith @*/
35857087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3586d763cef2SBarry Smith {
3587d952e501SBarry Smith   PetscErrorCode ierr;
3588d952e501SBarry Smith   PetscInt       i;
3589d952e501SBarry Smith 
3590d763cef2SBarry Smith   PetscFunctionBegin;
35910700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3592d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
35938704b422SBarry Smith     if (ts->monitordestroy[i]) {
35948704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3595d952e501SBarry Smith     }
3596d952e501SBarry Smith   }
3597d763cef2SBarry Smith   ts->numbermonitors = 0;
3598d763cef2SBarry Smith   PetscFunctionReturn(0);
3599d763cef2SBarry Smith }
3600d763cef2SBarry Smith 
3601721cd6eeSBarry Smith /*@C
3602721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
36035516499fSSatish Balay 
36045516499fSSatish Balay    Level: intermediate
360541251cbbSSatish Balay 
360663e21af5SBarry Smith .seealso:  TSMonitorSet()
360741251cbbSSatish Balay @*/
3608721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3609d763cef2SBarry Smith {
3610dfbe8321SBarry Smith   PetscErrorCode ierr;
3611721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
361241aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3613d132466eSBarry Smith 
3614d763cef2SBarry Smith   PetscFunctionBegin;
36154d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
361641aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
361741aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3618721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
361941aca3d6SBarry Smith   if (iascii) {
3620649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
362163e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
362263e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
362363e21af5SBarry Smith     } else {
36248392e04aSShri 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);
362563e21af5SBarry Smith     }
3626649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
362741aca3d6SBarry Smith   } else if (ibinary) {
362841aca3d6SBarry Smith     PetscMPIInt rank;
362941aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
363041aca3d6SBarry Smith     if (!rank) {
3631450a797fSBarry Smith       PetscBool skipHeader;
3632450a797fSBarry Smith       PetscInt  classid = REAL_FILE_CLASSID;
3633450a797fSBarry Smith 
3634450a797fSBarry Smith       ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr);
3635450a797fSBarry Smith       if (!skipHeader) {
3636f253e43cSLisandro Dalcin          ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
3637450a797fSBarry Smith        }
363841aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
363941aca3d6SBarry Smith     } else {
364041aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
364141aca3d6SBarry Smith     }
364241aca3d6SBarry Smith   }
3643721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3644d763cef2SBarry Smith   PetscFunctionReturn(0);
3645d763cef2SBarry Smith }
3646d763cef2SBarry Smith 
3647cc9c3a59SBarry Smith /*@C
3648cc9c3a59SBarry Smith    TSMonitorExtreme - Prints the extreme values of the solution at each timestep
3649cc9c3a59SBarry Smith 
3650cc9c3a59SBarry Smith    Level: intermediate
3651cc9c3a59SBarry Smith 
3652cc9c3a59SBarry Smith .seealso:  TSMonitorSet()
3653cc9c3a59SBarry Smith @*/
3654cc9c3a59SBarry Smith PetscErrorCode TSMonitorExtreme(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3655cc9c3a59SBarry Smith {
3656cc9c3a59SBarry Smith   PetscErrorCode ierr;
3657cc9c3a59SBarry Smith   PetscViewer    viewer =  vf->viewer;
3658cc9c3a59SBarry Smith   PetscBool      iascii;
3659cc9c3a59SBarry Smith   PetscReal      max,min;
3660cc9c3a59SBarry Smith 
3661cc9c3a59SBarry Smith 
3662cc9c3a59SBarry Smith   PetscFunctionBegin;
3663cc9c3a59SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3664cc9c3a59SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
3665cc9c3a59SBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
3666cc9c3a59SBarry Smith   if (iascii) {
3667cc9c3a59SBarry Smith     ierr = VecMax(v,NULL,&max);CHKERRQ(ierr);
3668cc9c3a59SBarry Smith     ierr = VecMin(v,NULL,&min);CHKERRQ(ierr);
3669cc9c3a59SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
36705132926bSBarry 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);
3671cc9c3a59SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3672cc9c3a59SBarry Smith   }
3673cc9c3a59SBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3674cc9c3a59SBarry Smith   PetscFunctionReturn(0);
3675cc9c3a59SBarry Smith }
3676cc9c3a59SBarry Smith 
3677cd652676SJed Brown /*@
3678cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3679cd652676SJed Brown 
3680cd652676SJed Brown    Collective on TS
3681cd652676SJed Brown 
3682cd652676SJed Brown    Input Argument:
3683cd652676SJed Brown +  ts - time stepping context
3684cd652676SJed Brown -  t - time to interpolate to
3685cd652676SJed Brown 
3686cd652676SJed Brown    Output Argument:
36870910c330SBarry Smith .  U - state at given time
3688cd652676SJed Brown 
3689cd652676SJed Brown    Level: intermediate
3690cd652676SJed Brown 
3691cd652676SJed Brown    Developer Notes:
3692cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3693cd652676SJed Brown 
3694874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
3695cd652676SJed Brown @*/
36960910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3697cd652676SJed Brown {
3698cd652676SJed Brown   PetscErrorCode ierr;
3699cd652676SJed Brown 
3700cd652676SJed Brown   PetscFunctionBegin;
3701cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3702b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3703be5899b3SLisandro 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);
3704ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
37050910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3706cd652676SJed Brown   PetscFunctionReturn(0);
3707cd652676SJed Brown }
3708cd652676SJed Brown 
3709d763cef2SBarry Smith /*@
37106d9e5789SSean Farley    TSStep - Steps one time step
3711d763cef2SBarry Smith 
3712d763cef2SBarry Smith    Collective on TS
3713d763cef2SBarry Smith 
3714d763cef2SBarry Smith    Input Parameter:
3715d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3716d763cef2SBarry Smith 
371727829d71SBarry Smith    Level: developer
3718d763cef2SBarry Smith 
3719b8123daeSJed Brown    Notes:
372027829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
372127829d71SBarry Smith 
3722b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3723b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3724b8123daeSJed Brown 
372519eac22cSLisandro Dalcin    This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the
372619eac22cSLisandro Dalcin    time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
372725cb2221SBarry Smith 
37289be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3729d763cef2SBarry Smith @*/
3730193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3731d763cef2SBarry Smith {
3732dfbe8321SBarry Smith   PetscErrorCode   ierr;
3733fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3734be5899b3SLisandro Dalcin   PetscReal        ptime;
3735d763cef2SBarry Smith 
3736d763cef2SBarry Smith   PetscFunctionBegin;
37370700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3738f1d62c27SHong Zhang   ierr = PetscCitationsRegister("@article{tspaper,\n"
3739fffbeea8SBarry Smith                                 "  title         = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3740f1d62c27SHong Zhang                                 "  author        = {Abhyankar, Shrirang and Brown, Jed and Constantinescu, Emil and Ghosh, Debojyoti and Smith, Barry F. and Zhang, Hong},\n"
3741f1d62c27SHong Zhang                                 "  journal       = {arXiv e-preprints},\n"
3742f1d62c27SHong Zhang                                 "  eprint        = {1806.01437},\n"
3743f1d62c27SHong Zhang                                 "  archivePrefix = {arXiv},\n"
3744f1d62c27SHong Zhang                                 "  year          = {2018}\n}\n",&cite);CHKERRQ(ierr);
3745fffbeea8SBarry Smith 
3746d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
374768bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3748d405a339SMatthew Knepley 
3749fc8dbba5SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3750ef85077eSLisandro 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>");
3751a6772fa2SLisandro 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()");
3752be5899b3SLisandro 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");
3753a6772fa2SLisandro Dalcin 
3754be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
3755be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
37562808aa04SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3757fc8dbba5SLisandro Dalcin 
3758d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3759193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3760d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3761fc8dbba5SLisandro Dalcin 
3762fc8dbba5SLisandro Dalcin   if (ts->reason >= 0) {
3763be5899b3SLisandro Dalcin     ts->ptime_prev = ptime;
37642808aa04SLisandro Dalcin     ts->steps++;
3765be5899b3SLisandro Dalcin     ts->steprollback = PETSC_FALSE;
376628d5b5d6SLisandro Dalcin     ts->steprestart  = PETSC_FALSE;
3767d2daff3dSHong Zhang   }
3768fc8dbba5SLisandro Dalcin 
3769fc8dbba5SLisandro Dalcin   if (!ts->reason) {
377008c7845fSBarry Smith     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
377108c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
377208c7845fSBarry Smith   }
3773fc8dbba5SLisandro Dalcin 
3774fc8dbba5SLisandro 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]);
3775fc8dbba5SLisandro Dalcin   if (ts->reason < 0 && ts->errorifstepfailed) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
377608c7845fSBarry Smith   PetscFunctionReturn(0);
377708c7845fSBarry Smith }
377808c7845fSBarry Smith 
377908c7845fSBarry Smith /*@
37807cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
37817cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
37827cbde773SLisandro Dalcin 
37837cbde773SLisandro Dalcin    Collective on TS
37847cbde773SLisandro Dalcin 
37857cbde773SLisandro Dalcin    Input Arguments:
37867cbde773SLisandro Dalcin +  ts - time stepping context
37877cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
37887cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
37897cbde773SLisandro Dalcin 
37907cbde773SLisandro Dalcin    Output Arguments:
37917cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
37927cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
37937cbde773SLisandro Dalcin 
37947cbde773SLisandro Dalcin    Level: advanced
37957cbde773SLisandro Dalcin 
37967cbde773SLisandro Dalcin    Notes:
37977cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
37987cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
37997cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
38007cbde773SLisandro Dalcin 
38017cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
38027cbde773SLisandro Dalcin @*/
38037cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
38047cbde773SLisandro Dalcin {
38057cbde773SLisandro Dalcin   PetscErrorCode ierr;
38067cbde773SLisandro Dalcin 
38077cbde773SLisandro Dalcin   PetscFunctionBegin;
38087cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
38097cbde773SLisandro Dalcin   PetscValidType(ts,1);
38107cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
38117cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
38127cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
38137cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
38147cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
38157cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
38167cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
38177cbde773SLisandro Dalcin   PetscFunctionReturn(0);
38187cbde773SLisandro Dalcin }
38197cbde773SLisandro Dalcin 
382005175c85SJed Brown /*@
382105175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
382205175c85SJed Brown 
38231c3436cfSJed Brown    Collective on TS
382405175c85SJed Brown 
382505175c85SJed Brown    Input Arguments:
38261c3436cfSJed Brown +  ts - time stepping context
38271c3436cfSJed Brown .  order - desired order of accuracy
38280298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
382905175c85SJed Brown 
383005175c85SJed Brown    Output Arguments:
38310910c330SBarry Smith .  U - state at the end of the current step
383205175c85SJed Brown 
383305175c85SJed Brown    Level: advanced
383405175c85SJed Brown 
3835108c343cSJed Brown    Notes:
3836108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3837108c343cSJed 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.
3838108c343cSJed Brown 
38391c3436cfSJed Brown .seealso: TSStep(), TSAdapt
384005175c85SJed Brown @*/
38410910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
384205175c85SJed Brown {
384305175c85SJed Brown   PetscErrorCode ierr;
384405175c85SJed Brown 
384505175c85SJed Brown   PetscFunctionBegin;
384605175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
384705175c85SJed Brown   PetscValidType(ts,1);
38480910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3849ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
38500910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
385105175c85SJed Brown   PetscFunctionReturn(0);
385205175c85SJed Brown }
385305175c85SJed Brown 
3854aad739acSMatthew G. Knepley /*@C
38552e61be88SMatthew G. Knepley   TSGetComputeInitialCondition - Get the function used to automatically compute an initial condition for the timestepping.
3856aad739acSMatthew G. Knepley 
3857aad739acSMatthew G. Knepley   Not collective
3858aad739acSMatthew G. Knepley 
3859aad739acSMatthew G. Knepley   Input Argument:
3860aad739acSMatthew G. Knepley . ts        - time stepping context
3861aad739acSMatthew G. Knepley 
3862aad739acSMatthew G. Knepley   Output Argument:
38632e61be88SMatthew G. Knepley . initConditions - The function which computes an initial condition
3864aad739acSMatthew G. Knepley 
3865aad739acSMatthew G. Knepley    Level: advanced
3866aad739acSMatthew G. Knepley 
3867aad739acSMatthew G. Knepley    Notes:
3868aad739acSMatthew G. Knepley    The calling sequence for the function is
38692e61be88SMatthew G. Knepley $ initCondition(TS ts, Vec u)
3870aad739acSMatthew G. Knepley $ ts - The timestepping context
38712e61be88SMatthew G. Knepley $ u  - The input vector in which the initial condition is stored
3872aad739acSMatthew G. Knepley 
38732e61be88SMatthew G. Knepley .seealso: TSSetComputeInitialCondition(), TSComputeInitialCondition()
3874aad739acSMatthew G. Knepley @*/
38752e61be88SMatthew G. Knepley PetscErrorCode TSGetComputeInitialCondition(TS ts, PetscErrorCode (**initCondition)(TS, Vec))
3876aad739acSMatthew G. Knepley {
3877aad739acSMatthew G. Knepley   PetscFunctionBegin;
3878aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
38792e61be88SMatthew G. Knepley   PetscValidPointer(initCondition, 2);
38802e61be88SMatthew G. Knepley   *initCondition = ts->ops->initcondition;
3881aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3882aad739acSMatthew G. Knepley }
3883aad739acSMatthew G. Knepley 
3884aad739acSMatthew G. Knepley /*@C
38852e61be88SMatthew G. Knepley   TSSetComputeInitialCondition - Set the function used to automatically compute an initial condition for the timestepping.
3886aad739acSMatthew G. Knepley 
3887aad739acSMatthew G. Knepley   Logically collective on ts
3888aad739acSMatthew G. Knepley 
3889aad739acSMatthew G. Knepley   Input Arguments:
3890aad739acSMatthew G. Knepley + ts        - time stepping context
38912e61be88SMatthew G. Knepley - initCondition - The function which computes an initial condition
3892aad739acSMatthew G. Knepley 
3893aad739acSMatthew G. Knepley   Level: advanced
3894aad739acSMatthew G. Knepley 
3895a96d6ef6SBarry Smith   Calling sequence for initCondition:
3896a96d6ef6SBarry Smith $ PetscErrorCode initCondition(TS ts, Vec u)
3897a96d6ef6SBarry Smith 
3898a96d6ef6SBarry Smith + ts - The timestepping context
3899a96d6ef6SBarry Smith - u  - The input vector in which the initial condition is to be stored
3900aad739acSMatthew G. Knepley 
39012e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSComputeInitialCondition()
3902aad739acSMatthew G. Knepley @*/
39032e61be88SMatthew G. Knepley PetscErrorCode TSSetComputeInitialCondition(TS ts, PetscErrorCode (*initCondition)(TS, Vec))
3904aad739acSMatthew G. Knepley {
3905aad739acSMatthew G. Knepley   PetscFunctionBegin;
3906aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
39072e61be88SMatthew G. Knepley   PetscValidFunction(initCondition, 2);
39082e61be88SMatthew G. Knepley   ts->ops->initcondition = initCondition;
3909aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3910aad739acSMatthew G. Knepley }
3911aad739acSMatthew G. Knepley 
3912aad739acSMatthew G. Knepley /*@
39132e61be88SMatthew G. Knepley   TSComputeInitialCondition - Compute an initial condition for the timestepping using the function previously set.
3914aad739acSMatthew G. Knepley 
3915aad739acSMatthew G. Knepley   Collective on ts
3916aad739acSMatthew G. Knepley 
3917aad739acSMatthew G. Knepley   Input Arguments:
3918aad739acSMatthew G. Knepley + ts - time stepping context
39192e61be88SMatthew G. Knepley - u  - The Vec to store the condition in which will be used in TSSolve()
3920aad739acSMatthew G. Knepley 
3921aad739acSMatthew G. Knepley   Level: advanced
3922aad739acSMatthew G. Knepley 
39232e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve()
3924aad739acSMatthew G. Knepley @*/
39252e61be88SMatthew G. Knepley PetscErrorCode TSComputeInitialCondition(TS ts, Vec u)
3926aad739acSMatthew G. Knepley {
3927aad739acSMatthew G. Knepley   PetscErrorCode ierr;
3928aad739acSMatthew G. Knepley 
3929aad739acSMatthew G. Knepley   PetscFunctionBegin;
3930aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3931aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
39322e61be88SMatthew G. Knepley   if (ts->ops->initcondition) {ierr = (*ts->ops->initcondition)(ts, u);CHKERRQ(ierr);}
3933aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3934aad739acSMatthew G. Knepley }
3935aad739acSMatthew G. Knepley 
3936aad739acSMatthew G. Knepley /*@C
3937aad739acSMatthew G. Knepley   TSGetComputeExactError - Get the function used to automatically compute the exact error for the timestepping.
3938aad739acSMatthew G. Knepley 
3939aad739acSMatthew G. Knepley   Not collective
3940aad739acSMatthew G. Knepley 
3941aad739acSMatthew G. Knepley   Input Argument:
3942aad739acSMatthew G. Knepley . ts         - time stepping context
3943aad739acSMatthew G. Knepley 
3944aad739acSMatthew G. Knepley   Output Argument:
3945aad739acSMatthew G. Knepley . exactError - The function which computes the solution error
3946aad739acSMatthew G. Knepley 
3947aad739acSMatthew G. Knepley   Level: advanced
3948aad739acSMatthew G. Knepley 
3949a96d6ef6SBarry Smith   Calling sequence for exactError:
3950a96d6ef6SBarry Smith $ PetscErrorCode exactError(TS ts, Vec u)
3951a96d6ef6SBarry Smith 
3952a96d6ef6SBarry Smith + ts - The timestepping context
3953a96d6ef6SBarry Smith . u  - The approximate solution vector
3954a96d6ef6SBarry Smith - e  - The input vector in which the error is stored
3955aad739acSMatthew G. Knepley 
3956aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError()
3957aad739acSMatthew G. Knepley @*/
3958aad739acSMatthew G. Knepley PetscErrorCode TSGetComputeExactError(TS ts, PetscErrorCode (**exactError)(TS, Vec, Vec))
3959aad739acSMatthew G. Knepley {
3960aad739acSMatthew G. Knepley   PetscFunctionBegin;
3961aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3962aad739acSMatthew G. Knepley   PetscValidPointer(exactError, 2);
3963aad739acSMatthew G. Knepley   *exactError = ts->ops->exacterror;
3964aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3965aad739acSMatthew G. Knepley }
3966aad739acSMatthew G. Knepley 
3967aad739acSMatthew G. Knepley /*@C
3968aad739acSMatthew G. Knepley   TSSetComputeExactError - Set the function used to automatically compute the exact error for the timestepping.
3969aad739acSMatthew G. Knepley 
3970aad739acSMatthew G. Knepley   Logically collective on ts
3971aad739acSMatthew G. Knepley 
3972aad739acSMatthew G. Knepley   Input Arguments:
3973aad739acSMatthew G. Knepley + ts         - time stepping context
3974aad739acSMatthew G. Knepley - exactError - The function which computes the solution error
3975aad739acSMatthew G. Knepley 
3976aad739acSMatthew G. Knepley   Level: advanced
3977aad739acSMatthew G. Knepley 
3978a96d6ef6SBarry Smith   Calling sequence for exactError:
3979a96d6ef6SBarry Smith $ PetscErrorCode exactError(TS ts, Vec u)
3980a96d6ef6SBarry Smith 
3981a96d6ef6SBarry Smith + ts - The timestepping context
3982a96d6ef6SBarry Smith . u  - The approximate solution vector
3983a96d6ef6SBarry Smith - e  - The input vector in which the error is stored
3984aad739acSMatthew G. Knepley 
3985aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError()
3986aad739acSMatthew G. Knepley @*/
3987aad739acSMatthew G. Knepley PetscErrorCode TSSetComputeExactError(TS ts, PetscErrorCode (*exactError)(TS, Vec, Vec))
3988aad739acSMatthew G. Knepley {
3989aad739acSMatthew G. Knepley   PetscFunctionBegin;
3990aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3991f907fdbfSMatthew G. Knepley   PetscValidFunction(exactError, 2);
3992aad739acSMatthew G. Knepley   ts->ops->exacterror = exactError;
3993aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3994aad739acSMatthew G. Knepley }
3995aad739acSMatthew G. Knepley 
3996aad739acSMatthew G. Knepley /*@
3997aad739acSMatthew G. Knepley   TSComputeExactError - Compute the solution error for the timestepping using the function previously set.
3998aad739acSMatthew G. Knepley 
3999aad739acSMatthew G. Knepley   Collective on ts
4000aad739acSMatthew G. Knepley 
4001aad739acSMatthew G. Knepley   Input Arguments:
4002aad739acSMatthew G. Knepley + ts - time stepping context
4003aad739acSMatthew G. Knepley . u  - The approximate solution
4004aad739acSMatthew G. Knepley - e  - The Vec used to store the error
4005aad739acSMatthew G. Knepley 
4006aad739acSMatthew G. Knepley   Level: advanced
4007aad739acSMatthew G. Knepley 
40082e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve()
4009aad739acSMatthew G. Knepley @*/
4010aad739acSMatthew G. Knepley PetscErrorCode TSComputeExactError(TS ts, Vec u, Vec e)
4011aad739acSMatthew G. Knepley {
4012aad739acSMatthew G. Knepley   PetscErrorCode ierr;
4013aad739acSMatthew G. Knepley 
4014aad739acSMatthew G. Knepley   PetscFunctionBegin;
4015aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
4016aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
4017aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(e, VEC_CLASSID, 3);
4018aad739acSMatthew G. Knepley   if (ts->ops->exacterror) {ierr = (*ts->ops->exacterror)(ts, u, e);CHKERRQ(ierr);}
4019aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
4020aad739acSMatthew G. Knepley }
4021aad739acSMatthew G. Knepley 
4022b1cb36f3SHong Zhang /*@
40236a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
40246a4d4014SLisandro Dalcin 
40256a4d4014SLisandro Dalcin    Collective on TS
40266a4d4014SLisandro Dalcin 
40276a4d4014SLisandro Dalcin    Input Parameter:
40286a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
402963e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
403063e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
40315a3a76d0SJed Brown 
40326a4d4014SLisandro Dalcin    Level: beginner
40336a4d4014SLisandro Dalcin 
40345a3a76d0SJed Brown    Notes:
40355a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
40365a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
40375a3a76d0SJed Brown    stepped over the final time.
40385a3a76d0SJed Brown 
403963e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
40406a4d4014SLisandro Dalcin @*/
4041cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
40426a4d4014SLisandro Dalcin {
4043b06615a5SLisandro Dalcin   Vec               solution;
40446a4d4014SLisandro Dalcin   PetscErrorCode    ierr;
4045f22f69f0SBarry Smith 
40466a4d4014SLisandro Dalcin   PetscFunctionBegin;
40470700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4048f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
4049303a5415SBarry Smith 
4050303a5415SBarry Smith   ierr = TSSetExactFinalTimeDefault(ts);CHKERRQ(ierr);
4051ee41a567SStefano 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 */
40520910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
4053b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
4054b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
4055b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
40565a3a76d0SJed Brown     }
40570910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
4058715f1b00SHong Zhang     if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
4059bbd56ea5SKarl Rupp   } else if (u) {
40600910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
40615a3a76d0SJed Brown   }
4062b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
406368bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4064a6772fa2SLisandro Dalcin 
4065ef85077eSLisandro 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>");
4066a6772fa2SLisandro 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()");
4067a6772fa2SLisandro 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");
4068a6772fa2SLisandro Dalcin 
4069715f1b00SHong Zhang   if (ts->forward_solve) {
4070715f1b00SHong Zhang     ierr = TSForwardSetUp(ts);CHKERRQ(ierr);
4071715f1b00SHong Zhang   }
4072715f1b00SHong Zhang 
4073e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
4074715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
4075e7069c78SShri      TSTrajectory to incorrectly save the output files
4076e7069c78SShri   */
4077715f1b00SHong Zhang   /* reset time step and iteration counters */
40782808aa04SLisandro Dalcin   if (!ts->steps) {
40795ef26d82SJed Brown     ts->ksp_its           = 0;
40805ef26d82SJed Brown     ts->snes_its          = 0;
4081c610991cSLisandro Dalcin     ts->num_snes_failures = 0;
4082c610991cSLisandro Dalcin     ts->reject            = 0;
40832808aa04SLisandro Dalcin     ts->steprestart       = PETSC_TRUE;
40842808aa04SLisandro Dalcin     ts->steprollback      = PETSC_FALSE;
40857d51462cSStefano Zampini     ts->rhsjacobian.time  = PETSC_MIN_REAL;
40862808aa04SLisandro Dalcin   }
4087e97c63d7SStefano Zampini 
4088e97c63d7SStefano Zampini   /* make sure initial time step does not overshoot final time */
4089e97c63d7SStefano Zampini   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP) {
4090e97c63d7SStefano Zampini     PetscReal maxdt = ts->max_time-ts->ptime;
4091e97c63d7SStefano Zampini     PetscReal dt = ts->time_step;
4092e97c63d7SStefano Zampini 
4093e97c63d7SStefano Zampini     ts->time_step = dt >= maxdt ? maxdt : (PetscIsCloseAtTol(dt,maxdt,10*PETSC_MACHINE_EPSILON,0) ? maxdt : dt);
4094e97c63d7SStefano Zampini   }
4095193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
4096193ac0bcSJed Brown 
4097900f6b5bSMatthew G. Knepley   {
4098900f6b5bSMatthew G. Knepley     PetscViewer       viewer;
4099900f6b5bSMatthew G. Knepley     PetscViewerFormat format;
4100900f6b5bSMatthew G. Knepley     PetscBool         flg;
4101900f6b5bSMatthew G. Knepley     static PetscBool  incall = PETSC_FALSE;
4102900f6b5bSMatthew G. Knepley 
4103900f6b5bSMatthew G. Knepley     if (!incall) {
4104900f6b5bSMatthew G. Knepley       /* Estimate the convergence rate of the time discretization */
4105900f6b5bSMatthew G. Knepley       ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) ts),((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_estimate", &viewer, &format, &flg);CHKERRQ(ierr);
4106900f6b5bSMatthew G. Knepley       if (flg) {
4107900f6b5bSMatthew G. Knepley         PetscConvEst conv;
4108900f6b5bSMatthew G. Knepley         DM           dm;
4109900f6b5bSMatthew G. Knepley         PetscReal   *alpha; /* Convergence rate of the solution error for each field in the L_2 norm */
4110900f6b5bSMatthew G. Knepley         PetscInt     Nf;
4111f2ed2dc7SMatthew G. Knepley         PetscBool    checkTemporal = PETSC_TRUE;
4112900f6b5bSMatthew G. Knepley 
4113900f6b5bSMatthew G. Knepley         incall = PETSC_TRUE;
4114f2ed2dc7SMatthew G. Knepley         ierr = PetscOptionsGetBool(((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_temporal", &checkTemporal, &flg);CHKERRQ(ierr);
4115900f6b5bSMatthew G. Knepley         ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
4116900f6b5bSMatthew G. Knepley         ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4117900f6b5bSMatthew G. Knepley         ierr = PetscCalloc1(PetscMax(Nf, 1), &alpha);CHKERRQ(ierr);
4118900f6b5bSMatthew G. Knepley         ierr = PetscConvEstCreate(PetscObjectComm((PetscObject) ts), &conv);CHKERRQ(ierr);
4119f2ed2dc7SMatthew G. Knepley         ierr = PetscConvEstUseTS(conv, checkTemporal);CHKERRQ(ierr);
4120900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetSolver(conv, (PetscObject) ts);CHKERRQ(ierr);
4121900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetFromOptions(conv);CHKERRQ(ierr);
4122900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetUp(conv);CHKERRQ(ierr);
4123900f6b5bSMatthew G. Knepley         ierr = PetscConvEstGetConvRate(conv, alpha);CHKERRQ(ierr);
4124900f6b5bSMatthew G. Knepley         ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);
4125900f6b5bSMatthew G. Knepley         ierr = PetscConvEstRateView(conv, alpha, viewer);CHKERRQ(ierr);
4126900f6b5bSMatthew G. Knepley         ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
4127900f6b5bSMatthew G. Knepley         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4128900f6b5bSMatthew G. Knepley         ierr = PetscConvEstDestroy(&conv);CHKERRQ(ierr);
4129900f6b5bSMatthew G. Knepley         ierr = PetscFree(alpha);CHKERRQ(ierr);
4130900f6b5bSMatthew G. Knepley         incall = PETSC_FALSE;
4131900f6b5bSMatthew G. Knepley       }
4132900f6b5bSMatthew G. Knepley     }
4133900f6b5bSMatthew G. Knepley   }
4134900f6b5bSMatthew G. Knepley 
4135ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
4136f05ece33SBarry Smith 
4137193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
4138193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
4139a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4140cc708dedSBarry Smith     ts->solvetime = ts->ptime;
4141a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
4142be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
4143db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
4144db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
4145e7069c78SShri 
41462808aa04SLisandro Dalcin     if (!ts->steps) {
41472808aa04SLisandro Dalcin       ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41486427ac75SLisandro Dalcin       ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41492808aa04SLisandro Dalcin     }
41506427ac75SLisandro Dalcin 
4151e1a7a14fSJed Brown     while (!ts->reason) {
41522808aa04SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41539687d888SLisandro Dalcin       if (!ts->steprollback) {
41549687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
41559687d888SLisandro Dalcin       }
4156193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
4157f3b1f45cSBarry Smith       if (ts->testjacobian) {
4158f3b1f45cSBarry Smith         ierr = TSRHSJacobianTest(ts,NULL);CHKERRQ(ierr);
4159f3b1f45cSBarry Smith       }
4160f3b1f45cSBarry Smith       if (ts->testjacobiantranspose) {
4161f3b1f45cSBarry Smith         ierr = TSRHSJacobianTestTranspose(ts,NULL);CHKERRQ(ierr);
4162f3b1f45cSBarry Smith       }
4163cd4cee2dSHong Zhang       if (ts->quadraturets && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */
41647b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */
4165b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
41667b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps++;
4167b1cb36f3SHong Zhang       }
416858818c2dSLisandro Dalcin       if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */
41697b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */
4170715f1b00SHong Zhang         ierr = TSForwardStep(ts);CHKERRQ(ierr);
41717b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps++;
4172715f1b00SHong Zhang       }
417310b82f12SShri Abhyankar       ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
4174e783b05fSHong 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. */
417558818c2dSLisandro Dalcin       if (ts->steprollback) {
417658818c2dSLisandro Dalcin         ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
417758818c2dSLisandro Dalcin       }
4178e783b05fSHong Zhang       if (!ts->steprollback) {
41792808aa04SLisandro Dalcin         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41801eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
4181aeb4809dSShri Abhyankar       }
4182193ac0bcSJed Brown     }
41832808aa04SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41846427ac75SLisandro Dalcin 
418549354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
41860910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
4187cc708dedSBarry Smith       ts->solvetime = ts->max_time;
4188b06615a5SLisandro Dalcin       solution = u;
418963e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
41900574a7fbSJed Brown     } else {
4191ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4192cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4193b06615a5SLisandro Dalcin       solution = ts->vec_sol;
41940574a7fbSJed Brown     }
4195193ac0bcSJed Brown   }
4196d2daff3dSHong Zhang 
4197ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
419863e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
419956f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
4200ef222394SBarry Smith   if (ts->adjoint_solve) {
4201ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
42022b0a91c0SBarry Smith   }
42036a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
42046a4d4014SLisandro Dalcin }
42056a4d4014SLisandro Dalcin 
42067db568b7SBarry Smith /*@C
4207228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4208228d79bcSJed Brown 
4209228d79bcSJed Brown    Collective on TS
4210228d79bcSJed Brown 
4211228d79bcSJed Brown    Input Parameters:
4212228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
4213228d79bcSJed Brown .  step - step number that has just completed
4214228d79bcSJed Brown .  ptime - model time of the state
42150910c330SBarry Smith -  u - state at the current model time
4216228d79bcSJed Brown 
4217228d79bcSJed Brown    Notes:
42187db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
42197db568b7SBarry Smith    Users would almost never call this routine directly.
4220228d79bcSJed Brown 
422163e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
422263e21af5SBarry Smith 
42237db568b7SBarry Smith    Level: developer
4224228d79bcSJed Brown 
4225228d79bcSJed Brown @*/
42260910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4227d763cef2SBarry Smith {
4228d6152f81SLisandro Dalcin   DM             dm;
4229a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
4230d6152f81SLisandro Dalcin   PetscErrorCode ierr;
4231d763cef2SBarry Smith 
4232d763cef2SBarry Smith   PetscFunctionBegin;
4233b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4234b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4235d6152f81SLisandro Dalcin 
4236d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
4237d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
4238d6152f81SLisandro Dalcin 
42398860a134SJunchao Zhang   ierr = VecLockReadPush(u);CHKERRQ(ierr);
4240d763cef2SBarry Smith   for (i=0; i<n; i++) {
42410910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
4242d763cef2SBarry Smith   }
42438860a134SJunchao Zhang   ierr = VecLockReadPop(u);CHKERRQ(ierr);
4244d763cef2SBarry Smith   PetscFunctionReturn(0);
4245d763cef2SBarry Smith }
4246d763cef2SBarry Smith 
4247d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
4248d763cef2SBarry Smith /*@C
42497db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4250a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
4251d763cef2SBarry Smith 
4252d763cef2SBarry Smith    Collective on TS
4253d763cef2SBarry Smith 
4254d763cef2SBarry Smith    Input Parameters:
4255d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
4256d763cef2SBarry Smith .  label - the title to put in the title bar
42577c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
4258a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
4259a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4260d763cef2SBarry Smith 
4261d763cef2SBarry Smith    Output Parameter:
42620b039ecaSBarry Smith .  ctx - the context
4263d763cef2SBarry Smith 
4264d763cef2SBarry Smith    Options Database Key:
42654f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
42668b668821SLisandro Dalcin +  -ts_monitor_lg_timestep_log - automatically sets line graph monitor
42677db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
42687db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
42697db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
42707db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4271b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4272d763cef2SBarry Smith 
4273d763cef2SBarry Smith    Notes:
4274a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
4275d763cef2SBarry Smith 
42767db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
42777db568b7SBarry Smith 
42787db568b7SBarry 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
42797db568b7SBarry 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
42807db568b7SBarry Smith    as the first argument.
42817db568b7SBarry Smith 
42827db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
42837db568b7SBarry Smith 
4284d763cef2SBarry Smith    Level: intermediate
4285d763cef2SBarry Smith 
42867db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
42877db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
42887db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
42897db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
42907db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
42917c922b88SBarry Smith 
4292d763cef2SBarry Smith @*/
4293a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4294d763cef2SBarry Smith {
42957f52daa2SLisandro Dalcin   PetscDraw      draw;
4296dfbe8321SBarry Smith   PetscErrorCode ierr;
4297d763cef2SBarry Smith 
4298d763cef2SBarry Smith   PetscFunctionBegin;
4299b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
43007f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
43017f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
43027f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
4303287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
43047f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
4305a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
4306d763cef2SBarry Smith   PetscFunctionReturn(0);
4307d763cef2SBarry Smith }
4308d763cef2SBarry Smith 
4309b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4310d763cef2SBarry Smith {
43110b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4312c32365f1SBarry Smith   PetscReal      x   = ptime,y;
4313dfbe8321SBarry Smith   PetscErrorCode ierr;
4314d763cef2SBarry Smith 
4315d763cef2SBarry Smith   PetscFunctionBegin;
431663e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
4317b06615a5SLisandro Dalcin   if (!step) {
4318a9f9c1f6SBarry Smith     PetscDrawAxis axis;
43198b668821SLisandro Dalcin     const char *ylabel = ctx->semilogy ? "Log Time Step" : "Time Step";
4320a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
43218b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time",ylabel);CHKERRQ(ierr);
4322a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4323a9f9c1f6SBarry Smith   }
4324c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
43258b668821SLisandro Dalcin   if (ctx->semilogy) y = PetscLog10Real(y);
43260b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
4327b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
43280b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
43296934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
43303923b477SBarry Smith   }
4331d763cef2SBarry Smith   PetscFunctionReturn(0);
4332d763cef2SBarry Smith }
4333d763cef2SBarry Smith 
4334d763cef2SBarry Smith /*@C
4335a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4336a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
4337d763cef2SBarry Smith 
43380b039ecaSBarry Smith    Collective on TSMonitorLGCtx
4339d763cef2SBarry Smith 
4340d763cef2SBarry Smith    Input Parameter:
43410b039ecaSBarry Smith .  ctx - the monitor context
4342d763cef2SBarry Smith 
4343d763cef2SBarry Smith    Level: intermediate
4344d763cef2SBarry Smith 
43454f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
4346d763cef2SBarry Smith @*/
4347a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4348d763cef2SBarry Smith {
4349dfbe8321SBarry Smith   PetscErrorCode ierr;
4350d763cef2SBarry Smith 
4351d763cef2SBarry Smith   PetscFunctionBegin;
43527684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
43537684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
43547684fa3eSBarry Smith   }
43550b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
435631152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
4357387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
4358387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
4359387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
43600b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
4361d763cef2SBarry Smith   PetscFunctionReturn(0);
4362d763cef2SBarry Smith }
4363d763cef2SBarry Smith 
43641b575b74SJoseph Pusztay /*
43651b575b74SJoseph Pusztay 
43661b575b74SJoseph Pusztay   Creates a TS Monitor SPCtx for use with DM Swarm particle visualizations
43671b575b74SJoseph Pusztay 
43681b575b74SJoseph Pusztay */
43691b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorSPCtx *ctx)
43701b575b74SJoseph Pusztay {
43711b575b74SJoseph Pusztay   PetscDraw      draw;
43721b575b74SJoseph Pusztay   PetscErrorCode ierr;
43731b575b74SJoseph Pusztay 
43741b575b74SJoseph Pusztay   PetscFunctionBegin;
43751b575b74SJoseph Pusztay   ierr = PetscNew(ctx);CHKERRQ(ierr);
43761b575b74SJoseph Pusztay   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
43771b575b74SJoseph Pusztay   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
43781b575b74SJoseph Pusztay   ierr = PetscDrawSPCreate(draw,1,&(*ctx)->sp);CHKERRQ(ierr);
43791b575b74SJoseph Pusztay   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
43801b575b74SJoseph Pusztay   (*ctx)->howoften = howoften;
43811b575b74SJoseph Pusztay   PetscFunctionReturn(0);
43821b575b74SJoseph Pusztay 
43831b575b74SJoseph Pusztay }
43841b575b74SJoseph Pusztay 
43851b575b74SJoseph Pusztay /*
43861b575b74SJoseph Pusztay   Destroys a TSMonitorSPCtx that was created with TSMonitorSPCtxCreate
43871b575b74SJoseph Pusztay */
43881b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx *ctx)
43891b575b74SJoseph Pusztay {
43901b575b74SJoseph Pusztay   PetscErrorCode ierr;
43911b575b74SJoseph Pusztay 
43921b575b74SJoseph Pusztay   PetscFunctionBegin;
43931b575b74SJoseph Pusztay 
43941b575b74SJoseph Pusztay   ierr = PetscDrawSPDestroy(&(*ctx)->sp);CHKERRQ(ierr);
43951b575b74SJoseph Pusztay   ierr = PetscFree(*ctx);CHKERRQ(ierr);
43961b575b74SJoseph Pusztay 
43971b575b74SJoseph Pusztay   PetscFunctionReturn(0);
43981b575b74SJoseph Pusztay 
43991b575b74SJoseph Pusztay }
44001b575b74SJoseph Pusztay 
4401d763cef2SBarry Smith /*@
4402b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4403d763cef2SBarry Smith 
4404d763cef2SBarry Smith    Not Collective
4405d763cef2SBarry Smith 
4406d763cef2SBarry Smith    Input Parameter:
4407d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4408d763cef2SBarry Smith 
4409d763cef2SBarry Smith    Output Parameter:
441019eac22cSLisandro Dalcin .  t  - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime().
4411d763cef2SBarry Smith 
4412d763cef2SBarry Smith    Level: beginner
4413d763cef2SBarry Smith 
4414b8123daeSJed Brown    Note:
4415b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
44169be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4417b8123daeSJed Brown 
44188f199f4dSPatrick Sanan .seealso:  TSGetSolveTime(), TSSetTime(), TSGetTimeStep(), TSGetStepNumber()
4419d763cef2SBarry Smith 
4420d763cef2SBarry Smith @*/
44217087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4422d763cef2SBarry Smith {
4423d763cef2SBarry Smith   PetscFunctionBegin;
44240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4425f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4426d763cef2SBarry Smith   *t = ts->ptime;
4427d763cef2SBarry Smith   PetscFunctionReturn(0);
4428d763cef2SBarry Smith }
4429d763cef2SBarry Smith 
4430e5e524a1SHong Zhang /*@
4431e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4432e5e524a1SHong Zhang 
4433e5e524a1SHong Zhang    Not Collective
4434e5e524a1SHong Zhang 
4435e5e524a1SHong Zhang    Input Parameter:
4436e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4437e5e524a1SHong Zhang 
4438e5e524a1SHong Zhang    Output Parameter:
4439e5e524a1SHong Zhang .  t  - the previous time
4440e5e524a1SHong Zhang 
4441e5e524a1SHong Zhang    Level: beginner
4442e5e524a1SHong Zhang 
4443aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep()
4444e5e524a1SHong Zhang 
4445e5e524a1SHong Zhang @*/
4446e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4447e5e524a1SHong Zhang {
4448e5e524a1SHong Zhang   PetscFunctionBegin;
4449e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4450e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4451e5e524a1SHong Zhang   *t = ts->ptime_prev;
4452e5e524a1SHong Zhang   PetscFunctionReturn(0);
4453e5e524a1SHong Zhang }
4454e5e524a1SHong Zhang 
44556a4d4014SLisandro Dalcin /*@
44566a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
44576a4d4014SLisandro Dalcin 
44583f9fe445SBarry Smith    Logically Collective on TS
44596a4d4014SLisandro Dalcin 
44606a4d4014SLisandro Dalcin    Input Parameters:
44616a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
44626a4d4014SLisandro Dalcin -  time - the time
44636a4d4014SLisandro Dalcin 
44646a4d4014SLisandro Dalcin    Level: intermediate
44656a4d4014SLisandro Dalcin 
446619eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps()
44676a4d4014SLisandro Dalcin 
44686a4d4014SLisandro Dalcin @*/
44697087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
44706a4d4014SLisandro Dalcin {
44716a4d4014SLisandro Dalcin   PetscFunctionBegin;
44720700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4473c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
44746a4d4014SLisandro Dalcin   ts->ptime = t;
44756a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
44766a4d4014SLisandro Dalcin }
44776a4d4014SLisandro Dalcin 
4478d763cef2SBarry Smith /*@C
4479d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4480d763cef2SBarry Smith    TS options in the database.
4481d763cef2SBarry Smith 
44823f9fe445SBarry Smith    Logically Collective on TS
4483d763cef2SBarry Smith 
4484d763cef2SBarry Smith    Input Parameter:
4485d763cef2SBarry Smith +  ts     - The TS context
4486d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4487d763cef2SBarry Smith 
4488d763cef2SBarry Smith    Notes:
4489d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4490d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4491d763cef2SBarry Smith    hyphen.
4492d763cef2SBarry Smith 
4493d763cef2SBarry Smith    Level: advanced
4494d763cef2SBarry Smith 
4495d763cef2SBarry Smith .seealso: TSSetFromOptions()
4496d763cef2SBarry Smith 
4497d763cef2SBarry Smith @*/
44987087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4499d763cef2SBarry Smith {
4500dfbe8321SBarry Smith   PetscErrorCode ierr;
4501089b2837SJed Brown   SNES           snes;
4502d763cef2SBarry Smith 
4503d763cef2SBarry Smith   PetscFunctionBegin;
45040700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4505d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4506089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4507089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4508d763cef2SBarry Smith   PetscFunctionReturn(0);
4509d763cef2SBarry Smith }
4510d763cef2SBarry Smith 
4511d763cef2SBarry Smith /*@C
4512d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4513d763cef2SBarry Smith    TS options in the database.
4514d763cef2SBarry Smith 
45153f9fe445SBarry Smith    Logically Collective on TS
4516d763cef2SBarry Smith 
4517d763cef2SBarry Smith    Input Parameter:
4518d763cef2SBarry Smith +  ts     - The TS context
4519d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4520d763cef2SBarry Smith 
4521d763cef2SBarry Smith    Notes:
4522d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4523d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4524d763cef2SBarry Smith    hyphen.
4525d763cef2SBarry Smith 
4526d763cef2SBarry Smith    Level: advanced
4527d763cef2SBarry Smith 
4528d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4529d763cef2SBarry Smith 
4530d763cef2SBarry Smith @*/
45317087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4532d763cef2SBarry Smith {
4533dfbe8321SBarry Smith   PetscErrorCode ierr;
4534089b2837SJed Brown   SNES           snes;
4535d763cef2SBarry Smith 
4536d763cef2SBarry Smith   PetscFunctionBegin;
45370700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4538d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4539089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4540089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4541d763cef2SBarry Smith   PetscFunctionReturn(0);
4542d763cef2SBarry Smith }
4543d763cef2SBarry Smith 
4544d763cef2SBarry Smith /*@C
4545d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4546d763cef2SBarry Smith    TS options in the database.
4547d763cef2SBarry Smith 
4548d763cef2SBarry Smith    Not Collective
4549d763cef2SBarry Smith 
4550d763cef2SBarry Smith    Input Parameter:
4551d763cef2SBarry Smith .  ts - The TS context
4552d763cef2SBarry Smith 
4553d763cef2SBarry Smith    Output Parameter:
4554d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4555d763cef2SBarry Smith 
455695452b02SPatrick Sanan    Notes:
455795452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prifix' of
4558d763cef2SBarry Smith    sufficient length to hold the prefix.
4559d763cef2SBarry Smith 
4560d763cef2SBarry Smith    Level: intermediate
4561d763cef2SBarry Smith 
4562d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4563d763cef2SBarry Smith @*/
45647087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4565d763cef2SBarry Smith {
4566dfbe8321SBarry Smith   PetscErrorCode ierr;
4567d763cef2SBarry Smith 
4568d763cef2SBarry Smith   PetscFunctionBegin;
45690700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45704482741eSBarry Smith   PetscValidPointer(prefix,2);
4571d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4572d763cef2SBarry Smith   PetscFunctionReturn(0);
4573d763cef2SBarry Smith }
4574d763cef2SBarry Smith 
4575d763cef2SBarry Smith /*@C
4576d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4577d763cef2SBarry Smith 
4578d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4579d763cef2SBarry Smith 
4580d763cef2SBarry Smith    Input Parameter:
4581d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4582d763cef2SBarry Smith 
4583d763cef2SBarry Smith    Output Parameters:
4584e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4585e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4586e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4587e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4588d763cef2SBarry Smith 
458995452b02SPatrick Sanan    Notes:
459095452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
4591d763cef2SBarry Smith 
4592d763cef2SBarry Smith    Level: intermediate
4593d763cef2SBarry Smith 
459480275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
4595d763cef2SBarry Smith 
4596d763cef2SBarry Smith @*/
4597e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4598d763cef2SBarry Smith {
4599089b2837SJed Brown   PetscErrorCode ierr;
460024989b8cSPeter Brune   DM             dm;
4601089b2837SJed Brown 
4602d763cef2SBarry Smith   PetscFunctionBegin;
460323a57915SBarry Smith   if (Amat || Pmat) {
460423a57915SBarry Smith     SNES snes;
4605089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
460623a57915SBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4607e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
460823a57915SBarry Smith   }
460924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
461024989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4611d763cef2SBarry Smith   PetscFunctionReturn(0);
4612d763cef2SBarry Smith }
4613d763cef2SBarry Smith 
46142eca1d9cSJed Brown /*@C
46152eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
46162eca1d9cSJed Brown 
46172eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
46182eca1d9cSJed Brown 
46192eca1d9cSJed Brown    Input Parameter:
46202eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
46212eca1d9cSJed Brown 
46222eca1d9cSJed Brown    Output Parameters:
4623e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4624e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
46252eca1d9cSJed Brown .  f   - The function to compute the matrices
46262eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
46272eca1d9cSJed Brown 
462895452b02SPatrick Sanan    Notes:
462995452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
46302eca1d9cSJed Brown 
46312eca1d9cSJed Brown    Level: advanced
46322eca1d9cSJed Brown 
463380275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
46342eca1d9cSJed Brown 
46352eca1d9cSJed Brown @*/
4636e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
46372eca1d9cSJed Brown {
4638089b2837SJed Brown   PetscErrorCode ierr;
463924989b8cSPeter Brune   DM             dm;
46400910c330SBarry Smith 
46412eca1d9cSJed Brown   PetscFunctionBegin;
4642c0aab802Sstefano_zampini   if (Amat || Pmat) {
4643c0aab802Sstefano_zampini     SNES snes;
4644089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4645f7d39f7aSBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4646e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
4647c0aab802Sstefano_zampini   }
464824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
464924989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
46502eca1d9cSJed Brown   PetscFunctionReturn(0);
46512eca1d9cSJed Brown }
46522eca1d9cSJed Brown 
46531713a123SBarry Smith /*@C
465483a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
46551713a123SBarry Smith    VecView() for the solution at each timestep
46561713a123SBarry Smith 
46571713a123SBarry Smith    Collective on TS
46581713a123SBarry Smith 
46591713a123SBarry Smith    Input Parameters:
46601713a123SBarry Smith +  ts - the TS context
46611713a123SBarry Smith .  step - current time-step
4662142b95e3SSatish Balay .  ptime - current time
46630298fd71SBarry Smith -  dummy - either a viewer or NULL
46641713a123SBarry Smith 
466599fdda47SBarry Smith    Options Database:
466699fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
466799fdda47SBarry Smith 
466895452b02SPatrick Sanan    Notes:
466995452b02SPatrick Sanan     the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
467099fdda47SBarry Smith        will look bad
467199fdda47SBarry Smith 
46721713a123SBarry Smith    Level: intermediate
46731713a123SBarry Smith 
4674a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
46751713a123SBarry Smith @*/
46760910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
46771713a123SBarry Smith {
4678dfbe8321SBarry Smith   PetscErrorCode   ierr;
467983a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4680473a3ab2SBarry Smith   PetscDraw        draw;
46811713a123SBarry Smith 
46821713a123SBarry Smith   PetscFunctionBegin;
46836083293cSBarry Smith   if (!step && ictx->showinitial) {
46846083293cSBarry Smith     if (!ictx->initialsolution) {
46850910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
46861713a123SBarry Smith     }
46870910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
46886083293cSBarry Smith   }
4689b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
46900dcf80beSBarry Smith 
46916083293cSBarry Smith   if (ictx->showinitial) {
46926083293cSBarry Smith     PetscReal pause;
46936083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
46946083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
46956083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
46966083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
46976083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
46986083293cSBarry Smith   }
46990910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4700473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
470151fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4702473a3ab2SBarry Smith     char      time[32];
4703473a3ab2SBarry Smith 
4704473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
470585b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4706473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4707473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
470851fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4709473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4710473a3ab2SBarry Smith   }
4711473a3ab2SBarry Smith 
47126083293cSBarry Smith   if (ictx->showinitial) {
47136083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
47146083293cSBarry Smith   }
47151713a123SBarry Smith   PetscFunctionReturn(0);
47161713a123SBarry Smith }
47171713a123SBarry Smith 
47189110b2e7SHong Zhang /*@C
47192d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
47202d5ee99bSBarry Smith 
47212d5ee99bSBarry Smith    Collective on TS
47222d5ee99bSBarry Smith 
47232d5ee99bSBarry Smith    Input Parameters:
47242d5ee99bSBarry Smith +  ts - the TS context
47252d5ee99bSBarry Smith .  step - current time-step
47262d5ee99bSBarry Smith .  ptime - current time
47272d5ee99bSBarry Smith -  dummy - either a viewer or NULL
47282d5ee99bSBarry Smith 
47292d5ee99bSBarry Smith    Level: intermediate
47302d5ee99bSBarry Smith 
47312d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
47322d5ee99bSBarry Smith @*/
47332d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
47342d5ee99bSBarry Smith {
47352d5ee99bSBarry Smith   PetscErrorCode    ierr;
47362d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
47372d5ee99bSBarry Smith   PetscDraw         draw;
47386934998bSLisandro Dalcin   PetscDrawAxis     axis;
47392d5ee99bSBarry Smith   PetscInt          n;
47402d5ee99bSBarry Smith   PetscMPIInt       size;
47416934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
47422d5ee99bSBarry Smith   char              time[32];
47432d5ee99bSBarry Smith   const PetscScalar *U;
47442d5ee99bSBarry Smith 
47452d5ee99bSBarry Smith   PetscFunctionBegin;
47466934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
47476934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
47482d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
47496934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
47502d5ee99bSBarry Smith 
47512d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
47526934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
47536934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
47546934998bSLisandro Dalcin   if (!step) {
47556934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
47566934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
47576934998bSLisandro Dalcin   }
47582d5ee99bSBarry Smith 
47592d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
47606934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
47616934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
4762a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
47636934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
47642d5ee99bSBarry Smith 
47656934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
47666934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
47672d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
47684b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
476985b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
47702d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
477151fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
47722d5ee99bSBarry Smith   }
47736934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
47742d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
477556d62c8fSLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
47766934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
47772d5ee99bSBarry Smith   PetscFunctionReturn(0);
47782d5ee99bSBarry Smith }
47792d5ee99bSBarry Smith 
47806083293cSBarry Smith /*@C
478183a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
47826083293cSBarry Smith 
47836083293cSBarry Smith    Collective on TS
47846083293cSBarry Smith 
47856083293cSBarry Smith    Input Parameters:
47866083293cSBarry Smith .    ctx - the monitor context
47876083293cSBarry Smith 
47886083293cSBarry Smith    Level: intermediate
47896083293cSBarry Smith 
479083a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
47916083293cSBarry Smith @*/
479283a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
47936083293cSBarry Smith {
47946083293cSBarry Smith   PetscErrorCode ierr;
47956083293cSBarry Smith 
47966083293cSBarry Smith   PetscFunctionBegin;
479783a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
479883a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
479983a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
48006083293cSBarry Smith   PetscFunctionReturn(0);
48016083293cSBarry Smith }
48026083293cSBarry Smith 
48036083293cSBarry Smith /*@C
480483a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
48056083293cSBarry Smith 
48066083293cSBarry Smith    Collective on TS
48076083293cSBarry Smith 
48086083293cSBarry Smith    Input Parameter:
48096083293cSBarry Smith .    ts - time-step context
48106083293cSBarry Smith 
48116083293cSBarry Smith    Output Patameter:
48126083293cSBarry Smith .    ctx - the monitor context
48136083293cSBarry Smith 
481499fdda47SBarry Smith    Options Database:
481599fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
481699fdda47SBarry Smith 
48176083293cSBarry Smith    Level: intermediate
48186083293cSBarry Smith 
481983a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
48206083293cSBarry Smith @*/
482183a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
48226083293cSBarry Smith {
48236083293cSBarry Smith   PetscErrorCode   ierr;
48246083293cSBarry Smith 
48256083293cSBarry Smith   PetscFunctionBegin;
4826b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
482783a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4828e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4829bbd56ea5SKarl Rupp 
483083a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4831473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
4832c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4833473a3ab2SBarry Smith 
4834473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
4835c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
48366083293cSBarry Smith   PetscFunctionReturn(0);
48376083293cSBarry Smith }
48386083293cSBarry Smith 
48393a471f94SBarry Smith /*@C
48400ed3bfb6SBarry Smith    TSMonitorDrawSolutionFunction - Monitors progress of the TS solvers by calling
48410ed3bfb6SBarry Smith    VecView() for the solution provided by TSSetSolutionFunction() at each timestep
48420ed3bfb6SBarry Smith 
48430ed3bfb6SBarry Smith    Collective on TS
48440ed3bfb6SBarry Smith 
48450ed3bfb6SBarry Smith    Input Parameters:
48460ed3bfb6SBarry Smith +  ts - the TS context
48470ed3bfb6SBarry Smith .  step - current time-step
48480ed3bfb6SBarry Smith .  ptime - current time
48490ed3bfb6SBarry Smith -  dummy - either a viewer or NULL
48500ed3bfb6SBarry Smith 
48510ed3bfb6SBarry Smith    Options Database:
48520ed3bfb6SBarry Smith .  -ts_monitor_draw_solution_function - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
48530ed3bfb6SBarry Smith 
48540ed3bfb6SBarry Smith    Level: intermediate
48550ed3bfb6SBarry Smith 
48560ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
48570ed3bfb6SBarry Smith @*/
48580ed3bfb6SBarry Smith PetscErrorCode  TSMonitorDrawSolutionFunction(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
48590ed3bfb6SBarry Smith {
48600ed3bfb6SBarry Smith   PetscErrorCode   ierr;
48610ed3bfb6SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
48620ed3bfb6SBarry Smith   PetscViewer      viewer = ctx->viewer;
48630ed3bfb6SBarry Smith   Vec              work;
48640ed3bfb6SBarry Smith 
48650ed3bfb6SBarry Smith   PetscFunctionBegin;
48660ed3bfb6SBarry Smith   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
48670ed3bfb6SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
48680ed3bfb6SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
48690ed3bfb6SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
48700ed3bfb6SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
48710ed3bfb6SBarry Smith   PetscFunctionReturn(0);
48720ed3bfb6SBarry Smith }
48730ed3bfb6SBarry Smith 
48740ed3bfb6SBarry Smith /*@C
487583a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
48763a471f94SBarry Smith    VecView() for the error at each timestep
48773a471f94SBarry Smith 
48783a471f94SBarry Smith    Collective on TS
48793a471f94SBarry Smith 
48803a471f94SBarry Smith    Input Parameters:
48813a471f94SBarry Smith +  ts - the TS context
48823a471f94SBarry Smith .  step - current time-step
48833a471f94SBarry Smith .  ptime - current time
48840298fd71SBarry Smith -  dummy - either a viewer or NULL
48853a471f94SBarry Smith 
48860ed3bfb6SBarry Smith    Options Database:
48870ed3bfb6SBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
48880ed3bfb6SBarry Smith 
48893a471f94SBarry Smith    Level: intermediate
48903a471f94SBarry Smith 
48910ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
48923a471f94SBarry Smith @*/
48930910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
48943a471f94SBarry Smith {
48953a471f94SBarry Smith   PetscErrorCode   ierr;
489683a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
489783a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
48983a471f94SBarry Smith   Vec              work;
48993a471f94SBarry Smith 
49003a471f94SBarry Smith   PetscFunctionBegin;
4901b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
49020910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
49033a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
49040910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
49053a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
49063a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
49073a471f94SBarry Smith   PetscFunctionReturn(0);
49083a471f94SBarry Smith }
49093a471f94SBarry Smith 
4910af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
49116c699258SBarry Smith /*@
49122a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
49136c699258SBarry Smith 
4914d083f849SBarry Smith    Logically Collective on ts
49156c699258SBarry Smith 
49166c699258SBarry Smith    Input Parameters:
49172a808120SBarry Smith +  ts - the ODE integrator object
49182a808120SBarry Smith -  dm - the dm, cannot be NULL
49196c699258SBarry Smith 
4920e03a659cSJed Brown    Notes:
4921e03a659cSJed Brown    A DM can only be used for solving one problem at a time because information about the problem is stored on the DM,
4922e03a659cSJed Brown    even when not using interfaces like DMTSSetIFunction().  Use DMClone() to get a distinct DM when solving
4923e03a659cSJed Brown    different problems using the same function space.
4924e03a659cSJed Brown 
49256c699258SBarry Smith    Level: intermediate
49266c699258SBarry Smith 
49276c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
49286c699258SBarry Smith @*/
49297087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
49306c699258SBarry Smith {
49316c699258SBarry Smith   PetscErrorCode ierr;
4932089b2837SJed Brown   SNES           snes;
4933942e3340SBarry Smith   DMTS           tsdm;
49346c699258SBarry Smith 
49356c699258SBarry Smith   PetscFunctionBegin;
49360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49372a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
493870663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4939942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
49402a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4941942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4942942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
494324989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
494424989b8cSPeter Brune         tsdm->originaldm = dm;
494524989b8cSPeter Brune       }
494624989b8cSPeter Brune     }
49476bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
494824989b8cSPeter Brune   }
49496c699258SBarry Smith   ts->dm = dm;
4950bbd56ea5SKarl Rupp 
4951089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4952089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
49536c699258SBarry Smith   PetscFunctionReturn(0);
49546c699258SBarry Smith }
49556c699258SBarry Smith 
49566c699258SBarry Smith /*@
49576c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
49586c699258SBarry Smith 
49593f9fe445SBarry Smith    Not Collective
49606c699258SBarry Smith 
49616c699258SBarry Smith    Input Parameter:
49626c699258SBarry Smith . ts - the preconditioner context
49636c699258SBarry Smith 
49646c699258SBarry Smith    Output Parameter:
49656c699258SBarry Smith .  dm - the dm
49666c699258SBarry Smith 
49676c699258SBarry Smith    Level: intermediate
49686c699258SBarry Smith 
49696c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
49706c699258SBarry Smith @*/
49717087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
49726c699258SBarry Smith {
4973496e6a7aSJed Brown   PetscErrorCode ierr;
4974496e6a7aSJed Brown 
49756c699258SBarry Smith   PetscFunctionBegin;
49760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4977496e6a7aSJed Brown   if (!ts->dm) {
4978ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4979496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4980496e6a7aSJed Brown   }
49816c699258SBarry Smith   *dm = ts->dm;
49826c699258SBarry Smith   PetscFunctionReturn(0);
49836c699258SBarry Smith }
49841713a123SBarry Smith 
49850f5c6efeSJed Brown /*@
49860f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
49870f5c6efeSJed Brown 
49883f9fe445SBarry Smith    Logically Collective on SNES
49890f5c6efeSJed Brown 
49900f5c6efeSJed Brown    Input Parameter:
4991d42a1c89SJed Brown + snes - nonlinear solver
49920910c330SBarry Smith . U - the current state at which to evaluate the residual
4993d42a1c89SJed Brown - ctx - user context, must be a TS
49940f5c6efeSJed Brown 
49950f5c6efeSJed Brown    Output Parameter:
49960f5c6efeSJed Brown . F - the nonlinear residual
49970f5c6efeSJed Brown 
49980f5c6efeSJed Brown    Notes:
49990f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
50000f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
50010f5c6efeSJed Brown 
50020f5c6efeSJed Brown    Level: advanced
50030f5c6efeSJed Brown 
50040f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
50050f5c6efeSJed Brown @*/
50060910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
50070f5c6efeSJed Brown {
50080f5c6efeSJed Brown   TS             ts = (TS)ctx;
50090f5c6efeSJed Brown   PetscErrorCode ierr;
50100f5c6efeSJed Brown 
50110f5c6efeSJed Brown   PetscFunctionBegin;
50120f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
50130910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
50140f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
50150f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
50160910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
50170f5c6efeSJed Brown   PetscFunctionReturn(0);
50180f5c6efeSJed Brown }
50190f5c6efeSJed Brown 
50200f5c6efeSJed Brown /*@
50210f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
50220f5c6efeSJed Brown 
50230f5c6efeSJed Brown    Collective on SNES
50240f5c6efeSJed Brown 
50250f5c6efeSJed Brown    Input Parameter:
50260f5c6efeSJed Brown + snes - nonlinear solver
50270910c330SBarry Smith . U - the current state at which to evaluate the residual
50280f5c6efeSJed Brown - ctx - user context, must be a TS
50290f5c6efeSJed Brown 
50300f5c6efeSJed Brown    Output Parameter:
50310f5c6efeSJed Brown + A - the Jacobian
50320f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
50330f5c6efeSJed Brown - flag - indicates any structure change in the matrix
50340f5c6efeSJed Brown 
50350f5c6efeSJed Brown    Notes:
50360f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
50370f5c6efeSJed Brown 
50380f5c6efeSJed Brown    Level: developer
50390f5c6efeSJed Brown 
50400f5c6efeSJed Brown .seealso: SNESSetJacobian()
50410f5c6efeSJed Brown @*/
5042d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
50430f5c6efeSJed Brown {
50440f5c6efeSJed Brown   TS             ts = (TS)ctx;
50450f5c6efeSJed Brown   PetscErrorCode ierr;
50460f5c6efeSJed Brown 
50470f5c6efeSJed Brown   PetscFunctionBegin;
50480f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
50490910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
50500f5c6efeSJed Brown   PetscValidPointer(A,3);
505194ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
50520f5c6efeSJed Brown   PetscValidPointer(B,4);
505394ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
50540f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
5055d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
50560f5c6efeSJed Brown   PetscFunctionReturn(0);
50570f5c6efeSJed Brown }
5058325fc9f4SBarry Smith 
50590e4ef248SJed Brown /*@C
50609ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
50610e4ef248SJed Brown 
50620e4ef248SJed Brown    Collective on TS
50630e4ef248SJed Brown 
50640e4ef248SJed Brown    Input Arguments:
50650e4ef248SJed Brown +  ts - time stepping context
50660e4ef248SJed Brown .  t - time at which to evaluate
50670910c330SBarry Smith .  U - state at which to evaluate
50680e4ef248SJed Brown -  ctx - context
50690e4ef248SJed Brown 
50700e4ef248SJed Brown    Output Arguments:
50710e4ef248SJed Brown .  F - right hand side
50720e4ef248SJed Brown 
50730e4ef248SJed Brown    Level: intermediate
50740e4ef248SJed Brown 
50750e4ef248SJed Brown    Notes:
50760e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
50770e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
50780e4ef248SJed Brown 
50790e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
50800e4ef248SJed Brown @*/
50810910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
50820e4ef248SJed Brown {
50830e4ef248SJed Brown   PetscErrorCode ierr;
50840e4ef248SJed Brown   Mat            Arhs,Brhs;
50850e4ef248SJed Brown 
50860e4ef248SJed Brown   PetscFunctionBegin;
50870e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
50882663174eSHong Zhang   /* undo the damage caused by shifting */
5089cfa8a9a2SHong Zhang   ierr = TSRecoverRHSJacobian(ts,Arhs,Brhs);CHKERRQ(ierr);
5090d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
50910910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
50920e4ef248SJed Brown   PetscFunctionReturn(0);
50930e4ef248SJed Brown }
50940e4ef248SJed Brown 
50950e4ef248SJed Brown /*@C
50960e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
50970e4ef248SJed Brown 
50980e4ef248SJed Brown    Collective on TS
50990e4ef248SJed Brown 
51000e4ef248SJed Brown    Input Arguments:
51010e4ef248SJed Brown +  ts - time stepping context
51020e4ef248SJed Brown .  t - time at which to evaluate
51030910c330SBarry Smith .  U - state at which to evaluate
51040e4ef248SJed Brown -  ctx - context
51050e4ef248SJed Brown 
51060e4ef248SJed Brown    Output Arguments:
51070e4ef248SJed Brown +  A - pointer to operator
51080e4ef248SJed Brown .  B - pointer to preconditioning matrix
51090e4ef248SJed Brown -  flg - matrix structure flag
51100e4ef248SJed Brown 
51110e4ef248SJed Brown    Level: intermediate
51120e4ef248SJed Brown 
51130e4ef248SJed Brown    Notes:
51140e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
51150e4ef248SJed Brown 
51160e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
51170e4ef248SJed Brown @*/
5118d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
51190e4ef248SJed Brown {
51200e4ef248SJed Brown   PetscFunctionBegin;
51210e4ef248SJed Brown   PetscFunctionReturn(0);
51220e4ef248SJed Brown }
51230e4ef248SJed Brown 
51240026cea9SSean Farley /*@C
51250026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
51260026cea9SSean Farley 
51270026cea9SSean Farley    Collective on TS
51280026cea9SSean Farley 
51290026cea9SSean Farley    Input Arguments:
51300026cea9SSean Farley +  ts - time stepping context
51310026cea9SSean Farley .  t - time at which to evaluate
51320910c330SBarry Smith .  U - state at which to evaluate
51330910c330SBarry Smith .  Udot - time derivative of state vector
51340026cea9SSean Farley -  ctx - context
51350026cea9SSean Farley 
51360026cea9SSean Farley    Output Arguments:
51370026cea9SSean Farley .  F - left hand side
51380026cea9SSean Farley 
51390026cea9SSean Farley    Level: intermediate
51400026cea9SSean Farley 
51410026cea9SSean Farley    Notes:
51420910c330SBarry 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
51430026cea9SSean Farley    user is required to write their own TSComputeIFunction.
51440026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
51450026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
51460026cea9SSean Farley 
51479ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
51489ae8fd06SBarry Smith 
51499ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
51500026cea9SSean Farley @*/
51510910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
51520026cea9SSean Farley {
51530026cea9SSean Farley   PetscErrorCode ierr;
51540026cea9SSean Farley   Mat            A,B;
51550026cea9SSean Farley 
51560026cea9SSean Farley   PetscFunctionBegin;
51570298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
5158d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
51590910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
51600026cea9SSean Farley   PetscFunctionReturn(0);
51610026cea9SSean Farley }
51620026cea9SSean Farley 
51630026cea9SSean Farley /*@C
5164b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
51650026cea9SSean Farley 
51660026cea9SSean Farley    Collective on TS
51670026cea9SSean Farley 
51680026cea9SSean Farley    Input Arguments:
51690026cea9SSean Farley +  ts - time stepping context
51700026cea9SSean Farley .  t - time at which to evaluate
51710910c330SBarry Smith .  U - state at which to evaluate
51720910c330SBarry Smith .  Udot - time derivative of state vector
51730026cea9SSean Farley .  shift - shift to apply
51740026cea9SSean Farley -  ctx - context
51750026cea9SSean Farley 
51760026cea9SSean Farley    Output Arguments:
51770026cea9SSean Farley +  A - pointer to operator
51780026cea9SSean Farley .  B - pointer to preconditioning matrix
51790026cea9SSean Farley -  flg - matrix structure flag
51800026cea9SSean Farley 
5181b41af12eSJed Brown    Level: advanced
51820026cea9SSean Farley 
51830026cea9SSean Farley    Notes:
51840026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
51850026cea9SSean Farley 
5186b41af12eSJed Brown    It is only appropriate for problems of the form
5187b41af12eSJed Brown 
5188b41af12eSJed Brown $     M Udot = F(U,t)
5189b41af12eSJed Brown 
5190b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
5191b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5192b41af12eSJed Brown   an implicit operator of the form
5193b41af12eSJed Brown 
5194b41af12eSJed Brown $    shift*M + J
5195b41af12eSJed Brown 
5196b41af12eSJed 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
5197b41af12eSJed Brown   a copy of M or reassemble it when requested.
5198b41af12eSJed Brown 
51990026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
52000026cea9SSean Farley @*/
5201d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
52020026cea9SSean Farley {
5203b41af12eSJed Brown   PetscErrorCode ierr;
5204b41af12eSJed Brown 
52050026cea9SSean Farley   PetscFunctionBegin;
520694ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
5207b41af12eSJed Brown   ts->ijacobian.shift = shift;
52080026cea9SSean Farley   PetscFunctionReturn(0);
52090026cea9SSean Farley }
5210b41af12eSJed Brown 
5211e817cc15SEmil Constantinescu /*@
5212e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
5213e817cc15SEmil Constantinescu 
5214e817cc15SEmil Constantinescu    Not Collective
5215e817cc15SEmil Constantinescu 
5216e817cc15SEmil Constantinescu    Input Parameter:
5217e817cc15SEmil Constantinescu .  ts - the TS context
5218e817cc15SEmil Constantinescu 
5219e817cc15SEmil Constantinescu    Output Parameter:
52204e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
5221e817cc15SEmil Constantinescu 
5222e817cc15SEmil Constantinescu    Level: beginner
5223e817cc15SEmil Constantinescu 
5224e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
5225e817cc15SEmil Constantinescu @*/
5226e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
5227e817cc15SEmil Constantinescu {
5228e817cc15SEmil Constantinescu   PetscFunctionBegin;
5229e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5230e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
5231e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
5232e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5233e817cc15SEmil Constantinescu }
5234e817cc15SEmil Constantinescu 
5235e817cc15SEmil Constantinescu /*@
5236e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
5237e817cc15SEmil Constantinescu 
5238e817cc15SEmil Constantinescu    Not Collective
5239e817cc15SEmil Constantinescu 
5240e817cc15SEmil Constantinescu    Input Parameter:
5241e817cc15SEmil Constantinescu +  ts - the TS context
52421297b224SEmil Constantinescu -  equation_type - see TSEquationType
5243e817cc15SEmil Constantinescu 
5244e817cc15SEmil Constantinescu    Level: advanced
5245e817cc15SEmil Constantinescu 
5246e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
5247e817cc15SEmil Constantinescu @*/
5248e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
5249e817cc15SEmil Constantinescu {
5250e817cc15SEmil Constantinescu   PetscFunctionBegin;
5251e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5252e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
5253e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5254e817cc15SEmil Constantinescu }
52550026cea9SSean Farley 
52564af1b03aSJed Brown /*@
52574af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
52584af1b03aSJed Brown 
52594af1b03aSJed Brown    Not Collective
52604af1b03aSJed Brown 
52614af1b03aSJed Brown    Input Parameter:
52624af1b03aSJed Brown .  ts - the TS context
52634af1b03aSJed Brown 
52644af1b03aSJed Brown    Output Parameter:
52654af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
52664af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
52674af1b03aSJed Brown 
5268487e0bb9SJed Brown    Level: beginner
52694af1b03aSJed Brown 
5270cd652676SJed Brown    Notes:
5271cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
52724af1b03aSJed Brown 
52734af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
52744af1b03aSJed Brown @*/
52754af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
52764af1b03aSJed Brown {
52774af1b03aSJed Brown   PetscFunctionBegin;
52784af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
52794af1b03aSJed Brown   PetscValidPointer(reason,2);
52804af1b03aSJed Brown   *reason = ts->reason;
52814af1b03aSJed Brown   PetscFunctionReturn(0);
52824af1b03aSJed Brown }
52834af1b03aSJed Brown 
5284d6ad946cSShri Abhyankar /*@
5285d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5286d6ad946cSShri Abhyankar 
52876b221cbeSPatrick Sanan    Logically Collective; reason must contain common value
5288d6ad946cSShri Abhyankar 
52896b221cbeSPatrick Sanan    Input Parameters:
5290d6ad946cSShri Abhyankar +  ts - the TS context
52916b221cbeSPatrick Sanan -  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5292d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
5293d6ad946cSShri Abhyankar 
5294f5abba47SShri Abhyankar    Level: advanced
5295d6ad946cSShri Abhyankar 
5296d6ad946cSShri Abhyankar    Notes:
52976b221cbeSPatrick Sanan    Can only be called while TSSolve() is active.
5298d6ad946cSShri Abhyankar 
5299d6ad946cSShri Abhyankar .seealso: TSConvergedReason
5300d6ad946cSShri Abhyankar @*/
5301d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
5302d6ad946cSShri Abhyankar {
5303d6ad946cSShri Abhyankar   PetscFunctionBegin;
5304d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5305d6ad946cSShri Abhyankar   ts->reason = reason;
5306d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
5307d6ad946cSShri Abhyankar }
5308d6ad946cSShri Abhyankar 
5309cc708dedSBarry Smith /*@
5310cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
5311cc708dedSBarry Smith 
5312cc708dedSBarry Smith    Not Collective
5313cc708dedSBarry Smith 
5314cc708dedSBarry Smith    Input Parameter:
5315cc708dedSBarry Smith .  ts - the TS context
5316cc708dedSBarry Smith 
5317cc708dedSBarry Smith    Output Parameter:
531819eac22cSLisandro Dalcin .  ftime - the final time. This time corresponds to the final time set with TSSetMaxTime()
5319cc708dedSBarry Smith 
5320487e0bb9SJed Brown    Level: beginner
5321cc708dedSBarry Smith 
5322cc708dedSBarry Smith    Notes:
5323cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
5324cc708dedSBarry Smith 
5325cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
5326cc708dedSBarry Smith @*/
5327cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
5328cc708dedSBarry Smith {
5329cc708dedSBarry Smith   PetscFunctionBegin;
5330cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5331cc708dedSBarry Smith   PetscValidPointer(ftime,2);
5332cc708dedSBarry Smith   *ftime = ts->solvetime;
5333cc708dedSBarry Smith   PetscFunctionReturn(0);
5334cc708dedSBarry Smith }
5335cc708dedSBarry Smith 
53362c18e0fdSBarry Smith /*@
53375ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
53389f67acb7SJed Brown    used by the time integrator.
53399f67acb7SJed Brown 
53409f67acb7SJed Brown    Not Collective
53419f67acb7SJed Brown 
53429f67acb7SJed Brown    Input Parameter:
53439f67acb7SJed Brown .  ts - TS context
53449f67acb7SJed Brown 
53459f67acb7SJed Brown    Output Parameter:
53469f67acb7SJed Brown .  nits - number of nonlinear iterations
53479f67acb7SJed Brown 
53489f67acb7SJed Brown    Notes:
53499f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
53509f67acb7SJed Brown 
53519f67acb7SJed Brown    Level: intermediate
53529f67acb7SJed Brown 
53535ef26d82SJed Brown .seealso:  TSGetKSPIterations()
53549f67acb7SJed Brown @*/
53555ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
53569f67acb7SJed Brown {
53579f67acb7SJed Brown   PetscFunctionBegin;
53589f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53599f67acb7SJed Brown   PetscValidIntPointer(nits,2);
53605ef26d82SJed Brown   *nits = ts->snes_its;
53619f67acb7SJed Brown   PetscFunctionReturn(0);
53629f67acb7SJed Brown }
53639f67acb7SJed Brown 
53649f67acb7SJed Brown /*@
53655ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
53669f67acb7SJed Brown    used by the time integrator.
53679f67acb7SJed Brown 
53689f67acb7SJed Brown    Not Collective
53699f67acb7SJed Brown 
53709f67acb7SJed Brown    Input Parameter:
53719f67acb7SJed Brown .  ts - TS context
53729f67acb7SJed Brown 
53739f67acb7SJed Brown    Output Parameter:
53749f67acb7SJed Brown .  lits - number of linear iterations
53759f67acb7SJed Brown 
53769f67acb7SJed Brown    Notes:
53779f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
53789f67acb7SJed Brown 
53799f67acb7SJed Brown    Level: intermediate
53809f67acb7SJed Brown 
53815ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
53829f67acb7SJed Brown @*/
53835ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
53849f67acb7SJed Brown {
53859f67acb7SJed Brown   PetscFunctionBegin;
53869f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53879f67acb7SJed Brown   PetscValidIntPointer(lits,2);
53885ef26d82SJed Brown   *lits = ts->ksp_its;
53899f67acb7SJed Brown   PetscFunctionReturn(0);
53909f67acb7SJed Brown }
53919f67acb7SJed Brown 
5392cef5090cSJed Brown /*@
5393cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5394cef5090cSJed Brown 
5395cef5090cSJed Brown    Not Collective
5396cef5090cSJed Brown 
5397cef5090cSJed Brown    Input Parameter:
5398cef5090cSJed Brown .  ts - TS context
5399cef5090cSJed Brown 
5400cef5090cSJed Brown    Output Parameter:
5401cef5090cSJed Brown .  rejects - number of steps rejected
5402cef5090cSJed Brown 
5403cef5090cSJed Brown    Notes:
5404cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5405cef5090cSJed Brown 
5406cef5090cSJed Brown    Level: intermediate
5407cef5090cSJed Brown 
54085ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5409cef5090cSJed Brown @*/
5410cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5411cef5090cSJed Brown {
5412cef5090cSJed Brown   PetscFunctionBegin;
5413cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5414cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5415cef5090cSJed Brown   *rejects = ts->reject;
5416cef5090cSJed Brown   PetscFunctionReturn(0);
5417cef5090cSJed Brown }
5418cef5090cSJed Brown 
5419cef5090cSJed Brown /*@
5420cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5421cef5090cSJed Brown 
5422cef5090cSJed Brown    Not Collective
5423cef5090cSJed Brown 
5424cef5090cSJed Brown    Input Parameter:
5425cef5090cSJed Brown .  ts - TS context
5426cef5090cSJed Brown 
5427cef5090cSJed Brown    Output Parameter:
5428cef5090cSJed Brown .  fails - number of failed nonlinear solves
5429cef5090cSJed Brown 
5430cef5090cSJed Brown    Notes:
5431cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5432cef5090cSJed Brown 
5433cef5090cSJed Brown    Level: intermediate
5434cef5090cSJed Brown 
54355ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5436cef5090cSJed Brown @*/
5437cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5438cef5090cSJed Brown {
5439cef5090cSJed Brown   PetscFunctionBegin;
5440cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5441cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5442cef5090cSJed Brown   *fails = ts->num_snes_failures;
5443cef5090cSJed Brown   PetscFunctionReturn(0);
5444cef5090cSJed Brown }
5445cef5090cSJed Brown 
5446cef5090cSJed Brown /*@
5447cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5448cef5090cSJed Brown 
5449cef5090cSJed Brown    Not Collective
5450cef5090cSJed Brown 
5451cef5090cSJed Brown    Input Parameter:
5452cef5090cSJed Brown +  ts - TS context
5453cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5454cef5090cSJed Brown 
5455cef5090cSJed Brown    Notes:
5456cef5090cSJed Brown    The counter is reset to zero for each step
5457cef5090cSJed Brown 
5458cef5090cSJed Brown    Options Database Key:
5459cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5460cef5090cSJed Brown 
5461cef5090cSJed Brown    Level: intermediate
5462cef5090cSJed Brown 
54635ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5464cef5090cSJed Brown @*/
5465cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5466cef5090cSJed Brown {
5467cef5090cSJed Brown   PetscFunctionBegin;
5468cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5469cef5090cSJed Brown   ts->max_reject = rejects;
5470cef5090cSJed Brown   PetscFunctionReturn(0);
5471cef5090cSJed Brown }
5472cef5090cSJed Brown 
5473cef5090cSJed Brown /*@
5474cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5475cef5090cSJed Brown 
5476cef5090cSJed Brown    Not Collective
5477cef5090cSJed Brown 
5478cef5090cSJed Brown    Input Parameter:
5479cef5090cSJed Brown +  ts - TS context
5480cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5481cef5090cSJed Brown 
5482cef5090cSJed Brown    Notes:
5483cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5484cef5090cSJed Brown 
5485cef5090cSJed Brown    Options Database Key:
5486cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5487cef5090cSJed Brown 
5488cef5090cSJed Brown    Level: intermediate
5489cef5090cSJed Brown 
54905ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5491cef5090cSJed Brown @*/
5492cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5493cef5090cSJed Brown {
5494cef5090cSJed Brown   PetscFunctionBegin;
5495cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5496cef5090cSJed Brown   ts->max_snes_failures = fails;
5497cef5090cSJed Brown   PetscFunctionReturn(0);
5498cef5090cSJed Brown }
5499cef5090cSJed Brown 
5500cef5090cSJed Brown /*@
5501cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5502cef5090cSJed Brown 
5503cef5090cSJed Brown    Not Collective
5504cef5090cSJed Brown 
5505cef5090cSJed Brown    Input Parameter:
5506cef5090cSJed Brown +  ts - TS context
5507cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5508cef5090cSJed Brown 
5509cef5090cSJed Brown    Options Database Key:
5510cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5511cef5090cSJed Brown 
5512cef5090cSJed Brown    Level: intermediate
5513cef5090cSJed Brown 
55145ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5515cef5090cSJed Brown @*/
5516cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5517cef5090cSJed Brown {
5518cef5090cSJed Brown   PetscFunctionBegin;
5519cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5520cef5090cSJed Brown   ts->errorifstepfailed = err;
5521cef5090cSJed Brown   PetscFunctionReturn(0);
5522cef5090cSJed Brown }
5523cef5090cSJed Brown 
5524fb1732b5SBarry Smith /*@C
5525fde5950dSBarry 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
5526fb1732b5SBarry Smith 
5527fb1732b5SBarry Smith    Collective on TS
5528fb1732b5SBarry Smith 
5529fb1732b5SBarry Smith    Input Parameters:
5530fb1732b5SBarry Smith +  ts - the TS context
5531fb1732b5SBarry Smith .  step - current time-step
5532fb1732b5SBarry Smith .  ptime - current time
55330910c330SBarry Smith .  u - current state
5534721cd6eeSBarry Smith -  vf - viewer and its format
5535fb1732b5SBarry Smith 
5536fb1732b5SBarry Smith    Level: intermediate
5537fb1732b5SBarry Smith 
5538fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5539fb1732b5SBarry Smith @*/
5540721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5541fb1732b5SBarry Smith {
5542fb1732b5SBarry Smith   PetscErrorCode ierr;
5543fb1732b5SBarry Smith 
5544fb1732b5SBarry Smith   PetscFunctionBegin;
5545721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5546721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5547721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5548ed81e22dSJed Brown   PetscFunctionReturn(0);
5549ed81e22dSJed Brown }
5550ed81e22dSJed Brown 
5551ed81e22dSJed Brown /*@C
5552ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5553ed81e22dSJed Brown 
5554ed81e22dSJed Brown    Collective on TS
5555ed81e22dSJed Brown 
5556ed81e22dSJed Brown    Input Parameters:
5557ed81e22dSJed Brown +  ts - the TS context
5558ed81e22dSJed Brown .  step - current time-step
5559ed81e22dSJed Brown .  ptime - current time
55600910c330SBarry Smith .  u - current state
5561ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5562ed81e22dSJed Brown 
5563ed81e22dSJed Brown    Level: intermediate
5564ed81e22dSJed Brown 
5565ed81e22dSJed Brown    Notes:
5566ed81e22dSJed 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.
5567ed81e22dSJed Brown    These are named according to the file name template.
5568ed81e22dSJed Brown 
5569ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5570ed81e22dSJed Brown 
5571ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5572ed81e22dSJed Brown @*/
55730910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5574ed81e22dSJed Brown {
5575ed81e22dSJed Brown   PetscErrorCode ierr;
5576ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5577ed81e22dSJed Brown   PetscViewer    viewer;
5578ed81e22dSJed Brown 
5579ed81e22dSJed Brown   PetscFunctionBegin;
558063e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
55818caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5582ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
55830910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5584ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5585ed81e22dSJed Brown   PetscFunctionReturn(0);
5586ed81e22dSJed Brown }
5587ed81e22dSJed Brown 
5588ed81e22dSJed Brown /*@C
5589ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5590ed81e22dSJed Brown 
5591ed81e22dSJed Brown    Collective on TS
5592ed81e22dSJed Brown 
5593ed81e22dSJed Brown    Input Parameters:
5594ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5595ed81e22dSJed Brown 
5596ed81e22dSJed Brown    Level: intermediate
5597ed81e22dSJed Brown 
5598ed81e22dSJed Brown    Note:
5599ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5600ed81e22dSJed Brown 
5601ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5602ed81e22dSJed Brown @*/
5603ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5604ed81e22dSJed Brown {
5605ed81e22dSJed Brown   PetscErrorCode ierr;
5606ed81e22dSJed Brown 
5607ed81e22dSJed Brown   PetscFunctionBegin;
5608ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5609fb1732b5SBarry Smith   PetscFunctionReturn(0);
5610fb1732b5SBarry Smith }
5611fb1732b5SBarry Smith 
561284df9cb4SJed Brown /*@
5613552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
561484df9cb4SJed Brown 
5615ed81e22dSJed Brown    Collective on TS if controller has not been created yet
561684df9cb4SJed Brown 
561784df9cb4SJed Brown    Input Arguments:
5618ed81e22dSJed Brown .  ts - time stepping context
561984df9cb4SJed Brown 
562084df9cb4SJed Brown    Output Arguments:
5621ed81e22dSJed Brown .  adapt - adaptive controller
562284df9cb4SJed Brown 
562384df9cb4SJed Brown    Level: intermediate
562484df9cb4SJed Brown 
5625ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
562684df9cb4SJed Brown @*/
5627552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
562884df9cb4SJed Brown {
562984df9cb4SJed Brown   PetscErrorCode ierr;
563084df9cb4SJed Brown 
563184df9cb4SJed Brown   PetscFunctionBegin;
563284df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5633bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
563484df9cb4SJed Brown   if (!ts->adapt) {
5635ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
56363bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
56371c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
563884df9cb4SJed Brown   }
5639bec58848SLisandro Dalcin   *adapt = ts->adapt;
564084df9cb4SJed Brown   PetscFunctionReturn(0);
564184df9cb4SJed Brown }
5642d6ebe24aSShri Abhyankar 
56431c3436cfSJed Brown /*@
56441c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
56451c3436cfSJed Brown 
56461c3436cfSJed Brown    Logically Collective
56471c3436cfSJed Brown 
56481c3436cfSJed Brown    Input Arguments:
56491c3436cfSJed Brown +  ts - time integration context
56501c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
56510298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
56521c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
56530298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
56541c3436cfSJed Brown 
5655a3cdaa26SBarry Smith    Options Database keys:
5656a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5657a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5658a3cdaa26SBarry Smith 
56593ff766beSShri Abhyankar    Notes:
56603ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
56613ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
56623ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
56633ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
56643ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
56653ff766beSShri Abhyankar    differential variables.
56663ff766beSShri Abhyankar 
56671c3436cfSJed Brown    Level: beginner
56681c3436cfSJed Brown 
56695c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSGetTolerances()
56701c3436cfSJed Brown @*/
56711c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
56721c3436cfSJed Brown {
56731c3436cfSJed Brown   PetscErrorCode ierr;
56741c3436cfSJed Brown 
56751c3436cfSJed Brown   PetscFunctionBegin;
5676c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
56771c3436cfSJed Brown   if (vatol) {
56781c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
56791c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
56801c3436cfSJed Brown     ts->vatol = vatol;
56811c3436cfSJed Brown   }
5682c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
56831c3436cfSJed Brown   if (vrtol) {
56841c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
56851c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
56861c3436cfSJed Brown     ts->vrtol = vrtol;
56871c3436cfSJed Brown   }
56881c3436cfSJed Brown   PetscFunctionReturn(0);
56891c3436cfSJed Brown }
56901c3436cfSJed Brown 
5691c5033834SJed Brown /*@
5692c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5693c5033834SJed Brown 
5694c5033834SJed Brown    Logically Collective
5695c5033834SJed Brown 
5696c5033834SJed Brown    Input Arguments:
5697c5033834SJed Brown .  ts - time integration context
5698c5033834SJed Brown 
5699c5033834SJed Brown    Output Arguments:
57000298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
57010298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
57020298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
57030298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5704c5033834SJed Brown 
5705c5033834SJed Brown    Level: beginner
5706c5033834SJed Brown 
57075c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSSetTolerances()
5708c5033834SJed Brown @*/
5709c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5710c5033834SJed Brown {
5711c5033834SJed Brown   PetscFunctionBegin;
5712c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5713c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5714c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5715c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5716c5033834SJed Brown   PetscFunctionReturn(0);
5717c5033834SJed Brown }
5718c5033834SJed Brown 
57199c6b16b5SShri Abhyankar /*@
5720a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
57219c6b16b5SShri Abhyankar 
57229c6b16b5SShri Abhyankar    Collective on TS
57239c6b16b5SShri Abhyankar 
57249c6b16b5SShri Abhyankar    Input Arguments:
57259c6b16b5SShri Abhyankar +  ts - time stepping context
5726a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5727a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
57289c6b16b5SShri Abhyankar 
57299c6b16b5SShri Abhyankar    Output Arguments:
5730a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
57317453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5732a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
57339c6b16b5SShri Abhyankar 
57349c6b16b5SShri Abhyankar    Level: developer
57359c6b16b5SShri Abhyankar 
5736deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
57379c6b16b5SShri Abhyankar @*/
57387453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
57399c6b16b5SShri Abhyankar {
57409c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
57419c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
57427453f775SEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
57437453f775SEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
57449c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
57457453f775SEmil Constantinescu   PetscReal         sum,suma,sumr,gsum,gsuma,gsumr,diff;
57467453f775SEmil Constantinescu   PetscReal         tol,tola,tolr;
57477453f775SEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
57489c6b16b5SShri Abhyankar 
57499c6b16b5SShri Abhyankar   PetscFunctionBegin;
57509c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5751a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5752a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5753a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5754a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5755a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5756a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
57578a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
57588a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
5759a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
57609c6b16b5SShri Abhyankar 
57619c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
57629c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
57639c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
57649c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
57659c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
57667453f775SEmil Constantinescu   sum  = 0.; n_loc  = 0;
57677453f775SEmil Constantinescu   suma = 0.; na_loc = 0;
57687453f775SEmil Constantinescu   sumr = 0.; nr_loc = 0;
57699c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
57709c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
57719c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
57729c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
57739c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
577476cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
57757453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
57767453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
57777453f775SEmil Constantinescu       if (tola>0.){
57787453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
57797453f775SEmil Constantinescu         na_loc++;
57807453f775SEmil Constantinescu       }
57817453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
57827453f775SEmil Constantinescu       if (tolr>0.){
57837453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
57847453f775SEmil Constantinescu         nr_loc++;
57857453f775SEmil Constantinescu       }
57867453f775SEmil Constantinescu       tol=tola+tolr;
57877453f775SEmil Constantinescu       if (tol>0.){
57887453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
57897453f775SEmil Constantinescu         n_loc++;
57907453f775SEmil Constantinescu       }
57919c6b16b5SShri Abhyankar     }
57929c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
57939c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
57949c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
57959c6b16b5SShri Abhyankar     const PetscScalar *atol;
57969c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
57979c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
579876cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
57997453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
58007453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
58017453f775SEmil Constantinescu       if (tola>0.){
58027453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
58037453f775SEmil Constantinescu         na_loc++;
58047453f775SEmil Constantinescu       }
58057453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58067453f775SEmil Constantinescu       if (tolr>0.){
58077453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
58087453f775SEmil Constantinescu         nr_loc++;
58097453f775SEmil Constantinescu       }
58107453f775SEmil Constantinescu       tol=tola+tolr;
58117453f775SEmil Constantinescu       if (tol>0.){
58127453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
58137453f775SEmil Constantinescu         n_loc++;
58147453f775SEmil Constantinescu       }
58159c6b16b5SShri Abhyankar     }
58169c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58179c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
58189c6b16b5SShri Abhyankar     const PetscScalar *rtol;
58199c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58209c6b16b5SShri Abhyankar     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 = ts->atol;
58247453f775SEmil Constantinescu       if (tola>0.){
58257453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
58267453f775SEmil Constantinescu         na_loc++;
58277453f775SEmil Constantinescu       }
58287453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58297453f775SEmil Constantinescu       if (tolr>0.){
58307453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
58317453f775SEmil Constantinescu         nr_loc++;
58327453f775SEmil Constantinescu       }
58337453f775SEmil Constantinescu       tol=tola+tolr;
58347453f775SEmil Constantinescu       if (tol>0.){
58357453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
58367453f775SEmil Constantinescu         n_loc++;
58377453f775SEmil Constantinescu       }
58389c6b16b5SShri Abhyankar     }
58399c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58409c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
58419c6b16b5SShri Abhyankar     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       if (tola>0.){
58467453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
58477453f775SEmil Constantinescu         na_loc++;
58487453f775SEmil Constantinescu       }
58497453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58507453f775SEmil Constantinescu       if (tolr>0.){
58517453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
58527453f775SEmil Constantinescu         nr_loc++;
58537453f775SEmil Constantinescu       }
58547453f775SEmil Constantinescu       tol=tola+tolr;
58557453f775SEmil Constantinescu       if (tol>0.){
58567453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
58577453f775SEmil Constantinescu         n_loc++;
58587453f775SEmil Constantinescu       }
58599c6b16b5SShri Abhyankar     }
58609c6b16b5SShri Abhyankar   }
58619c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
58629c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
58639c6b16b5SShri Abhyankar 
58647453f775SEmil Constantinescu   err_loc[0] = sum;
58657453f775SEmil Constantinescu   err_loc[1] = suma;
58667453f775SEmil Constantinescu   err_loc[2] = sumr;
58677453f775SEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
58687453f775SEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
58697453f775SEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
58707453f775SEmil Constantinescu 
5871a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
58727453f775SEmil Constantinescu 
58737453f775SEmil Constantinescu   gsum   = err_glb[0];
58747453f775SEmil Constantinescu   gsuma  = err_glb[1];
58757453f775SEmil Constantinescu   gsumr  = err_glb[2];
58767453f775SEmil Constantinescu   n_glb  = err_glb[3];
58777453f775SEmil Constantinescu   na_glb = err_glb[4];
58787453f775SEmil Constantinescu   nr_glb = err_glb[5];
58797453f775SEmil Constantinescu 
5880b1316ef9SEmil Constantinescu   *norm  = 0.;
5881b1316ef9SEmil Constantinescu   if (n_glb>0.){*norm  = PetscSqrtReal(gsum  / n_glb);}
5882b1316ef9SEmil Constantinescu   *norma = 0.;
5883b1316ef9SEmil Constantinescu   if (na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
5884b1316ef9SEmil Constantinescu   *normr = 0.;
5885b1316ef9SEmil Constantinescu   if (nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
58869c6b16b5SShri Abhyankar 
58879c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
58887453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
58897453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
58909c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
58919c6b16b5SShri Abhyankar }
58929c6b16b5SShri Abhyankar 
58939c6b16b5SShri Abhyankar /*@
5894a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
58959c6b16b5SShri Abhyankar 
58969c6b16b5SShri Abhyankar    Collective on TS
58979c6b16b5SShri Abhyankar 
58989c6b16b5SShri Abhyankar    Input Arguments:
58999c6b16b5SShri Abhyankar +  ts - time stepping context
5900a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5901a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
59029c6b16b5SShri Abhyankar 
59039c6b16b5SShri Abhyankar    Output Arguments:
5904a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
59057453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5906a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
59079c6b16b5SShri Abhyankar 
59089c6b16b5SShri Abhyankar    Level: developer
59099c6b16b5SShri Abhyankar 
5910deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
59119c6b16b5SShri Abhyankar @*/
59127453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
59139c6b16b5SShri Abhyankar {
59149c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
59157453f775SEmil Constantinescu   PetscInt          i,n,N,rstart;
59169c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
59177453f775SEmil Constantinescu   PetscReal         max,gmax,maxa,gmaxa,maxr,gmaxr;
59187453f775SEmil Constantinescu   PetscReal         tol,tola,tolr,diff;
59197453f775SEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
59209c6b16b5SShri Abhyankar 
59219c6b16b5SShri Abhyankar   PetscFunctionBegin;
59229c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5923a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5924a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5925a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5926a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5927a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5928a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
59298a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
59308a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
5931a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
59329c6b16b5SShri Abhyankar 
59339c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
59349c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
59359c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
59369c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
59379c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
59387453f775SEmil Constantinescu 
59397453f775SEmil Constantinescu   max=0.;
59407453f775SEmil Constantinescu   maxa=0.;
59417453f775SEmil Constantinescu   maxr=0.;
59427453f775SEmil Constantinescu 
59437453f775SEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
59449c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
59459c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59469c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59477453f775SEmil Constantinescu 
59487453f775SEmil Constantinescu     for (i=0; i<n; i++) {
594976cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59507453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59517453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
59527453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59537453f775SEmil Constantinescu       tol  = tola+tolr;
59547453f775SEmil Constantinescu       if (tola>0.){
59557453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
59567453f775SEmil Constantinescu       }
59577453f775SEmil Constantinescu       if (tolr>0.){
59587453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
59597453f775SEmil Constantinescu       }
59607453f775SEmil Constantinescu       if (tol>0.){
59617453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
59627453f775SEmil Constantinescu       }
59639c6b16b5SShri Abhyankar     }
59649c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59659c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59669c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
59679c6b16b5SShri Abhyankar     const PetscScalar *atol;
59689c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59697453f775SEmil Constantinescu     for (i=0; i<n; i++) {
597076cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59717453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59727453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
59737453f775SEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59747453f775SEmil Constantinescu       tol  = tola+tolr;
59757453f775SEmil Constantinescu       if (tola>0.){
59767453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
59777453f775SEmil Constantinescu       }
59787453f775SEmil Constantinescu       if (tolr>0.){
59797453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
59807453f775SEmil Constantinescu       }
59817453f775SEmil Constantinescu       if (tol>0.){
59827453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
59837453f775SEmil Constantinescu       }
59849c6b16b5SShri Abhyankar     }
59859c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59869c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
59879c6b16b5SShri Abhyankar     const PetscScalar *rtol;
59889c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59897453f775SEmil Constantinescu 
59907453f775SEmil Constantinescu     for (i=0; i<n; i++) {
599176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59927453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59937453f775SEmil Constantinescu       tola = ts->atol;
59947453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59957453f775SEmil Constantinescu       tol  = tola+tolr;
59967453f775SEmil Constantinescu       if (tola>0.){
59977453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
59987453f775SEmil Constantinescu       }
59997453f775SEmil Constantinescu       if (tolr>0.){
60007453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
60017453f775SEmil Constantinescu       }
60027453f775SEmil Constantinescu       if (tol>0.){
60037453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
60047453f775SEmil Constantinescu       }
60059c6b16b5SShri Abhyankar     }
60069c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60079c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
60087453f775SEmil Constantinescu 
60097453f775SEmil Constantinescu     for (i=0; i<n; i++) {
601076cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
60117453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
60127453f775SEmil Constantinescu       tola = ts->atol;
60137453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60147453f775SEmil Constantinescu       tol  = tola+tolr;
60157453f775SEmil Constantinescu       if (tola>0.){
60167453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
60177453f775SEmil Constantinescu       }
60187453f775SEmil Constantinescu       if (tolr>0.){
60197453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
60207453f775SEmil Constantinescu       }
60217453f775SEmil Constantinescu       if (tol>0.){
60227453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
60237453f775SEmil Constantinescu       }
60249c6b16b5SShri Abhyankar     }
60259c6b16b5SShri Abhyankar   }
60269c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
60279c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
60287453f775SEmil Constantinescu   err_loc[0] = max;
60297453f775SEmil Constantinescu   err_loc[1] = maxa;
60307453f775SEmil Constantinescu   err_loc[2] = maxr;
6031a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
60327453f775SEmil Constantinescu   gmax   = err_glb[0];
60337453f775SEmil Constantinescu   gmaxa  = err_glb[1];
60347453f775SEmil Constantinescu   gmaxr  = err_glb[2];
60359c6b16b5SShri Abhyankar 
60369c6b16b5SShri Abhyankar   *norm = gmax;
60377453f775SEmil Constantinescu   *norma = gmaxa;
60387453f775SEmil Constantinescu   *normr = gmaxr;
60399c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
60407453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
60417453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
60429c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
60439c6b16b5SShri Abhyankar }
60449c6b16b5SShri Abhyankar 
60451c3436cfSJed Brown /*@
60468a175baeSEmil Constantinescu    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
60471c3436cfSJed Brown 
60481c3436cfSJed Brown    Collective on TS
60491c3436cfSJed Brown 
60501c3436cfSJed Brown    Input Arguments:
60511c3436cfSJed Brown +  ts - time stepping context
6052a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6053a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
6054a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
60557619abb3SShri 
60561c3436cfSJed Brown    Output Arguments:
6057a2b725a8SWilliam Gropp +  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
60588a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
6059a2b725a8SWilliam Gropp -  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
6060a4868fbcSLisandro Dalcin 
6061a4868fbcSLisandro Dalcin    Options Database Keys:
6062a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
6063a4868fbcSLisandro Dalcin 
60641c3436cfSJed Brown    Level: developer
60651c3436cfSJed Brown 
60668a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm
60671c3436cfSJed Brown @*/
60687453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
60691c3436cfSJed Brown {
60708beabaa1SBarry Smith   PetscErrorCode ierr;
60711c3436cfSJed Brown 
60721c3436cfSJed Brown   PetscFunctionBegin;
6073a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
60747453f775SEmil Constantinescu     ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6075a4868fbcSLisandro Dalcin   } else if (wnormtype == NORM_INFINITY) {
60767453f775SEmil Constantinescu     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6077a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
60781c3436cfSJed Brown   PetscFunctionReturn(0);
60791c3436cfSJed Brown }
60801c3436cfSJed Brown 
60818a175baeSEmil Constantinescu 
60828a175baeSEmil Constantinescu /*@
60838a175baeSEmil Constantinescu    TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances
60848a175baeSEmil Constantinescu 
60858a175baeSEmil Constantinescu    Collective on TS
60868a175baeSEmil Constantinescu 
60878a175baeSEmil Constantinescu    Input Arguments:
60888a175baeSEmil Constantinescu +  ts - time stepping context
60898a175baeSEmil Constantinescu .  E - error vector
60908a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
60918a175baeSEmil Constantinescu -  Y - state vector, previous time step
60928a175baeSEmil Constantinescu 
60938a175baeSEmil Constantinescu    Output Arguments:
6094a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
60958a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
6096a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
60978a175baeSEmil Constantinescu 
60988a175baeSEmil Constantinescu    Level: developer
60998a175baeSEmil Constantinescu 
61008a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity()
61018a175baeSEmil Constantinescu @*/
61028a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
61038a175baeSEmil Constantinescu {
61048a175baeSEmil Constantinescu   PetscErrorCode    ierr;
61058a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
61068a175baeSEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
61078a175baeSEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
61088a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
61098a175baeSEmil Constantinescu   PetscReal         err,sum,suma,sumr,gsum,gsuma,gsumr;
61108a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
61118a175baeSEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
61128a175baeSEmil Constantinescu 
61138a175baeSEmil Constantinescu   PetscFunctionBegin;
61148a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
61158a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
61168a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
61178a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
61188a175baeSEmil Constantinescu   PetscValidType(E,2);
61198a175baeSEmil Constantinescu   PetscValidType(U,3);
61208a175baeSEmil Constantinescu   PetscValidType(Y,4);
61218a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
61228a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
61238a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
61248a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
61258a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
61268a175baeSEmil Constantinescu 
61278a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
61288a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
61298a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
61308a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
61318a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
61328a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
61338a175baeSEmil Constantinescu   sum  = 0.; n_loc  = 0;
61348a175baeSEmil Constantinescu   suma = 0.; na_loc = 0;
61358a175baeSEmil Constantinescu   sumr = 0.; nr_loc = 0;
61368a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {
61378a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
61388a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61398a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61408a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
614176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61428a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61438a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
61448a175baeSEmil Constantinescu       if (tola>0.){
61458a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
61468a175baeSEmil Constantinescu         na_loc++;
61478a175baeSEmil Constantinescu       }
61488a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61498a175baeSEmil Constantinescu       if (tolr>0.){
61508a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
61518a175baeSEmil Constantinescu         nr_loc++;
61528a175baeSEmil Constantinescu       }
61538a175baeSEmil Constantinescu       tol=tola+tolr;
61548a175baeSEmil Constantinescu       if (tol>0.){
61558a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
61568a175baeSEmil Constantinescu         n_loc++;
61578a175baeSEmil Constantinescu       }
61588a175baeSEmil Constantinescu     }
61598a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61608a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61618a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
61628a175baeSEmil Constantinescu     const PetscScalar *atol;
61638a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61648a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
616576cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61668a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61678a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
61688a175baeSEmil Constantinescu       if (tola>0.){
61698a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
61708a175baeSEmil Constantinescu         na_loc++;
61718a175baeSEmil Constantinescu       }
61728a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61738a175baeSEmil Constantinescu       if (tolr>0.){
61748a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
61758a175baeSEmil Constantinescu         nr_loc++;
61768a175baeSEmil Constantinescu       }
61778a175baeSEmil Constantinescu       tol=tola+tolr;
61788a175baeSEmil Constantinescu       if (tol>0.){
61798a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
61808a175baeSEmil Constantinescu         n_loc++;
61818a175baeSEmil Constantinescu       }
61828a175baeSEmil Constantinescu     }
61838a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61848a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
61858a175baeSEmil Constantinescu     const PetscScalar *rtol;
61868a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61878a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
618876cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61898a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61908a175baeSEmil Constantinescu       tola = ts->atol;
61918a175baeSEmil Constantinescu       if (tola>0.){
61928a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
61938a175baeSEmil Constantinescu         na_loc++;
61948a175baeSEmil Constantinescu       }
61958a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61968a175baeSEmil Constantinescu       if (tolr>0.){
61978a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
61988a175baeSEmil Constantinescu         nr_loc++;
61998a175baeSEmil Constantinescu       }
62008a175baeSEmil Constantinescu       tol=tola+tolr;
62018a175baeSEmil Constantinescu       if (tol>0.){
62028a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
62038a175baeSEmil Constantinescu         n_loc++;
62048a175baeSEmil Constantinescu       }
62058a175baeSEmil Constantinescu     }
62068a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62078a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
62088a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
620976cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
62108a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
62118a175baeSEmil Constantinescu       tola = ts->atol;
62128a175baeSEmil Constantinescu       if (tola>0.){
62138a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
62148a175baeSEmil Constantinescu         na_loc++;
62158a175baeSEmil Constantinescu       }
62168a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62178a175baeSEmil Constantinescu       if (tolr>0.){
62188a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
62198a175baeSEmil Constantinescu         nr_loc++;
62208a175baeSEmil Constantinescu       }
62218a175baeSEmil Constantinescu       tol=tola+tolr;
62228a175baeSEmil Constantinescu       if (tol>0.){
62238a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
62248a175baeSEmil Constantinescu         n_loc++;
62258a175baeSEmil Constantinescu       }
62268a175baeSEmil Constantinescu     }
62278a175baeSEmil Constantinescu   }
62288a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
62298a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
62308a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
62318a175baeSEmil Constantinescu 
62328a175baeSEmil Constantinescu   err_loc[0] = sum;
62338a175baeSEmil Constantinescu   err_loc[1] = suma;
62348a175baeSEmil Constantinescu   err_loc[2] = sumr;
62358a175baeSEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
62368a175baeSEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
62378a175baeSEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
62388a175baeSEmil Constantinescu 
6239a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
62408a175baeSEmil Constantinescu 
62418a175baeSEmil Constantinescu   gsum   = err_glb[0];
62428a175baeSEmil Constantinescu   gsuma  = err_glb[1];
62438a175baeSEmil Constantinescu   gsumr  = err_glb[2];
62448a175baeSEmil Constantinescu   n_glb  = err_glb[3];
62458a175baeSEmil Constantinescu   na_glb = err_glb[4];
62468a175baeSEmil Constantinescu   nr_glb = err_glb[5];
62478a175baeSEmil Constantinescu 
62488a175baeSEmil Constantinescu   *norm  = 0.;
62498a175baeSEmil Constantinescu   if (n_glb>0.){*norm  = PetscSqrtReal(gsum  / n_glb);}
62508a175baeSEmil Constantinescu   *norma = 0.;
62518a175baeSEmil Constantinescu   if (na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
62528a175baeSEmil Constantinescu   *normr = 0.;
62538a175baeSEmil Constantinescu   if (nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
62548a175baeSEmil Constantinescu 
62558a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
62568a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
62578a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
62588a175baeSEmil Constantinescu   PetscFunctionReturn(0);
62598a175baeSEmil Constantinescu }
62608a175baeSEmil Constantinescu 
62618a175baeSEmil Constantinescu /*@
62628a175baeSEmil Constantinescu    TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances
62638a175baeSEmil Constantinescu    Collective on TS
62648a175baeSEmil Constantinescu 
62658a175baeSEmil Constantinescu    Input Arguments:
62668a175baeSEmil Constantinescu +  ts - time stepping context
62678a175baeSEmil Constantinescu .  E - error vector
62688a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
62698a175baeSEmil Constantinescu -  Y - state vector, previous time step
62708a175baeSEmil Constantinescu 
62718a175baeSEmil Constantinescu    Output Arguments:
6272a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
62738a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
6274a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
62758a175baeSEmil Constantinescu 
62768a175baeSEmil Constantinescu    Level: developer
62778a175baeSEmil Constantinescu 
62788a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2()
62798a175baeSEmil Constantinescu @*/
62808a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
62818a175baeSEmil Constantinescu {
62828a175baeSEmil Constantinescu   PetscErrorCode    ierr;
62838a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
62848a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
62858a175baeSEmil Constantinescu   PetscReal         err,max,gmax,maxa,gmaxa,maxr,gmaxr;
62868a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
62878a175baeSEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
62888a175baeSEmil Constantinescu 
62898a175baeSEmil Constantinescu   PetscFunctionBegin;
62908a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
62918a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
62928a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
62938a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
62948a175baeSEmil Constantinescu   PetscValidType(E,2);
62958a175baeSEmil Constantinescu   PetscValidType(U,3);
62968a175baeSEmil Constantinescu   PetscValidType(Y,4);
62978a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
62988a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
62998a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
63008a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
63018a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
63028a175baeSEmil Constantinescu 
63038a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
63048a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
63058a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
63068a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
63078a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
63088a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
63098a175baeSEmil Constantinescu 
63108a175baeSEmil Constantinescu   max=0.;
63118a175baeSEmil Constantinescu   maxa=0.;
63128a175baeSEmil Constantinescu   maxr=0.;
63138a175baeSEmil Constantinescu 
63148a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
63158a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
63168a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63178a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63188a175baeSEmil Constantinescu 
63198a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
632076cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
63218a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63228a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
63238a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63248a175baeSEmil Constantinescu       tol  = tola+tolr;
63258a175baeSEmil Constantinescu       if (tola>0.){
63268a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
63278a175baeSEmil Constantinescu       }
63288a175baeSEmil Constantinescu       if (tolr>0.){
63298a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
63308a175baeSEmil Constantinescu       }
63318a175baeSEmil Constantinescu       if (tol>0.){
63328a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63338a175baeSEmil Constantinescu       }
63348a175baeSEmil Constantinescu     }
63358a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63368a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63378a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
63388a175baeSEmil Constantinescu     const PetscScalar *atol;
63398a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63408a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
634176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
63428a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63438a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
63448a175baeSEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63458a175baeSEmil Constantinescu       tol  = tola+tolr;
63468a175baeSEmil Constantinescu       if (tola>0.){
63478a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
63488a175baeSEmil Constantinescu       }
63498a175baeSEmil Constantinescu       if (tolr>0.){
63508a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
63518a175baeSEmil Constantinescu       }
63528a175baeSEmil Constantinescu       if (tol>0.){
63538a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63548a175baeSEmil Constantinescu       }
63558a175baeSEmil Constantinescu     }
63568a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63578a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
63588a175baeSEmil Constantinescu     const PetscScalar *rtol;
63598a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63608a175baeSEmil Constantinescu 
63618a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
636276cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
63638a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63648a175baeSEmil Constantinescu       tola = ts->atol;
63658a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63668a175baeSEmil Constantinescu       tol  = tola+tolr;
63678a175baeSEmil Constantinescu       if (tola>0.){
63688a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
63698a175baeSEmil Constantinescu       }
63708a175baeSEmil Constantinescu       if (tolr>0.){
63718a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
63728a175baeSEmil Constantinescu       }
63738a175baeSEmil Constantinescu       if (tol>0.){
63748a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63758a175baeSEmil Constantinescu       }
63768a175baeSEmil Constantinescu     }
63778a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63788a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
63798a175baeSEmil Constantinescu 
63808a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
638176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
63828a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63838a175baeSEmil Constantinescu       tola = ts->atol;
63848a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63858a175baeSEmil Constantinescu       tol  = tola+tolr;
63868a175baeSEmil Constantinescu       if (tola>0.){
63878a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
63888a175baeSEmil Constantinescu       }
63898a175baeSEmil Constantinescu       if (tolr>0.){
63908a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
63918a175baeSEmil Constantinescu       }
63928a175baeSEmil Constantinescu       if (tol>0.){
63938a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63948a175baeSEmil Constantinescu       }
63958a175baeSEmil Constantinescu     }
63968a175baeSEmil Constantinescu   }
63978a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
63988a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
63998a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
64008a175baeSEmil Constantinescu   err_loc[0] = max;
64018a175baeSEmil Constantinescu   err_loc[1] = maxa;
64028a175baeSEmil Constantinescu   err_loc[2] = maxr;
6403a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
64048a175baeSEmil Constantinescu   gmax   = err_glb[0];
64058a175baeSEmil Constantinescu   gmaxa  = err_glb[1];
64068a175baeSEmil Constantinescu   gmaxr  = err_glb[2];
64078a175baeSEmil Constantinescu 
64088a175baeSEmil Constantinescu   *norm = gmax;
64098a175baeSEmil Constantinescu   *norma = gmaxa;
64108a175baeSEmil Constantinescu   *normr = gmaxr;
64118a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
64128a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
64138a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
64148a175baeSEmil Constantinescu   PetscFunctionReturn(0);
64158a175baeSEmil Constantinescu }
64168a175baeSEmil Constantinescu 
64178a175baeSEmil Constantinescu /*@
64188a175baeSEmil Constantinescu    TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
64198a175baeSEmil Constantinescu 
64208a175baeSEmil Constantinescu    Collective on TS
64218a175baeSEmil Constantinescu 
64228a175baeSEmil Constantinescu    Input Arguments:
64238a175baeSEmil Constantinescu +  ts - time stepping context
64248a175baeSEmil Constantinescu .  E - error vector
64258a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
64268a175baeSEmil Constantinescu .  Y - state vector, previous time step
64278a175baeSEmil Constantinescu -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
64288a175baeSEmil Constantinescu 
64298a175baeSEmil Constantinescu    Output Arguments:
6430a2b725a8SWilliam Gropp +  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
64318a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
6432a2b725a8SWilliam Gropp -  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
64338a175baeSEmil Constantinescu 
64348a175baeSEmil Constantinescu    Options Database Keys:
64358a175baeSEmil Constantinescu .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
64368a175baeSEmil Constantinescu 
64378a175baeSEmil Constantinescu    Level: developer
64388a175baeSEmil Constantinescu 
64398a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
64408a175baeSEmil Constantinescu @*/
64418a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
64428a175baeSEmil Constantinescu {
64438a175baeSEmil Constantinescu   PetscErrorCode ierr;
64448a175baeSEmil Constantinescu 
64458a175baeSEmil Constantinescu   PetscFunctionBegin;
64468a175baeSEmil Constantinescu   if (wnormtype == NORM_2) {
64478a175baeSEmil Constantinescu     ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
64488a175baeSEmil Constantinescu   } else if (wnormtype == NORM_INFINITY) {
64498a175baeSEmil Constantinescu     ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
64508a175baeSEmil Constantinescu   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
64518a175baeSEmil Constantinescu   PetscFunctionReturn(0);
64528a175baeSEmil Constantinescu }
64538a175baeSEmil Constantinescu 
64548a175baeSEmil Constantinescu 
64558d59e960SJed Brown /*@
64568d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
64578d59e960SJed Brown 
64588d59e960SJed Brown    Logically Collective on TS
64598d59e960SJed Brown 
64608d59e960SJed Brown    Input Arguments:
64618d59e960SJed Brown +  ts - time stepping context
64628d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
64638d59e960SJed Brown 
64648d59e960SJed Brown    Note:
64658d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
64668d59e960SJed Brown 
64678d59e960SJed Brown    Level: intermediate
64688d59e960SJed Brown 
64698d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
64708d59e960SJed Brown @*/
64718d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
64728d59e960SJed Brown {
64738d59e960SJed Brown   PetscFunctionBegin;
64748d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
64758d59e960SJed Brown   ts->cfltime_local = cfltime;
64768d59e960SJed Brown   ts->cfltime       = -1.;
64778d59e960SJed Brown   PetscFunctionReturn(0);
64788d59e960SJed Brown }
64798d59e960SJed Brown 
64808d59e960SJed Brown /*@
64818d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
64828d59e960SJed Brown 
64838d59e960SJed Brown    Collective on TS
64848d59e960SJed Brown 
64858d59e960SJed Brown    Input Arguments:
64868d59e960SJed Brown .  ts - time stepping context
64878d59e960SJed Brown 
64888d59e960SJed Brown    Output Arguments:
64898d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
64908d59e960SJed Brown 
64918d59e960SJed Brown    Level: advanced
64928d59e960SJed Brown 
64938d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
64948d59e960SJed Brown @*/
64958d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
64968d59e960SJed Brown {
64978d59e960SJed Brown   PetscErrorCode ierr;
64988d59e960SJed Brown 
64998d59e960SJed Brown   PetscFunctionBegin;
65008d59e960SJed Brown   if (ts->cfltime < 0) {
6501b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
65028d59e960SJed Brown   }
65038d59e960SJed Brown   *cfltime = ts->cfltime;
65048d59e960SJed Brown   PetscFunctionReturn(0);
65058d59e960SJed Brown }
65068d59e960SJed Brown 
6507d6ebe24aSShri Abhyankar /*@
6508d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6509d6ebe24aSShri Abhyankar 
6510d6ebe24aSShri Abhyankar    Input Parameters:
6511a2b725a8SWilliam Gropp +  ts   - the TS context.
6512d6ebe24aSShri Abhyankar .  xl   - lower bound.
6513a2b725a8SWilliam Gropp -  xu   - upper bound.
6514d6ebe24aSShri Abhyankar 
6515d6ebe24aSShri Abhyankar    Notes:
6516d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6517e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6518d6ebe24aSShri Abhyankar 
65192bd2b0e6SSatish Balay    Level: advanced
65202bd2b0e6SSatish Balay 
6521d6ebe24aSShri Abhyankar @*/
6522d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6523d6ebe24aSShri Abhyankar {
6524d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6525d6ebe24aSShri Abhyankar   SNES           snes;
6526d6ebe24aSShri Abhyankar 
6527d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6528d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6529d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6530d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6531d6ebe24aSShri Abhyankar }
6532d6ebe24aSShri Abhyankar 
6533b3603a34SBarry Smith /*@C
65344f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
6535b3603a34SBarry Smith        in a time based line graph
6536b3603a34SBarry Smith 
6537b3603a34SBarry Smith    Collective on TS
6538b3603a34SBarry Smith 
6539b3603a34SBarry Smith    Input Parameters:
6540b3603a34SBarry Smith +  ts - the TS context
6541b3603a34SBarry Smith .  step - current time-step
6542b3603a34SBarry Smith .  ptime - current time
65437db568b7SBarry Smith .  u - current solution
65447db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
6545b3603a34SBarry Smith 
6546b3d3934dSBarry Smith    Options Database:
65479ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
6548b3d3934dSBarry Smith 
6549b3603a34SBarry Smith    Level: intermediate
6550b3603a34SBarry Smith 
655195452b02SPatrick Sanan    Notes:
655295452b02SPatrick Sanan     Each process in a parallel run displays its component solutions in a separate window
6553b3603a34SBarry Smith 
65547db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
65557db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
65567db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
65577db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
6558b3603a34SBarry Smith @*/
65597db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6560b3603a34SBarry Smith {
6561b3603a34SBarry Smith   PetscErrorCode    ierr;
65627db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
6563b3603a34SBarry Smith   const PetscScalar *yy;
656480666b62SBarry Smith   Vec               v;
6565b3603a34SBarry Smith 
6566b3603a34SBarry Smith   PetscFunctionBegin;
656763e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
656858ff32f7SBarry Smith   if (!step) {
6569a9f9c1f6SBarry Smith     PetscDrawAxis axis;
65706934998bSLisandro Dalcin     PetscInt      dim;
6571a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
65720ec8ee2bSJoseph Pusztay     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
6573bab0a581SBarry Smith     if (!ctx->names) {
6574bab0a581SBarry Smith       PetscBool flg;
6575bab0a581SBarry Smith       /* user provides names of variables to plot but no names has been set so assume names are integer values */
6576bab0a581SBarry Smith       ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr);
6577bab0a581SBarry Smith       if (flg) {
6578bab0a581SBarry Smith         PetscInt i,n;
6579bab0a581SBarry Smith         char     **names;
6580bab0a581SBarry Smith         ierr = VecGetSize(u,&n);CHKERRQ(ierr);
6581bab0a581SBarry Smith         ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr);
6582bab0a581SBarry Smith         for (i=0; i<n; i++) {
6583bab0a581SBarry Smith           ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr);
6584bab0a581SBarry Smith           ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr);
6585bab0a581SBarry Smith         }
6586bab0a581SBarry Smith         names[n] = NULL;
6587bab0a581SBarry Smith         ctx->names = names;
6588bab0a581SBarry Smith       }
6589bab0a581SBarry Smith     }
6590387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
6591387f4636SBarry Smith       char      **displaynames;
6592387f4636SBarry Smith       PetscBool flg;
6593387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6594580bdb30SBarry Smith       ierr = PetscCalloc1(dim+1,&displaynames);CHKERRQ(ierr);
6595c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
6596387f4636SBarry Smith       if (flg) {
6597a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
6598387f4636SBarry Smith       }
6599387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
6600387f4636SBarry Smith     }
6601387f4636SBarry Smith     if (ctx->displaynames) {
6602387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
6603387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
6604387f4636SBarry Smith     } else if (ctx->names) {
66050910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
66060b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6607387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
6608b0bc92c6SBarry Smith     } else {
6609b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6610b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6611387f4636SBarry Smith     }
66120b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
661358ff32f7SBarry Smith   }
66146934998bSLisandro Dalcin 
66156934998bSLisandro Dalcin   if (!ctx->transform) v = u;
66166934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
661780666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
66186934998bSLisandro Dalcin   if (ctx->displaynames) {
66196934998bSLisandro Dalcin     PetscInt i;
66206934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
66216934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
66226934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
66236934998bSLisandro Dalcin   } else {
6624e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6625e3efe391SJed Brown     PetscInt  i,n;
66266934998bSLisandro Dalcin     PetscReal *yreal;
662780666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
6628785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6629e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
66300b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6631e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6632e3efe391SJed Brown #else
66330b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6634e3efe391SJed Brown #endif
663580666b62SBarry Smith   }
66366934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
66376934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
66386934998bSLisandro Dalcin 
6639b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
66400b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
66416934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
66423923b477SBarry Smith   }
6643b3603a34SBarry Smith   PetscFunctionReturn(0);
6644b3603a34SBarry Smith }
6645b3603a34SBarry Smith 
6646b037adc7SBarry Smith /*@C
664731152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6648b037adc7SBarry Smith 
6649b037adc7SBarry Smith    Collective on TS
6650b037adc7SBarry Smith 
6651b037adc7SBarry Smith    Input Parameters:
6652b037adc7SBarry Smith +  ts - the TS context
6653b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
6654b037adc7SBarry Smith 
6655b037adc7SBarry Smith    Level: intermediate
6656b037adc7SBarry Smith 
665795452b02SPatrick Sanan    Notes:
665895452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66597db568b7SBarry Smith 
6660a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
6661b037adc7SBarry Smith @*/
666231152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
6663b037adc7SBarry Smith {
6664b037adc7SBarry Smith   PetscErrorCode    ierr;
6665b037adc7SBarry Smith   PetscInt          i;
6666b037adc7SBarry Smith 
6667b037adc7SBarry Smith   PetscFunctionBegin;
6668b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6669b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
66705537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
6671b3d3934dSBarry Smith       break;
6672b3d3934dSBarry Smith     }
6673b3d3934dSBarry Smith   }
6674b3d3934dSBarry Smith   PetscFunctionReturn(0);
6675b3d3934dSBarry Smith }
6676b3d3934dSBarry Smith 
6677e673d494SBarry Smith /*@C
6678e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6679e673d494SBarry Smith 
6680e673d494SBarry Smith    Collective on TS
6681e673d494SBarry Smith 
6682e673d494SBarry Smith    Input Parameters:
6683e673d494SBarry Smith +  ts - the TS context
6684e673d494SBarry Smith -  names - the names of the components, final string must be NULL
6685e673d494SBarry Smith 
6686e673d494SBarry Smith    Level: intermediate
6687e673d494SBarry Smith 
6688a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
6689e673d494SBarry Smith @*/
6690e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
6691e673d494SBarry Smith {
6692e673d494SBarry Smith   PetscErrorCode    ierr;
6693e673d494SBarry Smith 
6694e673d494SBarry Smith   PetscFunctionBegin;
6695e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
6696e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
6697e673d494SBarry Smith   PetscFunctionReturn(0);
6698e673d494SBarry Smith }
6699e673d494SBarry Smith 
6700b3d3934dSBarry Smith /*@C
6701b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
6702b3d3934dSBarry Smith 
6703b3d3934dSBarry Smith    Collective on TS
6704b3d3934dSBarry Smith 
6705b3d3934dSBarry Smith    Input Parameter:
6706b3d3934dSBarry Smith .  ts - the TS context
6707b3d3934dSBarry Smith 
6708b3d3934dSBarry Smith    Output Parameter:
6709b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
6710b3d3934dSBarry Smith 
6711b3d3934dSBarry Smith    Level: intermediate
6712b3d3934dSBarry Smith 
671395452b02SPatrick Sanan    Notes:
671495452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
67157db568b7SBarry Smith 
6716b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6717b3d3934dSBarry Smith @*/
6718b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
6719b3d3934dSBarry Smith {
6720b3d3934dSBarry Smith   PetscInt       i;
6721b3d3934dSBarry Smith 
6722b3d3934dSBarry Smith   PetscFunctionBegin;
6723b3d3934dSBarry Smith   *names = NULL;
6724b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6725b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
67265537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
6727b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
6728b3d3934dSBarry Smith       break;
6729387f4636SBarry Smith     }
6730387f4636SBarry Smith   }
6731387f4636SBarry Smith   PetscFunctionReturn(0);
6732387f4636SBarry Smith }
6733387f4636SBarry Smith 
6734a66092f1SBarry Smith /*@C
6735a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
6736a66092f1SBarry Smith 
6737a66092f1SBarry Smith    Collective on TS
6738a66092f1SBarry Smith 
6739a66092f1SBarry Smith    Input Parameters:
6740a66092f1SBarry Smith +  ctx - the TSMonitorLG context
6741a2b725a8SWilliam Gropp -  displaynames - the names of the components, final string must be NULL
6742a66092f1SBarry Smith 
6743a66092f1SBarry Smith    Level: intermediate
6744a66092f1SBarry Smith 
6745a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6746a66092f1SBarry Smith @*/
6747a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6748a66092f1SBarry Smith {
6749a66092f1SBarry Smith   PetscInt          j = 0,k;
6750a66092f1SBarry Smith   PetscErrorCode    ierr;
6751a66092f1SBarry Smith 
6752a66092f1SBarry Smith   PetscFunctionBegin;
6753a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6754a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6755a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6756a66092f1SBarry Smith   while (displaynames[j]) j++;
6757a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6758a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6759a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6760a66092f1SBarry Smith   j = 0;
6761a66092f1SBarry Smith   while (displaynames[j]) {
6762a66092f1SBarry Smith     k = 0;
6763a66092f1SBarry Smith     while (ctx->names[k]) {
6764a66092f1SBarry Smith       PetscBool flg;
6765a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6766a66092f1SBarry Smith       if (flg) {
6767a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6768a66092f1SBarry Smith         break;
6769a66092f1SBarry Smith       }
6770a66092f1SBarry Smith       k++;
6771a66092f1SBarry Smith     }
6772a66092f1SBarry Smith     j++;
6773a66092f1SBarry Smith   }
6774a66092f1SBarry Smith   PetscFunctionReturn(0);
6775a66092f1SBarry Smith }
6776a66092f1SBarry Smith 
6777387f4636SBarry Smith /*@C
6778387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6779387f4636SBarry Smith 
6780387f4636SBarry Smith    Collective on TS
6781387f4636SBarry Smith 
6782387f4636SBarry Smith    Input Parameters:
6783387f4636SBarry Smith +  ts - the TS context
6784a2b725a8SWilliam Gropp -  displaynames - the names of the components, final string must be NULL
6785387f4636SBarry Smith 
678695452b02SPatrick Sanan    Notes:
678795452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
67887db568b7SBarry Smith 
6789387f4636SBarry Smith    Level: intermediate
6790387f4636SBarry Smith 
6791387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6792387f4636SBarry Smith @*/
6793387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6794387f4636SBarry Smith {
6795a66092f1SBarry Smith   PetscInt          i;
6796387f4636SBarry Smith   PetscErrorCode    ierr;
6797387f4636SBarry Smith 
6798387f4636SBarry Smith   PetscFunctionBegin;
6799387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6800387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
68015537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6802b3d3934dSBarry Smith       break;
6803b037adc7SBarry Smith     }
6804b037adc7SBarry Smith   }
6805b037adc7SBarry Smith   PetscFunctionReturn(0);
6806b037adc7SBarry Smith }
6807b037adc7SBarry Smith 
680880666b62SBarry Smith /*@C
680980666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
681080666b62SBarry Smith 
681180666b62SBarry Smith    Collective on TS
681280666b62SBarry Smith 
681380666b62SBarry Smith    Input Parameters:
681480666b62SBarry Smith +  ts - the TS context
681580666b62SBarry Smith .  transform - the transform function
68167684fa3eSBarry Smith .  destroy - function to destroy the optional context
681780666b62SBarry Smith -  ctx - optional context used by transform function
681880666b62SBarry Smith 
681995452b02SPatrick Sanan    Notes:
682095452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
68217db568b7SBarry Smith 
682280666b62SBarry Smith    Level: intermediate
682380666b62SBarry Smith 
6824a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
682580666b62SBarry Smith @*/
68267684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
682780666b62SBarry Smith {
682880666b62SBarry Smith   PetscInt          i;
6829a66092f1SBarry Smith   PetscErrorCode    ierr;
683080666b62SBarry Smith 
683180666b62SBarry Smith   PetscFunctionBegin;
683280666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
683380666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
68345537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
683580666b62SBarry Smith     }
683680666b62SBarry Smith   }
683780666b62SBarry Smith   PetscFunctionReturn(0);
683880666b62SBarry Smith }
683980666b62SBarry Smith 
6840e673d494SBarry Smith /*@C
6841e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6842e673d494SBarry Smith 
6843e673d494SBarry Smith    Collective on TSLGCtx
6844e673d494SBarry Smith 
6845e673d494SBarry Smith    Input Parameters:
6846e673d494SBarry Smith +  ts - the TS context
6847e673d494SBarry Smith .  transform - the transform function
68487684fa3eSBarry Smith .  destroy - function to destroy the optional context
6849e673d494SBarry Smith -  ctx - optional context used by transform function
6850e673d494SBarry Smith 
6851e673d494SBarry Smith    Level: intermediate
6852e673d494SBarry Smith 
6853a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6854e673d494SBarry Smith @*/
68557684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6856e673d494SBarry Smith {
6857e673d494SBarry Smith   PetscFunctionBegin;
6858e673d494SBarry Smith   ctx->transform    = transform;
68597684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6860e673d494SBarry Smith   ctx->transformctx = tctx;
6861e673d494SBarry Smith   PetscFunctionReturn(0);
6862e673d494SBarry Smith }
6863e673d494SBarry Smith 
6864ef20d060SBarry Smith /*@C
68658b668821SLisandro Dalcin    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the error
6866ef20d060SBarry Smith        in a time based line graph
6867ef20d060SBarry Smith 
6868ef20d060SBarry Smith    Collective on TS
6869ef20d060SBarry Smith 
6870ef20d060SBarry Smith    Input Parameters:
6871ef20d060SBarry Smith +  ts - the TS context
6872ef20d060SBarry Smith .  step - current time-step
6873ef20d060SBarry Smith .  ptime - current time
68747db568b7SBarry Smith .  u - current solution
68757db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6876ef20d060SBarry Smith 
6877ef20d060SBarry Smith    Level: intermediate
6878ef20d060SBarry Smith 
687995452b02SPatrick Sanan    Notes:
688095452b02SPatrick Sanan     Each process in a parallel run displays its component errors in a separate window
6881abd5a294SJed Brown 
6882abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6883abd5a294SJed Brown 
6884abd5a294SJed Brown    Options Database Keys:
68854f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6886ef20d060SBarry Smith 
6887abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6888ef20d060SBarry Smith @*/
68890910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6890ef20d060SBarry Smith {
6891ef20d060SBarry Smith   PetscErrorCode    ierr;
68920b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6893ef20d060SBarry Smith   const PetscScalar *yy;
6894ef20d060SBarry Smith   Vec               y;
6895ef20d060SBarry Smith 
6896ef20d060SBarry Smith   PetscFunctionBegin;
6897a9f9c1f6SBarry Smith   if (!step) {
6898a9f9c1f6SBarry Smith     PetscDrawAxis axis;
68996934998bSLisandro Dalcin     PetscInt      dim;
6900a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
69018b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Error");CHKERRQ(ierr);
69020910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6903a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6904a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6905a9f9c1f6SBarry Smith   }
69060910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6907ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
69080910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6909ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6910e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6911e3efe391SJed Brown   {
6912e3efe391SJed Brown     PetscReal *yreal;
6913e3efe391SJed Brown     PetscInt  i,n;
6914e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6915785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6916e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
69170b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6918e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6919e3efe391SJed Brown   }
6920e3efe391SJed Brown #else
69210b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6922e3efe391SJed Brown #endif
6923ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6924ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6925b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
69260b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
69276934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
69283923b477SBarry Smith   }
6929ef20d060SBarry Smith   PetscFunctionReturn(0);
6930ef20d060SBarry Smith }
6931ef20d060SBarry Smith 
69325e3b7effSJoseph Pusztay /*@C
69335e3b7effSJoseph Pusztay    TSMonitorSPSwarmSolution - Graphically displays phase plots of DMSwarm particles on a scatter plot
69345e3b7effSJoseph Pusztay 
69355e3b7effSJoseph Pusztay    Input Parameters:
69365e3b7effSJoseph Pusztay +  ts - the TS context
69375e3b7effSJoseph Pusztay .  step - current time-step
69385e3b7effSJoseph Pusztay .  ptime - current time
69395e3b7effSJoseph Pusztay .  u - current solution
69405e3b7effSJoseph Pusztay -  dctx - the TSMonitorSPCtx object that contains all the options for the monitoring, this is created with TSMonitorSPCtxCreate()
69415e3b7effSJoseph Pusztay 
69425e3b7effSJoseph Pusztay    Options Database:
6943918b1d10SJoseph Pusztay .   -ts_monitor_sp_swarm
69445e3b7effSJoseph Pusztay 
69455e3b7effSJoseph Pusztay    Level: intermediate
69465e3b7effSJoseph Pusztay 
69475e3b7effSJoseph Pusztay @*/
69480ec8ee2bSJoseph Pusztay PetscErrorCode TSMonitorSPSwarmSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
69491b575b74SJoseph Pusztay {
69501b575b74SJoseph Pusztay   PetscErrorCode    ierr;
69511b575b74SJoseph Pusztay   TSMonitorSPCtx    ctx = (TSMonitorSPCtx)dctx;
69521b575b74SJoseph Pusztay   const PetscScalar *yy;
6953b1670a61SJoseph Pusztay   PetscReal       *y,*x;
69541b575b74SJoseph Pusztay   PetscInt          Np, p, dim=2;
69551b575b74SJoseph Pusztay   DM                dm;
69561b575b74SJoseph Pusztay 
69571b575b74SJoseph Pusztay   PetscFunctionBegin;
69581b575b74SJoseph Pusztay 
69591b575b74SJoseph Pusztay   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
69601b575b74SJoseph Pusztay   if (!step) {
69611b575b74SJoseph Pusztay     PetscDrawAxis axis;
69621b575b74SJoseph Pusztay     ierr = PetscDrawSPGetAxis(ctx->sp,&axis);CHKERRQ(ierr);
69631b575b74SJoseph Pusztay     ierr = PetscDrawAxisSetLabels(axis,"Particles","X","Y");CHKERRQ(ierr);
6964895f37d5SJoseph Pusztay     ierr = PetscDrawAxisSetLimits(axis, -5, 5, -5, 5);CHKERRQ(ierr);
6965895f37d5SJoseph Pusztay     ierr = PetscDrawAxisSetHoldLimits(axis, PETSC_TRUE);CHKERRQ(ierr);
69661b575b74SJoseph Pusztay     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
69671b575b74SJoseph Pusztay     ierr = DMGetDimension(dm, &dim);
69681b575b74SJoseph Pusztay     if (dim!=2) SETERRQ(PETSC_COMM_SELF, ierr, "Dimensions improper for monitor arguments! Current support: two dimensions.");CHKERRQ(ierr);
69691b575b74SJoseph Pusztay     ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr);
69701b575b74SJoseph Pusztay     Np /= 2*dim;
69711b575b74SJoseph Pusztay     ierr = PetscDrawSPSetDimension(ctx->sp, Np);CHKERRQ(ierr);
69721b575b74SJoseph Pusztay     ierr = PetscDrawSPReset(ctx->sp);CHKERRQ(ierr);
69731b575b74SJoseph Pusztay   }
69741b575b74SJoseph Pusztay 
69751b575b74SJoseph Pusztay   ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr);
69761b575b74SJoseph Pusztay   Np /= 2*dim;
69771b575b74SJoseph Pusztay   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
6978895f37d5SJoseph Pusztay   ierr = PetscMalloc2(Np, &x, Np, &y);CHKERRQ(ierr);
69791b575b74SJoseph Pusztay   /* get points from solution vector */
69801b575b74SJoseph Pusztay   for (p=0; p<Np; ++p){
6981b1670a61SJoseph Pusztay     x[p] = PetscRealPart(yy[2*dim*p]);
6982b1670a61SJoseph Pusztay     y[p] = PetscRealPart(yy[2*dim*p+1]);
6983895f37d5SJoseph Pusztay   }
69841b575b74SJoseph Pusztay   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
69851b575b74SJoseph Pusztay 
69861b575b74SJoseph Pusztay   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
69871b575b74SJoseph Pusztay     ierr = PetscDrawSPAddPoint(ctx->sp,x,y);CHKERRQ(ierr);
69881b575b74SJoseph Pusztay     ierr = PetscDrawSPDraw(ctx->sp,PETSC_FALSE);CHKERRQ(ierr);
69891b575b74SJoseph Pusztay     ierr = PetscDrawSPSave(ctx->sp);CHKERRQ(ierr);
69901b575b74SJoseph Pusztay   }
69911b575b74SJoseph Pusztay 
6992918b1d10SJoseph Pusztay   ierr = PetscFree2(x, y);CHKERRQ(ierr);
6993918b1d10SJoseph Pusztay 
69941b575b74SJoseph Pusztay   PetscFunctionReturn(0);
69951b575b74SJoseph Pusztay }
69961b575b74SJoseph Pusztay 
69971b575b74SJoseph Pusztay 
69981b575b74SJoseph Pusztay 
69997cf37e64SBarry Smith /*@C
70007cf37e64SBarry Smith    TSMonitorError - Monitors progress of the TS solvers by printing the 2 norm of the error at each timestep
70017cf37e64SBarry Smith 
70027cf37e64SBarry Smith    Collective on TS
70037cf37e64SBarry Smith 
70047cf37e64SBarry Smith    Input Parameters:
70057cf37e64SBarry Smith +  ts - the TS context
70067cf37e64SBarry Smith .  step - current time-step
70077cf37e64SBarry Smith .  ptime - current time
70087cf37e64SBarry Smith .  u - current solution
70097cf37e64SBarry Smith -  dctx - unused context
70107cf37e64SBarry Smith 
70117cf37e64SBarry Smith    Level: intermediate
70127cf37e64SBarry Smith 
70137cf37e64SBarry Smith    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
70147cf37e64SBarry Smith 
70157cf37e64SBarry Smith    Options Database Keys:
70167cf37e64SBarry Smith .  -ts_monitor_error - create a graphical monitor of error history
70177cf37e64SBarry Smith 
70187cf37e64SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
70197cf37e64SBarry Smith @*/
7020edbaebb3SBarry Smith PetscErrorCode  TSMonitorError(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
70217cf37e64SBarry Smith {
70227cf37e64SBarry Smith   PetscErrorCode    ierr;
70237cf37e64SBarry Smith   Vec               y;
70247cf37e64SBarry Smith   PetscReal         nrm;
7025edbaebb3SBarry Smith   PetscBool         flg;
70267cf37e64SBarry Smith 
70277cf37e64SBarry Smith   PetscFunctionBegin;
70287cf37e64SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
70297cf37e64SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
70307cf37e64SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
7031edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERASCII,&flg);CHKERRQ(ierr);
7032edbaebb3SBarry Smith   if (flg) {
70337cf37e64SBarry Smith     ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
7034edbaebb3SBarry Smith     ierr = PetscViewerASCIIPrintf(vf->viewer,"2-norm of error %g\n",(double)nrm);CHKERRQ(ierr);
7035edbaebb3SBarry Smith   }
7036edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERDRAW,&flg);CHKERRQ(ierr);
7037edbaebb3SBarry Smith   if (flg) {
7038edbaebb3SBarry Smith     ierr = VecView(y,vf->viewer);CHKERRQ(ierr);
7039edbaebb3SBarry Smith   }
7040edbaebb3SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
70417cf37e64SBarry Smith   PetscFunctionReturn(0);
70427cf37e64SBarry Smith }
70437cf37e64SBarry Smith 
7044201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7045201da799SBarry Smith {
7046201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7047201da799SBarry Smith   PetscReal      x   = ptime,y;
7048201da799SBarry Smith   PetscErrorCode ierr;
7049201da799SBarry Smith   PetscInt       its;
7050201da799SBarry Smith 
7051201da799SBarry Smith   PetscFunctionBegin;
705263e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7053201da799SBarry Smith   if (!n) {
7054201da799SBarry Smith     PetscDrawAxis axis;
7055201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7056201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
7057201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7058201da799SBarry Smith     ctx->snes_its = 0;
7059201da799SBarry Smith   }
7060201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
7061201da799SBarry Smith   y    = its - ctx->snes_its;
7062201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
70633fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7064201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
70656934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7066201da799SBarry Smith   }
7067201da799SBarry Smith   ctx->snes_its = its;
7068201da799SBarry Smith   PetscFunctionReturn(0);
7069201da799SBarry Smith }
7070201da799SBarry Smith 
7071201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7072201da799SBarry Smith {
7073201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7074201da799SBarry Smith   PetscReal      x   = ptime,y;
7075201da799SBarry Smith   PetscErrorCode ierr;
7076201da799SBarry Smith   PetscInt       its;
7077201da799SBarry Smith 
7078201da799SBarry Smith   PetscFunctionBegin;
707963e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7080201da799SBarry Smith   if (!n) {
7081201da799SBarry Smith     PetscDrawAxis axis;
7082201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7083201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
7084201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7085201da799SBarry Smith     ctx->ksp_its = 0;
7086201da799SBarry Smith   }
7087201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
7088201da799SBarry Smith   y    = its - ctx->ksp_its;
7089201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
709099fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7091201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
70926934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7093201da799SBarry Smith   }
7094201da799SBarry Smith   ctx->ksp_its = its;
7095201da799SBarry Smith   PetscFunctionReturn(0);
7096201da799SBarry Smith }
7097f9c1d6abSBarry Smith 
7098f9c1d6abSBarry Smith /*@
7099f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
7100f9c1d6abSBarry Smith 
7101d083f849SBarry Smith    Collective on TS
7102f9c1d6abSBarry Smith 
7103f9c1d6abSBarry Smith    Input Parameters:
7104f9c1d6abSBarry Smith +  ts - the TS context
7105f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
7106f9c1d6abSBarry Smith 
7107f9c1d6abSBarry Smith    Output Parameters:
7108f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
7109f9c1d6abSBarry Smith 
7110f9c1d6abSBarry Smith    Level: developer
7111f9c1d6abSBarry Smith 
7112f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
7113f9c1d6abSBarry Smith @*/
7114f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
7115f9c1d6abSBarry Smith {
7116f9c1d6abSBarry Smith   PetscErrorCode ierr;
7117f9c1d6abSBarry Smith 
7118f9c1d6abSBarry Smith   PetscFunctionBegin;
7119f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7120ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
7121f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
7122f9c1d6abSBarry Smith   PetscFunctionReturn(0);
7123f9c1d6abSBarry Smith }
712424655328SShri 
7125b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
7126b3d3934dSBarry Smith /*@C
7127b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
7128b3d3934dSBarry Smith 
7129b3d3934dSBarry Smith    Collective on TS
7130b3d3934dSBarry Smith 
7131b3d3934dSBarry Smith    Input Parameters:
7132b3d3934dSBarry Smith .  ts  - the ODE solver object
7133b3d3934dSBarry Smith 
7134b3d3934dSBarry Smith    Output Parameter:
7135b3d3934dSBarry Smith .  ctx - the context
7136b3d3934dSBarry Smith 
7137b3d3934dSBarry Smith    Level: intermediate
7138b3d3934dSBarry Smith 
7139b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
7140b3d3934dSBarry Smith 
7141b3d3934dSBarry Smith @*/
7142b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
7143b3d3934dSBarry Smith {
7144b3d3934dSBarry Smith   PetscErrorCode ierr;
7145b3d3934dSBarry Smith 
7146b3d3934dSBarry Smith   PetscFunctionBegin;
7147a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
7148b3d3934dSBarry Smith   PetscFunctionReturn(0);
7149b3d3934dSBarry Smith }
7150b3d3934dSBarry Smith 
7151b3d3934dSBarry Smith /*@C
7152b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
7153b3d3934dSBarry Smith 
7154b3d3934dSBarry Smith    Collective on TS
7155b3d3934dSBarry Smith 
7156b3d3934dSBarry Smith    Input Parameters:
7157b3d3934dSBarry Smith +  ts - the TS context
7158b3d3934dSBarry Smith .  step - current time-step
7159b3d3934dSBarry Smith .  ptime - current time
71607db568b7SBarry Smith .  u  - current solution
71617db568b7SBarry Smith -  dctx - the envelope context
7162b3d3934dSBarry Smith 
7163b3d3934dSBarry Smith    Options Database:
7164b3d3934dSBarry Smith .  -ts_monitor_envelope
7165b3d3934dSBarry Smith 
7166b3d3934dSBarry Smith    Level: intermediate
7167b3d3934dSBarry Smith 
716895452b02SPatrick Sanan    Notes:
716995452b02SPatrick Sanan     after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
7170b3d3934dSBarry Smith 
71717db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
7172b3d3934dSBarry Smith @*/
71737db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7174b3d3934dSBarry Smith {
7175b3d3934dSBarry Smith   PetscErrorCode       ierr;
71767db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
7177b3d3934dSBarry Smith 
7178b3d3934dSBarry Smith   PetscFunctionBegin;
7179b3d3934dSBarry Smith   if (!ctx->max) {
7180b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
7181b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
7182b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
7183b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
7184b3d3934dSBarry Smith   } else {
7185b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
7186b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
7187b3d3934dSBarry Smith   }
7188b3d3934dSBarry Smith   PetscFunctionReturn(0);
7189b3d3934dSBarry Smith }
7190b3d3934dSBarry Smith 
7191b3d3934dSBarry Smith /*@C
7192b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
7193b3d3934dSBarry Smith 
7194b3d3934dSBarry Smith    Collective on TS
7195b3d3934dSBarry Smith 
7196b3d3934dSBarry Smith    Input Parameter:
7197b3d3934dSBarry Smith .  ts - the TS context
7198b3d3934dSBarry Smith 
7199b3d3934dSBarry Smith    Output Parameter:
7200b3d3934dSBarry Smith +  max - the maximum values
7201b3d3934dSBarry Smith -  min - the minimum values
7202b3d3934dSBarry Smith 
720395452b02SPatrick Sanan    Notes:
720495452b02SPatrick Sanan     If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
72057db568b7SBarry Smith 
7206b3d3934dSBarry Smith    Level: intermediate
7207b3d3934dSBarry Smith 
7208b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7209b3d3934dSBarry Smith @*/
7210b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
7211b3d3934dSBarry Smith {
7212b3d3934dSBarry Smith   PetscInt i;
7213b3d3934dSBarry Smith 
7214b3d3934dSBarry Smith   PetscFunctionBegin;
7215b3d3934dSBarry Smith   if (max) *max = NULL;
7216b3d3934dSBarry Smith   if (min) *min = NULL;
7217b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7218b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
72195537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7220b3d3934dSBarry Smith       if (max) *max = ctx->max;
7221b3d3934dSBarry Smith       if (min) *min = ctx->min;
7222b3d3934dSBarry Smith       break;
7223b3d3934dSBarry Smith     }
7224b3d3934dSBarry Smith   }
7225b3d3934dSBarry Smith   PetscFunctionReturn(0);
7226b3d3934dSBarry Smith }
7227b3d3934dSBarry Smith 
7228b3d3934dSBarry Smith /*@C
7229b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7230b3d3934dSBarry Smith 
7231b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7232b3d3934dSBarry Smith 
7233b3d3934dSBarry Smith    Input Parameter:
7234b3d3934dSBarry Smith .  ctx - the monitor context
7235b3d3934dSBarry Smith 
7236b3d3934dSBarry Smith    Level: intermediate
7237b3d3934dSBarry Smith 
72387db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7239b3d3934dSBarry Smith @*/
7240b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7241b3d3934dSBarry Smith {
7242b3d3934dSBarry Smith   PetscErrorCode ierr;
7243b3d3934dSBarry Smith 
7244b3d3934dSBarry Smith   PetscFunctionBegin;
7245b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7246b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7247b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7248b3d3934dSBarry Smith   PetscFunctionReturn(0);
7249b3d3934dSBarry Smith }
7250f2dee214SBarry Smith 
725124655328SShri /*@
7252dcb233daSLisandro Dalcin    TSRestartStep - Flags the solver to restart the next step
7253dcb233daSLisandro Dalcin 
7254dcb233daSLisandro Dalcin    Collective on TS
7255dcb233daSLisandro Dalcin 
7256dcb233daSLisandro Dalcin    Input Parameter:
7257dcb233daSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
7258dcb233daSLisandro Dalcin 
7259dcb233daSLisandro Dalcin    Level: advanced
7260dcb233daSLisandro Dalcin 
7261dcb233daSLisandro Dalcin    Notes:
7262dcb233daSLisandro Dalcin    Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of
7263dcb233daSLisandro Dalcin    discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution
7264dcb233daSLisandro Dalcin    vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For
7265dcb233daSLisandro Dalcin    the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce
7266dcb233daSLisandro Dalcin    discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with
7267dcb233daSLisandro Dalcin    discontinuous source terms).
7268dcb233daSLisandro Dalcin 
7269dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep()
7270dcb233daSLisandro Dalcin @*/
7271dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts)
7272dcb233daSLisandro Dalcin {
7273dcb233daSLisandro Dalcin   PetscFunctionBegin;
7274dcb233daSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7275dcb233daSLisandro Dalcin   ts->steprestart = PETSC_TRUE;
7276dcb233daSLisandro Dalcin   PetscFunctionReturn(0);
7277dcb233daSLisandro Dalcin }
7278dcb233daSLisandro Dalcin 
7279dcb233daSLisandro Dalcin /*@
728024655328SShri    TSRollBack - Rolls back one time step
728124655328SShri 
728224655328SShri    Collective on TS
728324655328SShri 
728424655328SShri    Input Parameter:
728524655328SShri .  ts - the TS context obtained from TSCreate()
728624655328SShri 
728724655328SShri    Level: advanced
728824655328SShri 
728924655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
729024655328SShri @*/
729124655328SShri PetscErrorCode  TSRollBack(TS ts)
729224655328SShri {
729324655328SShri   PetscErrorCode ierr;
729424655328SShri 
729524655328SShri   PetscFunctionBegin;
729624655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7297b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
729824655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
729924655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
730024655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
730124655328SShri   ts->ptime = ts->ptime_prev;
7302be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
73032808aa04SLisandro Dalcin   ts->steps--;
7304b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
730524655328SShri   PetscFunctionReturn(0);
730624655328SShri }
7307aeb4809dSShri Abhyankar 
7308ff22ae23SHong Zhang /*@
7309ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7310ff22ae23SHong Zhang 
7311ff22ae23SHong Zhang    Input Parameter:
7312ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7313ff22ae23SHong Zhang 
73140429704eSStefano Zampini    Output Parameters:
73150429704eSStefano Zampini +  ns - the number of stages
73160429704eSStefano Zampini -  Y - the current stage vectors
73170429704eSStefano Zampini 
7318ff22ae23SHong Zhang    Level: advanced
7319ff22ae23SHong Zhang 
73200429704eSStefano Zampini    Notes: Both ns and Y can be NULL.
73210429704eSStefano Zampini 
7322ff22ae23SHong Zhang .seealso: TSCreate()
7323ff22ae23SHong Zhang @*/
7324ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7325ff22ae23SHong Zhang {
7326ff22ae23SHong Zhang   PetscErrorCode ierr;
7327ff22ae23SHong Zhang 
7328ff22ae23SHong Zhang   PetscFunctionBegin;
7329ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
73300429704eSStefano Zampini   if (ns) PetscValidPointer(ns,2);
73310429704eSStefano Zampini   if (Y) PetscValidPointer(Y,3);
73320429704eSStefano Zampini   if (!ts->ops->getstages) {
73330429704eSStefano Zampini     if (ns) *ns = 0;
73340429704eSStefano Zampini     if (Y) *Y = NULL;
73350429704eSStefano Zampini   } else {
7336ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7337ff22ae23SHong Zhang   }
7338ff22ae23SHong Zhang   PetscFunctionReturn(0);
7339ff22ae23SHong Zhang }
7340ff22ae23SHong Zhang 
7341847ff0e1SMatthew G. Knepley /*@C
7342847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7343847ff0e1SMatthew G. Knepley 
7344847ff0e1SMatthew G. Knepley   Collective on SNES
7345847ff0e1SMatthew G. Knepley 
7346847ff0e1SMatthew G. Knepley   Input Parameters:
7347847ff0e1SMatthew G. Knepley + ts - the TS context
7348847ff0e1SMatthew G. Knepley . t - current timestep
7349847ff0e1SMatthew G. Knepley . U - state vector
7350847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7351847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7352847ff0e1SMatthew G. Knepley - ctx - an optional user context
7353847ff0e1SMatthew G. Knepley 
7354847ff0e1SMatthew G. Knepley   Output Parameters:
7355847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7356847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7357847ff0e1SMatthew G. Knepley 
7358847ff0e1SMatthew G. Knepley   Level: intermediate
7359847ff0e1SMatthew G. Knepley 
7360847ff0e1SMatthew G. Knepley   Notes:
7361847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7362847ff0e1SMatthew G. Knepley 
7363847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7364847ff0e1SMatthew G. Knepley 
7365847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7366847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7367847ff0e1SMatthew G. Knepley 
7368847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7369847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7370847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7371847ff0e1SMatthew G. Knepley 
7372847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7373847ff0e1SMatthew G. Knepley @*/
7374847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7375847ff0e1SMatthew G. Knepley {
7376847ff0e1SMatthew G. Knepley   SNES           snes;
7377847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7378847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7379847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
7380847ff0e1SMatthew G. Knepley 
7381847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
7382c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
7383847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
7384847ff0e1SMatthew G. Knepley   if (!color) {
7385847ff0e1SMatthew G. Knepley     DM         dm;
7386847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
7387847ff0e1SMatthew G. Knepley 
7388847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
7389847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
7390847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
7391847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
7392847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7393847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7394847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7395847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7396847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7397847ff0e1SMatthew G. Knepley     } else {
7398847ff0e1SMatthew G. Knepley       MatColoring mc;
7399847ff0e1SMatthew G. Knepley 
7400847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
7401847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
7402847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
7403847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
7404847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
7405847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
7406847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7407847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7408847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7409847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7410847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7411847ff0e1SMatthew G. Knepley     }
7412847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
7413847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
7414847ff0e1SMatthew G. Knepley   }
7415847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
7416847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
7417847ff0e1SMatthew G. Knepley   if (J != B) {
7418847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7419847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7420847ff0e1SMatthew G. Knepley   }
7421847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
7422847ff0e1SMatthew G. Knepley }
742393b34091SDebojyoti Ghosh 
7424cb9d8021SPierre Barbier de Reuille /*@
74256bc98fa9SBarry Smith     TSSetFunctionDomainError - Set a function that tests if the current state vector is valid
7426cb9d8021SPierre Barbier de Reuille 
7427cb9d8021SPierre Barbier de Reuille     Input Parameters:
74286bc98fa9SBarry Smith +    ts - the TS context
74296bc98fa9SBarry Smith -    func - function called within TSFunctionDomainError
74306bc98fa9SBarry Smith 
74316bc98fa9SBarry Smith     Calling sequence of func:
74326bc98fa9SBarry Smith $     PetscErrorCode func(TS ts,PetscReal time,Vec state,PetscBool reject)
74336bc98fa9SBarry Smith 
74346bc98fa9SBarry Smith +   ts - the TS context
74356bc98fa9SBarry Smith .   time - the current time (of the stage)
74366bc98fa9SBarry Smith .   state - the state to check if it is valid
74376bc98fa9SBarry Smith -   reject - (output parameter) PETSC_FALSE if the state is acceptable, PETSC_TRUE if not acceptable
7438cb9d8021SPierre Barbier de Reuille 
7439cb9d8021SPierre Barbier de Reuille     Level: intermediate
7440cb9d8021SPierre Barbier de Reuille 
74416bc98fa9SBarry Smith     Notes:
74426bc98fa9SBarry Smith       If an implicit ODE solver is being used then, in addition to providing this routine, the
74436bc98fa9SBarry Smith       user's code should call SNESSetFunctionDomainError() when domain errors occur during
74446bc98fa9SBarry Smith       function evaluations where the functions are provided by TSSetIFunction() or TSSetRHSFunction().
74456bc98fa9SBarry Smith       Use TSGetSNES() to obtain the SNES object
74466bc98fa9SBarry Smith 
74476bc98fa9SBarry Smith     Developer Notes:
74486bc98fa9SBarry Smith       The naming of this function is inconsistent with the SNESSetFunctionDomainError()
74496bc98fa9SBarry Smith       since one takes a function pointer and the other does not.
74506bc98fa9SBarry Smith 
74516bc98fa9SBarry Smith .seealso: TSAdaptCheckStage(), TSFunctionDomainError(), SNESSetFunctionDomainError(), TSGetSNES()
7452cb9d8021SPierre Barbier de Reuille @*/
7453cb9d8021SPierre Barbier de Reuille 
7454d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
7455cb9d8021SPierre Barbier de Reuille {
7456cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7457cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7458cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
7459cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7460cb9d8021SPierre Barbier de Reuille }
7461cb9d8021SPierre Barbier de Reuille 
7462cb9d8021SPierre Barbier de Reuille /*@
74636bc98fa9SBarry Smith     TSFunctionDomainError - Checks if the current state is valid
7464cb9d8021SPierre Barbier de Reuille 
7465cb9d8021SPierre Barbier de Reuille     Input Parameters:
74666bc98fa9SBarry Smith +    ts - the TS context
74676bc98fa9SBarry Smith .    stagetime - time of the simulation
74686bc98fa9SBarry Smith -    Y - state vector to check.
7469cb9d8021SPierre Barbier de Reuille 
7470cb9d8021SPierre Barbier de Reuille     Output Parameter:
74716bc98fa9SBarry Smith .    accept - Set to PETSC_FALSE if the current state vector is valid.
7472cb9d8021SPierre Barbier de Reuille 
7473cb9d8021SPierre Barbier de Reuille     Note:
74746bc98fa9SBarry Smith     This function is called by the TS integration routines and calls the user provided function (set with TSSetFunctionDomainError())
74756bc98fa9SBarry Smith     to check if the current state is valid.
747696a0c994SBarry Smith 
74776bc98fa9SBarry Smith     Level: developer
74786bc98fa9SBarry Smith 
74796bc98fa9SBarry Smith .seealso: TSSetFunctionDomainError()
7480cb9d8021SPierre Barbier de Reuille @*/
7481d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
7482cb9d8021SPierre Barbier de Reuille {
7483cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7484cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7485cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
7486cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
7487d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
7488cb9d8021SPierre Barbier de Reuille   }
7489cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7490cb9d8021SPierre Barbier de Reuille }
74911ceb14c0SBarry Smith 
749293b34091SDebojyoti Ghosh /*@C
7493e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
749493b34091SDebojyoti Ghosh 
7495d083f849SBarry Smith   Collective
749693b34091SDebojyoti Ghosh 
749793b34091SDebojyoti Ghosh   Input Parameter:
749893b34091SDebojyoti Ghosh . tsin    - The input TS
749993b34091SDebojyoti Ghosh 
750093b34091SDebojyoti Ghosh   Output Parameter:
7501e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
750293b34091SDebojyoti Ghosh 
75035eca1a21SEmil Constantinescu   Notes:
75045eca1a21SEmil 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.
75055eca1a21SEmil Constantinescu 
7506928bb9adSStefano 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);
75075eca1a21SEmil Constantinescu 
75085eca1a21SEmil Constantinescu   Level: developer
750993b34091SDebojyoti Ghosh 
7510e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
751193b34091SDebojyoti Ghosh @*/
7512baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
751393b34091SDebojyoti Ghosh {
751493b34091SDebojyoti Ghosh   TS             t;
751593b34091SDebojyoti Ghosh   PetscErrorCode ierr;
7516dc846ba4SSatish Balay   SNES           snes_start;
7517dc846ba4SSatish Balay   DM             dm;
7518dc846ba4SSatish Balay   TSType         type;
751993b34091SDebojyoti Ghosh 
752093b34091SDebojyoti Ghosh   PetscFunctionBegin;
752193b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
752293b34091SDebojyoti Ghosh   *tsout = NULL;
752393b34091SDebojyoti Ghosh 
75247a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
752593b34091SDebojyoti Ghosh 
752693b34091SDebojyoti Ghosh   /* General TS description */
752793b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
752893b34091SDebojyoti Ghosh   t->setupcalled       = 0;
752993b34091SDebojyoti Ghosh   t->ksp_its           = 0;
753093b34091SDebojyoti Ghosh   t->snes_its          = 0;
753193b34091SDebojyoti Ghosh   t->nwork             = 0;
75327d51462cSStefano Zampini   t->rhsjacobian.time  = PETSC_MIN_REAL;
753393b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
753493b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
753593b34091SDebojyoti Ghosh 
753634561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
753734561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
7538d15a3a53SEmil Constantinescu 
753993b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
754093b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
754193b34091SDebojyoti Ghosh 
754293b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
754351699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
754493b34091SDebojyoti Ghosh 
7545e7069c78SShri   t->trajectory = tsin->trajectory;
7546e7069c78SShri   ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr);
7547e7069c78SShri 
7548e7069c78SShri   t->event = tsin->event;
75496b10a48eSSatish Balay   if (t->event) t->event->refct++;
7550e7069c78SShri 
755193b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
755293b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
7553e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
755493b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
755593b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
755693b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
755793b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
755893b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
755993b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
756093b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
756193b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
756293b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
756393b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
756493b34091SDebojyoti Ghosh 
756593b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
756693b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
756793b34091SDebojyoti Ghosh 
756893b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
756993b34091SDebojyoti Ghosh 
757093b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
757193b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
757293b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
757393b34091SDebojyoti Ghosh 
757493b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
757593b34091SDebojyoti Ghosh 
75760d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
75770d4fed19SBarry Smith     PetscInt i;
75780d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
75790d4fed19SBarry Smith     for (i=0; i<10; i++) {
75800d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
75810d4fed19SBarry Smith     }
75820d4fed19SBarry Smith   }
758393b34091SDebojyoti Ghosh   *tsout = t;
758493b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
758593b34091SDebojyoti Ghosh }
7586f3b1f45cSBarry Smith 
7587f3b1f45cSBarry Smith static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void* ctx,Vec x,Vec y)
7588f3b1f45cSBarry Smith {
7589f3b1f45cSBarry Smith   PetscErrorCode ierr;
7590f3b1f45cSBarry Smith   TS             ts = (TS) ctx;
7591f3b1f45cSBarry Smith 
7592f3b1f45cSBarry Smith   PetscFunctionBegin;
7593f3b1f45cSBarry Smith   ierr = TSComputeRHSFunction(ts,0,x,y);CHKERRQ(ierr);
7594f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7595f3b1f45cSBarry Smith }
7596f3b1f45cSBarry Smith 
7597f3b1f45cSBarry Smith /*@
7598f3b1f45cSBarry Smith     TSRHSJacobianTest - Compares the multiply routine provided to the MATSHELL with differencing on the TS given RHS function.
7599f3b1f45cSBarry Smith 
7600d083f849SBarry Smith    Logically Collective on TS
7601f3b1f45cSBarry Smith 
7602f3b1f45cSBarry Smith     Input Parameters:
7603f3b1f45cSBarry Smith     TS - the time stepping routine
7604f3b1f45cSBarry Smith 
7605f3b1f45cSBarry Smith    Output Parameter:
7606f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
7607f3b1f45cSBarry Smith 
7608f3b1f45cSBarry Smith    Options Database:
7609f3b1f45cSBarry Smith  .   -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator
7610f3b1f45cSBarry Smith 
7611f3b1f45cSBarry Smith    Level: advanced
7612f3b1f45cSBarry Smith 
761395452b02SPatrick Sanan    Notes:
761495452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
7615f3b1f45cSBarry Smith 
7616f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTestTranspose()
7617f3b1f45cSBarry Smith @*/
7618f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTest(TS ts,PetscBool *flg)
7619f3b1f45cSBarry Smith {
7620f3b1f45cSBarry Smith   Mat            J,B;
7621f3b1f45cSBarry Smith   PetscErrorCode ierr;
7622f3b1f45cSBarry Smith   TSRHSJacobian  func;
7623f3b1f45cSBarry Smith   void*          ctx;
7624f3b1f45cSBarry Smith 
7625f3b1f45cSBarry Smith   PetscFunctionBegin;
7626f3b1f45cSBarry Smith   ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr);
7627f3b1f45cSBarry Smith   ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr);
7628f3b1f45cSBarry Smith   ierr = MatShellTestMult(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr);
7629f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7630f3b1f45cSBarry Smith }
7631f3b1f45cSBarry Smith 
7632f3b1f45cSBarry Smith /*@C
7633f3b1f45cSBarry Smith     TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the MATSHELL with differencing on the TS given RHS function.
7634f3b1f45cSBarry Smith 
7635d083f849SBarry Smith    Logically Collective on TS
7636f3b1f45cSBarry Smith 
7637f3b1f45cSBarry Smith     Input Parameters:
7638f3b1f45cSBarry Smith     TS - the time stepping routine
7639f3b1f45cSBarry Smith 
7640f3b1f45cSBarry Smith    Output Parameter:
7641f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
7642f3b1f45cSBarry Smith 
7643f3b1f45cSBarry Smith    Options Database:
7644f3b1f45cSBarry Smith .   -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator
7645f3b1f45cSBarry Smith 
764695452b02SPatrick Sanan    Notes:
764795452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
7648f3b1f45cSBarry Smith 
7649f3b1f45cSBarry Smith    Level: advanced
7650f3b1f45cSBarry Smith 
7651f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTest()
7652f3b1f45cSBarry Smith @*/
7653f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTestTranspose(TS ts,PetscBool *flg)
7654f3b1f45cSBarry Smith {
7655f3b1f45cSBarry Smith   Mat            J,B;
7656f3b1f45cSBarry Smith   PetscErrorCode ierr;
7657f3b1f45cSBarry Smith   void           *ctx;
7658f3b1f45cSBarry Smith   TSRHSJacobian  func;
7659f3b1f45cSBarry Smith 
7660f3b1f45cSBarry Smith   PetscFunctionBegin;
7661f3b1f45cSBarry Smith   ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr);
7662f3b1f45cSBarry Smith   ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr);
7663f3b1f45cSBarry Smith   ierr = MatShellTestMultTranspose(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr);
7664f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7665f3b1f45cSBarry Smith }
76660fe4d17eSHong Zhang 
76670fe4d17eSHong Zhang /*@
76680fe4d17eSHong Zhang   TSSetUseSplitRHSFunction - Use the split RHSFunction when a multirate method is used.
76690fe4d17eSHong Zhang 
76700fe4d17eSHong Zhang   Logically collective
76710fe4d17eSHong Zhang 
76720fe4d17eSHong Zhang   Input Parameter:
76730fe4d17eSHong Zhang +  ts - timestepping context
76740fe4d17eSHong Zhang -  use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used
76750fe4d17eSHong Zhang 
76760fe4d17eSHong Zhang   Options Database:
76770fe4d17eSHong Zhang .   -ts_use_splitrhsfunction - <true,false>
76780fe4d17eSHong Zhang 
76790fe4d17eSHong Zhang   Notes:
76800fe4d17eSHong Zhang     This is only useful for multirate methods
76810fe4d17eSHong Zhang 
76820fe4d17eSHong Zhang   Level: intermediate
76830fe4d17eSHong Zhang 
76840fe4d17eSHong Zhang .seealso: TSGetUseSplitRHSFunction()
76850fe4d17eSHong Zhang @*/
76860fe4d17eSHong Zhang PetscErrorCode TSSetUseSplitRHSFunction(TS ts, PetscBool use_splitrhsfunction)
76870fe4d17eSHong Zhang {
76880fe4d17eSHong Zhang   PetscFunctionBegin;
76890fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
76900fe4d17eSHong Zhang   ts->use_splitrhsfunction = use_splitrhsfunction;
76910fe4d17eSHong Zhang   PetscFunctionReturn(0);
76920fe4d17eSHong Zhang }
76930fe4d17eSHong Zhang 
76940fe4d17eSHong Zhang /*@
76950fe4d17eSHong Zhang   TSGetUseSplitRHSFunction - Gets whether to use the split RHSFunction when a multirate method is used.
76960fe4d17eSHong Zhang 
76970fe4d17eSHong Zhang   Not collective
76980fe4d17eSHong Zhang 
76990fe4d17eSHong Zhang   Input Parameter:
77000fe4d17eSHong Zhang .  ts - timestepping context
77010fe4d17eSHong Zhang 
77020fe4d17eSHong Zhang   Output Parameter:
77030fe4d17eSHong Zhang .  use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used
77040fe4d17eSHong Zhang 
77050fe4d17eSHong Zhang   Level: intermediate
77060fe4d17eSHong Zhang 
77070fe4d17eSHong Zhang .seealso: TSSetUseSplitRHSFunction()
77080fe4d17eSHong Zhang @*/
77090fe4d17eSHong Zhang PetscErrorCode TSGetUseSplitRHSFunction(TS ts, PetscBool *use_splitrhsfunction)
77100fe4d17eSHong Zhang {
77110fe4d17eSHong Zhang   PetscFunctionBegin;
77120fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
77130fe4d17eSHong Zhang   *use_splitrhsfunction = ts->use_splitrhsfunction;
77140fe4d17eSHong Zhang   PetscFunctionReturn(0);
77150fe4d17eSHong Zhang }
7716