xref: /petsc/src/ts/interface/ts.c (revision 2663174ec5429ec9e8210559e7b2e2603482cd09)
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) {
1970b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1983923b477SBarry Smith     PetscInt       howoften = 1;
199b3603a34SBarry Smith 
2000298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
201c793f718SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2024f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
203bdad233fSMatthew Knepley   }
2046ba87a44SLisandro Dalcin 
2054f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
206ef20d060SBarry Smith   if (opt) {
2070b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2083923b477SBarry Smith     PetscInt       howoften = 1;
209ef20d060SBarry Smith 
2100298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
211c793f718SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2124f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
213ef20d060SBarry Smith   }
214edbaebb3SBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_error","View the error at each timestep","TSMonitorError",TSMonitorError,NULL);CHKERRQ(ierr);
2157cf37e64SBarry Smith 
2166934998bSLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2176934998bSLisandro Dalcin   if (opt) {
2186934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
2196934998bSLisandro Dalcin     PetscInt       howoften = 1;
2206934998bSLisandro Dalcin 
2216934998bSLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2226ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2236934998bSLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2246934998bSLisandro Dalcin   }
2258b668821SLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2268b668821SLisandro Dalcin   if (opt) {
2278b668821SLisandro Dalcin     TSMonitorLGCtx ctx;
2288b668821SLisandro Dalcin     PetscInt       howoften = 1;
2298b668821SLisandro Dalcin 
2308b668821SLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2318b668821SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2328b668821SLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2338b668821SLisandro Dalcin     ctx->semilogy = PETSC_TRUE;
2348b668821SLisandro Dalcin   }
2358b668821SLisandro Dalcin 
236201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
237201da799SBarry Smith   if (opt) {
238201da799SBarry Smith     TSMonitorLGCtx ctx;
239201da799SBarry Smith     PetscInt       howoften = 1;
240201da799SBarry Smith 
2410298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2426ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
243201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
244201da799SBarry Smith   }
245201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
246201da799SBarry Smith   if (opt) {
247201da799SBarry Smith     TSMonitorLGCtx ctx;
248201da799SBarry Smith     PetscInt       howoften = 1;
249201da799SBarry Smith 
2500298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2516ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
252201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
253201da799SBarry Smith   }
2548189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
2558189c53fSBarry Smith   if (opt) {
2568189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2578189c53fSBarry Smith     PetscInt          howoften = 1;
2588189c53fSBarry Smith 
2590298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
260c793f718SLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2618189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
2628189c53fSBarry Smith   }
2630ec8ee2bSJoseph Pusztay   ierr = PetscOptionsName("-ts_monitor_sp_swarm","Display particle phase from the DMSwarm","TSMonitorSPSwarm",&opt);CHKERRQ(ierr);
2641b575b74SJoseph Pusztay   if (opt) {
2651b575b74SJoseph Pusztay     TSMonitorSPCtx  ctx;
2661b575b74SJoseph Pusztay     PetscInt        howoften = 1;
2670ec8ee2bSJoseph Pusztay     ierr = PetscOptionsInt("-ts_monitor_sp_swarm","Display particles phase from the DMSwarm","TSMonitorSPSwarm",howoften,&howoften,NULL);CHKERRQ(ierr);
2681b575b74SJoseph Pusztay     ierr = TSMonitorSPCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx);CHKERRQ(ierr);
2690ec8ee2bSJoseph Pusztay     ierr = TSMonitorSet(ts, TSMonitorSPSwarmSolution, ctx, (PetscErrorCode (*)(void**))TSMonitorSPCtxDestroy);CHKERRQ(ierr);
2701b575b74SJoseph Pusztay   }
271ef20d060SBarry Smith   opt  = PETSC_FALSE;
2720dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
273a7cc72afSBarry Smith   if (opt) {
27483a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
27583a4ac43SBarry Smith     PetscInt         howoften = 1;
276a80ad3e0SBarry Smith 
2770298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
278c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
27983a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
280bdad233fSMatthew Knepley   }
281fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2822d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
2832d5ee99bSBarry Smith   if (opt) {
2842d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2852d5ee99bSBarry Smith     PetscReal        bounds[4];
2862d5ee99bSBarry Smith     PetscInt         n = 4;
2872d5ee99bSBarry Smith     PetscDraw        draw;
2886934998bSLisandro Dalcin     PetscDrawAxis    axis;
2892d5ee99bSBarry Smith 
2902d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
2912d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
292c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr);
2932d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
2946934998bSLisandro Dalcin     ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr);
2956934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
2966934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
2972d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2982d5ee99bSBarry Smith   }
2992d5ee99bSBarry Smith   opt  = PETSC_FALSE;
3000dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
3013a471f94SBarry Smith   if (opt) {
30283a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
30383a4ac43SBarry Smith     PetscInt         howoften = 1;
3043a471f94SBarry Smith 
3050298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
306c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
30783a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3083a471f94SBarry Smith   }
3090ed3bfb6SBarry Smith   opt  = PETSC_FALSE;
3100ed3bfb6SBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt);CHKERRQ(ierr);
3110ed3bfb6SBarry Smith   if (opt) {
3120ed3bfb6SBarry Smith     TSMonitorDrawCtx ctx;
3130ed3bfb6SBarry Smith     PetscInt         howoften = 1;
3140ed3bfb6SBarry Smith 
3150ed3bfb6SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL);CHKERRQ(ierr);
316c793f718SLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3170ed3bfb6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3180ed3bfb6SBarry Smith   }
319fde5950dSBarry Smith 
320ed81e22dSJed Brown   opt  = PETSC_FALSE;
321589a23caSBarry 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);
322ed81e22dSJed Brown   if (flg) {
323ed81e22dSJed Brown     const char *ptr,*ptr2;
324ed81e22dSJed Brown     char       *filetemplate;
325ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
326ed81e22dSJed Brown     /* Do some cursory validation of the input. */
327ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
328ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
329ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
330ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
331ce94432eSBarry 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");
332ed81e22dSJed Brown       if (ptr2) break;
333ed81e22dSJed Brown     }
334ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
335ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
336ed81e22dSJed Brown   }
337bdad233fSMatthew Knepley 
338589a23caSBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,sizeof(dir),&flg);CHKERRQ(ierr);
339d1212d36SBarry Smith   if (flg) {
340d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
341d1212d36SBarry Smith     int                  ray = 0;
3423ee9839eSMatthew G. Knepley     DMDirection          ddir;
343d1212d36SBarry Smith     DM                   da;
344d1212d36SBarry Smith     PetscMPIInt          rank;
345d1212d36SBarry Smith 
346ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
3473ee9839eSMatthew G. Knepley     if (dir[0] == 'x') ddir = DM_X;
3483ee9839eSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DM_Y;
349ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
350d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
351d1212d36SBarry Smith 
3525bd1e576SStefano Zampini     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %d\n",dir[0],ray);CHKERRQ(ierr);
353b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
354d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
355d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
356ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
357d1212d36SBarry Smith     if (!rank) {
358c793f718SLisandro Dalcin       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,NULL,NULL,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
359d1212d36SBarry Smith     }
36051b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
361d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
362d1212d36SBarry Smith   }
363589a23caSBarry Smith   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,sizeof(dir),&flg);CHKERRQ(ierr);
36451b4a12fSMatthew G. Knepley   if (flg) {
36551b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
36651b4a12fSMatthew G. Knepley     int                 ray = 0;
3673ee9839eSMatthew G. Knepley     DMDirection         ddir;
36851b4a12fSMatthew G. Knepley     DM                  da;
36951b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
370d1212d36SBarry Smith 
37151b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
3723ee9839eSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DM_X;
3733ee9839eSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DM_Y;
37451b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
37551b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3761c3436cfSJed Brown 
3775bd1e576SStefano Zampini     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %d\n", dir[0], ray);CHKERRQ(ierr);
378b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
37951b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
38051b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
381c793f718SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
38251b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
38351b4a12fSMatthew G. Knepley   }
384a7a1495cSBarry Smith 
385b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
386b3d3934dSBarry Smith   if (opt) {
387b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
388b3d3934dSBarry Smith 
389b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
390b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
391b3d3934dSBarry Smith   }
392b3d3934dSBarry Smith 
393847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
394847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
395847ff0e1SMatthew G. Knepley   if (flg) {
396847ff0e1SMatthew G. Knepley     DM   dm;
397847ff0e1SMatthew G. Knepley     DMTS tdm;
398847ff0e1SMatthew G. Knepley 
399847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
400847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
401847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
402c793f718SLisandro Dalcin     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, NULL);CHKERRQ(ierr);
403847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
404847ff0e1SMatthew G. Knepley   }
405847ff0e1SMatthew G. Knepley 
406d763cef2SBarry Smith   /* Handle specific TS options */
407d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
4086991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
409d763cef2SBarry Smith   }
410fbc52257SHong Zhang 
411a7bdc993SLisandro Dalcin   /* Handle TSAdapt options */
412a7bdc993SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
413a7bdc993SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
414a7bdc993SLisandro Dalcin   ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr);
415a7bdc993SLisandro Dalcin 
41668bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
4174f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
41868bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
41968bece0bSHong Zhang   if (tflg) {
42068bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
42168bece0bSHong Zhang   }
422a05bf03eSHong Zhang 
423a05bf03eSHong Zhang   ierr = TSAdjointSetFromOptions(PetscOptionsObject,ts);CHKERRQ(ierr);
424d763cef2SBarry Smith 
425d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
4260633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
427fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
428d763cef2SBarry Smith 
4294f122a70SLisandro Dalcin   if (ts->trajectory) {
4304f122a70SLisandro Dalcin     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
431d763cef2SBarry Smith   }
43268bece0bSHong Zhang 
4331ef27442SStefano Zampini   /* why do we have to do this here and not during TSSetUp? */
4344f122a70SLisandro Dalcin   ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr);
4351ef27442SStefano Zampini   if (ts->problem_type == TS_LINEAR) {
4361ef27442SStefano Zampini     ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&flg,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr);
4371ef27442SStefano Zampini     if (!flg) { ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); }
4381ef27442SStefano Zampini   }
4394f122a70SLisandro Dalcin   ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
440d763cef2SBarry Smith   PetscFunctionReturn(0);
441d763cef2SBarry Smith }
442d763cef2SBarry Smith 
443d2daff3dSHong Zhang /*@
44478fbdcc8SBarry Smith    TSGetTrajectory - Gets the trajectory from a TS if it exists
44578fbdcc8SBarry Smith 
44678fbdcc8SBarry Smith    Collective on TS
44778fbdcc8SBarry Smith 
44878fbdcc8SBarry Smith    Input Parameters:
44978fbdcc8SBarry Smith .  ts - the TS context obtained from TSCreate()
45078fbdcc8SBarry Smith 
4517a7aea1fSJed Brown    Output Parameters:
45278fbdcc8SBarry Smith .  tr - the TSTrajectory object, if it exists
45378fbdcc8SBarry Smith 
45478fbdcc8SBarry Smith    Note: This routine should be called after all TS options have been set
45578fbdcc8SBarry Smith 
45678fbdcc8SBarry Smith    Level: advanced
45778fbdcc8SBarry Smith 
45878fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate()
45978fbdcc8SBarry Smith 
46078fbdcc8SBarry Smith @*/
46178fbdcc8SBarry Smith PetscErrorCode  TSGetTrajectory(TS ts,TSTrajectory *tr)
46278fbdcc8SBarry Smith {
46378fbdcc8SBarry Smith   PetscFunctionBegin;
46478fbdcc8SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
46578fbdcc8SBarry Smith   *tr = ts->trajectory;
46678fbdcc8SBarry Smith   PetscFunctionReturn(0);
46778fbdcc8SBarry Smith }
46878fbdcc8SBarry Smith 
46978fbdcc8SBarry Smith /*@
470bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
471d2daff3dSHong Zhang 
472d2daff3dSHong Zhang    Collective on TS
473d2daff3dSHong Zhang 
474d2daff3dSHong Zhang    Input Parameters:
475bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
476bc952696SBarry Smith 
47778fbdcc8SBarry Smith    Options Database:
47878fbdcc8SBarry Smith +  -ts_save_trajectory - saves the trajectory to a file
47978fbdcc8SBarry Smith -  -ts_trajectory_type type
48078fbdcc8SBarry Smith 
48168bece0bSHong Zhang Note: This routine should be called after all TS options have been set
482d2daff3dSHong Zhang 
483c3a89c15SBarry Smith     The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/lib/petsc/bin/PetscBinaryIOTrajectory.py and
48478fbdcc8SBarry Smith    MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m
48578fbdcc8SBarry Smith 
486d2daff3dSHong Zhang    Level: intermediate
487d2daff3dSHong Zhang 
4882d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve()
489d2daff3dSHong Zhang 
490d2daff3dSHong Zhang @*/
491bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
492d2daff3dSHong Zhang {
493bc952696SBarry Smith   PetscErrorCode ierr;
494bc952696SBarry Smith 
495d2daff3dSHong Zhang   PetscFunctionBegin;
496d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
497bc952696SBarry Smith   if (!ts->trajectory) {
498bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
499bc952696SBarry Smith   }
500d2daff3dSHong Zhang   PetscFunctionReturn(0);
501d2daff3dSHong Zhang }
502d2daff3dSHong Zhang 
503a7a1495cSBarry Smith /*@
5042d29f1f2SStefano Zampini    TSResetTrajectory - Destroys and recreates the internal TSTrajectory object
5052d29f1f2SStefano Zampini 
5062d29f1f2SStefano Zampini    Collective on TS
5072d29f1f2SStefano Zampini 
5082d29f1f2SStefano Zampini    Input Parameters:
5092d29f1f2SStefano Zampini .  ts - the TS context obtained from TSCreate()
5102d29f1f2SStefano Zampini 
5112d29f1f2SStefano Zampini    Level: intermediate
5122d29f1f2SStefano Zampini 
5132d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve()
5142d29f1f2SStefano Zampini 
5152d29f1f2SStefano Zampini @*/
5162d29f1f2SStefano Zampini PetscErrorCode  TSResetTrajectory(TS ts)
5172d29f1f2SStefano Zampini {
5182d29f1f2SStefano Zampini   PetscErrorCode ierr;
5192d29f1f2SStefano Zampini 
5202d29f1f2SStefano Zampini   PetscFunctionBegin;
5212d29f1f2SStefano Zampini   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5222d29f1f2SStefano Zampini   if (ts->trajectory) {
5232d29f1f2SStefano Zampini     ierr = TSTrajectoryDestroy(&ts->trajectory);CHKERRQ(ierr);
5242d29f1f2SStefano Zampini     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
5252d29f1f2SStefano Zampini   }
5262d29f1f2SStefano Zampini   PetscFunctionReturn(0);
5272d29f1f2SStefano Zampini }
5282d29f1f2SStefano Zampini 
5292d29f1f2SStefano Zampini /*@
530a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
531a7a1495cSBarry Smith       set with TSSetRHSJacobian().
532a7a1495cSBarry Smith 
533d083f849SBarry Smith    Collective on TS
534a7a1495cSBarry Smith 
535a7a1495cSBarry Smith    Input Parameters:
536316643e7SJed Brown +  ts - the TS context
537a7a1495cSBarry Smith .  t - current timestep
5380910c330SBarry Smith -  U - input vector
539a7a1495cSBarry Smith 
540a7a1495cSBarry Smith    Output Parameters:
541a7a1495cSBarry Smith +  A - Jacobian matrix
542a7a1495cSBarry Smith .  B - optional preconditioning matrix
543a7a1495cSBarry Smith -  flag - flag indicating matrix structure
544a7a1495cSBarry Smith 
545a7a1495cSBarry Smith    Notes:
546a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
547a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
548a7a1495cSBarry Smith 
54994b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
550a7a1495cSBarry Smith    flag parameter.
551a7a1495cSBarry Smith 
552a7a1495cSBarry Smith    Level: developer
553a7a1495cSBarry Smith 
55494b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
555a7a1495cSBarry Smith @*/
556d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
557a7a1495cSBarry Smith {
558dfbe8321SBarry Smith   PetscErrorCode   ierr;
559270bf2e7SJed Brown   PetscObjectState Ustate;
5606c1e1eecSBarry Smith   PetscObjectId    Uid;
56124989b8cSPeter Brune   DM               dm;
562942e3340SBarry Smith   DMTS             tsdm;
56324989b8cSPeter Brune   TSRHSJacobian    rhsjacobianfunc;
56424989b8cSPeter Brune   void             *ctx;
565b2df71adSDebojyoti Ghosh   TSRHSFunction    rhsfunction;
566a7a1495cSBarry Smith 
567a7a1495cSBarry Smith   PetscFunctionBegin;
5680700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5690910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5700910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
57124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
572942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
5736374d434SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
574*2663174eSHong Zhang   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
57559e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
5766c1e1eecSBarry Smith   ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr);
577971015bcSStefano Zampini 
578*2663174eSHong Zhang   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) PetscFunctionReturn(0);
579e1244c69SJed Brown 
58024989b8cSPeter Brune   if (rhsjacobianfunc) {
58194ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
582a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
583d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
584a7a1495cSBarry Smith     PetscStackPop;
58594ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
586ef66eb69SBarry Smith   } else {
58794ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
588971015bcSStefano Zampini     if (B && A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
589ef66eb69SBarry Smith   }
5900e4ef248SJed Brown   ts->rhsjacobian.time  = t;
591971015bcSStefano Zampini   ts->rhsjacobian.shift = 0;
592971015bcSStefano Zampini   ts->rhsjacobian.scale = 1.;
5937f79407eSBarry Smith   ierr                  = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr);
59459e4f3c8SBarry Smith   ierr                  = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
595a7a1495cSBarry Smith   PetscFunctionReturn(0);
596a7a1495cSBarry Smith }
597a7a1495cSBarry Smith 
598316643e7SJed Brown /*@
599d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
600d763cef2SBarry Smith 
601d083f849SBarry Smith    Collective on TS
602316643e7SJed Brown 
603316643e7SJed Brown    Input Parameters:
604316643e7SJed Brown +  ts - the TS context
605316643e7SJed Brown .  t - current time
6060910c330SBarry Smith -  U - state vector
607316643e7SJed Brown 
608316643e7SJed Brown    Output Parameter:
609316643e7SJed Brown .  y - right hand side
610316643e7SJed Brown 
611316643e7SJed Brown    Note:
612316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
613316643e7SJed Brown    is used internally within the nonlinear solvers.
614316643e7SJed Brown 
615316643e7SJed Brown    Level: developer
616316643e7SJed Brown 
617316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
618316643e7SJed Brown @*/
6190910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
620d763cef2SBarry Smith {
621dfbe8321SBarry Smith   PetscErrorCode ierr;
62224989b8cSPeter Brune   TSRHSFunction  rhsfunction;
62324989b8cSPeter Brune   TSIFunction    ifunction;
62424989b8cSPeter Brune   void           *ctx;
62524989b8cSPeter Brune   DM             dm;
62624989b8cSPeter Brune 
627d763cef2SBarry Smith   PetscFunctionBegin;
6280700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6290910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6300700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
63124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
63224989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
6330298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
634d763cef2SBarry Smith 
635ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
636d763cef2SBarry Smith 
6370910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
63824989b8cSPeter Brune   if (rhsfunction) {
6391be370b1SHong Zhang     ierr = VecLockReadPush(U);CHKERRQ(ierr);
640d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
6410910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
642d763cef2SBarry Smith     PetscStackPop;
6431be370b1SHong Zhang     ierr = VecLockReadPop(U);CHKERRQ(ierr);
644214bc6a2SJed Brown   } else {
645214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
646b2cd27e8SJed Brown   }
64744a41b28SSean Farley 
6480910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
649d763cef2SBarry Smith   PetscFunctionReturn(0);
650d763cef2SBarry Smith }
651d763cef2SBarry Smith 
652ef20d060SBarry Smith /*@
653ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
654ef20d060SBarry Smith 
655d083f849SBarry Smith    Collective on TS
656ef20d060SBarry Smith 
657ef20d060SBarry Smith    Input Parameters:
658ef20d060SBarry Smith +  ts - the TS context
659ef20d060SBarry Smith -  t - current time
660ef20d060SBarry Smith 
661ef20d060SBarry Smith    Output Parameter:
6620910c330SBarry Smith .  U - the solution
663ef20d060SBarry Smith 
664ef20d060SBarry Smith    Note:
665ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
666ef20d060SBarry Smith    is used internally within the nonlinear solvers.
667ef20d060SBarry Smith 
668ef20d060SBarry Smith    Level: developer
669ef20d060SBarry Smith 
670abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
671ef20d060SBarry Smith @*/
6720910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
673ef20d060SBarry Smith {
674ef20d060SBarry Smith   PetscErrorCode     ierr;
675ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
676ef20d060SBarry Smith   void               *ctx;
677ef20d060SBarry Smith   DM                 dm;
678ef20d060SBarry Smith 
679ef20d060SBarry Smith   PetscFunctionBegin;
680ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6810910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
682ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
683ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
684ef20d060SBarry Smith 
685ef20d060SBarry Smith   if (solutionfunction) {
6869b7cd975SBarry Smith     PetscStackPush("TS user solution function");
6870910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
688ef20d060SBarry Smith     PetscStackPop;
689ef20d060SBarry Smith   }
690ef20d060SBarry Smith   PetscFunctionReturn(0);
691ef20d060SBarry Smith }
6929b7cd975SBarry Smith /*@
6939b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
6949b7cd975SBarry Smith 
695d083f849SBarry Smith    Collective on TS
6969b7cd975SBarry Smith 
6979b7cd975SBarry Smith    Input Parameters:
6989b7cd975SBarry Smith +  ts - the TS context
6999b7cd975SBarry Smith -  t - current time
7009b7cd975SBarry Smith 
7019b7cd975SBarry Smith    Output Parameter:
7029b7cd975SBarry Smith .  U - the function value
7039b7cd975SBarry Smith 
7049b7cd975SBarry Smith    Note:
7059b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
7069b7cd975SBarry Smith    is used internally within the nonlinear solvers.
7079b7cd975SBarry Smith 
7089b7cd975SBarry Smith    Level: developer
7099b7cd975SBarry Smith 
7109b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7119b7cd975SBarry Smith @*/
7129b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7139b7cd975SBarry Smith {
7149b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7159b7cd975SBarry Smith   void               *ctx;
7169b7cd975SBarry Smith   DM                 dm;
7179b7cd975SBarry Smith 
7189b7cd975SBarry Smith   PetscFunctionBegin;
7199b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7209b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7219b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7229b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7239b7cd975SBarry Smith 
7249b7cd975SBarry Smith   if (forcing) {
7259b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
7269b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
7279b7cd975SBarry Smith     PetscStackPop;
7289b7cd975SBarry Smith   }
7299b7cd975SBarry Smith   PetscFunctionReturn(0);
7309b7cd975SBarry Smith }
731ef20d060SBarry Smith 
732214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
733214bc6a2SJed Brown {
7342dd45cf8SJed Brown   Vec            F;
735214bc6a2SJed Brown   PetscErrorCode ierr;
736214bc6a2SJed Brown 
737214bc6a2SJed Brown   PetscFunctionBegin;
7380298fd71SBarry Smith   *Frhs = NULL;
7390298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
740214bc6a2SJed Brown   if (!ts->Frhs) {
7412dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
742214bc6a2SJed Brown   }
743214bc6a2SJed Brown   *Frhs = ts->Frhs;
744214bc6a2SJed Brown   PetscFunctionReturn(0);
745214bc6a2SJed Brown }
746214bc6a2SJed Brown 
747971015bcSStefano Zampini PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
748214bc6a2SJed Brown {
749214bc6a2SJed Brown   Mat            A,B;
7502dd45cf8SJed Brown   PetscErrorCode ierr;
75141a1d4d2SBarry Smith   TSIJacobian    ijacobian;
752214bc6a2SJed Brown 
753214bc6a2SJed Brown   PetscFunctionBegin;
754c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
755c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
75641a1d4d2SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr);
757214bc6a2SJed Brown   if (Arhs) {
758214bc6a2SJed Brown     if (!ts->Arhs) {
75941a1d4d2SBarry Smith       if (ijacobian) {
760214bc6a2SJed Brown         ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
76141a1d4d2SBarry Smith       } else {
76241a1d4d2SBarry Smith         ts->Arhs = A;
76341a1d4d2SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
76441a1d4d2SBarry Smith       }
7653565c898SBarry Smith     } else {
7663565c898SBarry Smith       PetscBool flg;
7673565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
7683565c898SBarry Smith       /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */
7693565c898SBarry Smith       if (flg && !ijacobian && ts->Arhs == ts->Brhs){
7703565c898SBarry Smith         ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr);
7713565c898SBarry Smith         ts->Arhs = A;
7723565c898SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
7733565c898SBarry Smith       }
774214bc6a2SJed Brown     }
775214bc6a2SJed Brown     *Arhs = ts->Arhs;
776214bc6a2SJed Brown   }
777214bc6a2SJed Brown   if (Brhs) {
778214bc6a2SJed Brown     if (!ts->Brhs) {
779bdb70873SJed Brown       if (A != B) {
78041a1d4d2SBarry Smith         if (ijacobian) {
781214bc6a2SJed Brown           ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
782bdb70873SJed Brown         } else {
78341a1d4d2SBarry Smith           ts->Brhs = B;
78441a1d4d2SBarry Smith           ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
78541a1d4d2SBarry Smith         }
78641a1d4d2SBarry Smith       } else {
787bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
78851699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
789bdb70873SJed Brown       }
790214bc6a2SJed Brown     }
791214bc6a2SJed Brown     *Brhs = ts->Brhs;
792214bc6a2SJed Brown   }
793214bc6a2SJed Brown   PetscFunctionReturn(0);
794214bc6a2SJed Brown }
795214bc6a2SJed Brown 
796316643e7SJed Brown /*@
7970910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
798316643e7SJed Brown 
799d083f849SBarry Smith    Collective on TS
800316643e7SJed Brown 
801316643e7SJed Brown    Input Parameters:
802316643e7SJed Brown +  ts - the TS context
803316643e7SJed Brown .  t - current time
8040910c330SBarry Smith .  U - state vector
8050910c330SBarry Smith .  Udot - time derivative of state vector
806214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
807316643e7SJed Brown 
808316643e7SJed Brown    Output Parameter:
809316643e7SJed Brown .  Y - right hand side
810316643e7SJed Brown 
811316643e7SJed Brown    Note:
812316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
813316643e7SJed Brown    is used internally within the nonlinear solvers.
814316643e7SJed Brown 
815316643e7SJed Brown    If the user did did not write their equations in implicit form, this
816316643e7SJed Brown    function recasts them in implicit form.
817316643e7SJed Brown 
818316643e7SJed Brown    Level: developer
819316643e7SJed Brown 
820316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
821316643e7SJed Brown @*/
8220910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
823316643e7SJed Brown {
824316643e7SJed Brown   PetscErrorCode ierr;
82524989b8cSPeter Brune   TSIFunction    ifunction;
82624989b8cSPeter Brune   TSRHSFunction  rhsfunction;
82724989b8cSPeter Brune   void           *ctx;
82824989b8cSPeter Brune   DM             dm;
829316643e7SJed Brown 
830316643e7SJed Brown   PetscFunctionBegin;
8310700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8320910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8330910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
8340700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
835316643e7SJed Brown 
83624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
83724989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
8380298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
83924989b8cSPeter Brune 
840ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
841d90be118SSean Farley 
8420910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
84324989b8cSPeter Brune   if (ifunction) {
844316643e7SJed Brown     PetscStackPush("TS user implicit function");
8450910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
846316643e7SJed Brown     PetscStackPop;
847214bc6a2SJed Brown   }
848214bc6a2SJed Brown   if (imex) {
84924989b8cSPeter Brune     if (!ifunction) {
8500910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
8512dd45cf8SJed Brown     }
85224989b8cSPeter Brune   } else if (rhsfunction) {
85324989b8cSPeter Brune     if (ifunction) {
854214bc6a2SJed Brown       Vec Frhs;
855214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
8560910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
857214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
8582dd45cf8SJed Brown     } else {
8590910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
8600910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
861316643e7SJed Brown     }
8624a6899ffSJed Brown   }
8630910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
864316643e7SJed Brown   PetscFunctionReturn(0);
865316643e7SJed Brown }
866316643e7SJed Brown 
867316643e7SJed Brown /*@
868316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
869316643e7SJed Brown 
870d083f849SBarry Smith    Collective on TS
871316643e7SJed Brown 
872316643e7SJed Brown    Input
873316643e7SJed Brown       Input Parameters:
874316643e7SJed Brown +  ts - the TS context
875316643e7SJed Brown .  t - current timestep
8760910c330SBarry Smith .  U - state vector
8770910c330SBarry Smith .  Udot - time derivative of state vector
878214bc6a2SJed Brown .  shift - shift to apply, see note below
879214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
880316643e7SJed Brown 
881316643e7SJed Brown    Output Parameters:
882316643e7SJed Brown +  A - Jacobian matrix
8833565c898SBarry Smith -  B - matrix from which the preconditioner is constructed; often the same as A
884316643e7SJed Brown 
885316643e7SJed Brown    Notes:
8860910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
887316643e7SJed Brown 
8880910c330SBarry Smith    dF/dU + shift*dF/dUdot
889316643e7SJed Brown 
890316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
891316643e7SJed Brown    is used internally within the nonlinear solvers.
892316643e7SJed Brown 
893316643e7SJed Brown    Level: developer
894316643e7SJed Brown 
895316643e7SJed Brown .seealso:  TSSetIJacobian()
89663495f91SJed Brown @*/
897d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
898316643e7SJed Brown {
899316643e7SJed Brown   PetscErrorCode ierr;
90024989b8cSPeter Brune   TSIJacobian    ijacobian;
90124989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
90224989b8cSPeter Brune   DM             dm;
90324989b8cSPeter Brune   void           *ctx;
904316643e7SJed Brown 
905316643e7SJed Brown   PetscFunctionBegin;
9060700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9070910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9080910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
909316643e7SJed Brown   PetscValidPointer(A,6);
91094ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
911316643e7SJed Brown   PetscValidPointer(B,7);
91294ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
91324989b8cSPeter Brune 
91424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
91524989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
9160298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
91724989b8cSPeter Brune 
918ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
919316643e7SJed Brown 
92094ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
92124989b8cSPeter Brune   if (ijacobian) {
922316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
923d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
924316643e7SJed Brown     PetscStackPop;
9254a6899ffSJed Brown   }
926214bc6a2SJed Brown   if (imex) {
927b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
9284c26be97Sstefano_zampini       PetscBool assembled;
929971015bcSStefano Zampini       if (rhsjacobian) {
930971015bcSStefano Zampini         Mat Arhs = NULL;
931971015bcSStefano Zampini         ierr = TSGetRHSMats_Private(ts,&Arhs,NULL);CHKERRQ(ierr);
932971015bcSStefano Zampini         if (A == Arhs) {
933e8b1e424SHong 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 */
934971015bcSStefano Zampini           ts->rhsjacobian.time = PETSC_MIN_REAL;
935971015bcSStefano Zampini         }
936971015bcSStefano Zampini       }
93794ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
9384c26be97Sstefano_zampini       ierr = MatAssembled(A,&assembled);CHKERRQ(ierr);
9394c26be97Sstefano_zampini       if (!assembled) {
9404c26be97Sstefano_zampini         ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9414c26be97Sstefano_zampini         ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9424c26be97Sstefano_zampini       }
94394ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
94494ab13aaSBarry Smith       if (A != B) {
94594ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
9464c26be97Sstefano_zampini         ierr = MatAssembled(B,&assembled);CHKERRQ(ierr);
9474c26be97Sstefano_zampini         if (!assembled) {
9484c26be97Sstefano_zampini           ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9494c26be97Sstefano_zampini           ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9504c26be97Sstefano_zampini         }
95194ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
952214bc6a2SJed Brown       }
953214bc6a2SJed Brown     }
954214bc6a2SJed Brown   } else {
955e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
956e8b1e424SHong Zhang     if (rhsjacobian) { /* RHSJacobian needs to be converted to part of IJacobian if exists */
957214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
958e1244c69SJed Brown     }
959e8b1e424SHong Zhang     if (Arhs == A) { /* No IJacobian matrix, so we only have the RHS matrix */
960e8b1e424SHong Zhang       PetscObjectState Ustate;
961e8b1e424SHong Zhang       PetscObjectId    Uid;
962e8b1e424SHong Zhang       TSRHSFunction    rhsfunction;
963e8b1e424SHong Zhang 
964e8b1e424SHong Zhang       ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
965e8b1e424SHong Zhang       ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
966e8b1e424SHong Zhang       ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr);
967e8b1e424SHong Zhang       if ((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 */
968e8b1e424SHong 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 */
969e8b1e424SHong Zhang       } else {
9703565c898SBarry Smith         PetscBool flg;
971e8b1e424SHong Zhang 
972e8b1e424SHong Zhang         if (ts->rhsjacobian.reuse) { /* Undo the damage */
973e8b1e424SHong Zhang           /* MatScale has a short path for this case.
974e8b1e424SHong Zhang              However, this code path is taken the first time TSComputeRHSJacobian is called
975e8b1e424SHong Zhang              and the matrices have not been assembled yet */
976e8b1e424SHong Zhang           if (ts->rhsjacobian.shift) {
977e8b1e424SHong Zhang             ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
978e8b1e424SHong Zhang           }
979e8b1e424SHong Zhang           if (ts->rhsjacobian.scale == -1.) {
980e8b1e424SHong Zhang             ierr = MatScale(A,-1);CHKERRQ(ierr);
981e8b1e424SHong Zhang           }
982e8b1e424SHong Zhang           if (B && B == ts->Brhs && A != B) {
983e8b1e424SHong Zhang             if (ts->rhsjacobian.shift) {
984e8b1e424SHong Zhang               ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
985e8b1e424SHong Zhang             }
986e8b1e424SHong Zhang             if (ts->rhsjacobian.scale == -1.) {
987e8b1e424SHong Zhang               ierr = MatScale(B,-1);CHKERRQ(ierr);
988e8b1e424SHong Zhang             }
989e8b1e424SHong Zhang           }
990e8b1e424SHong Zhang           ts->rhsjacobian.shift = 0;
991e8b1e424SHong Zhang           ts->rhsjacobian.scale = 1.;
992e8b1e424SHong Zhang         }
993e8b1e424SHong Zhang         ierr = TSComputeRHSJacobian(ts,t,U,A,B);CHKERRQ(ierr);
9943565c898SBarry Smith         ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
9953565c898SBarry Smith         /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */
9963565c898SBarry Smith         if (!flg) {
99794ab13aaSBarry Smith           ierr = MatScale(A,-1);CHKERRQ(ierr);
99894ab13aaSBarry Smith           ierr = MatShift(A,shift);CHKERRQ(ierr);
9993565c898SBarry Smith         }
100094ab13aaSBarry Smith         if (A != B) {
100194ab13aaSBarry Smith           ierr = MatScale(B,-1);CHKERRQ(ierr);
100294ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
1003316643e7SJed Brown         }
1004e8b1e424SHong Zhang       }
1005e8b1e424SHong Zhang       ts->rhsjacobian.scale = -1;
1006e8b1e424SHong Zhang       ts->rhsjacobian.shift = shift;
1007e8b1e424SHong Zhang     } else if (Arhs) {  /* Both IJacobian and RHSJacobian exist or the RHS matrix provided (A) is different from the internal RHS matrix (Arhs) */
1008e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1009e8b1e424SHong Zhang 
1010e1244c69SJed Brown       if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */
101194ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
101294ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
101394ab13aaSBarry Smith         if (A != B) {
101494ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
101594ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
1016214bc6a2SJed Brown         }
1017316643e7SJed Brown       }
1018e8b1e424SHong Zhang       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
101994ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
102094ab13aaSBarry Smith       if (A != B) {
102194ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
1022316643e7SJed Brown       }
1023316643e7SJed Brown     }
1024316643e7SJed Brown   }
102594ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
1026316643e7SJed Brown   PetscFunctionReturn(0);
1027316643e7SJed Brown }
1028316643e7SJed Brown 
1029d763cef2SBarry Smith /*@C
1030d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
1031b5abc632SBarry Smith     where U_t = G(t,u).
1032d763cef2SBarry Smith 
10333f9fe445SBarry Smith     Logically Collective on TS
1034d763cef2SBarry Smith 
1035d763cef2SBarry Smith     Input Parameters:
1036d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
10370298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
1038d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
1039d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
10400298fd71SBarry Smith           function evaluation routine (may be NULL)
1041d763cef2SBarry Smith 
1042a96d6ef6SBarry Smith     Calling sequence of f:
1043a96d6ef6SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,Vec F,void *ctx);
1044d763cef2SBarry Smith 
1045a96d6ef6SBarry Smith +   ts - timestep context
1046a96d6ef6SBarry Smith .   t - current timestep
1047d763cef2SBarry Smith .   u - input vector
1048d763cef2SBarry Smith .   F - function vector
1049d763cef2SBarry Smith -   ctx - [optional] user-defined function context
1050d763cef2SBarry Smith 
1051d763cef2SBarry Smith     Level: beginner
1052d763cef2SBarry Smith 
105395452b02SPatrick Sanan     Notes:
105495452b02SPatrick Sanan     You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
10552bbac0d3SBarry Smith 
1056ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
1057d763cef2SBarry Smith @*/
1058089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
1059d763cef2SBarry Smith {
1060089b2837SJed Brown   PetscErrorCode ierr;
1061089b2837SJed Brown   SNES           snes;
10620298fd71SBarry Smith   Vec            ralloc = NULL;
106324989b8cSPeter Brune   DM             dm;
1064d763cef2SBarry Smith 
1065089b2837SJed Brown   PetscFunctionBegin;
10660700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1067ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
106824989b8cSPeter Brune 
106924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
107024989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1071089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1072e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1073e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1074e856ceecSJed Brown     r = ralloc;
1075e856ceecSJed Brown   }
1076089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1077e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1078d763cef2SBarry Smith   PetscFunctionReturn(0);
1079d763cef2SBarry Smith }
1080d763cef2SBarry Smith 
1081ef20d060SBarry Smith /*@C
1082abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1083ef20d060SBarry Smith 
1084ef20d060SBarry Smith     Logically Collective on TS
1085ef20d060SBarry Smith 
1086ef20d060SBarry Smith     Input Parameters:
1087ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1088ef20d060SBarry Smith .   f - routine for evaluating the solution
1089ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
10900298fd71SBarry Smith           function evaluation routine (may be NULL)
1091ef20d060SBarry Smith 
1092a96d6ef6SBarry Smith     Calling sequence of f:
1093a96d6ef6SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,void *ctx);
1094ef20d060SBarry Smith 
1095ef20d060SBarry Smith +   t - current timestep
1096ef20d060SBarry Smith .   u - output vector
1097ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1098ef20d060SBarry Smith 
10990ed3bfb6SBarry Smith     Options Database:
11000ed3bfb6SBarry Smith +  -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction()
11010ed3bfb6SBarry Smith -  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
11020ed3bfb6SBarry Smith 
1103abd5a294SJed Brown     Notes:
1104abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1105abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1106abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1107abd5a294SJed Brown 
11084f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1109abd5a294SJed Brown 
1110ef20d060SBarry Smith     Level: beginner
1111ef20d060SBarry Smith 
11120ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError()
1113ef20d060SBarry Smith @*/
1114ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1115ef20d060SBarry Smith {
1116ef20d060SBarry Smith   PetscErrorCode ierr;
1117ef20d060SBarry Smith   DM             dm;
1118ef20d060SBarry Smith 
1119ef20d060SBarry Smith   PetscFunctionBegin;
1120ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1121ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1122ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1123ef20d060SBarry Smith   PetscFunctionReturn(0);
1124ef20d060SBarry Smith }
1125ef20d060SBarry Smith 
11269b7cd975SBarry Smith /*@C
11279b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
11289b7cd975SBarry Smith 
11299b7cd975SBarry Smith     Logically Collective on TS
11309b7cd975SBarry Smith 
11319b7cd975SBarry Smith     Input Parameters:
11329b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
1133e162b725SBarry Smith .   func - routine for evaluating the forcing function
11349b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
11350298fd71SBarry Smith           function evaluation routine (may be NULL)
11369b7cd975SBarry Smith 
11379b7cd975SBarry Smith     Calling sequence of func:
11386bc98fa9SBarry Smith $     PetscErrorCode func (TS ts,PetscReal t,Vec f,void *ctx);
11399b7cd975SBarry Smith 
11409b7cd975SBarry Smith +   t - current timestep
1141e162b725SBarry Smith .   f - output vector
11429b7cd975SBarry Smith -   ctx - [optional] user-defined function context
11439b7cd975SBarry Smith 
11449b7cd975SBarry Smith     Notes:
11459b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
1146e162b725SBarry 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
1147e162b725SBarry Smith     definition of the problem you are solving and hence possibly introducing bugs.
1148e162b725SBarry Smith 
1149e162b725SBarry Smith     This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0
1150e162b725SBarry Smith 
1151e162b725SBarry 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
1152e162b725SBarry Smith     parameters can be passed in the ctx variable.
11539b7cd975SBarry Smith 
11549b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
11559b7cd975SBarry Smith 
11569b7cd975SBarry Smith     Level: beginner
11579b7cd975SBarry Smith 
11589b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
11599b7cd975SBarry Smith @*/
1160e162b725SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx)
11619b7cd975SBarry Smith {
11629b7cd975SBarry Smith   PetscErrorCode ierr;
11639b7cd975SBarry Smith   DM             dm;
11649b7cd975SBarry Smith 
11659b7cd975SBarry Smith   PetscFunctionBegin;
11669b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
11679b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1168e162b725SBarry Smith   ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr);
11699b7cd975SBarry Smith   PetscFunctionReturn(0);
11709b7cd975SBarry Smith }
11719b7cd975SBarry Smith 
1172d763cef2SBarry Smith /*@C
1173f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1174b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1175d763cef2SBarry Smith 
11763f9fe445SBarry Smith    Logically Collective on TS
1177d763cef2SBarry Smith 
1178d763cef2SBarry Smith    Input Parameters:
1179d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1180e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1181e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1182d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1183d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
11840298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1185d763cef2SBarry Smith 
1186f7ab8db6SBarry Smith    Calling sequence of f:
1187a96d6ef6SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1188d763cef2SBarry Smith 
1189d763cef2SBarry Smith +  t - current timestep
1190d763cef2SBarry Smith .  u - input vector
1191e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1192e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1193d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1194d763cef2SBarry Smith 
11956cd88445SBarry Smith    Notes:
11966cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
11976cd88445SBarry Smith 
11986cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1199ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1200d763cef2SBarry Smith 
1201d763cef2SBarry Smith    Level: beginner
1202d763cef2SBarry Smith 
1203ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1204d763cef2SBarry Smith 
1205d763cef2SBarry Smith @*/
1206e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1207d763cef2SBarry Smith {
1208277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1209089b2837SJed Brown   SNES           snes;
121024989b8cSPeter Brune   DM             dm;
121124989b8cSPeter Brune   TSIJacobian    ijacobian;
1212277b19d0SLisandro Dalcin 
1213d763cef2SBarry Smith   PetscFunctionBegin;
12140700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1215e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1216e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1217e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1218e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1219d763cef2SBarry Smith 
122024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
122124989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1222e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1223e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1224e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1225e1244c69SJed Brown   }
12260298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1227089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12285f659677SPeter Brune   if (!ijacobian) {
1229e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
12300e4ef248SJed Brown   }
1231e5d3d808SBarry Smith   if (Amat) {
1232e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
12330e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1234e5d3d808SBarry Smith     ts->Arhs = Amat;
12350e4ef248SJed Brown   }
1236e5d3d808SBarry Smith   if (Pmat) {
1237e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
12380e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1239e5d3d808SBarry Smith     ts->Brhs = Pmat;
12400e4ef248SJed Brown   }
1241d763cef2SBarry Smith   PetscFunctionReturn(0);
1242d763cef2SBarry Smith }
1243d763cef2SBarry Smith 
1244316643e7SJed Brown /*@C
1245b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1246316643e7SJed Brown 
12473f9fe445SBarry Smith    Logically Collective on TS
1248316643e7SJed Brown 
1249316643e7SJed Brown    Input Parameters:
1250316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
12510298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1252316643e7SJed Brown .  f   - the function evaluation routine
12530298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1254316643e7SJed Brown 
1255316643e7SJed Brown    Calling sequence of f:
12566bc98fa9SBarry Smith $     PetscErrorCode f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1257316643e7SJed Brown 
1258316643e7SJed Brown +  t   - time at step/stage being solved
1259316643e7SJed Brown .  u   - state vector
1260316643e7SJed Brown .  u_t - time derivative of state vector
1261316643e7SJed Brown .  F   - function vector
1262316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1263316643e7SJed Brown 
1264316643e7SJed Brown    Important:
12652bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1266316643e7SJed Brown 
1267316643e7SJed Brown    Level: beginner
1268316643e7SJed Brown 
1269d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1270316643e7SJed Brown @*/
127151699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1272316643e7SJed Brown {
1273089b2837SJed Brown   PetscErrorCode ierr;
1274089b2837SJed Brown   SNES           snes;
127551699248SLisandro Dalcin   Vec            ralloc = NULL;
127624989b8cSPeter Brune   DM             dm;
1277316643e7SJed Brown 
1278316643e7SJed Brown   PetscFunctionBegin;
12790700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
128051699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
128124989b8cSPeter Brune 
128224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
128324989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
128424989b8cSPeter Brune 
1285089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
128651699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
128751699248SLisandro Dalcin     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
128851699248SLisandro Dalcin     r  = ralloc;
1289e856ceecSJed Brown   }
129051699248SLisandro Dalcin   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
129151699248SLisandro Dalcin   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1292089b2837SJed Brown   PetscFunctionReturn(0);
1293089b2837SJed Brown }
1294089b2837SJed Brown 
1295089b2837SJed Brown /*@C
1296089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1297089b2837SJed Brown 
1298089b2837SJed Brown    Not Collective
1299089b2837SJed Brown 
1300089b2837SJed Brown    Input Parameter:
1301089b2837SJed Brown .  ts - the TS context
1302089b2837SJed Brown 
1303089b2837SJed Brown    Output Parameter:
13040298fd71SBarry Smith +  r - vector to hold residual (or NULL)
13050298fd71SBarry Smith .  func - the function to compute residual (or NULL)
13060298fd71SBarry Smith -  ctx - the function context (or NULL)
1307089b2837SJed Brown 
1308089b2837SJed Brown    Level: advanced
1309089b2837SJed Brown 
1310089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1311089b2837SJed Brown @*/
1312089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1313089b2837SJed Brown {
1314089b2837SJed Brown   PetscErrorCode ierr;
1315089b2837SJed Brown   SNES           snes;
131624989b8cSPeter Brune   DM             dm;
1317089b2837SJed Brown 
1318089b2837SJed Brown   PetscFunctionBegin;
1319089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1320089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13210298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
132224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
132324989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1324089b2837SJed Brown   PetscFunctionReturn(0);
1325089b2837SJed Brown }
1326089b2837SJed Brown 
1327089b2837SJed Brown /*@C
1328089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1329089b2837SJed Brown 
1330089b2837SJed Brown    Not Collective
1331089b2837SJed Brown 
1332089b2837SJed Brown    Input Parameter:
1333089b2837SJed Brown .  ts - the TS context
1334089b2837SJed Brown 
1335089b2837SJed Brown    Output Parameter:
13360298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
13370298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
13380298fd71SBarry Smith -  ctx - the function context (or NULL)
1339089b2837SJed Brown 
1340089b2837SJed Brown    Level: advanced
1341089b2837SJed Brown 
13422bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1343089b2837SJed Brown @*/
1344089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1345089b2837SJed Brown {
1346089b2837SJed Brown   PetscErrorCode ierr;
1347089b2837SJed Brown   SNES           snes;
134824989b8cSPeter Brune   DM             dm;
1349089b2837SJed Brown 
1350089b2837SJed Brown   PetscFunctionBegin;
1351089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1352089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13530298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
135424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
135524989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1356316643e7SJed Brown   PetscFunctionReturn(0);
1357316643e7SJed Brown }
1358316643e7SJed Brown 
1359316643e7SJed Brown /*@C
1360a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1361ae8867d6SBarry Smith         provided with TSSetIFunction().
1362316643e7SJed Brown 
13633f9fe445SBarry Smith    Logically Collective on TS
1364316643e7SJed Brown 
1365316643e7SJed Brown    Input Parameters:
1366316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1367e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1368e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1369316643e7SJed Brown .  f   - the Jacobian evaluation routine
13700298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1371316643e7SJed Brown 
1372316643e7SJed Brown    Calling sequence of f:
13736bc98fa9SBarry Smith $    PetscErrorCode f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1374316643e7SJed Brown 
1375316643e7SJed Brown +  t    - time at step/stage being solved
13761b4a444bSJed Brown .  U    - state vector
13771b4a444bSJed Brown .  U_t  - time derivative of state vector
1378316643e7SJed Brown .  a    - shift
1379e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1380e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1381316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1382316643e7SJed Brown 
1383316643e7SJed Brown    Notes:
1384e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1385316643e7SJed Brown 
1386895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1387895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1388895c21f2SBarry Smith 
1389a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1390b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1391a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1392a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1393a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1394a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1395a4f0a591SBarry Smith 
13966cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
13976cd88445SBarry Smith 
13986cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1399ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1400ca5f011dSBarry Smith 
1401316643e7SJed Brown    Level: beginner
1402316643e7SJed Brown 
1403ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1404316643e7SJed Brown 
1405316643e7SJed Brown @*/
1406e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1407316643e7SJed Brown {
1408316643e7SJed Brown   PetscErrorCode ierr;
1409089b2837SJed Brown   SNES           snes;
141024989b8cSPeter Brune   DM             dm;
1411316643e7SJed Brown 
1412316643e7SJed Brown   PetscFunctionBegin;
14130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1414e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1415e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1416e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1417e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
141824989b8cSPeter Brune 
141924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
142024989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
142124989b8cSPeter Brune 
1422089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1423e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1424316643e7SJed Brown   PetscFunctionReturn(0);
1425316643e7SJed Brown }
1426316643e7SJed Brown 
1427e1244c69SJed Brown /*@
1428e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1429e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1430e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1431e1244c69SJed Brown    not been changed by the TS.
1432e1244c69SJed Brown 
1433e1244c69SJed Brown    Logically Collective
1434e1244c69SJed Brown 
1435e1244c69SJed Brown    Input Arguments:
1436e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1437e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1438e1244c69SJed Brown 
1439e1244c69SJed Brown    Level: intermediate
1440e1244c69SJed Brown 
1441e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1442e1244c69SJed Brown @*/
1443e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1444e1244c69SJed Brown {
1445e1244c69SJed Brown   PetscFunctionBegin;
1446e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1447e1244c69SJed Brown   PetscFunctionReturn(0);
1448e1244c69SJed Brown }
1449e1244c69SJed Brown 
1450efe9872eSLisandro Dalcin /*@C
1451efe9872eSLisandro Dalcin    TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1452efe9872eSLisandro Dalcin 
1453efe9872eSLisandro Dalcin    Logically Collective on TS
1454efe9872eSLisandro Dalcin 
1455efe9872eSLisandro Dalcin    Input Parameters:
1456efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1457efe9872eSLisandro Dalcin .  F   - vector to hold the residual (or NULL to have it created internally)
1458efe9872eSLisandro Dalcin .  fun - the function evaluation routine
1459efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1460efe9872eSLisandro Dalcin 
1461efe9872eSLisandro Dalcin    Calling sequence of fun:
14626bc98fa9SBarry Smith $     PetscErrorCode fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx);
1463efe9872eSLisandro Dalcin 
1464efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1465efe9872eSLisandro Dalcin .  U    - state vector
1466efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1467efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1468efe9872eSLisandro Dalcin .  F    - function vector
1469efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine (may be NULL)
1470efe9872eSLisandro Dalcin 
1471efe9872eSLisandro Dalcin    Level: beginner
1472efe9872eSLisandro Dalcin 
1473a96d6ef6SBarry Smith .seealso: TSSetI2Jacobian(), TSSetIFunction(), TSCreate(), TSSetRHSFunction()
1474efe9872eSLisandro Dalcin @*/
1475efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx)
1476efe9872eSLisandro Dalcin {
1477efe9872eSLisandro Dalcin   DM             dm;
1478efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1479efe9872eSLisandro Dalcin 
1480efe9872eSLisandro Dalcin   PetscFunctionBegin;
1481efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1482efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2);
1483efe9872eSLisandro Dalcin   ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr);
1484efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1485efe9872eSLisandro Dalcin   ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1486efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1487efe9872eSLisandro Dalcin }
1488efe9872eSLisandro Dalcin 
1489efe9872eSLisandro Dalcin /*@C
1490efe9872eSLisandro Dalcin   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1491efe9872eSLisandro Dalcin 
1492efe9872eSLisandro Dalcin   Not Collective
1493efe9872eSLisandro Dalcin 
1494efe9872eSLisandro Dalcin   Input Parameter:
1495efe9872eSLisandro Dalcin . ts - the TS context
1496efe9872eSLisandro Dalcin 
1497efe9872eSLisandro Dalcin   Output Parameter:
1498efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL)
1499efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL)
1500efe9872eSLisandro Dalcin - ctx - the function context (or NULL)
1501efe9872eSLisandro Dalcin 
1502efe9872eSLisandro Dalcin   Level: advanced
1503efe9872eSLisandro Dalcin 
1504a96d6ef6SBarry Smith .seealso: TSSetIFunction(), SNESGetFunction(), TSCreate()
1505efe9872eSLisandro Dalcin @*/
1506efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1507efe9872eSLisandro Dalcin {
1508efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1509efe9872eSLisandro Dalcin   SNES           snes;
1510efe9872eSLisandro Dalcin   DM             dm;
1511efe9872eSLisandro Dalcin 
1512efe9872eSLisandro Dalcin   PetscFunctionBegin;
1513efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1514efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1515efe9872eSLisandro Dalcin   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1516efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1517efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1518efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1519efe9872eSLisandro Dalcin }
1520efe9872eSLisandro Dalcin 
1521efe9872eSLisandro Dalcin /*@C
1522bc77d74cSLisandro Dalcin    TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1523efe9872eSLisandro Dalcin         where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1524efe9872eSLisandro Dalcin 
1525efe9872eSLisandro Dalcin    Logically Collective on TS
1526efe9872eSLisandro Dalcin 
1527efe9872eSLisandro Dalcin    Input Parameters:
1528efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1529efe9872eSLisandro Dalcin .  J   - Jacobian matrix
1530efe9872eSLisandro Dalcin .  P   - preconditioning matrix for J (may be same as J)
1531efe9872eSLisandro Dalcin .  jac - the Jacobian evaluation routine
1532efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1533efe9872eSLisandro Dalcin 
1534efe9872eSLisandro Dalcin    Calling sequence of jac:
15356bc98fa9SBarry 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);
1536efe9872eSLisandro Dalcin 
1537efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1538efe9872eSLisandro Dalcin .  U    - state vector
1539efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1540efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1541efe9872eSLisandro Dalcin .  v    - shift for U_t
1542efe9872eSLisandro Dalcin .  a    - shift for U_tt
1543efe9872eSLisandro 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
1544efe9872eSLisandro Dalcin .  P    - preconditioning matrix for J, may be same as J
1545efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine
1546efe9872eSLisandro Dalcin 
1547efe9872eSLisandro Dalcin    Notes:
1548efe9872eSLisandro Dalcin    The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1549efe9872eSLisandro Dalcin 
1550efe9872eSLisandro Dalcin    The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1551efe9872eSLisandro 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.
1552efe9872eSLisandro Dalcin    The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1553bc77d74cSLisandro Dalcin    parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1554efe9872eSLisandro Dalcin 
1555efe9872eSLisandro Dalcin    Level: beginner
1556efe9872eSLisandro Dalcin 
1557a96d6ef6SBarry Smith .seealso: TSSetI2Function(), TSGetI2Jacobian()
1558efe9872eSLisandro Dalcin @*/
1559efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1560efe9872eSLisandro Dalcin {
1561efe9872eSLisandro Dalcin   DM             dm;
1562efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1563efe9872eSLisandro Dalcin 
1564efe9872eSLisandro Dalcin   PetscFunctionBegin;
1565efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1566efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2);
1567efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3);
1568efe9872eSLisandro Dalcin   ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr);
1569efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1570efe9872eSLisandro Dalcin   ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1571efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1572efe9872eSLisandro Dalcin }
1573efe9872eSLisandro Dalcin 
1574efe9872eSLisandro Dalcin /*@C
1575efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1576efe9872eSLisandro Dalcin 
1577efe9872eSLisandro Dalcin   Not Collective, but parallel objects are returned if TS is parallel
1578efe9872eSLisandro Dalcin 
1579efe9872eSLisandro Dalcin   Input Parameter:
1580efe9872eSLisandro Dalcin . ts  - The TS context obtained from TSCreate()
1581efe9872eSLisandro Dalcin 
1582efe9872eSLisandro Dalcin   Output Parameters:
1583efe9872eSLisandro Dalcin + J  - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1584efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J
1585efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1586efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1587efe9872eSLisandro Dalcin 
158895452b02SPatrick Sanan   Notes:
158995452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
1590efe9872eSLisandro Dalcin 
1591efe9872eSLisandro Dalcin   Level: advanced
1592efe9872eSLisandro Dalcin 
1593a96d6ef6SBarry Smith .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber(), TSSetI2Jacobian(), TSGetI2Function(), TSCreate()
1594efe9872eSLisandro Dalcin 
1595efe9872eSLisandro Dalcin @*/
1596efe9872eSLisandro Dalcin PetscErrorCode  TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1597efe9872eSLisandro Dalcin {
1598efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1599efe9872eSLisandro Dalcin   SNES           snes;
1600efe9872eSLisandro Dalcin   DM             dm;
1601efe9872eSLisandro Dalcin 
1602efe9872eSLisandro Dalcin   PetscFunctionBegin;
1603efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1604efe9872eSLisandro Dalcin   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
1605efe9872eSLisandro Dalcin   ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr);
1606efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1607efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1608efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1609efe9872eSLisandro Dalcin }
1610efe9872eSLisandro Dalcin 
1611efe9872eSLisandro Dalcin /*@
1612efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1613efe9872eSLisandro Dalcin 
1614d083f849SBarry Smith   Collective on TS
1615efe9872eSLisandro Dalcin 
1616efe9872eSLisandro Dalcin   Input Parameters:
1617efe9872eSLisandro Dalcin + ts - the TS context
1618efe9872eSLisandro Dalcin . t - current time
1619efe9872eSLisandro Dalcin . U - state vector
1620efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t)
1621efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt)
1622efe9872eSLisandro Dalcin 
1623efe9872eSLisandro Dalcin   Output Parameter:
1624efe9872eSLisandro Dalcin . F - the residual vector
1625efe9872eSLisandro Dalcin 
1626efe9872eSLisandro Dalcin   Note:
1627efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1628efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1629efe9872eSLisandro Dalcin 
1630efe9872eSLisandro Dalcin   Level: developer
1631efe9872eSLisandro Dalcin 
1632a96d6ef6SBarry Smith .seealso: TSSetI2Function(), TSGetI2Function()
1633efe9872eSLisandro Dalcin @*/
1634efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1635efe9872eSLisandro Dalcin {
1636efe9872eSLisandro Dalcin   DM             dm;
1637efe9872eSLisandro Dalcin   TSI2Function   I2Function;
1638efe9872eSLisandro Dalcin   void           *ctx;
1639efe9872eSLisandro Dalcin   TSRHSFunction  rhsfunction;
1640efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1641efe9872eSLisandro Dalcin 
1642efe9872eSLisandro Dalcin   PetscFunctionBegin;
1643efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1644efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1645efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1646efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1647efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F,VEC_CLASSID,6);
1648efe9872eSLisandro Dalcin 
1649efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1650efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr);
1651efe9872eSLisandro Dalcin   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
1652efe9872eSLisandro Dalcin 
1653efe9872eSLisandro Dalcin   if (!I2Function) {
1654efe9872eSLisandro Dalcin     ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr);
1655efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1656efe9872eSLisandro Dalcin   }
1657efe9872eSLisandro Dalcin 
1658efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1659efe9872eSLisandro Dalcin 
1660efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit function");
1661efe9872eSLisandro Dalcin   ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr);
1662efe9872eSLisandro Dalcin   PetscStackPop;
1663efe9872eSLisandro Dalcin 
1664efe9872eSLisandro Dalcin   if (rhsfunction) {
1665efe9872eSLisandro Dalcin     Vec Frhs;
1666efe9872eSLisandro Dalcin     ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
1667efe9872eSLisandro Dalcin     ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
1668efe9872eSLisandro Dalcin     ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr);
1669efe9872eSLisandro Dalcin   }
1670efe9872eSLisandro Dalcin 
1671efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1672efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1673efe9872eSLisandro Dalcin }
1674efe9872eSLisandro Dalcin 
1675efe9872eSLisandro Dalcin /*@
1676efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1677efe9872eSLisandro Dalcin 
1678d083f849SBarry Smith   Collective on TS
1679efe9872eSLisandro Dalcin 
1680efe9872eSLisandro Dalcin   Input Parameters:
1681efe9872eSLisandro Dalcin + ts - the TS context
1682efe9872eSLisandro Dalcin . t - current timestep
1683efe9872eSLisandro Dalcin . U - state vector
1684efe9872eSLisandro Dalcin . V - time derivative of state vector
1685efe9872eSLisandro Dalcin . A - second time derivative of state vector
1686efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1687efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1688efe9872eSLisandro Dalcin 
1689efe9872eSLisandro Dalcin   Output Parameters:
1690efe9872eSLisandro Dalcin + J - Jacobian matrix
1691efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1692efe9872eSLisandro Dalcin 
1693efe9872eSLisandro Dalcin   Notes:
1694efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1695efe9872eSLisandro Dalcin 
1696efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1697efe9872eSLisandro Dalcin 
1698efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1699efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1700efe9872eSLisandro Dalcin 
1701efe9872eSLisandro Dalcin   Level: developer
1702efe9872eSLisandro Dalcin 
1703efe9872eSLisandro Dalcin .seealso:  TSSetI2Jacobian()
1704efe9872eSLisandro Dalcin @*/
1705efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1706efe9872eSLisandro Dalcin {
1707efe9872eSLisandro Dalcin   DM             dm;
1708efe9872eSLisandro Dalcin   TSI2Jacobian   I2Jacobian;
1709efe9872eSLisandro Dalcin   void           *ctx;
1710efe9872eSLisandro Dalcin   TSRHSJacobian  rhsjacobian;
1711efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1712efe9872eSLisandro Dalcin 
1713efe9872eSLisandro Dalcin   PetscFunctionBegin;
1714efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1715efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1716efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1717efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1718efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J,MAT_CLASSID,8);
1719efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P,MAT_CLASSID,9);
1720efe9872eSLisandro Dalcin 
1721efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1722efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr);
1723efe9872eSLisandro Dalcin   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
1724efe9872eSLisandro Dalcin 
1725efe9872eSLisandro Dalcin   if (!I2Jacobian) {
1726efe9872eSLisandro Dalcin     ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr);
1727efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1728efe9872eSLisandro Dalcin   }
1729efe9872eSLisandro Dalcin 
1730efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1731efe9872eSLisandro Dalcin 
1732efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit Jacobian");
1733efe9872eSLisandro Dalcin   ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr);
1734efe9872eSLisandro Dalcin   PetscStackPop;
1735efe9872eSLisandro Dalcin 
1736efe9872eSLisandro Dalcin   if (rhsjacobian) {
1737efe9872eSLisandro Dalcin     Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1738efe9872eSLisandro Dalcin     ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr);
1739efe9872eSLisandro Dalcin     ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr);
1740efe9872eSLisandro Dalcin     ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr);
1741efe9872eSLisandro Dalcin     if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);}
1742efe9872eSLisandro Dalcin   }
1743efe9872eSLisandro Dalcin 
1744efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1745efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1746efe9872eSLisandro Dalcin }
1747efe9872eSLisandro Dalcin 
1748438f35afSJed Brown /*@C
1749438f35afSJed Brown    TSSetTransientVariable - sets function to transform from state to transient variables
1750438f35afSJed Brown 
1751438f35afSJed Brown    Logically Collective
1752438f35afSJed Brown 
1753438f35afSJed Brown    Input Arguments:
1754438f35afSJed Brown +  ts - time stepping context on which to change the transient variable
1755a96d6ef6SBarry Smith .  tvar - a function that transforms to transient variables
1756438f35afSJed Brown -  ctx - a context for tvar
1757438f35afSJed Brown 
1758a96d6ef6SBarry Smith     Calling sequence of tvar:
1759a96d6ef6SBarry Smith $     PetscErrorCode tvar(TS ts,Vec p,Vec c,void *ctx);
1760a96d6ef6SBarry Smith 
1761a96d6ef6SBarry Smith +   ts - timestep context
1762a96d6ef6SBarry Smith .   p - input vector (primative form)
1763a96d6ef6SBarry Smith .   c - output vector, transient variables (conservative form)
1764a96d6ef6SBarry Smith -   ctx - [optional] user-defined function context
1765a96d6ef6SBarry Smith 
1766438f35afSJed Brown    Level: advanced
1767438f35afSJed Brown 
1768438f35afSJed Brown    Notes:
1769438f35afSJed Brown    This is typically used to transform from primitive to conservative variables so that a time integrator (e.g., TSBDF)
1770438f35afSJed Brown    can be conservative.  In this context, primitive variables P are used to model the state (e.g., because they lead to
1771438f35afSJed Brown    well-conditioned formulations even in limiting cases such as low-Mach or zero porosity).  The transient variable is
1772438f35afSJed Brown    C(P), specified by calling this function.  An IFunction thus receives arguments (P, Cdot) and the IJacobian must be
1773438f35afSJed Brown    evaluated via the chain rule, as in
1774438f35afSJed Brown 
1775438f35afSJed Brown      dF/dP + shift * dF/dCdot dC/dP.
1776438f35afSJed Brown 
1777438f35afSJed Brown .seealso: DMTSSetTransientVariable(), DMTSGetTransientVariable(), TSSetIFunction(), TSSetIJacobian()
1778438f35afSJed Brown @*/
1779438f35afSJed Brown PetscErrorCode TSSetTransientVariable(TS ts,TSTransientVariable tvar,void *ctx)
1780438f35afSJed Brown {
1781438f35afSJed Brown   PetscErrorCode ierr;
1782438f35afSJed Brown   DM             dm;
1783438f35afSJed Brown 
1784438f35afSJed Brown   PetscFunctionBegin;
1785438f35afSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1786438f35afSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1787438f35afSJed Brown   ierr = DMTSSetTransientVariable(dm,tvar,ctx);CHKERRQ(ierr);
1788438f35afSJed Brown   PetscFunctionReturn(0);
1789438f35afSJed Brown }
1790438f35afSJed Brown 
1791efe9872eSLisandro Dalcin /*@
1792e3c11fc1SJed Brown    TSComputeTransientVariable - transforms state (primitive) variables to transient (conservative) variables
1793e3c11fc1SJed Brown 
1794e3c11fc1SJed Brown    Logically Collective
1795e3c11fc1SJed Brown 
1796e3c11fc1SJed Brown    Input Parameters:
1797e3c11fc1SJed Brown +  ts - TS on which to compute
1798e3c11fc1SJed Brown -  U - state vector to be transformed to transient variables
1799e3c11fc1SJed Brown 
1800e3c11fc1SJed Brown    Output Parameters:
1801e3c11fc1SJed Brown .  C - transient (conservative) variable
1802e3c11fc1SJed Brown 
1803e3c11fc1SJed Brown    Developer Notes:
1804e3c11fc1SJed Brown    If DMTSSetTransientVariable() has not been called, then C is not modified in this routine and C=NULL is allowed.
1805e3c11fc1SJed Brown    This makes it safe to call without a guard.  One can use TSHasTransientVariable() to check if transient variables are
1806e3c11fc1SJed Brown    being used.
1807e3c11fc1SJed Brown 
1808e3c11fc1SJed Brown    Level: developer
1809e3c11fc1SJed Brown 
1810e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeIFunction(), TSComputeIJacobian()
1811e3c11fc1SJed Brown @*/
1812e3c11fc1SJed Brown PetscErrorCode TSComputeTransientVariable(TS ts,Vec U,Vec C)
1813e3c11fc1SJed Brown {
1814e3c11fc1SJed Brown   PetscErrorCode ierr;
1815e3c11fc1SJed Brown   DM             dm;
1816e3c11fc1SJed Brown   DMTS           dmts;
1817e3c11fc1SJed Brown 
1818e3c11fc1SJed Brown   PetscFunctionBegin;
1819e3c11fc1SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1820e3c11fc1SJed Brown   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
1821e3c11fc1SJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1822e3c11fc1SJed Brown   ierr = DMGetDMTS(dm,&dmts);CHKERRQ(ierr);
1823e3c11fc1SJed Brown   if (dmts->ops->transientvar) {
1824e3c11fc1SJed Brown     PetscValidHeaderSpecific(C,VEC_CLASSID,3);
1825e3c11fc1SJed Brown     ierr = (*dmts->ops->transientvar)(ts,U,C,dmts->transientvarctx);CHKERRQ(ierr);
1826e3c11fc1SJed Brown   }
1827e3c11fc1SJed Brown   PetscFunctionReturn(0);
1828e3c11fc1SJed Brown }
1829e3c11fc1SJed Brown 
1830e3c11fc1SJed Brown /*@
1831e3c11fc1SJed Brown    TSHasTransientVariable - determine whether transient variables have been set
1832e3c11fc1SJed Brown 
1833e3c11fc1SJed Brown    Logically Collective
1834e3c11fc1SJed Brown 
1835e3c11fc1SJed Brown    Input Parameters:
1836e3c11fc1SJed Brown .  ts - TS on which to compute
1837e3c11fc1SJed Brown 
1838e3c11fc1SJed Brown    Output Parameters:
1839e3c11fc1SJed Brown .  has - PETSC_TRUE if transient variables have been set
1840e3c11fc1SJed Brown 
1841e3c11fc1SJed Brown    Level: developer
1842e3c11fc1SJed Brown 
1843e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeTransientVariable()
1844e3c11fc1SJed Brown @*/
1845e3c11fc1SJed Brown PetscErrorCode TSHasTransientVariable(TS ts,PetscBool *has)
1846e3c11fc1SJed Brown {
1847e3c11fc1SJed Brown   PetscErrorCode ierr;
1848e3c11fc1SJed Brown   DM             dm;
1849e3c11fc1SJed Brown   DMTS           dmts;
1850e3c11fc1SJed Brown 
1851e3c11fc1SJed Brown   PetscFunctionBegin;
1852e3c11fc1SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1853e3c11fc1SJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1854e3c11fc1SJed Brown   ierr = DMGetDMTS(dm,&dmts);CHKERRQ(ierr);
1855e3c11fc1SJed Brown   *has = dmts->ops->transientvar ? PETSC_TRUE : PETSC_FALSE;
1856e3c11fc1SJed Brown   PetscFunctionReturn(0);
1857e3c11fc1SJed Brown }
1858e3c11fc1SJed Brown 
1859e3c11fc1SJed Brown /*@
1860efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1861efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1862efe9872eSLisandro Dalcin 
1863d083f849SBarry Smith    Logically Collective on TS
1864efe9872eSLisandro Dalcin 
1865efe9872eSLisandro Dalcin    Input Parameters:
1866efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1867efe9872eSLisandro Dalcin .  u - the solution vector
1868efe9872eSLisandro Dalcin -  v - the time derivative vector
1869efe9872eSLisandro Dalcin 
1870efe9872eSLisandro Dalcin    Level: beginner
1871efe9872eSLisandro Dalcin 
1872efe9872eSLisandro Dalcin @*/
1873efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1874efe9872eSLisandro Dalcin {
1875efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1876efe9872eSLisandro Dalcin 
1877efe9872eSLisandro Dalcin   PetscFunctionBegin;
1878efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1879efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1880efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1881efe9872eSLisandro Dalcin   ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
1882efe9872eSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr);
1883efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
1884efe9872eSLisandro Dalcin   ts->vec_dot = v;
1885efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1886efe9872eSLisandro Dalcin }
1887efe9872eSLisandro Dalcin 
1888efe9872eSLisandro Dalcin /*@
1889efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1890efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1891efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1892efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1893efe9872eSLisandro Dalcin 
1894efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1895efe9872eSLisandro Dalcin 
1896efe9872eSLisandro Dalcin    Input Parameter:
1897efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1898efe9872eSLisandro Dalcin 
1899efe9872eSLisandro Dalcin    Output Parameter:
1900efe9872eSLisandro Dalcin +  u - the vector containing the solution
1901efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1902efe9872eSLisandro Dalcin 
1903efe9872eSLisandro Dalcin    Level: intermediate
1904efe9872eSLisandro Dalcin 
1905efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1906efe9872eSLisandro Dalcin 
1907efe9872eSLisandro Dalcin @*/
1908efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1909efe9872eSLisandro Dalcin {
1910efe9872eSLisandro Dalcin   PetscFunctionBegin;
1911efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1912efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1913efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1914efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1915efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1916efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1917efe9872eSLisandro Dalcin }
1918efe9872eSLisandro Dalcin 
191955849f57SBarry Smith /*@C
192055849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
192155849f57SBarry Smith 
192255849f57SBarry Smith   Collective on PetscViewer
192355849f57SBarry Smith 
192455849f57SBarry Smith   Input Parameters:
192555849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
192655849f57SBarry Smith            some related function before a call to TSLoad().
192755849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
192855849f57SBarry Smith 
192955849f57SBarry Smith    Level: intermediate
193055849f57SBarry Smith 
193155849f57SBarry Smith   Notes:
193255849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
193355849f57SBarry Smith 
193455849f57SBarry Smith   Notes for advanced users:
193555849f57SBarry Smith   Most users should not need to know the details of the binary storage
193655849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
193755849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
193855849f57SBarry Smith   format is
193955849f57SBarry Smith .vb
194055849f57SBarry Smith      has not yet been determined
194155849f57SBarry Smith .ve
194255849f57SBarry Smith 
194355849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
194455849f57SBarry Smith @*/
1945f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
194655849f57SBarry Smith {
194755849f57SBarry Smith   PetscErrorCode ierr;
194855849f57SBarry Smith   PetscBool      isbinary;
194955849f57SBarry Smith   PetscInt       classid;
195055849f57SBarry Smith   char           type[256];
19512d53ad75SBarry Smith   DMTS           sdm;
1952ad6bc421SBarry Smith   DM             dm;
195355849f57SBarry Smith 
195455849f57SBarry Smith   PetscFunctionBegin;
1955f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
195655849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
195755849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
195855849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
195955849f57SBarry Smith 
1960060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1961ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1962060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1963f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1964f2c2a1b9SBarry Smith   if (ts->ops->load) {
1965f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1966f2c2a1b9SBarry Smith   }
1967ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1968ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1969ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1970f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1971f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
19722d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19732d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
197455849f57SBarry Smith   PetscFunctionReturn(0);
197555849f57SBarry Smith }
197655849f57SBarry Smith 
19779804daf3SBarry Smith #include <petscdraw.h>
1978e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1979e04113cfSBarry Smith #include <petscviewersaws.h>
1980f05ece33SBarry Smith #endif
1981fe2efc57SMark 
1982fe2efc57SMark /*@C
1983fe2efc57SMark    TSViewFromOptions - View from Options
1984fe2efc57SMark 
1985fe2efc57SMark    Collective on TS
1986fe2efc57SMark 
1987fe2efc57SMark    Input Parameters:
1988fe2efc57SMark +  A - the application ordering context
1989736c3998SJose E. Roman .  obj - Optional object
1990736c3998SJose E. Roman -  name - command line option
1991fe2efc57SMark 
1992fe2efc57SMark    Level: intermediate
1993fe2efc57SMark .seealso:  TS, TSView, PetscObjectViewFromOptions(), TSCreate()
1994fe2efc57SMark @*/
1995fe2efc57SMark PetscErrorCode  TSViewFromOptions(TS A,PetscObject obj,const char name[])
1996fe2efc57SMark {
1997fe2efc57SMark   PetscErrorCode ierr;
1998fe2efc57SMark 
1999fe2efc57SMark   PetscFunctionBegin;
2000fe2efc57SMark   PetscValidHeaderSpecific(A,TS_CLASSID,1);
2001fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)A,obj,name);CHKERRQ(ierr);
2002fe2efc57SMark   PetscFunctionReturn(0);
2003fe2efc57SMark }
2004fe2efc57SMark 
20057e2c5f70SBarry Smith /*@C
2006d763cef2SBarry Smith     TSView - Prints the TS data structure.
2007d763cef2SBarry Smith 
20084c49b128SBarry Smith     Collective on TS
2009d763cef2SBarry Smith 
2010d763cef2SBarry Smith     Input Parameters:
2011d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
2012d763cef2SBarry Smith -   viewer - visualization context
2013d763cef2SBarry Smith 
2014d763cef2SBarry Smith     Options Database Key:
2015d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
2016d763cef2SBarry Smith 
2017d763cef2SBarry Smith     Notes:
2018d763cef2SBarry Smith     The available visualization contexts include
2019b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
2020b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
2021d763cef2SBarry Smith          output where only the first processor opens
2022d763cef2SBarry Smith          the file.  All other processors send their
2023d763cef2SBarry Smith          data to the first processor to print.
2024d763cef2SBarry Smith 
2025d763cef2SBarry Smith     The user can open an alternative visualization context with
2026b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
2027d763cef2SBarry Smith 
2028d763cef2SBarry Smith     Level: beginner
2029d763cef2SBarry Smith 
2030b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
2031d763cef2SBarry Smith @*/
20327087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
2033d763cef2SBarry Smith {
2034dfbe8321SBarry Smith   PetscErrorCode ierr;
203519fd82e9SBarry Smith   TSType         type;
20362b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
20372d53ad75SBarry Smith   DMTS           sdm;
2038e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2039536b137fSBarry Smith   PetscBool      issaws;
2040f05ece33SBarry Smith #endif
2041d763cef2SBarry Smith 
2042d763cef2SBarry Smith   PetscFunctionBegin;
20430700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20443050cee2SBarry Smith   if (!viewer) {
2045ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
20463050cee2SBarry Smith   }
20470700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
2048c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
2049fd16b177SBarry Smith 
2050251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
2051251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
205255849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
20532b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
2054e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2055536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
2056f05ece33SBarry Smith #endif
205732077d6dSBarry Smith   if (iascii) {
2058dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
2059efd4aadfSBarry Smith     if (ts->ops->view) {
2060efd4aadfSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2061efd4aadfSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
2062efd4aadfSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2063efd4aadfSBarry Smith     }
2064ef85077eSLisandro Dalcin     if (ts->max_steps < PETSC_MAX_INT) {
206577431f27SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
2066ef85077eSLisandro Dalcin     }
2067ef85077eSLisandro Dalcin     if (ts->max_time < PETSC_MAX_REAL) {
20687c8652ddSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
2069ef85077eSLisandro Dalcin     }
2070efd4aadfSBarry Smith     if (ts->usessnes) {
2071efd4aadfSBarry Smith       PetscBool lin;
2072d763cef2SBarry Smith       if (ts->problem_type == TS_NONLINEAR) {
20735ef26d82SJed Brown         ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
2074d763cef2SBarry Smith       }
20755ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
20761ef27442SStefano Zampini       ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&lin,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr);
2077efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr);
2078efd4aadfSBarry Smith     }
2079193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
2080a0af407cSBarry Smith     if (ts->vrtol) {
2081a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of relative error tolerances, ");CHKERRQ(ierr);
2082a0af407cSBarry Smith     } else {
2083a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr);
2084a0af407cSBarry Smith     }
2085a0af407cSBarry Smith     if (ts->vatol) {
2086a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of absolute error tolerances\n");CHKERRQ(ierr);
2087a0af407cSBarry Smith     } else {
2088a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr);
2089a0af407cSBarry Smith     }
2090825ab935SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2091efd4aadfSBarry Smith     ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);
2092825ab935SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
20930f5bd95cSBarry Smith   } else if (isstring) {
2094a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
209536a9e3b9SBarry Smith     ierr = PetscViewerStringSPrintf(viewer," TSType: %-7.7s",type);CHKERRQ(ierr);
209636a9e3b9SBarry Smith     if (ts->ops->view) {ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);}
209755849f57SBarry Smith   } else if (isbinary) {
209855849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
209955849f57SBarry Smith     MPI_Comm    comm;
210055849f57SBarry Smith     PetscMPIInt rank;
210155849f57SBarry Smith     char        type[256];
210255849f57SBarry Smith 
210355849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
210455849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
210555849f57SBarry Smith     if (!rank) {
2106f253e43cSLisandro Dalcin       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
210755849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
2108f253e43cSLisandro Dalcin       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
210955849f57SBarry Smith     }
211055849f57SBarry Smith     if (ts->ops->view) {
211155849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
211255849f57SBarry Smith     }
2113efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2114f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
2115f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
21162d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
21172d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
21182b0a91c0SBarry Smith   } else if (isdraw) {
21192b0a91c0SBarry Smith     PetscDraw draw;
21202b0a91c0SBarry Smith     char      str[36];
212189fd9fafSBarry Smith     PetscReal x,y,bottom,h;
21222b0a91c0SBarry Smith 
21232b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
21242b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
21252b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
21262b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
212751fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
212889fd9fafSBarry Smith     bottom = y - h;
21292b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
21302b0a91c0SBarry Smith     if (ts->ops->view) {
21312b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
21322b0a91c0SBarry Smith     }
2133efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2134efd4aadfSBarry Smith     if (ts->snes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
21352b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2136e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2137536b137fSBarry Smith   } else if (issaws) {
2138d45a07a7SBarry Smith     PetscMPIInt rank;
21392657e9d9SBarry Smith     const char  *name;
21402657e9d9SBarry Smith 
21412657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
2142d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
2143d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
2144d45a07a7SBarry Smith       char       dir[1024];
2145d45a07a7SBarry Smith 
2146e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
2147a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
21482657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
21492657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
21502657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
2151d763cef2SBarry Smith     }
21520acecf5bSBarry Smith     if (ts->ops->view) {
21530acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
21540acecf5bSBarry Smith     }
2155f05ece33SBarry Smith #endif
2156f05ece33SBarry Smith   }
215736a9e3b9SBarry Smith   if (ts->snes && ts->usessnes)  {
215836a9e3b9SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
215936a9e3b9SBarry Smith     ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);
216036a9e3b9SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
216136a9e3b9SBarry Smith   }
216236a9e3b9SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
216336a9e3b9SBarry Smith   ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
2164f05ece33SBarry Smith 
2165b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2166251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
2167b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2168d763cef2SBarry Smith   PetscFunctionReturn(0);
2169d763cef2SBarry Smith }
2170d763cef2SBarry Smith 
2171b07ff414SBarry Smith /*@
2172d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2173d763cef2SBarry Smith    the timesteppers.
2174d763cef2SBarry Smith 
21753f9fe445SBarry Smith    Logically Collective on TS
2176d763cef2SBarry Smith 
2177d763cef2SBarry Smith    Input Parameters:
2178d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2179d763cef2SBarry Smith -  usrP - optional user context
2180d763cef2SBarry Smith 
218195452b02SPatrick Sanan    Fortran Notes:
218295452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2183daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2184daf670e6SBarry Smith 
2185d763cef2SBarry Smith    Level: intermediate
2186d763cef2SBarry Smith 
2187d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2188d763cef2SBarry Smith @*/
21897087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2190d763cef2SBarry Smith {
2191d763cef2SBarry Smith   PetscFunctionBegin;
21920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2193d763cef2SBarry Smith   ts->user = usrP;
2194d763cef2SBarry Smith   PetscFunctionReturn(0);
2195d763cef2SBarry Smith }
2196d763cef2SBarry Smith 
2197b07ff414SBarry Smith /*@
2198d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2199d763cef2SBarry Smith     timestepper.
2200d763cef2SBarry Smith 
2201d763cef2SBarry Smith     Not Collective
2202d763cef2SBarry Smith 
2203d763cef2SBarry Smith     Input Parameter:
2204d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2205d763cef2SBarry Smith 
2206d763cef2SBarry Smith     Output Parameter:
2207d763cef2SBarry Smith .   usrP - user context
2208d763cef2SBarry Smith 
220995452b02SPatrick Sanan    Fortran Notes:
221095452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2211daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2212daf670e6SBarry Smith 
2213d763cef2SBarry Smith     Level: intermediate
2214d763cef2SBarry Smith 
2215d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2216d763cef2SBarry Smith @*/
2217e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2218d763cef2SBarry Smith {
2219d763cef2SBarry Smith   PetscFunctionBegin;
22200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2221e71120c6SJed Brown   *(void**)usrP = ts->user;
2222d763cef2SBarry Smith   PetscFunctionReturn(0);
2223d763cef2SBarry Smith }
2224d763cef2SBarry Smith 
2225d763cef2SBarry Smith /*@
222680275a0aSLisandro Dalcin    TSGetStepNumber - Gets the number of steps completed.
2227d763cef2SBarry Smith 
2228d763cef2SBarry Smith    Not Collective
2229d763cef2SBarry Smith 
2230d763cef2SBarry Smith    Input Parameter:
2231d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2232d763cef2SBarry Smith 
2233d763cef2SBarry Smith    Output Parameter:
223480275a0aSLisandro Dalcin .  steps - number of steps completed so far
2235d763cef2SBarry Smith 
2236d763cef2SBarry Smith    Level: intermediate
2237d763cef2SBarry Smith 
22389be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2239d763cef2SBarry Smith @*/
224080275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps)
2241d763cef2SBarry Smith {
2242d763cef2SBarry Smith   PetscFunctionBegin;
22430700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
224480275a0aSLisandro Dalcin   PetscValidIntPointer(steps,2);
224580275a0aSLisandro Dalcin   *steps = ts->steps;
224680275a0aSLisandro Dalcin   PetscFunctionReturn(0);
224780275a0aSLisandro Dalcin }
224880275a0aSLisandro Dalcin 
224980275a0aSLisandro Dalcin /*@
225080275a0aSLisandro Dalcin    TSSetStepNumber - Sets the number of steps completed.
225180275a0aSLisandro Dalcin 
225280275a0aSLisandro Dalcin    Logically Collective on TS
225380275a0aSLisandro Dalcin 
225480275a0aSLisandro Dalcin    Input Parameters:
225580275a0aSLisandro Dalcin +  ts - the TS context
225680275a0aSLisandro Dalcin -  steps - number of steps completed so far
225780275a0aSLisandro Dalcin 
225880275a0aSLisandro Dalcin    Notes:
225980275a0aSLisandro Dalcin    For most uses of the TS solvers the user need not explicitly call
226080275a0aSLisandro Dalcin    TSSetStepNumber(), as the step counter is appropriately updated in
226180275a0aSLisandro Dalcin    TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to
226280275a0aSLisandro Dalcin    reinitialize timestepping by setting the step counter to zero (and time
226380275a0aSLisandro Dalcin    to the initial time) to solve a similar problem with different initial
226480275a0aSLisandro Dalcin    conditions or parameters. Other possible use case is to continue
226580275a0aSLisandro Dalcin    timestepping from a previously interrupted run in such a way that TS
226680275a0aSLisandro Dalcin    monitors will be called with a initial nonzero step counter.
226780275a0aSLisandro Dalcin 
226880275a0aSLisandro Dalcin    Level: advanced
226980275a0aSLisandro Dalcin 
227080275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution()
227180275a0aSLisandro Dalcin @*/
227280275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps)
227380275a0aSLisandro Dalcin {
227480275a0aSLisandro Dalcin   PetscFunctionBegin;
227580275a0aSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
227680275a0aSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,steps,2);
227780275a0aSLisandro Dalcin   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative");
227880275a0aSLisandro Dalcin   ts->steps = steps;
2279d763cef2SBarry Smith   PetscFunctionReturn(0);
2280d763cef2SBarry Smith }
2281d763cef2SBarry Smith 
2282d763cef2SBarry Smith /*@
2283d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2284d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2285d763cef2SBarry Smith 
22863f9fe445SBarry Smith    Logically Collective on TS
2287d763cef2SBarry Smith 
2288d763cef2SBarry Smith    Input Parameters:
2289d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2290d763cef2SBarry Smith -  time_step - the size of the timestep
2291d763cef2SBarry Smith 
2292d763cef2SBarry Smith    Level: intermediate
2293d763cef2SBarry Smith 
2294aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime()
2295d763cef2SBarry Smith 
2296d763cef2SBarry Smith @*/
22977087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2298d763cef2SBarry Smith {
2299d763cef2SBarry Smith   PetscFunctionBegin;
23000700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2301c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2302d763cef2SBarry Smith   ts->time_step = time_step;
2303d763cef2SBarry Smith   PetscFunctionReturn(0);
2304d763cef2SBarry Smith }
2305d763cef2SBarry Smith 
2306a43b19c4SJed Brown /*@
230749354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
230849354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
230949354f04SShri Abhyankar      or just return at the final time TS computed.
2310a43b19c4SJed Brown 
2311a43b19c4SJed Brown   Logically Collective on TS
2312a43b19c4SJed Brown 
2313a43b19c4SJed Brown    Input Parameter:
2314a43b19c4SJed Brown +   ts - the time-step context
231549354f04SShri Abhyankar -   eftopt - exact final time option
2316a43b19c4SJed Brown 
2317feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2318feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2319feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2320feed9e9dSBarry Smith 
2321feed9e9dSBarry Smith    Options Database:
2322feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2323feed9e9dSBarry Smith 
2324ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2325ee346746SBarry Smith     then the final time you selected.
2326ee346746SBarry Smith 
2327a43b19c4SJed Brown    Level: beginner
2328a43b19c4SJed Brown 
2329f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime()
2330a43b19c4SJed Brown @*/
233149354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2332a43b19c4SJed Brown {
2333a43b19c4SJed Brown   PetscFunctionBegin;
2334a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
233549354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
233649354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2337a43b19c4SJed Brown   PetscFunctionReturn(0);
2338a43b19c4SJed Brown }
2339a43b19c4SJed Brown 
2340d763cef2SBarry Smith /*@
2341f6953c82SLisandro Dalcin    TSGetExactFinalTime - Gets the exact final time option.
2342f6953c82SLisandro Dalcin 
2343f6953c82SLisandro Dalcin    Not Collective
2344f6953c82SLisandro Dalcin 
2345f6953c82SLisandro Dalcin    Input Parameter:
2346f6953c82SLisandro Dalcin .  ts - the TS context
2347f6953c82SLisandro Dalcin 
2348f6953c82SLisandro Dalcin    Output Parameter:
2349f6953c82SLisandro Dalcin .  eftopt - exact final time option
2350f6953c82SLisandro Dalcin 
2351f6953c82SLisandro Dalcin    Level: beginner
2352f6953c82SLisandro Dalcin 
2353f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime()
2354f6953c82SLisandro Dalcin @*/
2355f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt)
2356f6953c82SLisandro Dalcin {
2357f6953c82SLisandro Dalcin   PetscFunctionBegin;
2358f6953c82SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2359f6953c82SLisandro Dalcin   PetscValidPointer(eftopt,2);
2360f6953c82SLisandro Dalcin   *eftopt = ts->exact_final_time;
2361f6953c82SLisandro Dalcin   PetscFunctionReturn(0);
2362f6953c82SLisandro Dalcin }
2363f6953c82SLisandro Dalcin 
2364f6953c82SLisandro Dalcin /*@
2365d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2366d763cef2SBarry Smith 
2367d763cef2SBarry Smith    Not Collective
2368d763cef2SBarry Smith 
2369d763cef2SBarry Smith    Input Parameter:
2370d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2371d763cef2SBarry Smith 
2372d763cef2SBarry Smith    Output Parameter:
2373d763cef2SBarry Smith .  dt - the current timestep size
2374d763cef2SBarry Smith 
2375d763cef2SBarry Smith    Level: intermediate
2376d763cef2SBarry Smith 
2377aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime()
2378d763cef2SBarry Smith 
2379d763cef2SBarry Smith @*/
23807087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2381d763cef2SBarry Smith {
2382d763cef2SBarry Smith   PetscFunctionBegin;
23830700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2384f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2385d763cef2SBarry Smith   *dt = ts->time_step;
2386d763cef2SBarry Smith   PetscFunctionReturn(0);
2387d763cef2SBarry Smith }
2388d763cef2SBarry Smith 
2389d8e5e3e6SSatish Balay /*@
2390d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2391d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2392d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2393d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2394d763cef2SBarry Smith 
2395d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2396d763cef2SBarry Smith 
2397d763cef2SBarry Smith    Input Parameter:
2398d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2399d763cef2SBarry Smith 
2400d763cef2SBarry Smith    Output Parameter:
2401d763cef2SBarry Smith .  v - the vector containing the solution
2402d763cef2SBarry Smith 
240363e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
240463e21af5SBarry Smith    final time. It returns the solution at the next timestep.
240563e21af5SBarry Smith 
2406d763cef2SBarry Smith    Level: intermediate
2407d763cef2SBarry Smith 
24080ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction()
2409d763cef2SBarry Smith 
2410d763cef2SBarry Smith @*/
24117087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2412d763cef2SBarry Smith {
2413d763cef2SBarry Smith   PetscFunctionBegin;
24140700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24154482741eSBarry Smith   PetscValidPointer(v,2);
24168737fe31SLisandro Dalcin   *v = ts->vec_sol;
2417d763cef2SBarry Smith   PetscFunctionReturn(0);
2418d763cef2SBarry Smith }
2419d763cef2SBarry Smith 
242003fe5f5eSDebojyoti Ghosh /*@
2421b2bf4f3aSDebojyoti Ghosh    TSGetSolutionComponents - Returns any solution components at the present
242203fe5f5eSDebojyoti Ghosh    timestep, if available for the time integration method being used.
2423b2bf4f3aSDebojyoti Ghosh    Solution components are quantities that share the same size and
242403fe5f5eSDebojyoti Ghosh    structure as the solution vector.
242503fe5f5eSDebojyoti Ghosh 
242603fe5f5eSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
242703fe5f5eSDebojyoti Ghosh 
242803fe5f5eSDebojyoti Ghosh    Parameters :
2429a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2430b2bf4f3aSDebojyoti Ghosh .  n - If v is PETSC_NULL, then the number of solution components is
2431b2bf4f3aSDebojyoti Ghosh        returned through n, else the n-th solution component is
243203fe5f5eSDebojyoti Ghosh        returned in v.
2433a2b725a8SWilliam Gropp -  v - the vector containing the n-th solution component
243403fe5f5eSDebojyoti Ghosh        (may be PETSC_NULL to use this function to find out
2435b2bf4f3aSDebojyoti Ghosh         the number of solutions components).
243603fe5f5eSDebojyoti Ghosh 
24374cdd57e5SDebojyoti Ghosh    Level: advanced
243803fe5f5eSDebojyoti Ghosh 
243903fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution()
244003fe5f5eSDebojyoti Ghosh 
244103fe5f5eSDebojyoti Ghosh @*/
2442b2bf4f3aSDebojyoti Ghosh PetscErrorCode  TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v)
244303fe5f5eSDebojyoti Ghosh {
244403fe5f5eSDebojyoti Ghosh   PetscErrorCode ierr;
244503fe5f5eSDebojyoti Ghosh 
244603fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
244703fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2448b2bf4f3aSDebojyoti Ghosh   if (!ts->ops->getsolutioncomponents) *n = 0;
244903fe5f5eSDebojyoti Ghosh   else {
2450b2bf4f3aSDebojyoti Ghosh     ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr);
245103fe5f5eSDebojyoti Ghosh   }
245203fe5f5eSDebojyoti Ghosh   PetscFunctionReturn(0);
245303fe5f5eSDebojyoti Ghosh }
245403fe5f5eSDebojyoti Ghosh 
24554cdd57e5SDebojyoti Ghosh /*@
24564cdd57e5SDebojyoti Ghosh    TSGetAuxSolution - Returns an auxiliary solution at the present
24574cdd57e5SDebojyoti Ghosh    timestep, if available for the time integration method being used.
24584cdd57e5SDebojyoti Ghosh 
24594cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
24604cdd57e5SDebojyoti Ghosh 
24614cdd57e5SDebojyoti Ghosh    Parameters :
2462a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2463a2b725a8SWilliam Gropp -  v - the vector containing the auxiliary solution
24644cdd57e5SDebojyoti Ghosh 
24654cdd57e5SDebojyoti Ghosh    Level: intermediate
24664cdd57e5SDebojyoti Ghosh 
24674cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution()
24684cdd57e5SDebojyoti Ghosh 
24694cdd57e5SDebojyoti Ghosh @*/
24704cdd57e5SDebojyoti Ghosh PetscErrorCode  TSGetAuxSolution(TS ts,Vec *v)
24714cdd57e5SDebojyoti Ghosh {
24724cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
24734cdd57e5SDebojyoti Ghosh 
24744cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
24754cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2476f6356ec7SDebojyoti Ghosh   if (ts->ops->getauxsolution) {
24774cdd57e5SDebojyoti Ghosh     ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr);
2478f6356ec7SDebojyoti Ghosh   } else {
2479f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v);CHKERRQ(ierr);
2480f6356ec7SDebojyoti Ghosh   }
24814cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
24824cdd57e5SDebojyoti Ghosh }
24834cdd57e5SDebojyoti Ghosh 
24844cdd57e5SDebojyoti Ghosh /*@
24854cdd57e5SDebojyoti Ghosh    TSGetTimeError - Returns the estimated error vector, if the chosen
24864cdd57e5SDebojyoti Ghosh    TSType has an error estimation functionality.
24874cdd57e5SDebojyoti Ghosh 
24884cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
24894cdd57e5SDebojyoti Ghosh 
24909657682dSDebojyoti Ghosh    Note: MUST call after TSSetUp()
24919657682dSDebojyoti Ghosh 
24924cdd57e5SDebojyoti Ghosh    Parameters :
2493a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2494657c1e31SEmil Constantinescu .  n - current estimate (n=0) or previous one (n=-1)
2495a2b725a8SWilliam Gropp -  v - the vector containing the error (same size as the solution).
24964cdd57e5SDebojyoti Ghosh 
24974cdd57e5SDebojyoti Ghosh    Level: intermediate
24984cdd57e5SDebojyoti Ghosh 
249957df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError()
25004cdd57e5SDebojyoti Ghosh 
25014cdd57e5SDebojyoti Ghosh @*/
25020a01e1b2SEmil Constantinescu PetscErrorCode  TSGetTimeError(TS ts,PetscInt n,Vec *v)
25034cdd57e5SDebojyoti Ghosh {
25044cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
25054cdd57e5SDebojyoti Ghosh 
25064cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
25074cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2508f6356ec7SDebojyoti Ghosh   if (ts->ops->gettimeerror) {
25090a01e1b2SEmil Constantinescu     ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr);
2510f6356ec7SDebojyoti Ghosh   } else {
2511f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v);CHKERRQ(ierr);
2512f6356ec7SDebojyoti Ghosh   }
25134cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
25144cdd57e5SDebojyoti Ghosh }
25154cdd57e5SDebojyoti Ghosh 
251657df6a1bSDebojyoti Ghosh /*@
251757df6a1bSDebojyoti Ghosh    TSSetTimeError - Sets the estimated error vector, if the chosen
251857df6a1bSDebojyoti Ghosh    TSType has an error estimation functionality. This can be used
251957df6a1bSDebojyoti Ghosh    to restart such a time integrator with a given error vector.
252057df6a1bSDebojyoti Ghosh 
252157df6a1bSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
252257df6a1bSDebojyoti Ghosh 
252357df6a1bSDebojyoti Ghosh    Parameters :
2524a2b725a8SWilliam Gropp +  ts - the TS context obtained from TSCreate() (input parameter).
2525a2b725a8SWilliam Gropp -  v - the vector containing the error (same size as the solution).
252657df6a1bSDebojyoti Ghosh 
252757df6a1bSDebojyoti Ghosh    Level: intermediate
252857df6a1bSDebojyoti Ghosh 
252957df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError)
253057df6a1bSDebojyoti Ghosh 
253157df6a1bSDebojyoti Ghosh @*/
253257df6a1bSDebojyoti Ghosh PetscErrorCode  TSSetTimeError(TS ts,Vec v)
253357df6a1bSDebojyoti Ghosh {
253457df6a1bSDebojyoti Ghosh   PetscErrorCode ierr;
253557df6a1bSDebojyoti Ghosh 
253657df6a1bSDebojyoti Ghosh   PetscFunctionBegin;
253757df6a1bSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25389657682dSDebojyoti Ghosh   if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first");
253957df6a1bSDebojyoti Ghosh   if (ts->ops->settimeerror) {
254057df6a1bSDebojyoti Ghosh     ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr);
254157df6a1bSDebojyoti Ghosh   }
254257df6a1bSDebojyoti Ghosh   PetscFunctionReturn(0);
254357df6a1bSDebojyoti Ghosh }
254457df6a1bSDebojyoti Ghosh 
2545bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
2546d8e5e3e6SSatish Balay /*@
2547bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2548d763cef2SBarry Smith 
2549bdad233fSMatthew Knepley   Not collective
2550d763cef2SBarry Smith 
2551bdad233fSMatthew Knepley   Input Parameters:
2552bdad233fSMatthew Knepley + ts   - The TS
2553bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2554d763cef2SBarry Smith .vb
25550910c330SBarry Smith          U_t - A U = 0      (linear)
25560910c330SBarry Smith          U_t - A(t) U = 0   (linear)
25570910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2558d763cef2SBarry Smith .ve
2559d763cef2SBarry Smith 
2560d763cef2SBarry Smith    Level: beginner
2561d763cef2SBarry Smith 
2562bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2563d763cef2SBarry Smith @*/
25647087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2565a7cc72afSBarry Smith {
25669e2a6581SJed Brown   PetscErrorCode ierr;
25679e2a6581SJed Brown 
2568d763cef2SBarry Smith   PetscFunctionBegin;
25690700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2570bdad233fSMatthew Knepley   ts->problem_type = type;
25719e2a6581SJed Brown   if (type == TS_LINEAR) {
25729e2a6581SJed Brown     SNES snes;
25739e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
25749e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
25759e2a6581SJed Brown   }
2576d763cef2SBarry Smith   PetscFunctionReturn(0);
2577d763cef2SBarry Smith }
2578d763cef2SBarry Smith 
2579bdad233fSMatthew Knepley /*@C
2580bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2581bdad233fSMatthew Knepley 
2582bdad233fSMatthew Knepley   Not collective
2583bdad233fSMatthew Knepley 
2584bdad233fSMatthew Knepley   Input Parameter:
2585bdad233fSMatthew Knepley . ts   - The TS
2586bdad233fSMatthew Knepley 
2587bdad233fSMatthew Knepley   Output Parameter:
2588bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2589bdad233fSMatthew Knepley .vb
2590089b2837SJed Brown          M U_t = A U
2591089b2837SJed Brown          M(t) U_t = A(t) U
2592b5abc632SBarry Smith          F(t,U,U_t)
2593bdad233fSMatthew Knepley .ve
2594bdad233fSMatthew Knepley 
2595bdad233fSMatthew Knepley    Level: beginner
2596bdad233fSMatthew Knepley 
2597bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2598bdad233fSMatthew Knepley @*/
25997087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2600a7cc72afSBarry Smith {
2601bdad233fSMatthew Knepley   PetscFunctionBegin;
26020700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
26034482741eSBarry Smith   PetscValidIntPointer(type,2);
2604bdad233fSMatthew Knepley   *type = ts->problem_type;
2605bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2606bdad233fSMatthew Knepley }
2607d763cef2SBarry Smith 
2608303a5415SBarry Smith /*
2609303a5415SBarry 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()
2610303a5415SBarry Smith */
2611303a5415SBarry Smith static PetscErrorCode TSSetExactFinalTimeDefault(TS ts)
2612303a5415SBarry Smith {
2613303a5415SBarry Smith   PetscErrorCode ierr;
2614303a5415SBarry Smith   PetscBool      isnone;
2615303a5415SBarry Smith 
2616303a5415SBarry Smith   PetscFunctionBegin;
2617303a5415SBarry Smith   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
2618303a5415SBarry Smith   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
2619303a5415SBarry Smith 
2620303a5415SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr);
2621303a5415SBarry Smith   if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) {
2622303a5415SBarry Smith     ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP;
2623303a5415SBarry Smith   } else if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) {
2624303a5415SBarry Smith     ts->exact_final_time = TS_EXACTFINALTIME_INTERPOLATE;
2625303a5415SBarry Smith   }
2626303a5415SBarry Smith   PetscFunctionReturn(0);
2627303a5415SBarry Smith }
2628303a5415SBarry Smith 
2629303a5415SBarry Smith 
2630d763cef2SBarry Smith /*@
2631303a5415SBarry Smith    TSSetUp - Sets up the internal data structures for the later use of a timestepper.
2632d763cef2SBarry Smith 
2633d763cef2SBarry Smith    Collective on TS
2634d763cef2SBarry Smith 
2635d763cef2SBarry Smith    Input Parameter:
2636d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2637d763cef2SBarry Smith 
2638d763cef2SBarry Smith    Notes:
2639d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2640d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2641141bd67dSStefano Zampini    the call to TSStep() or TSSolve().  However, if one wishes to control this
2642d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2643141bd67dSStefano Zampini    and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve().
2644d763cef2SBarry Smith 
2645d763cef2SBarry Smith    Level: advanced
2646d763cef2SBarry Smith 
2647141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve()
2648d763cef2SBarry Smith @*/
26497087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2650d763cef2SBarry Smith {
2651dfbe8321SBarry Smith   PetscErrorCode ierr;
26526c6b9e74SPeter Brune   DM             dm;
26536c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2654d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2655cd11d68dSLisandro Dalcin   TSIFunction    ifun;
26566c6b9e74SPeter Brune   TSIJacobian    ijac;
2657efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
26586c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
2659d763cef2SBarry Smith 
2660d763cef2SBarry Smith   PetscFunctionBegin;
26610700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2662277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2663277b19d0SLisandro Dalcin 
26647adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2665cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
2666cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
2667d763cef2SBarry Smith   }
2668277b19d0SLisandro Dalcin 
26691a638600SStefano Zampini   if (!ts->vec_sol) {
26701a638600SStefano Zampini     if (ts->dm) {
26711a638600SStefano Zampini       ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
26721a638600SStefano Zampini     } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
26731a638600SStefano Zampini   }
2674277b19d0SLisandro Dalcin 
2675298bade4SHong Zhang   if (!ts->Jacp && ts->Jacprhs) { /* IJacobianP shares the same matrix with RHSJacobianP if only RHSJacobianP is provided */
2676298bade4SHong Zhang     ierr = PetscObjectReference((PetscObject)ts->Jacprhs);CHKERRQ(ierr);
2677298bade4SHong Zhang     ts->Jacp = ts->Jacprhs;
2678298bade4SHong Zhang   }
2679298bade4SHong Zhang 
2680cd4cee2dSHong Zhang   if (ts->quadraturets) {
2681cd4cee2dSHong Zhang     ierr = TSSetUp(ts->quadraturets);CHKERRQ(ierr);
2682ecf68647SHong Zhang     ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2683cd4cee2dSHong Zhang     ierr = VecDuplicate(ts->quadraturets->vec_sol,&ts->vec_costintegrand);CHKERRQ(ierr);
2684cd4cee2dSHong Zhang   }
2685cd4cee2dSHong Zhang 
2686971015bcSStefano Zampini   ierr = TSGetRHSJacobian(ts,NULL,NULL,&rhsjac,NULL);CHKERRQ(ierr);
2687971015bcSStefano Zampini   if (ts->rhsjacobian.reuse && rhsjac == TSComputeRHSJacobianConstant) {
2688e1244c69SJed Brown     Mat Amat,Pmat;
2689e1244c69SJed Brown     SNES snes;
2690e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2691e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2692e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2693e1244c69SJed Brown      * have displaced the RHS matrix */
2694971015bcSStefano Zampini     if (Amat && Amat == ts->Arhs) {
2695abc0d4abSBarry 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 */
2696abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2697e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2698e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2699e1244c69SJed Brown     }
2700971015bcSStefano Zampini     if (Pmat && Pmat == ts->Brhs) {
2701abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2702e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2703e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2704e1244c69SJed Brown     }
2705e1244c69SJed Brown   }
27062ffb9264SLisandro Dalcin 
27072ffb9264SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
27082ffb9264SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
27092ffb9264SLisandro Dalcin 
2710277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2711000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2712277b19d0SLisandro Dalcin   }
2713277b19d0SLisandro Dalcin 
2714303a5415SBarry Smith   ierr = TSSetExactFinalTimeDefault(ts);CHKERRQ(ierr);
27152ffb9264SLisandro Dalcin 
2716a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
27176c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
27186c6b9e74SPeter Brune    */
27196c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
27200298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
27216c6b9e74SPeter Brune   if (!func) {
27226c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
27236c6b9e74SPeter Brune   }
2724a6772fa2SLisandro 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.
27256c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
27266c6b9e74SPeter Brune    */
27270298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
27280298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
2729efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr);
27300298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
2731efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
27326c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
27336c6b9e74SPeter Brune   }
2734c0517034SDebojyoti Ghosh 
2735c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2736c0517034SDebojyoti Ghosh   if (ts->ops->startingmethod) {
2737c0517034SDebojyoti Ghosh     ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr);
2738c0517034SDebojyoti Ghosh   }
2739c0517034SDebojyoti Ghosh 
2740277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2741277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2742277b19d0SLisandro Dalcin }
2743277b19d0SLisandro Dalcin 
2744f6a906c0SBarry Smith /*@
2745277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2746277b19d0SLisandro Dalcin 
2747277b19d0SLisandro Dalcin    Collective on TS
2748277b19d0SLisandro Dalcin 
2749277b19d0SLisandro Dalcin    Input Parameter:
2750277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2751277b19d0SLisandro Dalcin 
2752277b19d0SLisandro Dalcin    Level: beginner
2753277b19d0SLisandro Dalcin 
2754277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2755277b19d0SLisandro Dalcin @*/
2756277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2757277b19d0SLisandro Dalcin {
27581d06f6b3SHong Zhang   TS_RHSSplitLink ilink = ts->tsrhssplit,next;
2759277b19d0SLisandro Dalcin   PetscErrorCode  ierr;
2760277b19d0SLisandro Dalcin 
2761277b19d0SLisandro Dalcin   PetscFunctionBegin;
2762277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2763b18ea86cSHong Zhang 
2764277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2765277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2766277b19d0SLisandro Dalcin   }
2767277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2768e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2769bbd56ea5SKarl Rupp 
27704e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
27714e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2772214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
27736bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2774efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
2775e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2776e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
277738637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2778bbd56ea5SKarl Rupp 
2779cd4cee2dSHong Zhang   ierr = MatDestroy(&ts->Jacprhs);CHKERRQ(ierr);
2780ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2781ecf68647SHong Zhang   if (ts->forward_solve) {
2782ecf68647SHong Zhang     ierr = TSForwardReset(ts);CHKERRQ(ierr);
2783ecf68647SHong Zhang   }
2784cd4cee2dSHong Zhang   if (ts->quadraturets) {
2785cd4cee2dSHong Zhang     ierr = TSReset(ts->quadraturets);CHKERRQ(ierr);
278636eaed60SHong Zhang     ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2787cd4cee2dSHong Zhang   }
27881d06f6b3SHong Zhang   while (ilink) {
27891d06f6b3SHong Zhang     next = ilink->next;
27901d06f6b3SHong Zhang     ierr = TSDestroy(&ilink->ts);CHKERRQ(ierr);
27911d06f6b3SHong Zhang     ierr = PetscFree(ilink->splitname);CHKERRQ(ierr);
27921d06f6b3SHong Zhang     ierr = ISDestroy(&ilink->is);CHKERRQ(ierr);
27931d06f6b3SHong Zhang     ierr = PetscFree(ilink);CHKERRQ(ierr);
27941d06f6b3SHong Zhang     ilink = next;
279587f4e208SHong Zhang   }
2796545aaa6fSHong Zhang   ts->num_rhs_splits = 0;
2797277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2798d763cef2SBarry Smith   PetscFunctionReturn(0);
2799d763cef2SBarry Smith }
2800d763cef2SBarry Smith 
2801d8e5e3e6SSatish Balay /*@
2802d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2803d763cef2SBarry Smith    with TSCreate().
2804d763cef2SBarry Smith 
2805d763cef2SBarry Smith    Collective on TS
2806d763cef2SBarry Smith 
2807d763cef2SBarry Smith    Input Parameter:
2808d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2809d763cef2SBarry Smith 
2810d763cef2SBarry Smith    Level: beginner
2811d763cef2SBarry Smith 
2812d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2813d763cef2SBarry Smith @*/
28146bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2815d763cef2SBarry Smith {
28166849ba73SBarry Smith   PetscErrorCode ierr;
2817d763cef2SBarry Smith 
2818d763cef2SBarry Smith   PetscFunctionBegin;
28196bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
2820ecf68647SHong Zhang   PetscValidHeaderSpecific(*ts,TS_CLASSID,1);
2821c793f718SLisandro Dalcin   if (--((PetscObject)(*ts))->refct > 0) {*ts = NULL; PetscFunctionReturn(0);}
2822d763cef2SBarry Smith 
2823ecf68647SHong Zhang   ierr = TSReset(*ts);CHKERRQ(ierr);
2824ecf68647SHong Zhang   ierr = TSAdjointReset(*ts);CHKERRQ(ierr);
2825ecf68647SHong Zhang   if ((*ts)->forward_solve) {
2826ecf68647SHong Zhang     ierr = TSForwardReset(*ts);CHKERRQ(ierr);
2827ecf68647SHong Zhang   }
2828e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2829e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
28306bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
28316d4c513bSLisandro Dalcin 
2832bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2833bc952696SBarry Smith 
283484df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
28356427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
28366427ac75SLisandro Dalcin 
28376bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
28386bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
28396bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
28400dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
28416d4c513bSLisandro Dalcin 
2842cd4cee2dSHong Zhang   ierr = TSDestroy(&(*ts)->quadraturets);CHKERRQ(ierr);
2843a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2844d763cef2SBarry Smith   PetscFunctionReturn(0);
2845d763cef2SBarry Smith }
2846d763cef2SBarry Smith 
2847d8e5e3e6SSatish Balay /*@
2848d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2849d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2850d763cef2SBarry Smith 
2851d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2852d763cef2SBarry Smith 
2853d763cef2SBarry Smith    Input Parameter:
2854d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2855d763cef2SBarry Smith 
2856d763cef2SBarry Smith    Output Parameter:
2857d763cef2SBarry Smith .  snes - the nonlinear solver context
2858d763cef2SBarry Smith 
2859d763cef2SBarry Smith    Notes:
2860d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2861d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
286294b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2863d763cef2SBarry Smith 
2864d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
28650298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2866d763cef2SBarry Smith 
2867d763cef2SBarry Smith    Level: beginner
2868d763cef2SBarry Smith 
2869d763cef2SBarry Smith @*/
28707087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2871d763cef2SBarry Smith {
2872d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2873d372ba47SLisandro Dalcin 
2874d763cef2SBarry Smith   PetscFunctionBegin;
28750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28764482741eSBarry Smith   PetscValidPointer(snes,2);
2877d372ba47SLisandro Dalcin   if (!ts->snes) {
2878ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
287916413a6aSBarry Smith     ierr = PetscObjectSetOptions((PetscObject)ts->snes,((PetscObject)ts)->options);CHKERRQ(ierr);
28800298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
28813bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2882d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2883496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
28849e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
28859e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
28869e2a6581SJed Brown     }
2887d372ba47SLisandro Dalcin   }
2888d763cef2SBarry Smith   *snes = ts->snes;
2889d763cef2SBarry Smith   PetscFunctionReturn(0);
2890d763cef2SBarry Smith }
2891d763cef2SBarry Smith 
2892deb2cd25SJed Brown /*@
2893deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2894deb2cd25SJed Brown 
2895deb2cd25SJed Brown    Collective
2896deb2cd25SJed Brown 
2897deb2cd25SJed Brown    Input Parameter:
2898deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2899deb2cd25SJed Brown -  snes - the nonlinear solver context
2900deb2cd25SJed Brown 
2901deb2cd25SJed Brown    Notes:
2902deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2903deb2cd25SJed Brown 
2904deb2cd25SJed Brown    Level: developer
2905deb2cd25SJed Brown 
2906deb2cd25SJed Brown @*/
2907deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2908deb2cd25SJed Brown {
2909deb2cd25SJed Brown   PetscErrorCode ierr;
2910d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2911deb2cd25SJed Brown 
2912deb2cd25SJed Brown   PetscFunctionBegin;
2913deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2914deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2915deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2916deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2917bbd56ea5SKarl Rupp 
2918deb2cd25SJed Brown   ts->snes = snes;
2919bbd56ea5SKarl Rupp 
29200298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
29210298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2922740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
29230298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2924740132f1SEmil Constantinescu   }
2925deb2cd25SJed Brown   PetscFunctionReturn(0);
2926deb2cd25SJed Brown }
2927deb2cd25SJed Brown 
2928d8e5e3e6SSatish Balay /*@
292994b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2930d763cef2SBarry Smith    a TS (timestepper) context.
2931d763cef2SBarry Smith 
293294b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2933d763cef2SBarry Smith 
2934d763cef2SBarry Smith    Input Parameter:
2935d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2936d763cef2SBarry Smith 
2937d763cef2SBarry Smith    Output Parameter:
293894b7f48cSBarry Smith .  ksp - the nonlinear solver context
2939d763cef2SBarry Smith 
2940d763cef2SBarry Smith    Notes:
294194b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2942d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2943d763cef2SBarry Smith    KSP and PC contexts as well.
2944d763cef2SBarry Smith 
294594b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
29460298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2947d763cef2SBarry Smith 
2948d763cef2SBarry Smith    Level: beginner
2949d763cef2SBarry Smith 
2950d763cef2SBarry Smith @*/
29517087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2952d763cef2SBarry Smith {
2953d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2954089b2837SJed Brown   SNES           snes;
2955d372ba47SLisandro Dalcin 
2956d763cef2SBarry Smith   PetscFunctionBegin;
29570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29584482741eSBarry Smith   PetscValidPointer(ksp,2);
295917186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2960e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2961089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2962089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2963d763cef2SBarry Smith   PetscFunctionReturn(0);
2964d763cef2SBarry Smith }
2965d763cef2SBarry Smith 
2966d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2967d763cef2SBarry Smith 
2968adb62b0dSMatthew Knepley /*@
2969618ce8baSLisandro Dalcin    TSSetMaxSteps - Sets the maximum number of steps to use.
2970618ce8baSLisandro Dalcin 
2971618ce8baSLisandro Dalcin    Logically Collective on TS
2972618ce8baSLisandro Dalcin 
2973618ce8baSLisandro Dalcin    Input Parameters:
2974618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2975618ce8baSLisandro Dalcin -  maxsteps - maximum number of steps to use
2976618ce8baSLisandro Dalcin 
2977618ce8baSLisandro Dalcin    Options Database Keys:
2978618ce8baSLisandro Dalcin .  -ts_max_steps <maxsteps> - Sets maxsteps
2979618ce8baSLisandro Dalcin 
2980618ce8baSLisandro Dalcin    Notes:
2981618ce8baSLisandro Dalcin    The default maximum number of steps is 5000
2982618ce8baSLisandro Dalcin 
2983618ce8baSLisandro Dalcin    Level: intermediate
2984618ce8baSLisandro Dalcin 
2985618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime()
2986618ce8baSLisandro Dalcin @*/
2987618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps)
2988618ce8baSLisandro Dalcin {
2989618ce8baSLisandro Dalcin   PetscFunctionBegin;
2990618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2991618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2992618ce8baSLisandro Dalcin   if (maxsteps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative");
2993618ce8baSLisandro Dalcin   ts->max_steps = maxsteps;
2994618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2995618ce8baSLisandro Dalcin }
2996618ce8baSLisandro Dalcin 
2997618ce8baSLisandro Dalcin /*@
2998618ce8baSLisandro Dalcin    TSGetMaxSteps - Gets the maximum number of steps to use.
2999618ce8baSLisandro Dalcin 
3000618ce8baSLisandro Dalcin    Not Collective
3001618ce8baSLisandro Dalcin 
3002618ce8baSLisandro Dalcin    Input Parameters:
3003618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
3004618ce8baSLisandro Dalcin 
3005618ce8baSLisandro Dalcin    Output Parameter:
3006618ce8baSLisandro Dalcin .  maxsteps - maximum number of steps to use
3007618ce8baSLisandro Dalcin 
3008618ce8baSLisandro Dalcin    Level: advanced
3009618ce8baSLisandro Dalcin 
3010618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime()
3011618ce8baSLisandro Dalcin @*/
3012618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps)
3013618ce8baSLisandro Dalcin {
3014618ce8baSLisandro Dalcin   PetscFunctionBegin;
3015618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3016618ce8baSLisandro Dalcin   PetscValidIntPointer(maxsteps,2);
3017618ce8baSLisandro Dalcin   *maxsteps = ts->max_steps;
3018618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3019618ce8baSLisandro Dalcin }
3020618ce8baSLisandro Dalcin 
3021618ce8baSLisandro Dalcin /*@
3022618ce8baSLisandro Dalcin    TSSetMaxTime - Sets the maximum (or final) time for timestepping.
3023618ce8baSLisandro Dalcin 
3024618ce8baSLisandro Dalcin    Logically Collective on TS
3025618ce8baSLisandro Dalcin 
3026618ce8baSLisandro Dalcin    Input Parameters:
3027618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
3028618ce8baSLisandro Dalcin -  maxtime - final time to step to
3029618ce8baSLisandro Dalcin 
3030618ce8baSLisandro Dalcin    Options Database Keys:
3031ef85077eSLisandro Dalcin .  -ts_max_time <maxtime> - Sets maxtime
3032618ce8baSLisandro Dalcin 
3033618ce8baSLisandro Dalcin    Notes:
3034618ce8baSLisandro Dalcin    The default maximum time is 5.0
3035618ce8baSLisandro Dalcin 
3036618ce8baSLisandro Dalcin    Level: intermediate
3037618ce8baSLisandro Dalcin 
3038618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime()
3039618ce8baSLisandro Dalcin @*/
3040618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime)
3041618ce8baSLisandro Dalcin {
3042618ce8baSLisandro Dalcin   PetscFunctionBegin;
3043618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3044618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveReal(ts,maxtime,2);
3045618ce8baSLisandro Dalcin   ts->max_time = maxtime;
3046618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3047618ce8baSLisandro Dalcin }
3048618ce8baSLisandro Dalcin 
3049618ce8baSLisandro Dalcin /*@
3050618ce8baSLisandro Dalcin    TSGetMaxTime - Gets the maximum (or final) time for timestepping.
3051618ce8baSLisandro Dalcin 
3052618ce8baSLisandro Dalcin    Not Collective
3053618ce8baSLisandro Dalcin 
3054618ce8baSLisandro Dalcin    Input Parameters:
3055618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
3056618ce8baSLisandro Dalcin 
3057618ce8baSLisandro Dalcin    Output Parameter:
3058618ce8baSLisandro Dalcin .  maxtime - final time to step to
3059618ce8baSLisandro Dalcin 
3060618ce8baSLisandro Dalcin    Level: advanced
3061618ce8baSLisandro Dalcin 
3062618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps()
3063618ce8baSLisandro Dalcin @*/
3064618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime)
3065618ce8baSLisandro Dalcin {
3066618ce8baSLisandro Dalcin   PetscFunctionBegin;
3067618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3068618ce8baSLisandro Dalcin   PetscValidRealPointer(maxtime,2);
3069618ce8baSLisandro Dalcin   *maxtime = ts->max_time;
3070618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3071618ce8baSLisandro Dalcin }
3072618ce8baSLisandro Dalcin 
3073618ce8baSLisandro Dalcin /*@
3074aaa6c58dSLisandro Dalcin    TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep().
3075edc382c3SSatish Balay 
3076edc382c3SSatish Balay    Level: deprecated
3077edc382c3SSatish Balay 
3078aaa6c58dSLisandro Dalcin @*/
3079aaa6c58dSLisandro Dalcin PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
3080aaa6c58dSLisandro Dalcin {
3081aaa6c58dSLisandro Dalcin   PetscErrorCode ierr;
3082aaa6c58dSLisandro Dalcin   PetscFunctionBegin;
3083aaa6c58dSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3084aaa6c58dSLisandro Dalcin   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
3085aaa6c58dSLisandro Dalcin   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
3086aaa6c58dSLisandro Dalcin   PetscFunctionReturn(0);
3087aaa6c58dSLisandro Dalcin }
3088aaa6c58dSLisandro Dalcin 
3089aaa6c58dSLisandro Dalcin /*@
309019eac22cSLisandro Dalcin    TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime().
3091edc382c3SSatish Balay 
3092edc382c3SSatish Balay    Level: deprecated
3093edc382c3SSatish Balay 
3094adb62b0dSMatthew Knepley @*/
30957087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
3096adb62b0dSMatthew Knepley {
3097adb62b0dSMatthew Knepley   PetscFunctionBegin;
30980700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3099abc0a331SBarry Smith   if (maxsteps) {
31004482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
3101adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
3102adb62b0dSMatthew Knepley   }
3103abc0a331SBarry Smith   if (maxtime) {
31044482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
3105adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
3106adb62b0dSMatthew Knepley   }
3107adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
3108adb62b0dSMatthew Knepley }
3109adb62b0dSMatthew Knepley 
3110d763cef2SBarry Smith /*@
311119eac22cSLisandro Dalcin    TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime().
3112edc382c3SSatish Balay 
3113edc382c3SSatish Balay    Level: deprecated
3114edc382c3SSatish Balay 
3115d763cef2SBarry Smith @*/
31167087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
3117d763cef2SBarry Smith {
3118d763cef2SBarry Smith   PetscFunctionBegin;
31190700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3120c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
3121c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
312239b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
312339b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
3124d763cef2SBarry Smith   PetscFunctionReturn(0);
3125d763cef2SBarry Smith }
3126d763cef2SBarry Smith 
3127d763cef2SBarry Smith /*@
31285c5f5948SLisandro Dalcin    TSGetTimeStepNumber - Deprecated, use TSGetStepNumber().
3129edc382c3SSatish Balay 
3130edc382c3SSatish Balay    Level: deprecated
3131edc382c3SSatish Balay 
31325c5f5948SLisandro Dalcin @*/
3133e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31345c5f5948SLisandro Dalcin 
313519eac22cSLisandro Dalcin /*@
31364f4e0956SLisandro Dalcin    TSGetTotalSteps - Deprecated, use TSGetStepNumber().
3137edc382c3SSatish Balay 
3138edc382c3SSatish Balay    Level: deprecated
3139edc382c3SSatish Balay 
31404f4e0956SLisandro Dalcin @*/
31414f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31424f4e0956SLisandro Dalcin 
31434f4e0956SLisandro Dalcin /*@
3144d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
3145d763cef2SBarry Smith    for use by the TS routines.
3146d763cef2SBarry Smith 
3147d083f849SBarry Smith    Logically Collective on TS
3148d763cef2SBarry Smith 
3149d763cef2SBarry Smith    Input Parameters:
3150d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
31510910c330SBarry Smith -  u - the solution vector
3152d763cef2SBarry Smith 
3153d763cef2SBarry Smith    Level: beginner
3154d763cef2SBarry Smith 
31550ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate()
3156d763cef2SBarry Smith @*/
31570910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
3158d763cef2SBarry Smith {
31598737fe31SLisandro Dalcin   PetscErrorCode ierr;
3160496e6a7aSJed Brown   DM             dm;
31618737fe31SLisandro Dalcin 
3162d763cef2SBarry Smith   PetscFunctionBegin;
31630700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31640910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
31650910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
31666bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
31670910c330SBarry Smith   ts->vec_sol = u;
3168bbd56ea5SKarl Rupp 
3169496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
31700910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
3171d763cef2SBarry Smith   PetscFunctionReturn(0);
3172d763cef2SBarry Smith }
3173d763cef2SBarry Smith 
3174ac226902SBarry Smith /*@C
3175000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
31763f2090d5SJed Brown   called once at the beginning of each time step.
3177000e7ae3SMatthew Knepley 
31783f9fe445SBarry Smith   Logically Collective on TS
3179000e7ae3SMatthew Knepley 
3180000e7ae3SMatthew Knepley   Input Parameters:
3181000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3182000e7ae3SMatthew Knepley - func - The function
3183000e7ae3SMatthew Knepley 
3184000e7ae3SMatthew Knepley   Calling sequence of func:
31856bc98fa9SBarry Smith .   PetscErrorCode func (TS ts);
3186000e7ae3SMatthew Knepley 
3187000e7ae3SMatthew Knepley   Level: intermediate
3188000e7ae3SMatthew Knepley 
3189dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep()
3190000e7ae3SMatthew Knepley @*/
31917087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3192000e7ae3SMatthew Knepley {
3193000e7ae3SMatthew Knepley   PetscFunctionBegin;
31940700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3195ae60f76fSBarry Smith   ts->prestep = func;
3196000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3197000e7ae3SMatthew Knepley }
3198000e7ae3SMatthew Knepley 
319909ee8438SJed Brown /*@
32003f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
32013f2090d5SJed Brown 
32023f2090d5SJed Brown   Collective on TS
32033f2090d5SJed Brown 
32043f2090d5SJed Brown   Input Parameters:
32053f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
32063f2090d5SJed Brown 
32073f2090d5SJed Brown   Notes:
32083f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
32093f2090d5SJed Brown   so most users would not generally call this routine themselves.
32103f2090d5SJed Brown 
32113f2090d5SJed Brown   Level: developer
32123f2090d5SJed Brown 
32139be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
32143f2090d5SJed Brown @*/
32157087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
32163f2090d5SJed Brown {
32173f2090d5SJed Brown   PetscErrorCode ierr;
32183f2090d5SJed Brown 
32193f2090d5SJed Brown   PetscFunctionBegin;
32200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3221ae60f76fSBarry Smith   if (ts->prestep) {
32225efd42a4SStefano Zampini     Vec              U;
32235efd42a4SStefano Zampini     PetscObjectState sprev,spost;
32245efd42a4SStefano Zampini 
32255efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
32265efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3227ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
32285efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3229dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3230312ce896SJed Brown   }
32313f2090d5SJed Brown   PetscFunctionReturn(0);
32323f2090d5SJed Brown }
32333f2090d5SJed Brown 
3234b8123daeSJed Brown /*@C
3235b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3236b8123daeSJed Brown   called once at the beginning of each stage.
3237b8123daeSJed Brown 
3238b8123daeSJed Brown   Logically Collective on TS
3239b8123daeSJed Brown 
3240b8123daeSJed Brown   Input Parameters:
3241b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3242b8123daeSJed Brown - func - The function
3243b8123daeSJed Brown 
3244b8123daeSJed Brown   Calling sequence of func:
3245b8123daeSJed Brown .    PetscErrorCode func(TS ts, PetscReal stagetime);
3246b8123daeSJed Brown 
3247b8123daeSJed Brown   Level: intermediate
3248b8123daeSJed Brown 
3249b8123daeSJed Brown   Note:
3250b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
325180275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
3252b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3253b8123daeSJed Brown 
32549be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3255b8123daeSJed Brown @*/
3256b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3257b8123daeSJed Brown {
3258b8123daeSJed Brown   PetscFunctionBegin;
3259b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3260ae60f76fSBarry Smith   ts->prestage = func;
3261b8123daeSJed Brown   PetscFunctionReturn(0);
3262b8123daeSJed Brown }
3263b8123daeSJed Brown 
32649be3e283SDebojyoti Ghosh /*@C
32659be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
32669be3e283SDebojyoti Ghosh   called once at the end of each stage.
32679be3e283SDebojyoti Ghosh 
32689be3e283SDebojyoti Ghosh   Logically Collective on TS
32699be3e283SDebojyoti Ghosh 
32709be3e283SDebojyoti Ghosh   Input Parameters:
32719be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
32729be3e283SDebojyoti Ghosh - func - The function
32739be3e283SDebojyoti Ghosh 
32749be3e283SDebojyoti Ghosh   Calling sequence of func:
32759be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
32769be3e283SDebojyoti Ghosh 
32779be3e283SDebojyoti Ghosh   Level: intermediate
32789be3e283SDebojyoti Ghosh 
32799be3e283SDebojyoti Ghosh   Note:
32809be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
328180275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
32829be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
32839be3e283SDebojyoti Ghosh 
32849be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
32859be3e283SDebojyoti Ghosh @*/
32869be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
32879be3e283SDebojyoti Ghosh {
32889be3e283SDebojyoti Ghosh   PetscFunctionBegin;
32899be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
32909be3e283SDebojyoti Ghosh   ts->poststage = func;
32919be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
32929be3e283SDebojyoti Ghosh }
32939be3e283SDebojyoti Ghosh 
3294c688d042SShri Abhyankar /*@C
3295c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3296c688d042SShri Abhyankar   called once at the end of each step evaluation.
3297c688d042SShri Abhyankar 
3298c688d042SShri Abhyankar   Logically Collective on TS
3299c688d042SShri Abhyankar 
3300c688d042SShri Abhyankar   Input Parameters:
3301c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3302c688d042SShri Abhyankar - func - The function
3303c688d042SShri Abhyankar 
3304c688d042SShri Abhyankar   Calling sequence of func:
3305c688d042SShri Abhyankar . PetscErrorCode func(TS ts);
3306c688d042SShri Abhyankar 
3307c688d042SShri Abhyankar   Level: intermediate
3308c688d042SShri Abhyankar 
3309c688d042SShri Abhyankar   Note:
33101785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
33111785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3312e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3313e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3314e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3315c688d042SShri Abhyankar 
3316c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3317c688d042SShri Abhyankar @*/
3318c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3319c688d042SShri Abhyankar {
3320c688d042SShri Abhyankar   PetscFunctionBegin;
3321c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3322c688d042SShri Abhyankar   ts->postevaluate = func;
3323c688d042SShri Abhyankar   PetscFunctionReturn(0);
3324c688d042SShri Abhyankar }
3325c688d042SShri Abhyankar 
3326b8123daeSJed Brown /*@
3327b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3328b8123daeSJed Brown 
3329b8123daeSJed Brown   Collective on TS
3330b8123daeSJed Brown 
3331b8123daeSJed Brown   Input Parameters:
3332b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
33339be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3334b8123daeSJed Brown 
3335b8123daeSJed Brown   Notes:
3336b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3337b8123daeSJed Brown   most users would not generally call this routine themselves.
3338b8123daeSJed Brown 
3339b8123daeSJed Brown   Level: developer
3340b8123daeSJed Brown 
33419be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3342b8123daeSJed Brown @*/
3343b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3344b8123daeSJed Brown {
3345b8123daeSJed Brown   PetscFunctionBegin;
3346b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3347ae60f76fSBarry Smith   if (ts->prestage) {
3348ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3349b8123daeSJed Brown   }
3350b8123daeSJed Brown   PetscFunctionReturn(0);
3351b8123daeSJed Brown }
3352b8123daeSJed Brown 
33539be3e283SDebojyoti Ghosh /*@
33549be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
33559be3e283SDebojyoti Ghosh 
33569be3e283SDebojyoti Ghosh   Collective on TS
33579be3e283SDebojyoti Ghosh 
33589be3e283SDebojyoti Ghosh   Input Parameters:
33599be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
33609be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
33619be3e283SDebojyoti Ghosh   stageindex  - Stage number
33629be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
33639be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
33649be3e283SDebojyoti Ghosh 
33659be3e283SDebojyoti Ghosh   Notes:
33669be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
33679be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
33689be3e283SDebojyoti Ghosh 
33699be3e283SDebojyoti Ghosh   Level: developer
33709be3e283SDebojyoti Ghosh 
33719be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
33729be3e283SDebojyoti Ghosh @*/
33739be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
33749be3e283SDebojyoti Ghosh {
33759be3e283SDebojyoti Ghosh   PetscFunctionBegin;
33769be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33774beae5d8SLisandro Dalcin   if (ts->poststage) {
33789be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
33799be3e283SDebojyoti Ghosh   }
33809be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
33819be3e283SDebojyoti Ghosh }
33829be3e283SDebojyoti Ghosh 
3383c688d042SShri Abhyankar /*@
3384c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3385c688d042SShri Abhyankar 
3386c688d042SShri Abhyankar   Collective on TS
3387c688d042SShri Abhyankar 
3388c688d042SShri Abhyankar   Input Parameters:
3389c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3390c688d042SShri Abhyankar 
3391c688d042SShri Abhyankar   Notes:
3392c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3393c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3394c688d042SShri Abhyankar 
3395c688d042SShri Abhyankar   Level: developer
3396c688d042SShri Abhyankar 
3397c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3398c688d042SShri Abhyankar @*/
3399c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3400c688d042SShri Abhyankar {
3401c688d042SShri Abhyankar   PetscErrorCode ierr;
3402c688d042SShri Abhyankar 
3403c688d042SShri Abhyankar   PetscFunctionBegin;
3404c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3405c688d042SShri Abhyankar   if (ts->postevaluate) {
3406dcb233daSLisandro Dalcin     Vec              U;
3407dcb233daSLisandro Dalcin     PetscObjectState sprev,spost;
3408dcb233daSLisandro Dalcin 
3409dcb233daSLisandro Dalcin     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
3410dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3411c688d042SShri Abhyankar     PetscStackCallStandard((*ts->postevaluate),(ts));
3412dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3413dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3414c688d042SShri Abhyankar   }
3415c688d042SShri Abhyankar   PetscFunctionReturn(0);
3416c688d042SShri Abhyankar }
3417c688d042SShri Abhyankar 
3418ac226902SBarry Smith /*@C
3419000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
34203f2090d5SJed Brown   called once at the end of each time step.
3421000e7ae3SMatthew Knepley 
34223f9fe445SBarry Smith   Logically Collective on TS
3423000e7ae3SMatthew Knepley 
3424000e7ae3SMatthew Knepley   Input Parameters:
3425000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3426000e7ae3SMatthew Knepley - func - The function
3427000e7ae3SMatthew Knepley 
3428000e7ae3SMatthew Knepley   Calling sequence of func:
3429b8123daeSJed Brown $ func (TS ts);
3430000e7ae3SMatthew Knepley 
34311785ff2aSShri Abhyankar   Notes:
34321785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
34331785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
34341785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
34351785ff2aSShri Abhyankar 
3436000e7ae3SMatthew Knepley   Level: intermediate
3437000e7ae3SMatthew Knepley 
3438dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep()
3439000e7ae3SMatthew Knepley @*/
34407087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3441000e7ae3SMatthew Knepley {
3442000e7ae3SMatthew Knepley   PetscFunctionBegin;
34430700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3444ae60f76fSBarry Smith   ts->poststep = func;
3445000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3446000e7ae3SMatthew Knepley }
3447000e7ae3SMatthew Knepley 
344809ee8438SJed Brown /*@
34493f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
34503f2090d5SJed Brown 
34513f2090d5SJed Brown   Collective on TS
34523f2090d5SJed Brown 
34533f2090d5SJed Brown   Input Parameters:
34543f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
34553f2090d5SJed Brown 
34563f2090d5SJed Brown   Notes:
34573f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
34583f2090d5SJed Brown   so most users would not generally call this routine themselves.
34593f2090d5SJed Brown 
34603f2090d5SJed Brown   Level: developer
34613f2090d5SJed Brown 
34623f2090d5SJed Brown @*/
34637087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
34643f2090d5SJed Brown {
34653f2090d5SJed Brown   PetscErrorCode ierr;
34663f2090d5SJed Brown 
34673f2090d5SJed Brown   PetscFunctionBegin;
34680700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3469ae60f76fSBarry Smith   if (ts->poststep) {
34705efd42a4SStefano Zampini     Vec              U;
34715efd42a4SStefano Zampini     PetscObjectState sprev,spost;
34725efd42a4SStefano Zampini 
34735efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
34745efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3475ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
34765efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3477dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
347872ac3e02SJed Brown   }
34793f2090d5SJed Brown   PetscFunctionReturn(0);
34803f2090d5SJed Brown }
34813f2090d5SJed Brown 
3482d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3483d763cef2SBarry Smith 
3484d763cef2SBarry Smith /*@C
3485a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3486d763cef2SBarry Smith    timestep to display the iteration's  progress.
3487d763cef2SBarry Smith 
34883f9fe445SBarry Smith    Logically Collective on TS
3489d763cef2SBarry Smith 
3490d763cef2SBarry Smith    Input Parameters:
3491d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3492e213d8f1SJed Brown .  monitor - monitoring routine
3493329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
34940298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3495b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
34960298fd71SBarry Smith           (may be NULL)
3497d763cef2SBarry Smith 
3498e213d8f1SJed Brown    Calling sequence of monitor:
3499dcb233daSLisandro Dalcin $    PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3500d763cef2SBarry Smith 
3501d763cef2SBarry Smith +    ts - the TS context
350263e21af5SBarry 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)
35031f06c33eSBarry Smith .    time - current time
35040910c330SBarry Smith .    u - current iterate
3505d763cef2SBarry Smith -    mctx - [optional] monitoring context
3506d763cef2SBarry Smith 
3507d763cef2SBarry Smith    Notes:
3508d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3509d763cef2SBarry Smith    already has been loaded.
3510d763cef2SBarry Smith 
351195452b02SPatrick Sanan    Fortran Notes:
351295452b02SPatrick Sanan     Only a single monitor function can be set for each TS object
3513025f1a04SBarry Smith 
3514d763cef2SBarry Smith    Level: intermediate
3515d763cef2SBarry Smith 
3516a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3517d763cef2SBarry Smith @*/
3518c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3519d763cef2SBarry Smith {
352078064530SBarry Smith   PetscErrorCode ierr;
352178064530SBarry Smith   PetscInt       i;
352278064530SBarry Smith   PetscBool      identical;
352378064530SBarry Smith 
3524d763cef2SBarry Smith   PetscFunctionBegin;
35250700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
352678064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
352778064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
352878064530SBarry Smith     if (identical) PetscFunctionReturn(0);
352978064530SBarry Smith   }
353017186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3531d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
35328704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3533d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3534d763cef2SBarry Smith   PetscFunctionReturn(0);
3535d763cef2SBarry Smith }
3536d763cef2SBarry Smith 
3537d763cef2SBarry Smith /*@C
3538a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3539d763cef2SBarry Smith 
35403f9fe445SBarry Smith    Logically Collective on TS
3541d763cef2SBarry Smith 
3542d763cef2SBarry Smith    Input Parameters:
3543d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3544d763cef2SBarry Smith 
3545d763cef2SBarry Smith    Notes:
3546d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3547d763cef2SBarry Smith 
3548d763cef2SBarry Smith    Level: intermediate
3549d763cef2SBarry Smith 
3550a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3551d763cef2SBarry Smith @*/
35527087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3553d763cef2SBarry Smith {
3554d952e501SBarry Smith   PetscErrorCode ierr;
3555d952e501SBarry Smith   PetscInt       i;
3556d952e501SBarry Smith 
3557d763cef2SBarry Smith   PetscFunctionBegin;
35580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3559d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
35608704b422SBarry Smith     if (ts->monitordestroy[i]) {
35618704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3562d952e501SBarry Smith     }
3563d952e501SBarry Smith   }
3564d763cef2SBarry Smith   ts->numbermonitors = 0;
3565d763cef2SBarry Smith   PetscFunctionReturn(0);
3566d763cef2SBarry Smith }
3567d763cef2SBarry Smith 
3568721cd6eeSBarry Smith /*@C
3569721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
35705516499fSSatish Balay 
35715516499fSSatish Balay    Level: intermediate
357241251cbbSSatish Balay 
357363e21af5SBarry Smith .seealso:  TSMonitorSet()
357441251cbbSSatish Balay @*/
3575721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3576d763cef2SBarry Smith {
3577dfbe8321SBarry Smith   PetscErrorCode ierr;
3578721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
357941aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3580d132466eSBarry Smith 
3581d763cef2SBarry Smith   PetscFunctionBegin;
35824d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
358341aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
358441aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3585721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
358641aca3d6SBarry Smith   if (iascii) {
3587649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
358863e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
358963e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
359063e21af5SBarry Smith     } else {
35918392e04aSShri 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);
359263e21af5SBarry Smith     }
3593649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
359441aca3d6SBarry Smith   } else if (ibinary) {
359541aca3d6SBarry Smith     PetscMPIInt rank;
359641aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
359741aca3d6SBarry Smith     if (!rank) {
3598450a797fSBarry Smith       PetscBool skipHeader;
3599450a797fSBarry Smith       PetscInt  classid = REAL_FILE_CLASSID;
3600450a797fSBarry Smith 
3601450a797fSBarry Smith       ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr);
3602450a797fSBarry Smith       if (!skipHeader) {
3603f253e43cSLisandro Dalcin          ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
3604450a797fSBarry Smith        }
360541aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
360641aca3d6SBarry Smith     } else {
360741aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
360841aca3d6SBarry Smith     }
360941aca3d6SBarry Smith   }
3610721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3611d763cef2SBarry Smith   PetscFunctionReturn(0);
3612d763cef2SBarry Smith }
3613d763cef2SBarry Smith 
3614cc9c3a59SBarry Smith /*@C
3615cc9c3a59SBarry Smith    TSMonitorExtreme - Prints the extreme values of the solution at each timestep
3616cc9c3a59SBarry Smith 
3617cc9c3a59SBarry Smith    Level: intermediate
3618cc9c3a59SBarry Smith 
3619cc9c3a59SBarry Smith .seealso:  TSMonitorSet()
3620cc9c3a59SBarry Smith @*/
3621cc9c3a59SBarry Smith PetscErrorCode TSMonitorExtreme(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3622cc9c3a59SBarry Smith {
3623cc9c3a59SBarry Smith   PetscErrorCode ierr;
3624cc9c3a59SBarry Smith   PetscViewer    viewer =  vf->viewer;
3625cc9c3a59SBarry Smith   PetscBool      iascii;
3626cc9c3a59SBarry Smith   PetscReal      max,min;
3627cc9c3a59SBarry Smith 
3628cc9c3a59SBarry Smith 
3629cc9c3a59SBarry Smith   PetscFunctionBegin;
3630cc9c3a59SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3631cc9c3a59SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
3632cc9c3a59SBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
3633cc9c3a59SBarry Smith   if (iascii) {
3634cc9c3a59SBarry Smith     ierr = VecMax(v,NULL,&max);CHKERRQ(ierr);
3635cc9c3a59SBarry Smith     ierr = VecMin(v,NULL,&min);CHKERRQ(ierr);
3636cc9c3a59SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
36375132926bSBarry 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);
3638cc9c3a59SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3639cc9c3a59SBarry Smith   }
3640cc9c3a59SBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3641cc9c3a59SBarry Smith   PetscFunctionReturn(0);
3642cc9c3a59SBarry Smith }
3643cc9c3a59SBarry Smith 
3644cd652676SJed Brown /*@
3645cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3646cd652676SJed Brown 
3647cd652676SJed Brown    Collective on TS
3648cd652676SJed Brown 
3649cd652676SJed Brown    Input Argument:
3650cd652676SJed Brown +  ts - time stepping context
3651cd652676SJed Brown -  t - time to interpolate to
3652cd652676SJed Brown 
3653cd652676SJed Brown    Output Argument:
36540910c330SBarry Smith .  U - state at given time
3655cd652676SJed Brown 
3656cd652676SJed Brown    Level: intermediate
3657cd652676SJed Brown 
3658cd652676SJed Brown    Developer Notes:
3659cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3660cd652676SJed Brown 
3661874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
3662cd652676SJed Brown @*/
36630910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3664cd652676SJed Brown {
3665cd652676SJed Brown   PetscErrorCode ierr;
3666cd652676SJed Brown 
3667cd652676SJed Brown   PetscFunctionBegin;
3668cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3669b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3670be5899b3SLisandro 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);
3671ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
36720910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3673cd652676SJed Brown   PetscFunctionReturn(0);
3674cd652676SJed Brown }
3675cd652676SJed Brown 
3676d763cef2SBarry Smith /*@
36776d9e5789SSean Farley    TSStep - Steps one time step
3678d763cef2SBarry Smith 
3679d763cef2SBarry Smith    Collective on TS
3680d763cef2SBarry Smith 
3681d763cef2SBarry Smith    Input Parameter:
3682d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3683d763cef2SBarry Smith 
368427829d71SBarry Smith    Level: developer
3685d763cef2SBarry Smith 
3686b8123daeSJed Brown    Notes:
368727829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
368827829d71SBarry Smith 
3689b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3690b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3691b8123daeSJed Brown 
369219eac22cSLisandro Dalcin    This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the
369319eac22cSLisandro Dalcin    time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
369425cb2221SBarry Smith 
36959be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3696d763cef2SBarry Smith @*/
3697193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3698d763cef2SBarry Smith {
3699dfbe8321SBarry Smith   PetscErrorCode   ierr;
3700fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3701be5899b3SLisandro Dalcin   PetscReal        ptime;
3702d763cef2SBarry Smith 
3703d763cef2SBarry Smith   PetscFunctionBegin;
37040700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3705f1d62c27SHong Zhang   ierr = PetscCitationsRegister("@article{tspaper,\n"
3706fffbeea8SBarry Smith                                 "  title         = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3707f1d62c27SHong Zhang                                 "  author        = {Abhyankar, Shrirang and Brown, Jed and Constantinescu, Emil and Ghosh, Debojyoti and Smith, Barry F. and Zhang, Hong},\n"
3708f1d62c27SHong Zhang                                 "  journal       = {arXiv e-preprints},\n"
3709f1d62c27SHong Zhang                                 "  eprint        = {1806.01437},\n"
3710f1d62c27SHong Zhang                                 "  archivePrefix = {arXiv},\n"
3711f1d62c27SHong Zhang                                 "  year          = {2018}\n}\n",&cite);CHKERRQ(ierr);
3712fffbeea8SBarry Smith 
3713d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
371468bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3715d405a339SMatthew Knepley 
3716fc8dbba5SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3717ef85077eSLisandro 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>");
3718a6772fa2SLisandro 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()");
3719be5899b3SLisandro 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");
3720a6772fa2SLisandro Dalcin 
3721be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
3722be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
37232808aa04SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3724fc8dbba5SLisandro Dalcin 
3725d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3726193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3727d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3728fc8dbba5SLisandro Dalcin 
3729fc8dbba5SLisandro Dalcin   if (ts->reason >= 0) {
3730be5899b3SLisandro Dalcin     ts->ptime_prev = ptime;
37312808aa04SLisandro Dalcin     ts->steps++;
3732be5899b3SLisandro Dalcin     ts->steprollback = PETSC_FALSE;
373328d5b5d6SLisandro Dalcin     ts->steprestart  = PETSC_FALSE;
3734d2daff3dSHong Zhang   }
3735fc8dbba5SLisandro Dalcin 
3736fc8dbba5SLisandro Dalcin   if (!ts->reason) {
373708c7845fSBarry Smith     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
373808c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
373908c7845fSBarry Smith   }
3740fc8dbba5SLisandro Dalcin 
3741fc8dbba5SLisandro 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]);
3742fc8dbba5SLisandro Dalcin   if (ts->reason < 0 && ts->errorifstepfailed) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
374308c7845fSBarry Smith   PetscFunctionReturn(0);
374408c7845fSBarry Smith }
374508c7845fSBarry Smith 
374608c7845fSBarry Smith /*@
37477cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
37487cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
37497cbde773SLisandro Dalcin 
37507cbde773SLisandro Dalcin    Collective on TS
37517cbde773SLisandro Dalcin 
37527cbde773SLisandro Dalcin    Input Arguments:
37537cbde773SLisandro Dalcin +  ts - time stepping context
37547cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
37557cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
37567cbde773SLisandro Dalcin 
37577cbde773SLisandro Dalcin    Output Arguments:
37587cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
37597cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
37607cbde773SLisandro Dalcin 
37617cbde773SLisandro Dalcin    Level: advanced
37627cbde773SLisandro Dalcin 
37637cbde773SLisandro Dalcin    Notes:
37647cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
37657cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
37667cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
37677cbde773SLisandro Dalcin 
37687cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
37697cbde773SLisandro Dalcin @*/
37707cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
37717cbde773SLisandro Dalcin {
37727cbde773SLisandro Dalcin   PetscErrorCode ierr;
37737cbde773SLisandro Dalcin 
37747cbde773SLisandro Dalcin   PetscFunctionBegin;
37757cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
37767cbde773SLisandro Dalcin   PetscValidType(ts,1);
37777cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
37787cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
37797cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
37807cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
37817cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
37827cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
37837cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
37847cbde773SLisandro Dalcin   PetscFunctionReturn(0);
37857cbde773SLisandro Dalcin }
37867cbde773SLisandro Dalcin 
378705175c85SJed Brown /*@
378805175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
378905175c85SJed Brown 
37901c3436cfSJed Brown    Collective on TS
379105175c85SJed Brown 
379205175c85SJed Brown    Input Arguments:
37931c3436cfSJed Brown +  ts - time stepping context
37941c3436cfSJed Brown .  order - desired order of accuracy
37950298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
379605175c85SJed Brown 
379705175c85SJed Brown    Output Arguments:
37980910c330SBarry Smith .  U - state at the end of the current step
379905175c85SJed Brown 
380005175c85SJed Brown    Level: advanced
380105175c85SJed Brown 
3802108c343cSJed Brown    Notes:
3803108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3804108c343cSJed 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.
3805108c343cSJed Brown 
38061c3436cfSJed Brown .seealso: TSStep(), TSAdapt
380705175c85SJed Brown @*/
38080910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
380905175c85SJed Brown {
381005175c85SJed Brown   PetscErrorCode ierr;
381105175c85SJed Brown 
381205175c85SJed Brown   PetscFunctionBegin;
381305175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
381405175c85SJed Brown   PetscValidType(ts,1);
38150910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3816ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
38170910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
381805175c85SJed Brown   PetscFunctionReturn(0);
381905175c85SJed Brown }
382005175c85SJed Brown 
3821aad739acSMatthew G. Knepley /*@C
38222e61be88SMatthew G. Knepley   TSGetComputeInitialCondition - Get the function used to automatically compute an initial condition for the timestepping.
3823aad739acSMatthew G. Knepley 
3824aad739acSMatthew G. Knepley   Not collective
3825aad739acSMatthew G. Knepley 
3826aad739acSMatthew G. Knepley   Input Argument:
3827aad739acSMatthew G. Knepley . ts        - time stepping context
3828aad739acSMatthew G. Knepley 
3829aad739acSMatthew G. Knepley   Output Argument:
38302e61be88SMatthew G. Knepley . initConditions - The function which computes an initial condition
3831aad739acSMatthew G. Knepley 
3832aad739acSMatthew G. Knepley    Level: advanced
3833aad739acSMatthew G. Knepley 
3834aad739acSMatthew G. Knepley    Notes:
3835aad739acSMatthew G. Knepley    The calling sequence for the function is
38362e61be88SMatthew G. Knepley $ initCondition(TS ts, Vec u)
3837aad739acSMatthew G. Knepley $ ts - The timestepping context
38382e61be88SMatthew G. Knepley $ u  - The input vector in which the initial condition is stored
3839aad739acSMatthew G. Knepley 
38402e61be88SMatthew G. Knepley .seealso: TSSetComputeInitialCondition(), TSComputeInitialCondition()
3841aad739acSMatthew G. Knepley @*/
38422e61be88SMatthew G. Knepley PetscErrorCode TSGetComputeInitialCondition(TS ts, PetscErrorCode (**initCondition)(TS, Vec))
3843aad739acSMatthew G. Knepley {
3844aad739acSMatthew G. Knepley   PetscFunctionBegin;
3845aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
38462e61be88SMatthew G. Knepley   PetscValidPointer(initCondition, 2);
38472e61be88SMatthew G. Knepley   *initCondition = ts->ops->initcondition;
3848aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3849aad739acSMatthew G. Knepley }
3850aad739acSMatthew G. Knepley 
3851aad739acSMatthew G. Knepley /*@C
38522e61be88SMatthew G. Knepley   TSSetComputeInitialCondition - Set the function used to automatically compute an initial condition for the timestepping.
3853aad739acSMatthew G. Knepley 
3854aad739acSMatthew G. Knepley   Logically collective on ts
3855aad739acSMatthew G. Knepley 
3856aad739acSMatthew G. Knepley   Input Arguments:
3857aad739acSMatthew G. Knepley + ts        - time stepping context
38582e61be88SMatthew G. Knepley - initCondition - The function which computes an initial condition
3859aad739acSMatthew G. Knepley 
3860aad739acSMatthew G. Knepley   Level: advanced
3861aad739acSMatthew G. Knepley 
3862a96d6ef6SBarry Smith   Calling sequence for initCondition:
3863a96d6ef6SBarry Smith $ PetscErrorCode initCondition(TS ts, Vec u)
3864a96d6ef6SBarry Smith 
3865a96d6ef6SBarry Smith + ts - The timestepping context
3866a96d6ef6SBarry Smith - u  - The input vector in which the initial condition is to be stored
3867aad739acSMatthew G. Knepley 
38682e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSComputeInitialCondition()
3869aad739acSMatthew G. Knepley @*/
38702e61be88SMatthew G. Knepley PetscErrorCode TSSetComputeInitialCondition(TS ts, PetscErrorCode (*initCondition)(TS, Vec))
3871aad739acSMatthew G. Knepley {
3872aad739acSMatthew G. Knepley   PetscFunctionBegin;
3873aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
38742e61be88SMatthew G. Knepley   PetscValidFunction(initCondition, 2);
38752e61be88SMatthew G. Knepley   ts->ops->initcondition = initCondition;
3876aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3877aad739acSMatthew G. Knepley }
3878aad739acSMatthew G. Knepley 
3879aad739acSMatthew G. Knepley /*@
38802e61be88SMatthew G. Knepley   TSComputeInitialCondition - Compute an initial condition for the timestepping using the function previously set.
3881aad739acSMatthew G. Knepley 
3882aad739acSMatthew G. Knepley   Collective on ts
3883aad739acSMatthew G. Knepley 
3884aad739acSMatthew G. Knepley   Input Arguments:
3885aad739acSMatthew G. Knepley + ts - time stepping context
38862e61be88SMatthew G. Knepley - u  - The Vec to store the condition in which will be used in TSSolve()
3887aad739acSMatthew G. Knepley 
3888aad739acSMatthew G. Knepley   Level: advanced
3889aad739acSMatthew G. Knepley 
38902e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve()
3891aad739acSMatthew G. Knepley @*/
38922e61be88SMatthew G. Knepley PetscErrorCode TSComputeInitialCondition(TS ts, Vec u)
3893aad739acSMatthew G. Knepley {
3894aad739acSMatthew G. Knepley   PetscErrorCode ierr;
3895aad739acSMatthew G. Knepley 
3896aad739acSMatthew G. Knepley   PetscFunctionBegin;
3897aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3898aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
38992e61be88SMatthew G. Knepley   if (ts->ops->initcondition) {ierr = (*ts->ops->initcondition)(ts, u);CHKERRQ(ierr);}
3900aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3901aad739acSMatthew G. Knepley }
3902aad739acSMatthew G. Knepley 
3903aad739acSMatthew G. Knepley /*@C
3904aad739acSMatthew G. Knepley   TSGetComputeExactError - Get the function used to automatically compute the exact error for the timestepping.
3905aad739acSMatthew G. Knepley 
3906aad739acSMatthew G. Knepley   Not collective
3907aad739acSMatthew G. Knepley 
3908aad739acSMatthew G. Knepley   Input Argument:
3909aad739acSMatthew G. Knepley . ts         - time stepping context
3910aad739acSMatthew G. Knepley 
3911aad739acSMatthew G. Knepley   Output Argument:
3912aad739acSMatthew G. Knepley . exactError - The function which computes the solution error
3913aad739acSMatthew G. Knepley 
3914aad739acSMatthew G. Knepley   Level: advanced
3915aad739acSMatthew G. Knepley 
3916a96d6ef6SBarry Smith   Calling sequence for exactError:
3917a96d6ef6SBarry Smith $ PetscErrorCode exactError(TS ts, Vec u)
3918a96d6ef6SBarry Smith 
3919a96d6ef6SBarry Smith + ts - The timestepping context
3920a96d6ef6SBarry Smith . u  - The approximate solution vector
3921a96d6ef6SBarry Smith - e  - The input vector in which the error is stored
3922aad739acSMatthew G. Knepley 
3923aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError()
3924aad739acSMatthew G. Knepley @*/
3925aad739acSMatthew G. Knepley PetscErrorCode TSGetComputeExactError(TS ts, PetscErrorCode (**exactError)(TS, Vec, Vec))
3926aad739acSMatthew G. Knepley {
3927aad739acSMatthew G. Knepley   PetscFunctionBegin;
3928aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3929aad739acSMatthew G. Knepley   PetscValidPointer(exactError, 2);
3930aad739acSMatthew G. Knepley   *exactError = ts->ops->exacterror;
3931aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3932aad739acSMatthew G. Knepley }
3933aad739acSMatthew G. Knepley 
3934aad739acSMatthew G. Knepley /*@C
3935aad739acSMatthew G. Knepley   TSSetComputeExactError - Set the function used to automatically compute the exact error for the timestepping.
3936aad739acSMatthew G. Knepley 
3937aad739acSMatthew G. Knepley   Logically collective on ts
3938aad739acSMatthew G. Knepley 
3939aad739acSMatthew G. Knepley   Input Arguments:
3940aad739acSMatthew G. Knepley + ts         - time stepping context
3941aad739acSMatthew G. Knepley - exactError - The function which computes the solution error
3942aad739acSMatthew G. Knepley 
3943aad739acSMatthew G. Knepley   Level: advanced
3944aad739acSMatthew G. Knepley 
3945a96d6ef6SBarry Smith   Calling sequence for exactError:
3946a96d6ef6SBarry Smith $ PetscErrorCode exactError(TS ts, Vec u)
3947a96d6ef6SBarry Smith 
3948a96d6ef6SBarry Smith + ts - The timestepping context
3949a96d6ef6SBarry Smith . u  - The approximate solution vector
3950a96d6ef6SBarry Smith - e  - The input vector in which the error is stored
3951aad739acSMatthew G. Knepley 
3952aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError()
3953aad739acSMatthew G. Knepley @*/
3954aad739acSMatthew G. Knepley PetscErrorCode TSSetComputeExactError(TS ts, PetscErrorCode (*exactError)(TS, Vec, Vec))
3955aad739acSMatthew G. Knepley {
3956aad739acSMatthew G. Knepley   PetscFunctionBegin;
3957aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3958f907fdbfSMatthew G. Knepley   PetscValidFunction(exactError, 2);
3959aad739acSMatthew G. Knepley   ts->ops->exacterror = exactError;
3960aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3961aad739acSMatthew G. Knepley }
3962aad739acSMatthew G. Knepley 
3963aad739acSMatthew G. Knepley /*@
3964aad739acSMatthew G. Knepley   TSComputeExactError - Compute the solution error for the timestepping using the function previously set.
3965aad739acSMatthew G. Knepley 
3966aad739acSMatthew G. Knepley   Collective on ts
3967aad739acSMatthew G. Knepley 
3968aad739acSMatthew G. Knepley   Input Arguments:
3969aad739acSMatthew G. Knepley + ts - time stepping context
3970aad739acSMatthew G. Knepley . u  - The approximate solution
3971aad739acSMatthew G. Knepley - e  - The Vec used to store the error
3972aad739acSMatthew G. Knepley 
3973aad739acSMatthew G. Knepley   Level: advanced
3974aad739acSMatthew G. Knepley 
39752e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve()
3976aad739acSMatthew G. Knepley @*/
3977aad739acSMatthew G. Knepley PetscErrorCode TSComputeExactError(TS ts, Vec u, Vec e)
3978aad739acSMatthew G. Knepley {
3979aad739acSMatthew G. Knepley   PetscErrorCode ierr;
3980aad739acSMatthew G. Knepley 
3981aad739acSMatthew G. Knepley   PetscFunctionBegin;
3982aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3983aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
3984aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(e, VEC_CLASSID, 3);
3985aad739acSMatthew G. Knepley   if (ts->ops->exacterror) {ierr = (*ts->ops->exacterror)(ts, u, e);CHKERRQ(ierr);}
3986aad739acSMatthew G. Knepley   PetscFunctionReturn(0);
3987aad739acSMatthew G. Knepley }
3988aad739acSMatthew G. Knepley 
3989b1cb36f3SHong Zhang /*@
39906a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
39916a4d4014SLisandro Dalcin 
39926a4d4014SLisandro Dalcin    Collective on TS
39936a4d4014SLisandro Dalcin 
39946a4d4014SLisandro Dalcin    Input Parameter:
39956a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
399663e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
399763e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
39985a3a76d0SJed Brown 
39996a4d4014SLisandro Dalcin    Level: beginner
40006a4d4014SLisandro Dalcin 
40015a3a76d0SJed Brown    Notes:
40025a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
40035a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
40045a3a76d0SJed Brown    stepped over the final time.
40055a3a76d0SJed Brown 
400663e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
40076a4d4014SLisandro Dalcin @*/
4008cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
40096a4d4014SLisandro Dalcin {
4010b06615a5SLisandro Dalcin   Vec               solution;
40116a4d4014SLisandro Dalcin   PetscErrorCode    ierr;
4012f22f69f0SBarry Smith 
40136a4d4014SLisandro Dalcin   PetscFunctionBegin;
40140700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4015f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
4016303a5415SBarry Smith 
4017303a5415SBarry Smith   ierr = TSSetExactFinalTimeDefault(ts);CHKERRQ(ierr);
4018ee41a567SStefano 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 */
40190910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
4020b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
4021b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
4022b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
40235a3a76d0SJed Brown     }
40240910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
4025715f1b00SHong Zhang     if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
4026bbd56ea5SKarl Rupp   } else if (u) {
40270910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
40285a3a76d0SJed Brown   }
4029b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
403068bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4031a6772fa2SLisandro Dalcin 
4032ef85077eSLisandro 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>");
4033a6772fa2SLisandro 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()");
4034a6772fa2SLisandro 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");
4035a6772fa2SLisandro Dalcin 
4036715f1b00SHong Zhang   if (ts->forward_solve) {
4037715f1b00SHong Zhang     ierr = TSForwardSetUp(ts);CHKERRQ(ierr);
4038715f1b00SHong Zhang   }
4039715f1b00SHong Zhang 
4040e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
4041715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
4042e7069c78SShri      TSTrajectory to incorrectly save the output files
4043e7069c78SShri   */
4044715f1b00SHong Zhang   /* reset time step and iteration counters */
40452808aa04SLisandro Dalcin   if (!ts->steps) {
40465ef26d82SJed Brown     ts->ksp_its           = 0;
40475ef26d82SJed Brown     ts->snes_its          = 0;
4048c610991cSLisandro Dalcin     ts->num_snes_failures = 0;
4049c610991cSLisandro Dalcin     ts->reject            = 0;
40502808aa04SLisandro Dalcin     ts->steprestart       = PETSC_TRUE;
40512808aa04SLisandro Dalcin     ts->steprollback      = PETSC_FALSE;
40527d51462cSStefano Zampini     ts->rhsjacobian.time  = PETSC_MIN_REAL;
40532808aa04SLisandro Dalcin   }
4054e97c63d7SStefano Zampini 
4055e97c63d7SStefano Zampini   /* make sure initial time step does not overshoot final time */
4056e97c63d7SStefano Zampini   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP) {
4057e97c63d7SStefano Zampini     PetscReal maxdt = ts->max_time-ts->ptime;
4058e97c63d7SStefano Zampini     PetscReal dt = ts->time_step;
4059e97c63d7SStefano Zampini 
4060e97c63d7SStefano Zampini     ts->time_step = dt >= maxdt ? maxdt : (PetscIsCloseAtTol(dt,maxdt,10*PETSC_MACHINE_EPSILON,0) ? maxdt : dt);
4061e97c63d7SStefano Zampini   }
4062193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
4063193ac0bcSJed Brown 
4064900f6b5bSMatthew G. Knepley   {
4065900f6b5bSMatthew G. Knepley     PetscViewer       viewer;
4066900f6b5bSMatthew G. Knepley     PetscViewerFormat format;
4067900f6b5bSMatthew G. Knepley     PetscBool         flg;
4068900f6b5bSMatthew G. Knepley     static PetscBool  incall = PETSC_FALSE;
4069900f6b5bSMatthew G. Knepley 
4070900f6b5bSMatthew G. Knepley     if (!incall) {
4071900f6b5bSMatthew G. Knepley       /* Estimate the convergence rate of the time discretization */
4072900f6b5bSMatthew G. Knepley       ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) ts),((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_estimate", &viewer, &format, &flg);CHKERRQ(ierr);
4073900f6b5bSMatthew G. Knepley       if (flg) {
4074900f6b5bSMatthew G. Knepley         PetscConvEst conv;
4075900f6b5bSMatthew G. Knepley         DM           dm;
4076900f6b5bSMatthew G. Knepley         PetscReal   *alpha; /* Convergence rate of the solution error for each field in the L_2 norm */
4077900f6b5bSMatthew G. Knepley         PetscInt     Nf;
4078f2ed2dc7SMatthew G. Knepley         PetscBool    checkTemporal = PETSC_TRUE;
4079900f6b5bSMatthew G. Knepley 
4080900f6b5bSMatthew G. Knepley         incall = PETSC_TRUE;
4081f2ed2dc7SMatthew G. Knepley         ierr = PetscOptionsGetBool(((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_temporal", &checkTemporal, &flg);CHKERRQ(ierr);
4082900f6b5bSMatthew G. Knepley         ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
4083900f6b5bSMatthew G. Knepley         ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4084900f6b5bSMatthew G. Knepley         ierr = PetscCalloc1(PetscMax(Nf, 1), &alpha);CHKERRQ(ierr);
4085900f6b5bSMatthew G. Knepley         ierr = PetscConvEstCreate(PetscObjectComm((PetscObject) ts), &conv);CHKERRQ(ierr);
4086f2ed2dc7SMatthew G. Knepley         ierr = PetscConvEstUseTS(conv, checkTemporal);CHKERRQ(ierr);
4087900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetSolver(conv, (PetscObject) ts);CHKERRQ(ierr);
4088900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetFromOptions(conv);CHKERRQ(ierr);
4089900f6b5bSMatthew G. Knepley         ierr = PetscConvEstSetUp(conv);CHKERRQ(ierr);
4090900f6b5bSMatthew G. Knepley         ierr = PetscConvEstGetConvRate(conv, alpha);CHKERRQ(ierr);
4091900f6b5bSMatthew G. Knepley         ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);
4092900f6b5bSMatthew G. Knepley         ierr = PetscConvEstRateView(conv, alpha, viewer);CHKERRQ(ierr);
4093900f6b5bSMatthew G. Knepley         ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
4094900f6b5bSMatthew G. Knepley         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4095900f6b5bSMatthew G. Knepley         ierr = PetscConvEstDestroy(&conv);CHKERRQ(ierr);
4096900f6b5bSMatthew G. Knepley         ierr = PetscFree(alpha);CHKERRQ(ierr);
4097900f6b5bSMatthew G. Knepley         incall = PETSC_FALSE;
4098900f6b5bSMatthew G. Knepley       }
4099900f6b5bSMatthew G. Knepley     }
4100900f6b5bSMatthew G. Knepley   }
4101900f6b5bSMatthew G. Knepley 
4102ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
4103f05ece33SBarry Smith 
4104193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
4105193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
4106a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4107cc708dedSBarry Smith     ts->solvetime = ts->ptime;
4108a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
4109be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
4110db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
4111db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
4112e7069c78SShri 
41132808aa04SLisandro Dalcin     if (!ts->steps) {
41142808aa04SLisandro Dalcin       ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41156427ac75SLisandro Dalcin       ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41162808aa04SLisandro Dalcin     }
41176427ac75SLisandro Dalcin 
4118e1a7a14fSJed Brown     while (!ts->reason) {
41192808aa04SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41209687d888SLisandro Dalcin       if (!ts->steprollback) {
41219687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
41229687d888SLisandro Dalcin       }
4123193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
4124f3b1f45cSBarry Smith       if (ts->testjacobian) {
4125f3b1f45cSBarry Smith         ierr = TSRHSJacobianTest(ts,NULL);CHKERRQ(ierr);
4126f3b1f45cSBarry Smith       }
4127f3b1f45cSBarry Smith       if (ts->testjacobiantranspose) {
4128f3b1f45cSBarry Smith         ierr = TSRHSJacobianTestTranspose(ts,NULL);CHKERRQ(ierr);
4129f3b1f45cSBarry Smith       }
4130cd4cee2dSHong Zhang       if (ts->quadraturets && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */
41317b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */
4132b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
41337b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps++;
4134b1cb36f3SHong Zhang       }
413558818c2dSLisandro Dalcin       if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */
41367b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */
4137715f1b00SHong Zhang         ierr = TSForwardStep(ts);CHKERRQ(ierr);
41387b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps++;
4139715f1b00SHong Zhang       }
414010b82f12SShri Abhyankar       ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
4141e783b05fSHong 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. */
414258818c2dSLisandro Dalcin       if (ts->steprollback) {
414358818c2dSLisandro Dalcin         ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
414458818c2dSLisandro Dalcin       }
4145e783b05fSHong Zhang       if (!ts->steprollback) {
41462808aa04SLisandro Dalcin         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41471eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
4148aeb4809dSShri Abhyankar       }
4149193ac0bcSJed Brown     }
41502808aa04SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41516427ac75SLisandro Dalcin 
415249354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
41530910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
4154cc708dedSBarry Smith       ts->solvetime = ts->max_time;
4155b06615a5SLisandro Dalcin       solution = u;
415663e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
41570574a7fbSJed Brown     } else {
4158ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4159cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4160b06615a5SLisandro Dalcin       solution = ts->vec_sol;
41610574a7fbSJed Brown     }
4162193ac0bcSJed Brown   }
4163d2daff3dSHong Zhang 
4164ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
416563e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
416656f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
4167ef222394SBarry Smith   if (ts->adjoint_solve) {
4168ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
41692b0a91c0SBarry Smith   }
41706a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
41716a4d4014SLisandro Dalcin }
41726a4d4014SLisandro Dalcin 
41737db568b7SBarry Smith /*@C
4174228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4175228d79bcSJed Brown 
4176228d79bcSJed Brown    Collective on TS
4177228d79bcSJed Brown 
4178228d79bcSJed Brown    Input Parameters:
4179228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
4180228d79bcSJed Brown .  step - step number that has just completed
4181228d79bcSJed Brown .  ptime - model time of the state
41820910c330SBarry Smith -  u - state at the current model time
4183228d79bcSJed Brown 
4184228d79bcSJed Brown    Notes:
41857db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
41867db568b7SBarry Smith    Users would almost never call this routine directly.
4187228d79bcSJed Brown 
418863e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
418963e21af5SBarry Smith 
41907db568b7SBarry Smith    Level: developer
4191228d79bcSJed Brown 
4192228d79bcSJed Brown @*/
41930910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4194d763cef2SBarry Smith {
4195d6152f81SLisandro Dalcin   DM             dm;
4196a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
4197d6152f81SLisandro Dalcin   PetscErrorCode ierr;
4198d763cef2SBarry Smith 
4199d763cef2SBarry Smith   PetscFunctionBegin;
4200b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4201b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4202d6152f81SLisandro Dalcin 
4203d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
4204d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
4205d6152f81SLisandro Dalcin 
42068860a134SJunchao Zhang   ierr = VecLockReadPush(u);CHKERRQ(ierr);
4207d763cef2SBarry Smith   for (i=0; i<n; i++) {
42080910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
4209d763cef2SBarry Smith   }
42108860a134SJunchao Zhang   ierr = VecLockReadPop(u);CHKERRQ(ierr);
4211d763cef2SBarry Smith   PetscFunctionReturn(0);
4212d763cef2SBarry Smith }
4213d763cef2SBarry Smith 
4214d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
4215d763cef2SBarry Smith /*@C
42167db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4217a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
4218d763cef2SBarry Smith 
4219d763cef2SBarry Smith    Collective on TS
4220d763cef2SBarry Smith 
4221d763cef2SBarry Smith    Input Parameters:
4222d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
4223d763cef2SBarry Smith .  label - the title to put in the title bar
42247c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
4225a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
4226a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4227d763cef2SBarry Smith 
4228d763cef2SBarry Smith    Output Parameter:
42290b039ecaSBarry Smith .  ctx - the context
4230d763cef2SBarry Smith 
4231d763cef2SBarry Smith    Options Database Key:
42324f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
42338b668821SLisandro Dalcin +  -ts_monitor_lg_timestep_log - automatically sets line graph monitor
42347db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
42357db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
42367db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
42377db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4238b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4239d763cef2SBarry Smith 
4240d763cef2SBarry Smith    Notes:
4241a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
4242d763cef2SBarry Smith 
42437db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
42447db568b7SBarry Smith 
42457db568b7SBarry 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
42467db568b7SBarry 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
42477db568b7SBarry Smith    as the first argument.
42487db568b7SBarry Smith 
42497db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
42507db568b7SBarry Smith 
4251d763cef2SBarry Smith    Level: intermediate
4252d763cef2SBarry Smith 
42537db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
42547db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
42557db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
42567db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
42577db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
42587c922b88SBarry Smith 
4259d763cef2SBarry Smith @*/
4260a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4261d763cef2SBarry Smith {
42627f52daa2SLisandro Dalcin   PetscDraw      draw;
4263dfbe8321SBarry Smith   PetscErrorCode ierr;
4264d763cef2SBarry Smith 
4265d763cef2SBarry Smith   PetscFunctionBegin;
4266b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
42677f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
42687f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
42697f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
4270287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
42717f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
4272a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
4273d763cef2SBarry Smith   PetscFunctionReturn(0);
4274d763cef2SBarry Smith }
4275d763cef2SBarry Smith 
4276b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4277d763cef2SBarry Smith {
42780b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4279c32365f1SBarry Smith   PetscReal      x   = ptime,y;
4280dfbe8321SBarry Smith   PetscErrorCode ierr;
4281d763cef2SBarry Smith 
4282d763cef2SBarry Smith   PetscFunctionBegin;
428363e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
4284b06615a5SLisandro Dalcin   if (!step) {
4285a9f9c1f6SBarry Smith     PetscDrawAxis axis;
42868b668821SLisandro Dalcin     const char *ylabel = ctx->semilogy ? "Log Time Step" : "Time Step";
4287a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
42888b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time",ylabel);CHKERRQ(ierr);
4289a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4290a9f9c1f6SBarry Smith   }
4291c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
42928b668821SLisandro Dalcin   if (ctx->semilogy) y = PetscLog10Real(y);
42930b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
4294b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
42950b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
42966934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
42973923b477SBarry Smith   }
4298d763cef2SBarry Smith   PetscFunctionReturn(0);
4299d763cef2SBarry Smith }
4300d763cef2SBarry Smith 
4301d763cef2SBarry Smith /*@C
4302a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4303a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
4304d763cef2SBarry Smith 
43050b039ecaSBarry Smith    Collective on TSMonitorLGCtx
4306d763cef2SBarry Smith 
4307d763cef2SBarry Smith    Input Parameter:
43080b039ecaSBarry Smith .  ctx - the monitor context
4309d763cef2SBarry Smith 
4310d763cef2SBarry Smith    Level: intermediate
4311d763cef2SBarry Smith 
43124f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
4313d763cef2SBarry Smith @*/
4314a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4315d763cef2SBarry Smith {
4316dfbe8321SBarry Smith   PetscErrorCode ierr;
4317d763cef2SBarry Smith 
4318d763cef2SBarry Smith   PetscFunctionBegin;
43197684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
43207684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
43217684fa3eSBarry Smith   }
43220b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
432331152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
4324387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
4325387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
4326387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
43270b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
4328d763cef2SBarry Smith   PetscFunctionReturn(0);
4329d763cef2SBarry Smith }
4330d763cef2SBarry Smith 
43311b575b74SJoseph Pusztay /*
43321b575b74SJoseph Pusztay 
43331b575b74SJoseph Pusztay   Creates a TS Monitor SPCtx for use with DM Swarm particle visualizations
43341b575b74SJoseph Pusztay 
43351b575b74SJoseph Pusztay */
43361b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorSPCtx *ctx)
43371b575b74SJoseph Pusztay {
43381b575b74SJoseph Pusztay   PetscDraw      draw;
43391b575b74SJoseph Pusztay   PetscErrorCode ierr;
43401b575b74SJoseph Pusztay 
43411b575b74SJoseph Pusztay   PetscFunctionBegin;
43421b575b74SJoseph Pusztay   ierr = PetscNew(ctx);CHKERRQ(ierr);
43431b575b74SJoseph Pusztay   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
43441b575b74SJoseph Pusztay   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
43451b575b74SJoseph Pusztay   ierr = PetscDrawSPCreate(draw,1,&(*ctx)->sp);CHKERRQ(ierr);
43461b575b74SJoseph Pusztay   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
43471b575b74SJoseph Pusztay   (*ctx)->howoften = howoften;
43481b575b74SJoseph Pusztay   PetscFunctionReturn(0);
43491b575b74SJoseph Pusztay 
43501b575b74SJoseph Pusztay }
43511b575b74SJoseph Pusztay 
43521b575b74SJoseph Pusztay /*
43531b575b74SJoseph Pusztay   Destroys a TSMonitorSPCtx that was created with TSMonitorSPCtxCreate
43541b575b74SJoseph Pusztay */
43551b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx *ctx)
43561b575b74SJoseph Pusztay {
43571b575b74SJoseph Pusztay   PetscErrorCode ierr;
43581b575b74SJoseph Pusztay 
43591b575b74SJoseph Pusztay   PetscFunctionBegin;
43601b575b74SJoseph Pusztay 
43611b575b74SJoseph Pusztay   ierr = PetscDrawSPDestroy(&(*ctx)->sp);CHKERRQ(ierr);
43621b575b74SJoseph Pusztay   ierr = PetscFree(*ctx);CHKERRQ(ierr);
43631b575b74SJoseph Pusztay 
43641b575b74SJoseph Pusztay   PetscFunctionReturn(0);
43651b575b74SJoseph Pusztay 
43661b575b74SJoseph Pusztay }
43671b575b74SJoseph Pusztay 
4368d763cef2SBarry Smith /*@
4369b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4370d763cef2SBarry Smith 
4371d763cef2SBarry Smith    Not Collective
4372d763cef2SBarry Smith 
4373d763cef2SBarry Smith    Input Parameter:
4374d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4375d763cef2SBarry Smith 
4376d763cef2SBarry Smith    Output Parameter:
437719eac22cSLisandro Dalcin .  t  - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime().
4378d763cef2SBarry Smith 
4379d763cef2SBarry Smith    Level: beginner
4380d763cef2SBarry Smith 
4381b8123daeSJed Brown    Note:
4382b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
43839be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4384b8123daeSJed Brown 
43858f199f4dSPatrick Sanan .seealso:  TSGetSolveTime(), TSSetTime(), TSGetTimeStep(), TSGetStepNumber()
4386d763cef2SBarry Smith 
4387d763cef2SBarry Smith @*/
43887087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4389d763cef2SBarry Smith {
4390d763cef2SBarry Smith   PetscFunctionBegin;
43910700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4392f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4393d763cef2SBarry Smith   *t = ts->ptime;
4394d763cef2SBarry Smith   PetscFunctionReturn(0);
4395d763cef2SBarry Smith }
4396d763cef2SBarry Smith 
4397e5e524a1SHong Zhang /*@
4398e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4399e5e524a1SHong Zhang 
4400e5e524a1SHong Zhang    Not Collective
4401e5e524a1SHong Zhang 
4402e5e524a1SHong Zhang    Input Parameter:
4403e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4404e5e524a1SHong Zhang 
4405e5e524a1SHong Zhang    Output Parameter:
4406e5e524a1SHong Zhang .  t  - the previous time
4407e5e524a1SHong Zhang 
4408e5e524a1SHong Zhang    Level: beginner
4409e5e524a1SHong Zhang 
4410aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep()
4411e5e524a1SHong Zhang 
4412e5e524a1SHong Zhang @*/
4413e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4414e5e524a1SHong Zhang {
4415e5e524a1SHong Zhang   PetscFunctionBegin;
4416e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4417e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4418e5e524a1SHong Zhang   *t = ts->ptime_prev;
4419e5e524a1SHong Zhang   PetscFunctionReturn(0);
4420e5e524a1SHong Zhang }
4421e5e524a1SHong Zhang 
44226a4d4014SLisandro Dalcin /*@
44236a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
44246a4d4014SLisandro Dalcin 
44253f9fe445SBarry Smith    Logically Collective on TS
44266a4d4014SLisandro Dalcin 
44276a4d4014SLisandro Dalcin    Input Parameters:
44286a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
44296a4d4014SLisandro Dalcin -  time - the time
44306a4d4014SLisandro Dalcin 
44316a4d4014SLisandro Dalcin    Level: intermediate
44326a4d4014SLisandro Dalcin 
443319eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps()
44346a4d4014SLisandro Dalcin 
44356a4d4014SLisandro Dalcin @*/
44367087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
44376a4d4014SLisandro Dalcin {
44386a4d4014SLisandro Dalcin   PetscFunctionBegin;
44390700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4440c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
44416a4d4014SLisandro Dalcin   ts->ptime = t;
44426a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
44436a4d4014SLisandro Dalcin }
44446a4d4014SLisandro Dalcin 
4445d763cef2SBarry Smith /*@C
4446d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4447d763cef2SBarry Smith    TS options in the database.
4448d763cef2SBarry Smith 
44493f9fe445SBarry Smith    Logically Collective on TS
4450d763cef2SBarry Smith 
4451d763cef2SBarry Smith    Input Parameter:
4452d763cef2SBarry Smith +  ts     - The TS context
4453d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4454d763cef2SBarry Smith 
4455d763cef2SBarry Smith    Notes:
4456d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4457d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4458d763cef2SBarry Smith    hyphen.
4459d763cef2SBarry Smith 
4460d763cef2SBarry Smith    Level: advanced
4461d763cef2SBarry Smith 
4462d763cef2SBarry Smith .seealso: TSSetFromOptions()
4463d763cef2SBarry Smith 
4464d763cef2SBarry Smith @*/
44657087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4466d763cef2SBarry Smith {
4467dfbe8321SBarry Smith   PetscErrorCode ierr;
4468089b2837SJed Brown   SNES           snes;
4469d763cef2SBarry Smith 
4470d763cef2SBarry Smith   PetscFunctionBegin;
44710700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4472d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4473089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4474089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4475d763cef2SBarry Smith   PetscFunctionReturn(0);
4476d763cef2SBarry Smith }
4477d763cef2SBarry Smith 
4478d763cef2SBarry Smith /*@C
4479d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to 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: TSGetOptionsPrefix()
4496d763cef2SBarry Smith 
4497d763cef2SBarry Smith @*/
44987087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(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 = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4506089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4507089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4508d763cef2SBarry Smith   PetscFunctionReturn(0);
4509d763cef2SBarry Smith }
4510d763cef2SBarry Smith 
4511d763cef2SBarry Smith /*@C
4512d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4513d763cef2SBarry Smith    TS options in the database.
4514d763cef2SBarry Smith 
4515d763cef2SBarry Smith    Not Collective
4516d763cef2SBarry Smith 
4517d763cef2SBarry Smith    Input Parameter:
4518d763cef2SBarry Smith .  ts - The TS context
4519d763cef2SBarry Smith 
4520d763cef2SBarry Smith    Output Parameter:
4521d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4522d763cef2SBarry Smith 
452395452b02SPatrick Sanan    Notes:
452495452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prifix' of
4525d763cef2SBarry Smith    sufficient length to hold the prefix.
4526d763cef2SBarry Smith 
4527d763cef2SBarry Smith    Level: intermediate
4528d763cef2SBarry Smith 
4529d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4530d763cef2SBarry Smith @*/
45317087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4532d763cef2SBarry Smith {
4533dfbe8321SBarry Smith   PetscErrorCode ierr;
4534d763cef2SBarry Smith 
4535d763cef2SBarry Smith   PetscFunctionBegin;
45360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45374482741eSBarry Smith   PetscValidPointer(prefix,2);
4538d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4539d763cef2SBarry Smith   PetscFunctionReturn(0);
4540d763cef2SBarry Smith }
4541d763cef2SBarry Smith 
4542d763cef2SBarry Smith /*@C
4543d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4544d763cef2SBarry Smith 
4545d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4546d763cef2SBarry Smith 
4547d763cef2SBarry Smith    Input Parameter:
4548d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4549d763cef2SBarry Smith 
4550d763cef2SBarry Smith    Output Parameters:
4551e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4552e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4553e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4554e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4555d763cef2SBarry Smith 
455695452b02SPatrick Sanan    Notes:
455795452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
4558d763cef2SBarry Smith 
4559d763cef2SBarry Smith    Level: intermediate
4560d763cef2SBarry Smith 
456180275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
4562d763cef2SBarry Smith 
4563d763cef2SBarry Smith @*/
4564e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4565d763cef2SBarry Smith {
4566089b2837SJed Brown   PetscErrorCode ierr;
456724989b8cSPeter Brune   DM             dm;
4568089b2837SJed Brown 
4569d763cef2SBarry Smith   PetscFunctionBegin;
457023a57915SBarry Smith   if (Amat || Pmat) {
457123a57915SBarry Smith     SNES snes;
4572089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
457323a57915SBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4574e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
457523a57915SBarry Smith   }
457624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
457724989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4578d763cef2SBarry Smith   PetscFunctionReturn(0);
4579d763cef2SBarry Smith }
4580d763cef2SBarry Smith 
45812eca1d9cSJed Brown /*@C
45822eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
45832eca1d9cSJed Brown 
45842eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
45852eca1d9cSJed Brown 
45862eca1d9cSJed Brown    Input Parameter:
45872eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
45882eca1d9cSJed Brown 
45892eca1d9cSJed Brown    Output Parameters:
4590e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4591e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
45922eca1d9cSJed Brown .  f   - The function to compute the matrices
45932eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
45942eca1d9cSJed Brown 
459595452b02SPatrick Sanan    Notes:
459695452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
45972eca1d9cSJed Brown 
45982eca1d9cSJed Brown    Level: advanced
45992eca1d9cSJed Brown 
460080275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
46012eca1d9cSJed Brown 
46022eca1d9cSJed Brown @*/
4603e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
46042eca1d9cSJed Brown {
4605089b2837SJed Brown   PetscErrorCode ierr;
460624989b8cSPeter Brune   DM             dm;
46070910c330SBarry Smith 
46082eca1d9cSJed Brown   PetscFunctionBegin;
4609c0aab802Sstefano_zampini   if (Amat || Pmat) {
4610c0aab802Sstefano_zampini     SNES snes;
4611089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4612f7d39f7aSBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4613e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
4614c0aab802Sstefano_zampini   }
461524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
461624989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
46172eca1d9cSJed Brown   PetscFunctionReturn(0);
46182eca1d9cSJed Brown }
46192eca1d9cSJed Brown 
46201713a123SBarry Smith /*@C
462183a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
46221713a123SBarry Smith    VecView() for the solution at each timestep
46231713a123SBarry Smith 
46241713a123SBarry Smith    Collective on TS
46251713a123SBarry Smith 
46261713a123SBarry Smith    Input Parameters:
46271713a123SBarry Smith +  ts - the TS context
46281713a123SBarry Smith .  step - current time-step
4629142b95e3SSatish Balay .  ptime - current time
46300298fd71SBarry Smith -  dummy - either a viewer or NULL
46311713a123SBarry Smith 
463299fdda47SBarry Smith    Options Database:
463399fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
463499fdda47SBarry Smith 
463595452b02SPatrick Sanan    Notes:
463695452b02SPatrick Sanan     the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
463799fdda47SBarry Smith        will look bad
463899fdda47SBarry Smith 
46391713a123SBarry Smith    Level: intermediate
46401713a123SBarry Smith 
4641a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
46421713a123SBarry Smith @*/
46430910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
46441713a123SBarry Smith {
4645dfbe8321SBarry Smith   PetscErrorCode   ierr;
464683a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4647473a3ab2SBarry Smith   PetscDraw        draw;
46481713a123SBarry Smith 
46491713a123SBarry Smith   PetscFunctionBegin;
46506083293cSBarry Smith   if (!step && ictx->showinitial) {
46516083293cSBarry Smith     if (!ictx->initialsolution) {
46520910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
46531713a123SBarry Smith     }
46540910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
46556083293cSBarry Smith   }
4656b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
46570dcf80beSBarry Smith 
46586083293cSBarry Smith   if (ictx->showinitial) {
46596083293cSBarry Smith     PetscReal pause;
46606083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
46616083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
46626083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
46636083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
46646083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
46656083293cSBarry Smith   }
46660910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4667473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
466851fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4669473a3ab2SBarry Smith     char      time[32];
4670473a3ab2SBarry Smith 
4671473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
467285b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4673473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4674473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
467551fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4676473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4677473a3ab2SBarry Smith   }
4678473a3ab2SBarry Smith 
46796083293cSBarry Smith   if (ictx->showinitial) {
46806083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
46816083293cSBarry Smith   }
46821713a123SBarry Smith   PetscFunctionReturn(0);
46831713a123SBarry Smith }
46841713a123SBarry Smith 
46859110b2e7SHong Zhang /*@C
46862d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
46872d5ee99bSBarry Smith 
46882d5ee99bSBarry Smith    Collective on TS
46892d5ee99bSBarry Smith 
46902d5ee99bSBarry Smith    Input Parameters:
46912d5ee99bSBarry Smith +  ts - the TS context
46922d5ee99bSBarry Smith .  step - current time-step
46932d5ee99bSBarry Smith .  ptime - current time
46942d5ee99bSBarry Smith -  dummy - either a viewer or NULL
46952d5ee99bSBarry Smith 
46962d5ee99bSBarry Smith    Level: intermediate
46972d5ee99bSBarry Smith 
46982d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
46992d5ee99bSBarry Smith @*/
47002d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
47012d5ee99bSBarry Smith {
47022d5ee99bSBarry Smith   PetscErrorCode    ierr;
47032d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
47042d5ee99bSBarry Smith   PetscDraw         draw;
47056934998bSLisandro Dalcin   PetscDrawAxis     axis;
47062d5ee99bSBarry Smith   PetscInt          n;
47072d5ee99bSBarry Smith   PetscMPIInt       size;
47086934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
47092d5ee99bSBarry Smith   char              time[32];
47102d5ee99bSBarry Smith   const PetscScalar *U;
47112d5ee99bSBarry Smith 
47122d5ee99bSBarry Smith   PetscFunctionBegin;
47136934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
47146934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
47152d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
47166934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
47172d5ee99bSBarry Smith 
47182d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
47196934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
47206934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
47216934998bSLisandro Dalcin   if (!step) {
47226934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
47236934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
47246934998bSLisandro Dalcin   }
47252d5ee99bSBarry Smith 
47262d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
47276934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
47286934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
4729a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
47306934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
47312d5ee99bSBarry Smith 
47326934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
47336934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
47342d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
47354b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
473685b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
47372d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
473851fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
47392d5ee99bSBarry Smith   }
47406934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
47412d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
474256d62c8fSLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
47436934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
47442d5ee99bSBarry Smith   PetscFunctionReturn(0);
47452d5ee99bSBarry Smith }
47462d5ee99bSBarry Smith 
47476083293cSBarry Smith /*@C
474883a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
47496083293cSBarry Smith 
47506083293cSBarry Smith    Collective on TS
47516083293cSBarry Smith 
47526083293cSBarry Smith    Input Parameters:
47536083293cSBarry Smith .    ctx - the monitor context
47546083293cSBarry Smith 
47556083293cSBarry Smith    Level: intermediate
47566083293cSBarry Smith 
475783a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
47586083293cSBarry Smith @*/
475983a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
47606083293cSBarry Smith {
47616083293cSBarry Smith   PetscErrorCode ierr;
47626083293cSBarry Smith 
47636083293cSBarry Smith   PetscFunctionBegin;
476483a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
476583a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
476683a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
47676083293cSBarry Smith   PetscFunctionReturn(0);
47686083293cSBarry Smith }
47696083293cSBarry Smith 
47706083293cSBarry Smith /*@C
477183a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
47726083293cSBarry Smith 
47736083293cSBarry Smith    Collective on TS
47746083293cSBarry Smith 
47756083293cSBarry Smith    Input Parameter:
47766083293cSBarry Smith .    ts - time-step context
47776083293cSBarry Smith 
47786083293cSBarry Smith    Output Patameter:
47796083293cSBarry Smith .    ctx - the monitor context
47806083293cSBarry Smith 
478199fdda47SBarry Smith    Options Database:
478299fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
478399fdda47SBarry Smith 
47846083293cSBarry Smith    Level: intermediate
47856083293cSBarry Smith 
478683a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
47876083293cSBarry Smith @*/
478883a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
47896083293cSBarry Smith {
47906083293cSBarry Smith   PetscErrorCode   ierr;
47916083293cSBarry Smith 
47926083293cSBarry Smith   PetscFunctionBegin;
4793b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
479483a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4795e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4796bbd56ea5SKarl Rupp 
479783a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4798473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
4799c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4800473a3ab2SBarry Smith 
4801473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
4802c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
48036083293cSBarry Smith   PetscFunctionReturn(0);
48046083293cSBarry Smith }
48056083293cSBarry Smith 
48063a471f94SBarry Smith /*@C
48070ed3bfb6SBarry Smith    TSMonitorDrawSolutionFunction - Monitors progress of the TS solvers by calling
48080ed3bfb6SBarry Smith    VecView() for the solution provided by TSSetSolutionFunction() at each timestep
48090ed3bfb6SBarry Smith 
48100ed3bfb6SBarry Smith    Collective on TS
48110ed3bfb6SBarry Smith 
48120ed3bfb6SBarry Smith    Input Parameters:
48130ed3bfb6SBarry Smith +  ts - the TS context
48140ed3bfb6SBarry Smith .  step - current time-step
48150ed3bfb6SBarry Smith .  ptime - current time
48160ed3bfb6SBarry Smith -  dummy - either a viewer or NULL
48170ed3bfb6SBarry Smith 
48180ed3bfb6SBarry Smith    Options Database:
48190ed3bfb6SBarry Smith .  -ts_monitor_draw_solution_function - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
48200ed3bfb6SBarry Smith 
48210ed3bfb6SBarry Smith    Level: intermediate
48220ed3bfb6SBarry Smith 
48230ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
48240ed3bfb6SBarry Smith @*/
48250ed3bfb6SBarry Smith PetscErrorCode  TSMonitorDrawSolutionFunction(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
48260ed3bfb6SBarry Smith {
48270ed3bfb6SBarry Smith   PetscErrorCode   ierr;
48280ed3bfb6SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
48290ed3bfb6SBarry Smith   PetscViewer      viewer = ctx->viewer;
48300ed3bfb6SBarry Smith   Vec              work;
48310ed3bfb6SBarry Smith 
48320ed3bfb6SBarry Smith   PetscFunctionBegin;
48330ed3bfb6SBarry Smith   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
48340ed3bfb6SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
48350ed3bfb6SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
48360ed3bfb6SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
48370ed3bfb6SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
48380ed3bfb6SBarry Smith   PetscFunctionReturn(0);
48390ed3bfb6SBarry Smith }
48400ed3bfb6SBarry Smith 
48410ed3bfb6SBarry Smith /*@C
484283a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
48433a471f94SBarry Smith    VecView() for the error at each timestep
48443a471f94SBarry Smith 
48453a471f94SBarry Smith    Collective on TS
48463a471f94SBarry Smith 
48473a471f94SBarry Smith    Input Parameters:
48483a471f94SBarry Smith +  ts - the TS context
48493a471f94SBarry Smith .  step - current time-step
48503a471f94SBarry Smith .  ptime - current time
48510298fd71SBarry Smith -  dummy - either a viewer or NULL
48523a471f94SBarry Smith 
48530ed3bfb6SBarry Smith    Options Database:
48540ed3bfb6SBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
48550ed3bfb6SBarry Smith 
48563a471f94SBarry Smith    Level: intermediate
48573a471f94SBarry Smith 
48580ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
48593a471f94SBarry Smith @*/
48600910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
48613a471f94SBarry Smith {
48623a471f94SBarry Smith   PetscErrorCode   ierr;
486383a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
486483a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
48653a471f94SBarry Smith   Vec              work;
48663a471f94SBarry Smith 
48673a471f94SBarry Smith   PetscFunctionBegin;
4868b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
48690910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
48703a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
48710910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
48723a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
48733a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
48743a471f94SBarry Smith   PetscFunctionReturn(0);
48753a471f94SBarry Smith }
48763a471f94SBarry Smith 
4877af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
48786c699258SBarry Smith /*@
48792a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
48806c699258SBarry Smith 
4881d083f849SBarry Smith    Logically Collective on ts
48826c699258SBarry Smith 
48836c699258SBarry Smith    Input Parameters:
48842a808120SBarry Smith +  ts - the ODE integrator object
48852a808120SBarry Smith -  dm - the dm, cannot be NULL
48866c699258SBarry Smith 
4887e03a659cSJed Brown    Notes:
4888e03a659cSJed Brown    A DM can only be used for solving one problem at a time because information about the problem is stored on the DM,
4889e03a659cSJed Brown    even when not using interfaces like DMTSSetIFunction().  Use DMClone() to get a distinct DM when solving
4890e03a659cSJed Brown    different problems using the same function space.
4891e03a659cSJed Brown 
48926c699258SBarry Smith    Level: intermediate
48936c699258SBarry Smith 
48946c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
48956c699258SBarry Smith @*/
48967087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
48976c699258SBarry Smith {
48986c699258SBarry Smith   PetscErrorCode ierr;
4899089b2837SJed Brown   SNES           snes;
4900942e3340SBarry Smith   DMTS           tsdm;
49016c699258SBarry Smith 
49026c699258SBarry Smith   PetscFunctionBegin;
49030700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49042a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
490570663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4906942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
49072a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4908942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4909942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
491024989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
491124989b8cSPeter Brune         tsdm->originaldm = dm;
491224989b8cSPeter Brune       }
491324989b8cSPeter Brune     }
49146bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
491524989b8cSPeter Brune   }
49166c699258SBarry Smith   ts->dm = dm;
4917bbd56ea5SKarl Rupp 
4918089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4919089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
49206c699258SBarry Smith   PetscFunctionReturn(0);
49216c699258SBarry Smith }
49226c699258SBarry Smith 
49236c699258SBarry Smith /*@
49246c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
49256c699258SBarry Smith 
49263f9fe445SBarry Smith    Not Collective
49276c699258SBarry Smith 
49286c699258SBarry Smith    Input Parameter:
49296c699258SBarry Smith . ts - the preconditioner context
49306c699258SBarry Smith 
49316c699258SBarry Smith    Output Parameter:
49326c699258SBarry Smith .  dm - the dm
49336c699258SBarry Smith 
49346c699258SBarry Smith    Level: intermediate
49356c699258SBarry Smith 
49366c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
49376c699258SBarry Smith @*/
49387087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
49396c699258SBarry Smith {
4940496e6a7aSJed Brown   PetscErrorCode ierr;
4941496e6a7aSJed Brown 
49426c699258SBarry Smith   PetscFunctionBegin;
49430700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4944496e6a7aSJed Brown   if (!ts->dm) {
4945ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4946496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4947496e6a7aSJed Brown   }
49486c699258SBarry Smith   *dm = ts->dm;
49496c699258SBarry Smith   PetscFunctionReturn(0);
49506c699258SBarry Smith }
49511713a123SBarry Smith 
49520f5c6efeSJed Brown /*@
49530f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
49540f5c6efeSJed Brown 
49553f9fe445SBarry Smith    Logically Collective on SNES
49560f5c6efeSJed Brown 
49570f5c6efeSJed Brown    Input Parameter:
4958d42a1c89SJed Brown + snes - nonlinear solver
49590910c330SBarry Smith . U - the current state at which to evaluate the residual
4960d42a1c89SJed Brown - ctx - user context, must be a TS
49610f5c6efeSJed Brown 
49620f5c6efeSJed Brown    Output Parameter:
49630f5c6efeSJed Brown . F - the nonlinear residual
49640f5c6efeSJed Brown 
49650f5c6efeSJed Brown    Notes:
49660f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
49670f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
49680f5c6efeSJed Brown 
49690f5c6efeSJed Brown    Level: advanced
49700f5c6efeSJed Brown 
49710f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
49720f5c6efeSJed Brown @*/
49730910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
49740f5c6efeSJed Brown {
49750f5c6efeSJed Brown   TS             ts = (TS)ctx;
49760f5c6efeSJed Brown   PetscErrorCode ierr;
49770f5c6efeSJed Brown 
49780f5c6efeSJed Brown   PetscFunctionBegin;
49790f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
49800910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
49810f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
49820f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
49830910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
49840f5c6efeSJed Brown   PetscFunctionReturn(0);
49850f5c6efeSJed Brown }
49860f5c6efeSJed Brown 
49870f5c6efeSJed Brown /*@
49880f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
49890f5c6efeSJed Brown 
49900f5c6efeSJed Brown    Collective on SNES
49910f5c6efeSJed Brown 
49920f5c6efeSJed Brown    Input Parameter:
49930f5c6efeSJed Brown + snes - nonlinear solver
49940910c330SBarry Smith . U - the current state at which to evaluate the residual
49950f5c6efeSJed Brown - ctx - user context, must be a TS
49960f5c6efeSJed Brown 
49970f5c6efeSJed Brown    Output Parameter:
49980f5c6efeSJed Brown + A - the Jacobian
49990f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
50000f5c6efeSJed Brown - flag - indicates any structure change in the matrix
50010f5c6efeSJed Brown 
50020f5c6efeSJed Brown    Notes:
50030f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
50040f5c6efeSJed Brown 
50050f5c6efeSJed Brown    Level: developer
50060f5c6efeSJed Brown 
50070f5c6efeSJed Brown .seealso: SNESSetJacobian()
50080f5c6efeSJed Brown @*/
5009d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
50100f5c6efeSJed Brown {
50110f5c6efeSJed Brown   TS             ts = (TS)ctx;
50120f5c6efeSJed Brown   PetscErrorCode ierr;
50130f5c6efeSJed Brown 
50140f5c6efeSJed Brown   PetscFunctionBegin;
50150f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
50160910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
50170f5c6efeSJed Brown   PetscValidPointer(A,3);
501894ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
50190f5c6efeSJed Brown   PetscValidPointer(B,4);
502094ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
50210f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
5022d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
50230f5c6efeSJed Brown   PetscFunctionReturn(0);
50240f5c6efeSJed Brown }
5025325fc9f4SBarry Smith 
50260e4ef248SJed Brown /*@C
50279ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
50280e4ef248SJed Brown 
50290e4ef248SJed Brown    Collective on TS
50300e4ef248SJed Brown 
50310e4ef248SJed Brown    Input Arguments:
50320e4ef248SJed Brown +  ts - time stepping context
50330e4ef248SJed Brown .  t - time at which to evaluate
50340910c330SBarry Smith .  U - state at which to evaluate
50350e4ef248SJed Brown -  ctx - context
50360e4ef248SJed Brown 
50370e4ef248SJed Brown    Output Arguments:
50380e4ef248SJed Brown .  F - right hand side
50390e4ef248SJed Brown 
50400e4ef248SJed Brown    Level: intermediate
50410e4ef248SJed Brown 
50420e4ef248SJed Brown    Notes:
50430e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
50440e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
50450e4ef248SJed Brown 
50460e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
50470e4ef248SJed Brown @*/
50480910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
50490e4ef248SJed Brown {
50500e4ef248SJed Brown   PetscErrorCode ierr;
50510e4ef248SJed Brown   Mat            Arhs,Brhs;
50520e4ef248SJed Brown 
50530e4ef248SJed Brown   PetscFunctionBegin;
50540e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
5055*2663174eSHong Zhang 
5056*2663174eSHong Zhang   /* undo the damage caused by shifting */
5057*2663174eSHong Zhang   if (ts->rhsjacobian.shift) {
5058*2663174eSHong Zhang     ierr = MatShift(Arhs,-ts->rhsjacobian.shift);CHKERRQ(ierr);
5059*2663174eSHong Zhang    }
5060*2663174eSHong Zhang   if (ts->rhsjacobian.scale == -1.) {
5061*2663174eSHong Zhang     ierr = MatScale(Arhs,-1);CHKERRQ(ierr);
5062*2663174eSHong Zhang   }
5063*2663174eSHong Zhang   if (Arhs != Brhs) {
5064*2663174eSHong Zhang     if (ts->rhsjacobian.shift) {
5065*2663174eSHong Zhang       ierr = MatShift(Brhs,-ts->rhsjacobian.shift);CHKERRQ(ierr);
5066*2663174eSHong Zhang     }
5067*2663174eSHong Zhang     if (ts->rhsjacobian.scale == -1.) {
5068*2663174eSHong Zhang       ierr = MatScale(Brhs,-1);CHKERRQ(ierr);
5069*2663174eSHong Zhang     }
5070*2663174eSHong Zhang   }
5071*2663174eSHong Zhang   ts->rhsjacobian.shift = 0;
5072*2663174eSHong Zhang   ts->rhsjacobian.scale = 1;
5073d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
50740910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
50750e4ef248SJed Brown   PetscFunctionReturn(0);
50760e4ef248SJed Brown }
50770e4ef248SJed Brown 
50780e4ef248SJed Brown /*@C
50790e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
50800e4ef248SJed Brown 
50810e4ef248SJed Brown    Collective on TS
50820e4ef248SJed Brown 
50830e4ef248SJed Brown    Input Arguments:
50840e4ef248SJed Brown +  ts - time stepping context
50850e4ef248SJed Brown .  t - time at which to evaluate
50860910c330SBarry Smith .  U - state at which to evaluate
50870e4ef248SJed Brown -  ctx - context
50880e4ef248SJed Brown 
50890e4ef248SJed Brown    Output Arguments:
50900e4ef248SJed Brown +  A - pointer to operator
50910e4ef248SJed Brown .  B - pointer to preconditioning matrix
50920e4ef248SJed Brown -  flg - matrix structure flag
50930e4ef248SJed Brown 
50940e4ef248SJed Brown    Level: intermediate
50950e4ef248SJed Brown 
50960e4ef248SJed Brown    Notes:
50970e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
50980e4ef248SJed Brown 
50990e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
51000e4ef248SJed Brown @*/
5101d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
51020e4ef248SJed Brown {
51030e4ef248SJed Brown   PetscFunctionBegin;
51040e4ef248SJed Brown   PetscFunctionReturn(0);
51050e4ef248SJed Brown }
51060e4ef248SJed Brown 
51070026cea9SSean Farley /*@C
51080026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
51090026cea9SSean Farley 
51100026cea9SSean Farley    Collective on TS
51110026cea9SSean Farley 
51120026cea9SSean Farley    Input Arguments:
51130026cea9SSean Farley +  ts - time stepping context
51140026cea9SSean Farley .  t - time at which to evaluate
51150910c330SBarry Smith .  U - state at which to evaluate
51160910c330SBarry Smith .  Udot - time derivative of state vector
51170026cea9SSean Farley -  ctx - context
51180026cea9SSean Farley 
51190026cea9SSean Farley    Output Arguments:
51200026cea9SSean Farley .  F - left hand side
51210026cea9SSean Farley 
51220026cea9SSean Farley    Level: intermediate
51230026cea9SSean Farley 
51240026cea9SSean Farley    Notes:
51250910c330SBarry 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
51260026cea9SSean Farley    user is required to write their own TSComputeIFunction.
51270026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
51280026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
51290026cea9SSean Farley 
51309ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
51319ae8fd06SBarry Smith 
51329ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
51330026cea9SSean Farley @*/
51340910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
51350026cea9SSean Farley {
51360026cea9SSean Farley   PetscErrorCode ierr;
51370026cea9SSean Farley   Mat            A,B;
51380026cea9SSean Farley 
51390026cea9SSean Farley   PetscFunctionBegin;
51400298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
5141d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
51420910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
51430026cea9SSean Farley   PetscFunctionReturn(0);
51440026cea9SSean Farley }
51450026cea9SSean Farley 
51460026cea9SSean Farley /*@C
5147b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
51480026cea9SSean Farley 
51490026cea9SSean Farley    Collective on TS
51500026cea9SSean Farley 
51510026cea9SSean Farley    Input Arguments:
51520026cea9SSean Farley +  ts - time stepping context
51530026cea9SSean Farley .  t - time at which to evaluate
51540910c330SBarry Smith .  U - state at which to evaluate
51550910c330SBarry Smith .  Udot - time derivative of state vector
51560026cea9SSean Farley .  shift - shift to apply
51570026cea9SSean Farley -  ctx - context
51580026cea9SSean Farley 
51590026cea9SSean Farley    Output Arguments:
51600026cea9SSean Farley +  A - pointer to operator
51610026cea9SSean Farley .  B - pointer to preconditioning matrix
51620026cea9SSean Farley -  flg - matrix structure flag
51630026cea9SSean Farley 
5164b41af12eSJed Brown    Level: advanced
51650026cea9SSean Farley 
51660026cea9SSean Farley    Notes:
51670026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
51680026cea9SSean Farley 
5169b41af12eSJed Brown    It is only appropriate for problems of the form
5170b41af12eSJed Brown 
5171b41af12eSJed Brown $     M Udot = F(U,t)
5172b41af12eSJed Brown 
5173b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
5174b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5175b41af12eSJed Brown   an implicit operator of the form
5176b41af12eSJed Brown 
5177b41af12eSJed Brown $    shift*M + J
5178b41af12eSJed Brown 
5179b41af12eSJed 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
5180b41af12eSJed Brown   a copy of M or reassemble it when requested.
5181b41af12eSJed Brown 
51820026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
51830026cea9SSean Farley @*/
5184d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
51850026cea9SSean Farley {
5186b41af12eSJed Brown   PetscErrorCode ierr;
5187b41af12eSJed Brown 
51880026cea9SSean Farley   PetscFunctionBegin;
518994ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
5190b41af12eSJed Brown   ts->ijacobian.shift = shift;
51910026cea9SSean Farley   PetscFunctionReturn(0);
51920026cea9SSean Farley }
5193b41af12eSJed Brown 
5194e817cc15SEmil Constantinescu /*@
5195e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
5196e817cc15SEmil Constantinescu 
5197e817cc15SEmil Constantinescu    Not Collective
5198e817cc15SEmil Constantinescu 
5199e817cc15SEmil Constantinescu    Input Parameter:
5200e817cc15SEmil Constantinescu .  ts - the TS context
5201e817cc15SEmil Constantinescu 
5202e817cc15SEmil Constantinescu    Output Parameter:
52034e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
5204e817cc15SEmil Constantinescu 
5205e817cc15SEmil Constantinescu    Level: beginner
5206e817cc15SEmil Constantinescu 
5207e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
5208e817cc15SEmil Constantinescu @*/
5209e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
5210e817cc15SEmil Constantinescu {
5211e817cc15SEmil Constantinescu   PetscFunctionBegin;
5212e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5213e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
5214e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
5215e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5216e817cc15SEmil Constantinescu }
5217e817cc15SEmil Constantinescu 
5218e817cc15SEmil Constantinescu /*@
5219e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
5220e817cc15SEmil Constantinescu 
5221e817cc15SEmil Constantinescu    Not Collective
5222e817cc15SEmil Constantinescu 
5223e817cc15SEmil Constantinescu    Input Parameter:
5224e817cc15SEmil Constantinescu +  ts - the TS context
52251297b224SEmil Constantinescu -  equation_type - see TSEquationType
5226e817cc15SEmil Constantinescu 
5227e817cc15SEmil Constantinescu    Level: advanced
5228e817cc15SEmil Constantinescu 
5229e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
5230e817cc15SEmil Constantinescu @*/
5231e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
5232e817cc15SEmil Constantinescu {
5233e817cc15SEmil Constantinescu   PetscFunctionBegin;
5234e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5235e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
5236e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5237e817cc15SEmil Constantinescu }
52380026cea9SSean Farley 
52394af1b03aSJed Brown /*@
52404af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
52414af1b03aSJed Brown 
52424af1b03aSJed Brown    Not Collective
52434af1b03aSJed Brown 
52444af1b03aSJed Brown    Input Parameter:
52454af1b03aSJed Brown .  ts - the TS context
52464af1b03aSJed Brown 
52474af1b03aSJed Brown    Output Parameter:
52484af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
52494af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
52504af1b03aSJed Brown 
5251487e0bb9SJed Brown    Level: beginner
52524af1b03aSJed Brown 
5253cd652676SJed Brown    Notes:
5254cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
52554af1b03aSJed Brown 
52564af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
52574af1b03aSJed Brown @*/
52584af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
52594af1b03aSJed Brown {
52604af1b03aSJed Brown   PetscFunctionBegin;
52614af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
52624af1b03aSJed Brown   PetscValidPointer(reason,2);
52634af1b03aSJed Brown   *reason = ts->reason;
52644af1b03aSJed Brown   PetscFunctionReturn(0);
52654af1b03aSJed Brown }
52664af1b03aSJed Brown 
5267d6ad946cSShri Abhyankar /*@
5268d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5269d6ad946cSShri Abhyankar 
52706b221cbeSPatrick Sanan    Logically Collective; reason must contain common value
5271d6ad946cSShri Abhyankar 
52726b221cbeSPatrick Sanan    Input Parameters:
5273d6ad946cSShri Abhyankar +  ts - the TS context
52746b221cbeSPatrick Sanan -  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5275d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
5276d6ad946cSShri Abhyankar 
5277f5abba47SShri Abhyankar    Level: advanced
5278d6ad946cSShri Abhyankar 
5279d6ad946cSShri Abhyankar    Notes:
52806b221cbeSPatrick Sanan    Can only be called while TSSolve() is active.
5281d6ad946cSShri Abhyankar 
5282d6ad946cSShri Abhyankar .seealso: TSConvergedReason
5283d6ad946cSShri Abhyankar @*/
5284d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
5285d6ad946cSShri Abhyankar {
5286d6ad946cSShri Abhyankar   PetscFunctionBegin;
5287d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5288d6ad946cSShri Abhyankar   ts->reason = reason;
5289d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
5290d6ad946cSShri Abhyankar }
5291d6ad946cSShri Abhyankar 
5292cc708dedSBarry Smith /*@
5293cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
5294cc708dedSBarry Smith 
5295cc708dedSBarry Smith    Not Collective
5296cc708dedSBarry Smith 
5297cc708dedSBarry Smith    Input Parameter:
5298cc708dedSBarry Smith .  ts - the TS context
5299cc708dedSBarry Smith 
5300cc708dedSBarry Smith    Output Parameter:
530119eac22cSLisandro Dalcin .  ftime - the final time. This time corresponds to the final time set with TSSetMaxTime()
5302cc708dedSBarry Smith 
5303487e0bb9SJed Brown    Level: beginner
5304cc708dedSBarry Smith 
5305cc708dedSBarry Smith    Notes:
5306cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
5307cc708dedSBarry Smith 
5308cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
5309cc708dedSBarry Smith @*/
5310cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
5311cc708dedSBarry Smith {
5312cc708dedSBarry Smith   PetscFunctionBegin;
5313cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5314cc708dedSBarry Smith   PetscValidPointer(ftime,2);
5315cc708dedSBarry Smith   *ftime = ts->solvetime;
5316cc708dedSBarry Smith   PetscFunctionReturn(0);
5317cc708dedSBarry Smith }
5318cc708dedSBarry Smith 
53192c18e0fdSBarry Smith /*@
53205ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
53219f67acb7SJed Brown    used by the time integrator.
53229f67acb7SJed Brown 
53239f67acb7SJed Brown    Not Collective
53249f67acb7SJed Brown 
53259f67acb7SJed Brown    Input Parameter:
53269f67acb7SJed Brown .  ts - TS context
53279f67acb7SJed Brown 
53289f67acb7SJed Brown    Output Parameter:
53299f67acb7SJed Brown .  nits - number of nonlinear iterations
53309f67acb7SJed Brown 
53319f67acb7SJed Brown    Notes:
53329f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
53339f67acb7SJed Brown 
53349f67acb7SJed Brown    Level: intermediate
53359f67acb7SJed Brown 
53365ef26d82SJed Brown .seealso:  TSGetKSPIterations()
53379f67acb7SJed Brown @*/
53385ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
53399f67acb7SJed Brown {
53409f67acb7SJed Brown   PetscFunctionBegin;
53419f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53429f67acb7SJed Brown   PetscValidIntPointer(nits,2);
53435ef26d82SJed Brown   *nits = ts->snes_its;
53449f67acb7SJed Brown   PetscFunctionReturn(0);
53459f67acb7SJed Brown }
53469f67acb7SJed Brown 
53479f67acb7SJed Brown /*@
53485ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
53499f67acb7SJed Brown    used by the time integrator.
53509f67acb7SJed Brown 
53519f67acb7SJed Brown    Not Collective
53529f67acb7SJed Brown 
53539f67acb7SJed Brown    Input Parameter:
53549f67acb7SJed Brown .  ts - TS context
53559f67acb7SJed Brown 
53569f67acb7SJed Brown    Output Parameter:
53579f67acb7SJed Brown .  lits - number of linear iterations
53589f67acb7SJed Brown 
53599f67acb7SJed Brown    Notes:
53609f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
53619f67acb7SJed Brown 
53629f67acb7SJed Brown    Level: intermediate
53639f67acb7SJed Brown 
53645ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
53659f67acb7SJed Brown @*/
53665ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
53679f67acb7SJed Brown {
53689f67acb7SJed Brown   PetscFunctionBegin;
53699f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53709f67acb7SJed Brown   PetscValidIntPointer(lits,2);
53715ef26d82SJed Brown   *lits = ts->ksp_its;
53729f67acb7SJed Brown   PetscFunctionReturn(0);
53739f67acb7SJed Brown }
53749f67acb7SJed Brown 
5375cef5090cSJed Brown /*@
5376cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5377cef5090cSJed Brown 
5378cef5090cSJed Brown    Not Collective
5379cef5090cSJed Brown 
5380cef5090cSJed Brown    Input Parameter:
5381cef5090cSJed Brown .  ts - TS context
5382cef5090cSJed Brown 
5383cef5090cSJed Brown    Output Parameter:
5384cef5090cSJed Brown .  rejects - number of steps rejected
5385cef5090cSJed Brown 
5386cef5090cSJed Brown    Notes:
5387cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5388cef5090cSJed Brown 
5389cef5090cSJed Brown    Level: intermediate
5390cef5090cSJed Brown 
53915ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5392cef5090cSJed Brown @*/
5393cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5394cef5090cSJed Brown {
5395cef5090cSJed Brown   PetscFunctionBegin;
5396cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5397cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5398cef5090cSJed Brown   *rejects = ts->reject;
5399cef5090cSJed Brown   PetscFunctionReturn(0);
5400cef5090cSJed Brown }
5401cef5090cSJed Brown 
5402cef5090cSJed Brown /*@
5403cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5404cef5090cSJed Brown 
5405cef5090cSJed Brown    Not Collective
5406cef5090cSJed Brown 
5407cef5090cSJed Brown    Input Parameter:
5408cef5090cSJed Brown .  ts - TS context
5409cef5090cSJed Brown 
5410cef5090cSJed Brown    Output Parameter:
5411cef5090cSJed Brown .  fails - number of failed nonlinear solves
5412cef5090cSJed Brown 
5413cef5090cSJed Brown    Notes:
5414cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5415cef5090cSJed Brown 
5416cef5090cSJed Brown    Level: intermediate
5417cef5090cSJed Brown 
54185ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5419cef5090cSJed Brown @*/
5420cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5421cef5090cSJed Brown {
5422cef5090cSJed Brown   PetscFunctionBegin;
5423cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5424cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5425cef5090cSJed Brown   *fails = ts->num_snes_failures;
5426cef5090cSJed Brown   PetscFunctionReturn(0);
5427cef5090cSJed Brown }
5428cef5090cSJed Brown 
5429cef5090cSJed Brown /*@
5430cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5431cef5090cSJed Brown 
5432cef5090cSJed Brown    Not Collective
5433cef5090cSJed Brown 
5434cef5090cSJed Brown    Input Parameter:
5435cef5090cSJed Brown +  ts - TS context
5436cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5437cef5090cSJed Brown 
5438cef5090cSJed Brown    Notes:
5439cef5090cSJed Brown    The counter is reset to zero for each step
5440cef5090cSJed Brown 
5441cef5090cSJed Brown    Options Database Key:
5442cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5443cef5090cSJed Brown 
5444cef5090cSJed Brown    Level: intermediate
5445cef5090cSJed Brown 
54465ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5447cef5090cSJed Brown @*/
5448cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5449cef5090cSJed Brown {
5450cef5090cSJed Brown   PetscFunctionBegin;
5451cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5452cef5090cSJed Brown   ts->max_reject = rejects;
5453cef5090cSJed Brown   PetscFunctionReturn(0);
5454cef5090cSJed Brown }
5455cef5090cSJed Brown 
5456cef5090cSJed Brown /*@
5457cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5458cef5090cSJed Brown 
5459cef5090cSJed Brown    Not Collective
5460cef5090cSJed Brown 
5461cef5090cSJed Brown    Input Parameter:
5462cef5090cSJed Brown +  ts - TS context
5463cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5464cef5090cSJed Brown 
5465cef5090cSJed Brown    Notes:
5466cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5467cef5090cSJed Brown 
5468cef5090cSJed Brown    Options Database Key:
5469cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5470cef5090cSJed Brown 
5471cef5090cSJed Brown    Level: intermediate
5472cef5090cSJed Brown 
54735ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5474cef5090cSJed Brown @*/
5475cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5476cef5090cSJed Brown {
5477cef5090cSJed Brown   PetscFunctionBegin;
5478cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5479cef5090cSJed Brown   ts->max_snes_failures = fails;
5480cef5090cSJed Brown   PetscFunctionReturn(0);
5481cef5090cSJed Brown }
5482cef5090cSJed Brown 
5483cef5090cSJed Brown /*@
5484cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5485cef5090cSJed Brown 
5486cef5090cSJed Brown    Not Collective
5487cef5090cSJed Brown 
5488cef5090cSJed Brown    Input Parameter:
5489cef5090cSJed Brown +  ts - TS context
5490cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5491cef5090cSJed Brown 
5492cef5090cSJed Brown    Options Database Key:
5493cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5494cef5090cSJed Brown 
5495cef5090cSJed Brown    Level: intermediate
5496cef5090cSJed Brown 
54975ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5498cef5090cSJed Brown @*/
5499cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5500cef5090cSJed Brown {
5501cef5090cSJed Brown   PetscFunctionBegin;
5502cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5503cef5090cSJed Brown   ts->errorifstepfailed = err;
5504cef5090cSJed Brown   PetscFunctionReturn(0);
5505cef5090cSJed Brown }
5506cef5090cSJed Brown 
5507fb1732b5SBarry Smith /*@C
5508fde5950dSBarry 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
5509fb1732b5SBarry Smith 
5510fb1732b5SBarry Smith    Collective on TS
5511fb1732b5SBarry Smith 
5512fb1732b5SBarry Smith    Input Parameters:
5513fb1732b5SBarry Smith +  ts - the TS context
5514fb1732b5SBarry Smith .  step - current time-step
5515fb1732b5SBarry Smith .  ptime - current time
55160910c330SBarry Smith .  u - current state
5517721cd6eeSBarry Smith -  vf - viewer and its format
5518fb1732b5SBarry Smith 
5519fb1732b5SBarry Smith    Level: intermediate
5520fb1732b5SBarry Smith 
5521fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5522fb1732b5SBarry Smith @*/
5523721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5524fb1732b5SBarry Smith {
5525fb1732b5SBarry Smith   PetscErrorCode ierr;
5526fb1732b5SBarry Smith 
5527fb1732b5SBarry Smith   PetscFunctionBegin;
5528721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5529721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5530721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5531ed81e22dSJed Brown   PetscFunctionReturn(0);
5532ed81e22dSJed Brown }
5533ed81e22dSJed Brown 
5534ed81e22dSJed Brown /*@C
5535ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5536ed81e22dSJed Brown 
5537ed81e22dSJed Brown    Collective on TS
5538ed81e22dSJed Brown 
5539ed81e22dSJed Brown    Input Parameters:
5540ed81e22dSJed Brown +  ts - the TS context
5541ed81e22dSJed Brown .  step - current time-step
5542ed81e22dSJed Brown .  ptime - current time
55430910c330SBarry Smith .  u - current state
5544ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5545ed81e22dSJed Brown 
5546ed81e22dSJed Brown    Level: intermediate
5547ed81e22dSJed Brown 
5548ed81e22dSJed Brown    Notes:
5549ed81e22dSJed 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.
5550ed81e22dSJed Brown    These are named according to the file name template.
5551ed81e22dSJed Brown 
5552ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5553ed81e22dSJed Brown 
5554ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5555ed81e22dSJed Brown @*/
55560910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5557ed81e22dSJed Brown {
5558ed81e22dSJed Brown   PetscErrorCode ierr;
5559ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5560ed81e22dSJed Brown   PetscViewer    viewer;
5561ed81e22dSJed Brown 
5562ed81e22dSJed Brown   PetscFunctionBegin;
556363e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
55648caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5565ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
55660910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5567ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5568ed81e22dSJed Brown   PetscFunctionReturn(0);
5569ed81e22dSJed Brown }
5570ed81e22dSJed Brown 
5571ed81e22dSJed Brown /*@C
5572ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5573ed81e22dSJed Brown 
5574ed81e22dSJed Brown    Collective on TS
5575ed81e22dSJed Brown 
5576ed81e22dSJed Brown    Input Parameters:
5577ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5578ed81e22dSJed Brown 
5579ed81e22dSJed Brown    Level: intermediate
5580ed81e22dSJed Brown 
5581ed81e22dSJed Brown    Note:
5582ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5583ed81e22dSJed Brown 
5584ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5585ed81e22dSJed Brown @*/
5586ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5587ed81e22dSJed Brown {
5588ed81e22dSJed Brown   PetscErrorCode ierr;
5589ed81e22dSJed Brown 
5590ed81e22dSJed Brown   PetscFunctionBegin;
5591ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5592fb1732b5SBarry Smith   PetscFunctionReturn(0);
5593fb1732b5SBarry Smith }
5594fb1732b5SBarry Smith 
559584df9cb4SJed Brown /*@
5596552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
559784df9cb4SJed Brown 
5598ed81e22dSJed Brown    Collective on TS if controller has not been created yet
559984df9cb4SJed Brown 
560084df9cb4SJed Brown    Input Arguments:
5601ed81e22dSJed Brown .  ts - time stepping context
560284df9cb4SJed Brown 
560384df9cb4SJed Brown    Output Arguments:
5604ed81e22dSJed Brown .  adapt - adaptive controller
560584df9cb4SJed Brown 
560684df9cb4SJed Brown    Level: intermediate
560784df9cb4SJed Brown 
5608ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
560984df9cb4SJed Brown @*/
5610552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
561184df9cb4SJed Brown {
561284df9cb4SJed Brown   PetscErrorCode ierr;
561384df9cb4SJed Brown 
561484df9cb4SJed Brown   PetscFunctionBegin;
561584df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5616bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
561784df9cb4SJed Brown   if (!ts->adapt) {
5618ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
56193bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
56201c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
562184df9cb4SJed Brown   }
5622bec58848SLisandro Dalcin   *adapt = ts->adapt;
562384df9cb4SJed Brown   PetscFunctionReturn(0);
562484df9cb4SJed Brown }
5625d6ebe24aSShri Abhyankar 
56261c3436cfSJed Brown /*@
56271c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
56281c3436cfSJed Brown 
56291c3436cfSJed Brown    Logically Collective
56301c3436cfSJed Brown 
56311c3436cfSJed Brown    Input Arguments:
56321c3436cfSJed Brown +  ts - time integration context
56331c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
56340298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
56351c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
56360298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
56371c3436cfSJed Brown 
5638a3cdaa26SBarry Smith    Options Database keys:
5639a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5640a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5641a3cdaa26SBarry Smith 
56423ff766beSShri Abhyankar    Notes:
56433ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
56443ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
56453ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
56463ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
56473ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
56483ff766beSShri Abhyankar    differential variables.
56493ff766beSShri Abhyankar 
56501c3436cfSJed Brown    Level: beginner
56511c3436cfSJed Brown 
56525c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSGetTolerances()
56531c3436cfSJed Brown @*/
56541c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
56551c3436cfSJed Brown {
56561c3436cfSJed Brown   PetscErrorCode ierr;
56571c3436cfSJed Brown 
56581c3436cfSJed Brown   PetscFunctionBegin;
5659c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
56601c3436cfSJed Brown   if (vatol) {
56611c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
56621c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
56631c3436cfSJed Brown     ts->vatol = vatol;
56641c3436cfSJed Brown   }
5665c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
56661c3436cfSJed Brown   if (vrtol) {
56671c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
56681c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
56691c3436cfSJed Brown     ts->vrtol = vrtol;
56701c3436cfSJed Brown   }
56711c3436cfSJed Brown   PetscFunctionReturn(0);
56721c3436cfSJed Brown }
56731c3436cfSJed Brown 
5674c5033834SJed Brown /*@
5675c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5676c5033834SJed Brown 
5677c5033834SJed Brown    Logically Collective
5678c5033834SJed Brown 
5679c5033834SJed Brown    Input Arguments:
5680c5033834SJed Brown .  ts - time integration context
5681c5033834SJed Brown 
5682c5033834SJed Brown    Output Arguments:
56830298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
56840298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
56850298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
56860298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5687c5033834SJed Brown 
5688c5033834SJed Brown    Level: beginner
5689c5033834SJed Brown 
56905c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSSetTolerances()
5691c5033834SJed Brown @*/
5692c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5693c5033834SJed Brown {
5694c5033834SJed Brown   PetscFunctionBegin;
5695c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5696c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5697c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5698c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5699c5033834SJed Brown   PetscFunctionReturn(0);
5700c5033834SJed Brown }
5701c5033834SJed Brown 
57029c6b16b5SShri Abhyankar /*@
5703a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
57049c6b16b5SShri Abhyankar 
57059c6b16b5SShri Abhyankar    Collective on TS
57069c6b16b5SShri Abhyankar 
57079c6b16b5SShri Abhyankar    Input Arguments:
57089c6b16b5SShri Abhyankar +  ts - time stepping context
5709a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5710a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
57119c6b16b5SShri Abhyankar 
57129c6b16b5SShri Abhyankar    Output Arguments:
5713a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
57147453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5715a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
57169c6b16b5SShri Abhyankar 
57179c6b16b5SShri Abhyankar    Level: developer
57189c6b16b5SShri Abhyankar 
5719deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
57209c6b16b5SShri Abhyankar @*/
57217453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
57229c6b16b5SShri Abhyankar {
57239c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
57249c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
57257453f775SEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
57267453f775SEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
57279c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
57287453f775SEmil Constantinescu   PetscReal         sum,suma,sumr,gsum,gsuma,gsumr,diff;
57297453f775SEmil Constantinescu   PetscReal         tol,tola,tolr;
57307453f775SEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
57319c6b16b5SShri Abhyankar 
57329c6b16b5SShri Abhyankar   PetscFunctionBegin;
57339c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5734a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5735a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5736a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5737a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5738a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5739a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
57408a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
57418a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
5742a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
57439c6b16b5SShri Abhyankar 
57449c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
57459c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
57469c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
57479c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
57489c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
57497453f775SEmil Constantinescu   sum  = 0.; n_loc  = 0;
57507453f775SEmil Constantinescu   suma = 0.; na_loc = 0;
57517453f775SEmil Constantinescu   sumr = 0.; nr_loc = 0;
57529c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
57539c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
57549c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
57559c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
57569c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
575776cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
57587453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
57597453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
57607453f775SEmil Constantinescu       if (tola>0.){
57617453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
57627453f775SEmil Constantinescu         na_loc++;
57637453f775SEmil Constantinescu       }
57647453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
57657453f775SEmil Constantinescu       if (tolr>0.){
57667453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
57677453f775SEmil Constantinescu         nr_loc++;
57687453f775SEmil Constantinescu       }
57697453f775SEmil Constantinescu       tol=tola+tolr;
57707453f775SEmil Constantinescu       if (tol>0.){
57717453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
57727453f775SEmil Constantinescu         n_loc++;
57737453f775SEmil Constantinescu       }
57749c6b16b5SShri Abhyankar     }
57759c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
57769c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
57779c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
57789c6b16b5SShri Abhyankar     const PetscScalar *atol;
57799c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
57809c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
578176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
57827453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
57837453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
57847453f775SEmil Constantinescu       if (tola>0.){
57857453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
57867453f775SEmil Constantinescu         na_loc++;
57877453f775SEmil Constantinescu       }
57887453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
57897453f775SEmil Constantinescu       if (tolr>0.){
57907453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
57917453f775SEmil Constantinescu         nr_loc++;
57927453f775SEmil Constantinescu       }
57937453f775SEmil Constantinescu       tol=tola+tolr;
57947453f775SEmil Constantinescu       if (tol>0.){
57957453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
57967453f775SEmil Constantinescu         n_loc++;
57977453f775SEmil Constantinescu       }
57989c6b16b5SShri Abhyankar     }
57999c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58009c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
58019c6b16b5SShri Abhyankar     const PetscScalar *rtol;
58029c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58039c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
580476cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
58057453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
58067453f775SEmil Constantinescu       tola = ts->atol;
58077453f775SEmil Constantinescu       if (tola>0.){
58087453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
58097453f775SEmil Constantinescu         na_loc++;
58107453f775SEmil Constantinescu       }
58117453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58127453f775SEmil Constantinescu       if (tolr>0.){
58137453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
58147453f775SEmil Constantinescu         nr_loc++;
58157453f775SEmil Constantinescu       }
58167453f775SEmil Constantinescu       tol=tola+tolr;
58177453f775SEmil Constantinescu       if (tol>0.){
58187453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
58197453f775SEmil Constantinescu         n_loc++;
58207453f775SEmil Constantinescu       }
58219c6b16b5SShri Abhyankar     }
58229c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58239c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
58249c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
582576cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
58267453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
58277453f775SEmil Constantinescu       tola = ts->atol;
58287453f775SEmil Constantinescu       if (tola>0.){
58297453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
58307453f775SEmil Constantinescu         na_loc++;
58317453f775SEmil Constantinescu       }
58327453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58337453f775SEmil Constantinescu       if (tolr>0.){
58347453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
58357453f775SEmil Constantinescu         nr_loc++;
58367453f775SEmil Constantinescu       }
58377453f775SEmil Constantinescu       tol=tola+tolr;
58387453f775SEmil Constantinescu       if (tol>0.){
58397453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
58407453f775SEmil Constantinescu         n_loc++;
58417453f775SEmil Constantinescu       }
58429c6b16b5SShri Abhyankar     }
58439c6b16b5SShri Abhyankar   }
58449c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
58459c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
58469c6b16b5SShri Abhyankar 
58477453f775SEmil Constantinescu   err_loc[0] = sum;
58487453f775SEmil Constantinescu   err_loc[1] = suma;
58497453f775SEmil Constantinescu   err_loc[2] = sumr;
58507453f775SEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
58517453f775SEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
58527453f775SEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
58537453f775SEmil Constantinescu 
5854a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
58557453f775SEmil Constantinescu 
58567453f775SEmil Constantinescu   gsum   = err_glb[0];
58577453f775SEmil Constantinescu   gsuma  = err_glb[1];
58587453f775SEmil Constantinescu   gsumr  = err_glb[2];
58597453f775SEmil Constantinescu   n_glb  = err_glb[3];
58607453f775SEmil Constantinescu   na_glb = err_glb[4];
58617453f775SEmil Constantinescu   nr_glb = err_glb[5];
58627453f775SEmil Constantinescu 
5863b1316ef9SEmil Constantinescu   *norm  = 0.;
5864b1316ef9SEmil Constantinescu   if (n_glb>0.){*norm  = PetscSqrtReal(gsum  / n_glb);}
5865b1316ef9SEmil Constantinescu   *norma = 0.;
5866b1316ef9SEmil Constantinescu   if (na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
5867b1316ef9SEmil Constantinescu   *normr = 0.;
5868b1316ef9SEmil Constantinescu   if (nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
58699c6b16b5SShri Abhyankar 
58709c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
58717453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
58727453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
58739c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
58749c6b16b5SShri Abhyankar }
58759c6b16b5SShri Abhyankar 
58769c6b16b5SShri Abhyankar /*@
5877a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
58789c6b16b5SShri Abhyankar 
58799c6b16b5SShri Abhyankar    Collective on TS
58809c6b16b5SShri Abhyankar 
58819c6b16b5SShri Abhyankar    Input Arguments:
58829c6b16b5SShri Abhyankar +  ts - time stepping context
5883a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5884a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
58859c6b16b5SShri Abhyankar 
58869c6b16b5SShri Abhyankar    Output Arguments:
5887a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
58887453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
5889a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
58909c6b16b5SShri Abhyankar 
58919c6b16b5SShri Abhyankar    Level: developer
58929c6b16b5SShri Abhyankar 
5893deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
58949c6b16b5SShri Abhyankar @*/
58957453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
58969c6b16b5SShri Abhyankar {
58979c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
58987453f775SEmil Constantinescu   PetscInt          i,n,N,rstart;
58999c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
59007453f775SEmil Constantinescu   PetscReal         max,gmax,maxa,gmaxa,maxr,gmaxr;
59017453f775SEmil Constantinescu   PetscReal         tol,tola,tolr,diff;
59027453f775SEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
59039c6b16b5SShri Abhyankar 
59049c6b16b5SShri Abhyankar   PetscFunctionBegin;
59059c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5906a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5907a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5908a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5909a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5910a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5911a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
59128a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
59138a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
5914a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
59159c6b16b5SShri Abhyankar 
59169c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
59179c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
59189c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
59199c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
59209c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
59217453f775SEmil Constantinescu 
59227453f775SEmil Constantinescu   max=0.;
59237453f775SEmil Constantinescu   maxa=0.;
59247453f775SEmil Constantinescu   maxr=0.;
59257453f775SEmil Constantinescu 
59267453f775SEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
59279c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
59289c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59299c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59307453f775SEmil Constantinescu 
59317453f775SEmil Constantinescu     for (i=0; i<n; i++) {
593276cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59337453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59347453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
59357453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59367453f775SEmil Constantinescu       tol  = tola+tolr;
59377453f775SEmil Constantinescu       if (tola>0.){
59387453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
59397453f775SEmil Constantinescu       }
59407453f775SEmil Constantinescu       if (tolr>0.){
59417453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
59427453f775SEmil Constantinescu       }
59437453f775SEmil Constantinescu       if (tol>0.){
59447453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
59457453f775SEmil Constantinescu       }
59469c6b16b5SShri Abhyankar     }
59479c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59489c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59499c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
59509c6b16b5SShri Abhyankar     const PetscScalar *atol;
59519c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59527453f775SEmil Constantinescu     for (i=0; i<n; i++) {
595376cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59547453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59557453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
59567453f775SEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59577453f775SEmil Constantinescu       tol  = tola+tolr;
59587453f775SEmil Constantinescu       if (tola>0.){
59597453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
59607453f775SEmil Constantinescu       }
59617453f775SEmil Constantinescu       if (tolr>0.){
59627453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
59637453f775SEmil Constantinescu       }
59647453f775SEmil Constantinescu       if (tol>0.){
59657453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
59667453f775SEmil Constantinescu       }
59679c6b16b5SShri Abhyankar     }
59689c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59699c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
59709c6b16b5SShri Abhyankar     const PetscScalar *rtol;
59719c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59727453f775SEmil Constantinescu 
59737453f775SEmil Constantinescu     for (i=0; i<n; i++) {
597476cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59757453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59767453f775SEmil Constantinescu       tola = ts->atol;
59777453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59787453f775SEmil Constantinescu       tol  = tola+tolr;
59797453f775SEmil Constantinescu       if (tola>0.){
59807453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
59817453f775SEmil Constantinescu       }
59827453f775SEmil Constantinescu       if (tolr>0.){
59837453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
59847453f775SEmil Constantinescu       }
59857453f775SEmil Constantinescu       if (tol>0.){
59867453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
59877453f775SEmil Constantinescu       }
59889c6b16b5SShri Abhyankar     }
59899c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59909c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
59917453f775SEmil Constantinescu 
59927453f775SEmil Constantinescu     for (i=0; i<n; i++) {
599376cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
59947453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59957453f775SEmil Constantinescu       tola = ts->atol;
59967453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59977453f775SEmil Constantinescu       tol  = tola+tolr;
59987453f775SEmil Constantinescu       if (tola>0.){
59997453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
60007453f775SEmil Constantinescu       }
60017453f775SEmil Constantinescu       if (tolr>0.){
60027453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
60037453f775SEmil Constantinescu       }
60047453f775SEmil Constantinescu       if (tol>0.){
60057453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
60067453f775SEmil Constantinescu       }
60079c6b16b5SShri Abhyankar     }
60089c6b16b5SShri Abhyankar   }
60099c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
60109c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
60117453f775SEmil Constantinescu   err_loc[0] = max;
60127453f775SEmil Constantinescu   err_loc[1] = maxa;
60137453f775SEmil Constantinescu   err_loc[2] = maxr;
6014a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
60157453f775SEmil Constantinescu   gmax   = err_glb[0];
60167453f775SEmil Constantinescu   gmaxa  = err_glb[1];
60177453f775SEmil Constantinescu   gmaxr  = err_glb[2];
60189c6b16b5SShri Abhyankar 
60199c6b16b5SShri Abhyankar   *norm = gmax;
60207453f775SEmil Constantinescu   *norma = gmaxa;
60217453f775SEmil Constantinescu   *normr = gmaxr;
60229c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
60237453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
60247453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
60259c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
60269c6b16b5SShri Abhyankar }
60279c6b16b5SShri Abhyankar 
60281c3436cfSJed Brown /*@
60298a175baeSEmil Constantinescu    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
60301c3436cfSJed Brown 
60311c3436cfSJed Brown    Collective on TS
60321c3436cfSJed Brown 
60331c3436cfSJed Brown    Input Arguments:
60341c3436cfSJed Brown +  ts - time stepping context
6035a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6036a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
6037a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
60387619abb3SShri 
60391c3436cfSJed Brown    Output Arguments:
6040a2b725a8SWilliam Gropp +  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
60418a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
6042a2b725a8SWilliam Gropp -  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
6043a4868fbcSLisandro Dalcin 
6044a4868fbcSLisandro Dalcin    Options Database Keys:
6045a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
6046a4868fbcSLisandro Dalcin 
60471c3436cfSJed Brown    Level: developer
60481c3436cfSJed Brown 
60498a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm
60501c3436cfSJed Brown @*/
60517453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
60521c3436cfSJed Brown {
60538beabaa1SBarry Smith   PetscErrorCode ierr;
60541c3436cfSJed Brown 
60551c3436cfSJed Brown   PetscFunctionBegin;
6056a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
60577453f775SEmil Constantinescu     ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6058a4868fbcSLisandro Dalcin   } else if (wnormtype == NORM_INFINITY) {
60597453f775SEmil Constantinescu     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6060a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
60611c3436cfSJed Brown   PetscFunctionReturn(0);
60621c3436cfSJed Brown }
60631c3436cfSJed Brown 
60648a175baeSEmil Constantinescu 
60658a175baeSEmil Constantinescu /*@
60668a175baeSEmil Constantinescu    TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances
60678a175baeSEmil Constantinescu 
60688a175baeSEmil Constantinescu    Collective on TS
60698a175baeSEmil Constantinescu 
60708a175baeSEmil Constantinescu    Input Arguments:
60718a175baeSEmil Constantinescu +  ts - time stepping context
60728a175baeSEmil Constantinescu .  E - error vector
60738a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
60748a175baeSEmil Constantinescu -  Y - state vector, previous time step
60758a175baeSEmil Constantinescu 
60768a175baeSEmil Constantinescu    Output Arguments:
6077a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
60788a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
6079a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
60808a175baeSEmil Constantinescu 
60818a175baeSEmil Constantinescu    Level: developer
60828a175baeSEmil Constantinescu 
60838a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity()
60848a175baeSEmil Constantinescu @*/
60858a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
60868a175baeSEmil Constantinescu {
60878a175baeSEmil Constantinescu   PetscErrorCode    ierr;
60888a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
60898a175baeSEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
60908a175baeSEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
60918a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
60928a175baeSEmil Constantinescu   PetscReal         err,sum,suma,sumr,gsum,gsuma,gsumr;
60938a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
60948a175baeSEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
60958a175baeSEmil Constantinescu 
60968a175baeSEmil Constantinescu   PetscFunctionBegin;
60978a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
60988a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
60998a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
61008a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
61018a175baeSEmil Constantinescu   PetscValidType(E,2);
61028a175baeSEmil Constantinescu   PetscValidType(U,3);
61038a175baeSEmil Constantinescu   PetscValidType(Y,4);
61048a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
61058a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
61068a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
61078a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
61088a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
61098a175baeSEmil Constantinescu 
61108a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
61118a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
61128a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
61138a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
61148a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
61158a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
61168a175baeSEmil Constantinescu   sum  = 0.; n_loc  = 0;
61178a175baeSEmil Constantinescu   suma = 0.; na_loc = 0;
61188a175baeSEmil Constantinescu   sumr = 0.; nr_loc = 0;
61198a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {
61208a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
61218a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61228a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61238a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
612476cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61258a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61268a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
61278a175baeSEmil Constantinescu       if (tola>0.){
61288a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
61298a175baeSEmil Constantinescu         na_loc++;
61308a175baeSEmil Constantinescu       }
61318a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61328a175baeSEmil Constantinescu       if (tolr>0.){
61338a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
61348a175baeSEmil Constantinescu         nr_loc++;
61358a175baeSEmil Constantinescu       }
61368a175baeSEmil Constantinescu       tol=tola+tolr;
61378a175baeSEmil Constantinescu       if (tol>0.){
61388a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
61398a175baeSEmil Constantinescu         n_loc++;
61408a175baeSEmil Constantinescu       }
61418a175baeSEmil Constantinescu     }
61428a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61438a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61448a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
61458a175baeSEmil Constantinescu     const PetscScalar *atol;
61468a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61478a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
614876cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61498a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61508a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
61518a175baeSEmil Constantinescu       if (tola>0.){
61528a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
61538a175baeSEmil Constantinescu         na_loc++;
61548a175baeSEmil Constantinescu       }
61558a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61568a175baeSEmil Constantinescu       if (tolr>0.){
61578a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
61588a175baeSEmil Constantinescu         nr_loc++;
61598a175baeSEmil Constantinescu       }
61608a175baeSEmil Constantinescu       tol=tola+tolr;
61618a175baeSEmil Constantinescu       if (tol>0.){
61628a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
61638a175baeSEmil Constantinescu         n_loc++;
61648a175baeSEmil Constantinescu       }
61658a175baeSEmil Constantinescu     }
61668a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61678a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
61688a175baeSEmil Constantinescu     const PetscScalar *rtol;
61698a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61708a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
617176cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61728a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61738a175baeSEmil Constantinescu       tola = ts->atol;
61748a175baeSEmil Constantinescu       if (tola>0.){
61758a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
61768a175baeSEmil Constantinescu         na_loc++;
61778a175baeSEmil Constantinescu       }
61788a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61798a175baeSEmil Constantinescu       if (tolr>0.){
61808a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
61818a175baeSEmil Constantinescu         nr_loc++;
61828a175baeSEmil Constantinescu       }
61838a175baeSEmil Constantinescu       tol=tola+tolr;
61848a175baeSEmil Constantinescu       if (tol>0.){
61858a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
61868a175baeSEmil Constantinescu         n_loc++;
61878a175baeSEmil Constantinescu       }
61888a175baeSEmil Constantinescu     }
61898a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61908a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
61918a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
619276cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
61938a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
61948a175baeSEmil Constantinescu       tola = ts->atol;
61958a175baeSEmil Constantinescu       if (tola>0.){
61968a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
61978a175baeSEmil Constantinescu         na_loc++;
61988a175baeSEmil Constantinescu       }
61998a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62008a175baeSEmil Constantinescu       if (tolr>0.){
62018a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
62028a175baeSEmil Constantinescu         nr_loc++;
62038a175baeSEmil Constantinescu       }
62048a175baeSEmil Constantinescu       tol=tola+tolr;
62058a175baeSEmil Constantinescu       if (tol>0.){
62068a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
62078a175baeSEmil Constantinescu         n_loc++;
62088a175baeSEmil Constantinescu       }
62098a175baeSEmil Constantinescu     }
62108a175baeSEmil Constantinescu   }
62118a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
62128a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
62138a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
62148a175baeSEmil Constantinescu 
62158a175baeSEmil Constantinescu   err_loc[0] = sum;
62168a175baeSEmil Constantinescu   err_loc[1] = suma;
62178a175baeSEmil Constantinescu   err_loc[2] = sumr;
62188a175baeSEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
62198a175baeSEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
62208a175baeSEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
62218a175baeSEmil Constantinescu 
6222a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
62238a175baeSEmil Constantinescu 
62248a175baeSEmil Constantinescu   gsum   = err_glb[0];
62258a175baeSEmil Constantinescu   gsuma  = err_glb[1];
62268a175baeSEmil Constantinescu   gsumr  = err_glb[2];
62278a175baeSEmil Constantinescu   n_glb  = err_glb[3];
62288a175baeSEmil Constantinescu   na_glb = err_glb[4];
62298a175baeSEmil Constantinescu   nr_glb = err_glb[5];
62308a175baeSEmil Constantinescu 
62318a175baeSEmil Constantinescu   *norm  = 0.;
62328a175baeSEmil Constantinescu   if (n_glb>0.){*norm  = PetscSqrtReal(gsum  / n_glb);}
62338a175baeSEmil Constantinescu   *norma = 0.;
62348a175baeSEmil Constantinescu   if (na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
62358a175baeSEmil Constantinescu   *normr = 0.;
62368a175baeSEmil Constantinescu   if (nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
62378a175baeSEmil Constantinescu 
62388a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
62398a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
62408a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
62418a175baeSEmil Constantinescu   PetscFunctionReturn(0);
62428a175baeSEmil Constantinescu }
62438a175baeSEmil Constantinescu 
62448a175baeSEmil Constantinescu /*@
62458a175baeSEmil Constantinescu    TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances
62468a175baeSEmil Constantinescu    Collective on TS
62478a175baeSEmil Constantinescu 
62488a175baeSEmil Constantinescu    Input Arguments:
62498a175baeSEmil Constantinescu +  ts - time stepping context
62508a175baeSEmil Constantinescu .  E - error vector
62518a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
62528a175baeSEmil Constantinescu -  Y - state vector, previous time step
62538a175baeSEmil Constantinescu 
62548a175baeSEmil Constantinescu    Output Arguments:
6255a2b725a8SWilliam Gropp +  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
62568a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
6257a2b725a8SWilliam Gropp -  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
62588a175baeSEmil Constantinescu 
62598a175baeSEmil Constantinescu    Level: developer
62608a175baeSEmil Constantinescu 
62618a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2()
62628a175baeSEmil Constantinescu @*/
62638a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
62648a175baeSEmil Constantinescu {
62658a175baeSEmil Constantinescu   PetscErrorCode    ierr;
62668a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
62678a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
62688a175baeSEmil Constantinescu   PetscReal         err,max,gmax,maxa,gmaxa,maxr,gmaxr;
62698a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
62708a175baeSEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
62718a175baeSEmil Constantinescu 
62728a175baeSEmil Constantinescu   PetscFunctionBegin;
62738a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
62748a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
62758a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
62768a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
62778a175baeSEmil Constantinescu   PetscValidType(E,2);
62788a175baeSEmil Constantinescu   PetscValidType(U,3);
62798a175baeSEmil Constantinescu   PetscValidType(Y,4);
62808a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
62818a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
62828a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
62838a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
62848a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
62858a175baeSEmil Constantinescu 
62868a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
62878a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
62888a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
62898a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
62908a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
62918a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
62928a175baeSEmil Constantinescu 
62938a175baeSEmil Constantinescu   max=0.;
62948a175baeSEmil Constantinescu   maxa=0.;
62958a175baeSEmil Constantinescu   maxr=0.;
62968a175baeSEmil Constantinescu 
62978a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
62988a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
62998a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63008a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63018a175baeSEmil Constantinescu 
63028a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
630376cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
63048a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63058a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
63068a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63078a175baeSEmil Constantinescu       tol  = tola+tolr;
63088a175baeSEmil Constantinescu       if (tola>0.){
63098a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
63108a175baeSEmil Constantinescu       }
63118a175baeSEmil Constantinescu       if (tolr>0.){
63128a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
63138a175baeSEmil Constantinescu       }
63148a175baeSEmil Constantinescu       if (tol>0.){
63158a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63168a175baeSEmil Constantinescu       }
63178a175baeSEmil Constantinescu     }
63188a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63198a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63208a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
63218a175baeSEmil Constantinescu     const PetscScalar *atol;
63228a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63238a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
632476cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
63258a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63268a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
63278a175baeSEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63288a175baeSEmil Constantinescu       tol  = tola+tolr;
63298a175baeSEmil Constantinescu       if (tola>0.){
63308a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
63318a175baeSEmil Constantinescu       }
63328a175baeSEmil Constantinescu       if (tolr>0.){
63338a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
63348a175baeSEmil Constantinescu       }
63358a175baeSEmil Constantinescu       if (tol>0.){
63368a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63378a175baeSEmil Constantinescu       }
63388a175baeSEmil Constantinescu     }
63398a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63408a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
63418a175baeSEmil Constantinescu     const PetscScalar *rtol;
63428a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63438a175baeSEmil Constantinescu 
63448a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
634576cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
63468a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63478a175baeSEmil Constantinescu       tola = ts->atol;
63488a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63498a175baeSEmil Constantinescu       tol  = tola+tolr;
63508a175baeSEmil Constantinescu       if (tola>0.){
63518a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
63528a175baeSEmil Constantinescu       }
63538a175baeSEmil Constantinescu       if (tolr>0.){
63548a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
63558a175baeSEmil Constantinescu       }
63568a175baeSEmil Constantinescu       if (tol>0.){
63578a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63588a175baeSEmil Constantinescu       }
63598a175baeSEmil Constantinescu     }
63608a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63618a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
63628a175baeSEmil Constantinescu 
63638a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
636476cddca1SEmil Constantinescu       SkipSmallValue(y[i],u[i],ts->adapt->ignore_max);
63658a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63668a175baeSEmil Constantinescu       tola = ts->atol;
63678a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63688a175baeSEmil Constantinescu       tol  = tola+tolr;
63698a175baeSEmil Constantinescu       if (tola>0.){
63708a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
63718a175baeSEmil Constantinescu       }
63728a175baeSEmil Constantinescu       if (tolr>0.){
63738a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
63748a175baeSEmil Constantinescu       }
63758a175baeSEmil Constantinescu       if (tol>0.){
63768a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
63778a175baeSEmil Constantinescu       }
63788a175baeSEmil Constantinescu     }
63798a175baeSEmil Constantinescu   }
63808a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
63818a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
63828a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
63838a175baeSEmil Constantinescu   err_loc[0] = max;
63848a175baeSEmil Constantinescu   err_loc[1] = maxa;
63858a175baeSEmil Constantinescu   err_loc[2] = maxr;
6386a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
63878a175baeSEmil Constantinescu   gmax   = err_glb[0];
63888a175baeSEmil Constantinescu   gmaxa  = err_glb[1];
63898a175baeSEmil Constantinescu   gmaxr  = err_glb[2];
63908a175baeSEmil Constantinescu 
63918a175baeSEmil Constantinescu   *norm = gmax;
63928a175baeSEmil Constantinescu   *norma = gmaxa;
63938a175baeSEmil Constantinescu   *normr = gmaxr;
63948a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
63958a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
63968a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
63978a175baeSEmil Constantinescu   PetscFunctionReturn(0);
63988a175baeSEmil Constantinescu }
63998a175baeSEmil Constantinescu 
64008a175baeSEmil Constantinescu /*@
64018a175baeSEmil Constantinescu    TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
64028a175baeSEmil Constantinescu 
64038a175baeSEmil Constantinescu    Collective on TS
64048a175baeSEmil Constantinescu 
64058a175baeSEmil Constantinescu    Input Arguments:
64068a175baeSEmil Constantinescu +  ts - time stepping context
64078a175baeSEmil Constantinescu .  E - error vector
64088a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
64098a175baeSEmil Constantinescu .  Y - state vector, previous time step
64108a175baeSEmil Constantinescu -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
64118a175baeSEmil Constantinescu 
64128a175baeSEmil Constantinescu    Output Arguments:
6413a2b725a8SWilliam Gropp +  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
64148a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
6415a2b725a8SWilliam Gropp -  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
64168a175baeSEmil Constantinescu 
64178a175baeSEmil Constantinescu    Options Database Keys:
64188a175baeSEmil Constantinescu .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
64198a175baeSEmil Constantinescu 
64208a175baeSEmil Constantinescu    Level: developer
64218a175baeSEmil Constantinescu 
64228a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
64238a175baeSEmil Constantinescu @*/
64248a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
64258a175baeSEmil Constantinescu {
64268a175baeSEmil Constantinescu   PetscErrorCode ierr;
64278a175baeSEmil Constantinescu 
64288a175baeSEmil Constantinescu   PetscFunctionBegin;
64298a175baeSEmil Constantinescu   if (wnormtype == NORM_2) {
64308a175baeSEmil Constantinescu     ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
64318a175baeSEmil Constantinescu   } else if (wnormtype == NORM_INFINITY) {
64328a175baeSEmil Constantinescu     ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
64338a175baeSEmil Constantinescu   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
64348a175baeSEmil Constantinescu   PetscFunctionReturn(0);
64358a175baeSEmil Constantinescu }
64368a175baeSEmil Constantinescu 
64378a175baeSEmil Constantinescu 
64388d59e960SJed Brown /*@
64398d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
64408d59e960SJed Brown 
64418d59e960SJed Brown    Logically Collective on TS
64428d59e960SJed Brown 
64438d59e960SJed Brown    Input Arguments:
64448d59e960SJed Brown +  ts - time stepping context
64458d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
64468d59e960SJed Brown 
64478d59e960SJed Brown    Note:
64488d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
64498d59e960SJed Brown 
64508d59e960SJed Brown    Level: intermediate
64518d59e960SJed Brown 
64528d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
64538d59e960SJed Brown @*/
64548d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
64558d59e960SJed Brown {
64568d59e960SJed Brown   PetscFunctionBegin;
64578d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
64588d59e960SJed Brown   ts->cfltime_local = cfltime;
64598d59e960SJed Brown   ts->cfltime       = -1.;
64608d59e960SJed Brown   PetscFunctionReturn(0);
64618d59e960SJed Brown }
64628d59e960SJed Brown 
64638d59e960SJed Brown /*@
64648d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
64658d59e960SJed Brown 
64668d59e960SJed Brown    Collective on TS
64678d59e960SJed Brown 
64688d59e960SJed Brown    Input Arguments:
64698d59e960SJed Brown .  ts - time stepping context
64708d59e960SJed Brown 
64718d59e960SJed Brown    Output Arguments:
64728d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
64738d59e960SJed Brown 
64748d59e960SJed Brown    Level: advanced
64758d59e960SJed Brown 
64768d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
64778d59e960SJed Brown @*/
64788d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
64798d59e960SJed Brown {
64808d59e960SJed Brown   PetscErrorCode ierr;
64818d59e960SJed Brown 
64828d59e960SJed Brown   PetscFunctionBegin;
64838d59e960SJed Brown   if (ts->cfltime < 0) {
6484b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
64858d59e960SJed Brown   }
64868d59e960SJed Brown   *cfltime = ts->cfltime;
64878d59e960SJed Brown   PetscFunctionReturn(0);
64888d59e960SJed Brown }
64898d59e960SJed Brown 
6490d6ebe24aSShri Abhyankar /*@
6491d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6492d6ebe24aSShri Abhyankar 
6493d6ebe24aSShri Abhyankar    Input Parameters:
6494a2b725a8SWilliam Gropp +  ts   - the TS context.
6495d6ebe24aSShri Abhyankar .  xl   - lower bound.
6496a2b725a8SWilliam Gropp -  xu   - upper bound.
6497d6ebe24aSShri Abhyankar 
6498d6ebe24aSShri Abhyankar    Notes:
6499d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6500e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6501d6ebe24aSShri Abhyankar 
65022bd2b0e6SSatish Balay    Level: advanced
65032bd2b0e6SSatish Balay 
6504d6ebe24aSShri Abhyankar @*/
6505d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6506d6ebe24aSShri Abhyankar {
6507d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6508d6ebe24aSShri Abhyankar   SNES           snes;
6509d6ebe24aSShri Abhyankar 
6510d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6511d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6512d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6513d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6514d6ebe24aSShri Abhyankar }
6515d6ebe24aSShri Abhyankar 
6516b3603a34SBarry Smith /*@C
65174f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
6518b3603a34SBarry Smith        in a time based line graph
6519b3603a34SBarry Smith 
6520b3603a34SBarry Smith    Collective on TS
6521b3603a34SBarry Smith 
6522b3603a34SBarry Smith    Input Parameters:
6523b3603a34SBarry Smith +  ts - the TS context
6524b3603a34SBarry Smith .  step - current time-step
6525b3603a34SBarry Smith .  ptime - current time
65267db568b7SBarry Smith .  u - current solution
65277db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
6528b3603a34SBarry Smith 
6529b3d3934dSBarry Smith    Options Database:
65309ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
6531b3d3934dSBarry Smith 
6532b3603a34SBarry Smith    Level: intermediate
6533b3603a34SBarry Smith 
653495452b02SPatrick Sanan    Notes:
653595452b02SPatrick Sanan     Each process in a parallel run displays its component solutions in a separate window
6536b3603a34SBarry Smith 
65377db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
65387db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
65397db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
65407db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
6541b3603a34SBarry Smith @*/
65427db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6543b3603a34SBarry Smith {
6544b3603a34SBarry Smith   PetscErrorCode    ierr;
65457db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
6546b3603a34SBarry Smith   const PetscScalar *yy;
654780666b62SBarry Smith   Vec               v;
6548b3603a34SBarry Smith 
6549b3603a34SBarry Smith   PetscFunctionBegin;
655063e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
655158ff32f7SBarry Smith   if (!step) {
6552a9f9c1f6SBarry Smith     PetscDrawAxis axis;
65536934998bSLisandro Dalcin     PetscInt      dim;
6554a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
65550ec8ee2bSJoseph Pusztay     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
6556bab0a581SBarry Smith     if (!ctx->names) {
6557bab0a581SBarry Smith       PetscBool flg;
6558bab0a581SBarry Smith       /* user provides names of variables to plot but no names has been set so assume names are integer values */
6559bab0a581SBarry Smith       ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr);
6560bab0a581SBarry Smith       if (flg) {
6561bab0a581SBarry Smith         PetscInt i,n;
6562bab0a581SBarry Smith         char     **names;
6563bab0a581SBarry Smith         ierr = VecGetSize(u,&n);CHKERRQ(ierr);
6564bab0a581SBarry Smith         ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr);
6565bab0a581SBarry Smith         for (i=0; i<n; i++) {
6566bab0a581SBarry Smith           ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr);
6567bab0a581SBarry Smith           ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr);
6568bab0a581SBarry Smith         }
6569bab0a581SBarry Smith         names[n] = NULL;
6570bab0a581SBarry Smith         ctx->names = names;
6571bab0a581SBarry Smith       }
6572bab0a581SBarry Smith     }
6573387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
6574387f4636SBarry Smith       char      **displaynames;
6575387f4636SBarry Smith       PetscBool flg;
6576387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6577580bdb30SBarry Smith       ierr = PetscCalloc1(dim+1,&displaynames);CHKERRQ(ierr);
6578c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
6579387f4636SBarry Smith       if (flg) {
6580a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
6581387f4636SBarry Smith       }
6582387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
6583387f4636SBarry Smith     }
6584387f4636SBarry Smith     if (ctx->displaynames) {
6585387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
6586387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
6587387f4636SBarry Smith     } else if (ctx->names) {
65880910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
65890b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6590387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
6591b0bc92c6SBarry Smith     } else {
6592b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6593b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6594387f4636SBarry Smith     }
65950b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
659658ff32f7SBarry Smith   }
65976934998bSLisandro Dalcin 
65986934998bSLisandro Dalcin   if (!ctx->transform) v = u;
65996934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
660080666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
66016934998bSLisandro Dalcin   if (ctx->displaynames) {
66026934998bSLisandro Dalcin     PetscInt i;
66036934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
66046934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
66056934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
66066934998bSLisandro Dalcin   } else {
6607e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6608e3efe391SJed Brown     PetscInt  i,n;
66096934998bSLisandro Dalcin     PetscReal *yreal;
661080666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
6611785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6612e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
66130b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6614e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6615e3efe391SJed Brown #else
66160b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6617e3efe391SJed Brown #endif
661880666b62SBarry Smith   }
66196934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
66206934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
66216934998bSLisandro Dalcin 
6622b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
66230b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
66246934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
66253923b477SBarry Smith   }
6626b3603a34SBarry Smith   PetscFunctionReturn(0);
6627b3603a34SBarry Smith }
6628b3603a34SBarry Smith 
6629b037adc7SBarry Smith /*@C
663031152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6631b037adc7SBarry Smith 
6632b037adc7SBarry Smith    Collective on TS
6633b037adc7SBarry Smith 
6634b037adc7SBarry Smith    Input Parameters:
6635b037adc7SBarry Smith +  ts - the TS context
6636b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
6637b037adc7SBarry Smith 
6638b037adc7SBarry Smith    Level: intermediate
6639b037adc7SBarry Smith 
664095452b02SPatrick Sanan    Notes:
664195452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66427db568b7SBarry Smith 
6643a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
6644b037adc7SBarry Smith @*/
664531152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
6646b037adc7SBarry Smith {
6647b037adc7SBarry Smith   PetscErrorCode    ierr;
6648b037adc7SBarry Smith   PetscInt          i;
6649b037adc7SBarry Smith 
6650b037adc7SBarry Smith   PetscFunctionBegin;
6651b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6652b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
66535537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
6654b3d3934dSBarry Smith       break;
6655b3d3934dSBarry Smith     }
6656b3d3934dSBarry Smith   }
6657b3d3934dSBarry Smith   PetscFunctionReturn(0);
6658b3d3934dSBarry Smith }
6659b3d3934dSBarry Smith 
6660e673d494SBarry Smith /*@C
6661e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6662e673d494SBarry Smith 
6663e673d494SBarry Smith    Collective on TS
6664e673d494SBarry Smith 
6665e673d494SBarry Smith    Input Parameters:
6666e673d494SBarry Smith +  ts - the TS context
6667e673d494SBarry Smith -  names - the names of the components, final string must be NULL
6668e673d494SBarry Smith 
6669e673d494SBarry Smith    Level: intermediate
6670e673d494SBarry Smith 
6671a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
6672e673d494SBarry Smith @*/
6673e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
6674e673d494SBarry Smith {
6675e673d494SBarry Smith   PetscErrorCode    ierr;
6676e673d494SBarry Smith 
6677e673d494SBarry Smith   PetscFunctionBegin;
6678e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
6679e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
6680e673d494SBarry Smith   PetscFunctionReturn(0);
6681e673d494SBarry Smith }
6682e673d494SBarry Smith 
6683b3d3934dSBarry Smith /*@C
6684b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
6685b3d3934dSBarry Smith 
6686b3d3934dSBarry Smith    Collective on TS
6687b3d3934dSBarry Smith 
6688b3d3934dSBarry Smith    Input Parameter:
6689b3d3934dSBarry Smith .  ts - the TS context
6690b3d3934dSBarry Smith 
6691b3d3934dSBarry Smith    Output Parameter:
6692b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
6693b3d3934dSBarry Smith 
6694b3d3934dSBarry Smith    Level: intermediate
6695b3d3934dSBarry Smith 
669695452b02SPatrick Sanan    Notes:
669795452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66987db568b7SBarry Smith 
6699b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6700b3d3934dSBarry Smith @*/
6701b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
6702b3d3934dSBarry Smith {
6703b3d3934dSBarry Smith   PetscInt       i;
6704b3d3934dSBarry Smith 
6705b3d3934dSBarry Smith   PetscFunctionBegin;
6706b3d3934dSBarry Smith   *names = NULL;
6707b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6708b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
67095537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
6710b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
6711b3d3934dSBarry Smith       break;
6712387f4636SBarry Smith     }
6713387f4636SBarry Smith   }
6714387f4636SBarry Smith   PetscFunctionReturn(0);
6715387f4636SBarry Smith }
6716387f4636SBarry Smith 
6717a66092f1SBarry Smith /*@C
6718a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
6719a66092f1SBarry Smith 
6720a66092f1SBarry Smith    Collective on TS
6721a66092f1SBarry Smith 
6722a66092f1SBarry Smith    Input Parameters:
6723a66092f1SBarry Smith +  ctx - the TSMonitorLG context
6724a2b725a8SWilliam Gropp -  displaynames - the names of the components, final string must be NULL
6725a66092f1SBarry Smith 
6726a66092f1SBarry Smith    Level: intermediate
6727a66092f1SBarry Smith 
6728a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6729a66092f1SBarry Smith @*/
6730a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6731a66092f1SBarry Smith {
6732a66092f1SBarry Smith   PetscInt          j = 0,k;
6733a66092f1SBarry Smith   PetscErrorCode    ierr;
6734a66092f1SBarry Smith 
6735a66092f1SBarry Smith   PetscFunctionBegin;
6736a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6737a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6738a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6739a66092f1SBarry Smith   while (displaynames[j]) j++;
6740a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6741a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6742a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6743a66092f1SBarry Smith   j = 0;
6744a66092f1SBarry Smith   while (displaynames[j]) {
6745a66092f1SBarry Smith     k = 0;
6746a66092f1SBarry Smith     while (ctx->names[k]) {
6747a66092f1SBarry Smith       PetscBool flg;
6748a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6749a66092f1SBarry Smith       if (flg) {
6750a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6751a66092f1SBarry Smith         break;
6752a66092f1SBarry Smith       }
6753a66092f1SBarry Smith       k++;
6754a66092f1SBarry Smith     }
6755a66092f1SBarry Smith     j++;
6756a66092f1SBarry Smith   }
6757a66092f1SBarry Smith   PetscFunctionReturn(0);
6758a66092f1SBarry Smith }
6759a66092f1SBarry Smith 
6760387f4636SBarry Smith /*@C
6761387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6762387f4636SBarry Smith 
6763387f4636SBarry Smith    Collective on TS
6764387f4636SBarry Smith 
6765387f4636SBarry Smith    Input Parameters:
6766387f4636SBarry Smith +  ts - the TS context
6767a2b725a8SWilliam Gropp -  displaynames - the names of the components, final string must be NULL
6768387f4636SBarry Smith 
676995452b02SPatrick Sanan    Notes:
677095452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
67717db568b7SBarry Smith 
6772387f4636SBarry Smith    Level: intermediate
6773387f4636SBarry Smith 
6774387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6775387f4636SBarry Smith @*/
6776387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6777387f4636SBarry Smith {
6778a66092f1SBarry Smith   PetscInt          i;
6779387f4636SBarry Smith   PetscErrorCode    ierr;
6780387f4636SBarry Smith 
6781387f4636SBarry Smith   PetscFunctionBegin;
6782387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6783387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
67845537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6785b3d3934dSBarry Smith       break;
6786b037adc7SBarry Smith     }
6787b037adc7SBarry Smith   }
6788b037adc7SBarry Smith   PetscFunctionReturn(0);
6789b037adc7SBarry Smith }
6790b037adc7SBarry Smith 
679180666b62SBarry Smith /*@C
679280666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
679380666b62SBarry Smith 
679480666b62SBarry Smith    Collective on TS
679580666b62SBarry Smith 
679680666b62SBarry Smith    Input Parameters:
679780666b62SBarry Smith +  ts - the TS context
679880666b62SBarry Smith .  transform - the transform function
67997684fa3eSBarry Smith .  destroy - function to destroy the optional context
680080666b62SBarry Smith -  ctx - optional context used by transform function
680180666b62SBarry Smith 
680295452b02SPatrick Sanan    Notes:
680395452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
68047db568b7SBarry Smith 
680580666b62SBarry Smith    Level: intermediate
680680666b62SBarry Smith 
6807a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
680880666b62SBarry Smith @*/
68097684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
681080666b62SBarry Smith {
681180666b62SBarry Smith   PetscInt          i;
6812a66092f1SBarry Smith   PetscErrorCode    ierr;
681380666b62SBarry Smith 
681480666b62SBarry Smith   PetscFunctionBegin;
681580666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
681680666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
68175537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
681880666b62SBarry Smith     }
681980666b62SBarry Smith   }
682080666b62SBarry Smith   PetscFunctionReturn(0);
682180666b62SBarry Smith }
682280666b62SBarry Smith 
6823e673d494SBarry Smith /*@C
6824e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6825e673d494SBarry Smith 
6826e673d494SBarry Smith    Collective on TSLGCtx
6827e673d494SBarry Smith 
6828e673d494SBarry Smith    Input Parameters:
6829e673d494SBarry Smith +  ts - the TS context
6830e673d494SBarry Smith .  transform - the transform function
68317684fa3eSBarry Smith .  destroy - function to destroy the optional context
6832e673d494SBarry Smith -  ctx - optional context used by transform function
6833e673d494SBarry Smith 
6834e673d494SBarry Smith    Level: intermediate
6835e673d494SBarry Smith 
6836a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6837e673d494SBarry Smith @*/
68387684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6839e673d494SBarry Smith {
6840e673d494SBarry Smith   PetscFunctionBegin;
6841e673d494SBarry Smith   ctx->transform    = transform;
68427684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6843e673d494SBarry Smith   ctx->transformctx = tctx;
6844e673d494SBarry Smith   PetscFunctionReturn(0);
6845e673d494SBarry Smith }
6846e673d494SBarry Smith 
6847ef20d060SBarry Smith /*@C
68488b668821SLisandro Dalcin    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the error
6849ef20d060SBarry Smith        in a time based line graph
6850ef20d060SBarry Smith 
6851ef20d060SBarry Smith    Collective on TS
6852ef20d060SBarry Smith 
6853ef20d060SBarry Smith    Input Parameters:
6854ef20d060SBarry Smith +  ts - the TS context
6855ef20d060SBarry Smith .  step - current time-step
6856ef20d060SBarry Smith .  ptime - current time
68577db568b7SBarry Smith .  u - current solution
68587db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6859ef20d060SBarry Smith 
6860ef20d060SBarry Smith    Level: intermediate
6861ef20d060SBarry Smith 
686295452b02SPatrick Sanan    Notes:
686395452b02SPatrick Sanan     Each process in a parallel run displays its component errors in a separate window
6864abd5a294SJed Brown 
6865abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6866abd5a294SJed Brown 
6867abd5a294SJed Brown    Options Database Keys:
68684f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6869ef20d060SBarry Smith 
6870abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6871ef20d060SBarry Smith @*/
68720910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6873ef20d060SBarry Smith {
6874ef20d060SBarry Smith   PetscErrorCode    ierr;
68750b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6876ef20d060SBarry Smith   const PetscScalar *yy;
6877ef20d060SBarry Smith   Vec               y;
6878ef20d060SBarry Smith 
6879ef20d060SBarry Smith   PetscFunctionBegin;
6880a9f9c1f6SBarry Smith   if (!step) {
6881a9f9c1f6SBarry Smith     PetscDrawAxis axis;
68826934998bSLisandro Dalcin     PetscInt      dim;
6883a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
68848b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Error");CHKERRQ(ierr);
68850910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6886a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6887a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6888a9f9c1f6SBarry Smith   }
68890910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6890ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
68910910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6892ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6893e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6894e3efe391SJed Brown   {
6895e3efe391SJed Brown     PetscReal *yreal;
6896e3efe391SJed Brown     PetscInt  i,n;
6897e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6898785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6899e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
69000b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6901e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6902e3efe391SJed Brown   }
6903e3efe391SJed Brown #else
69040b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6905e3efe391SJed Brown #endif
6906ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6907ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6908b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
69090b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
69106934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
69113923b477SBarry Smith   }
6912ef20d060SBarry Smith   PetscFunctionReturn(0);
6913ef20d060SBarry Smith }
6914ef20d060SBarry Smith 
69155e3b7effSJoseph Pusztay /*@C
69165e3b7effSJoseph Pusztay    TSMonitorSPSwarmSolution - Graphically displays phase plots of DMSwarm particles on a scatter plot
69175e3b7effSJoseph Pusztay 
69185e3b7effSJoseph Pusztay    Input Parameters:
69195e3b7effSJoseph Pusztay +  ts - the TS context
69205e3b7effSJoseph Pusztay .  step - current time-step
69215e3b7effSJoseph Pusztay .  ptime - current time
69225e3b7effSJoseph Pusztay .  u - current solution
69235e3b7effSJoseph Pusztay -  dctx - the TSMonitorSPCtx object that contains all the options for the monitoring, this is created with TSMonitorSPCtxCreate()
69245e3b7effSJoseph Pusztay 
69255e3b7effSJoseph Pusztay    Options Database:
6926918b1d10SJoseph Pusztay .   -ts_monitor_sp_swarm
69275e3b7effSJoseph Pusztay 
69285e3b7effSJoseph Pusztay    Level: intermediate
69295e3b7effSJoseph Pusztay 
69305e3b7effSJoseph Pusztay @*/
69310ec8ee2bSJoseph Pusztay PetscErrorCode TSMonitorSPSwarmSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
69321b575b74SJoseph Pusztay {
69331b575b74SJoseph Pusztay   PetscErrorCode    ierr;
69341b575b74SJoseph Pusztay   TSMonitorSPCtx    ctx = (TSMonitorSPCtx)dctx;
69351b575b74SJoseph Pusztay   const PetscScalar *yy;
6936b1670a61SJoseph Pusztay   PetscReal       *y,*x;
69371b575b74SJoseph Pusztay   PetscInt          Np, p, dim=2;
69381b575b74SJoseph Pusztay   DM                dm;
69391b575b74SJoseph Pusztay 
69401b575b74SJoseph Pusztay   PetscFunctionBegin;
69411b575b74SJoseph Pusztay 
69421b575b74SJoseph Pusztay   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
69431b575b74SJoseph Pusztay   if (!step) {
69441b575b74SJoseph Pusztay     PetscDrawAxis axis;
69451b575b74SJoseph Pusztay     ierr = PetscDrawSPGetAxis(ctx->sp,&axis);CHKERRQ(ierr);
69461b575b74SJoseph Pusztay     ierr = PetscDrawAxisSetLabels(axis,"Particles","X","Y");CHKERRQ(ierr);
6947895f37d5SJoseph Pusztay     ierr = PetscDrawAxisSetLimits(axis, -5, 5, -5, 5);CHKERRQ(ierr);
6948895f37d5SJoseph Pusztay     ierr = PetscDrawAxisSetHoldLimits(axis, PETSC_TRUE);CHKERRQ(ierr);
69491b575b74SJoseph Pusztay     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
69501b575b74SJoseph Pusztay     ierr = DMGetDimension(dm, &dim);
69511b575b74SJoseph Pusztay     if (dim!=2) SETERRQ(PETSC_COMM_SELF, ierr, "Dimensions improper for monitor arguments! Current support: two dimensions.");CHKERRQ(ierr);
69521b575b74SJoseph Pusztay     ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr);
69531b575b74SJoseph Pusztay     Np /= 2*dim;
69541b575b74SJoseph Pusztay     ierr = PetscDrawSPSetDimension(ctx->sp, Np);CHKERRQ(ierr);
69551b575b74SJoseph Pusztay     ierr = PetscDrawSPReset(ctx->sp);CHKERRQ(ierr);
69561b575b74SJoseph Pusztay   }
69571b575b74SJoseph Pusztay 
69581b575b74SJoseph Pusztay   ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr);
69591b575b74SJoseph Pusztay   Np /= 2*dim;
69601b575b74SJoseph Pusztay   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
6961895f37d5SJoseph Pusztay   ierr = PetscMalloc2(Np, &x, Np, &y);CHKERRQ(ierr);
69621b575b74SJoseph Pusztay   /* get points from solution vector */
69631b575b74SJoseph Pusztay   for (p=0; p<Np; ++p){
6964b1670a61SJoseph Pusztay     x[p] = PetscRealPart(yy[2*dim*p]);
6965b1670a61SJoseph Pusztay     y[p] = PetscRealPart(yy[2*dim*p+1]);
6966895f37d5SJoseph Pusztay   }
69671b575b74SJoseph Pusztay   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
69681b575b74SJoseph Pusztay 
69691b575b74SJoseph Pusztay   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
69701b575b74SJoseph Pusztay     ierr = PetscDrawSPAddPoint(ctx->sp,x,y);CHKERRQ(ierr);
69711b575b74SJoseph Pusztay     ierr = PetscDrawSPDraw(ctx->sp,PETSC_FALSE);CHKERRQ(ierr);
69721b575b74SJoseph Pusztay     ierr = PetscDrawSPSave(ctx->sp);CHKERRQ(ierr);
69731b575b74SJoseph Pusztay   }
69741b575b74SJoseph Pusztay 
6975918b1d10SJoseph Pusztay   ierr = PetscFree2(x, y);CHKERRQ(ierr);
6976918b1d10SJoseph Pusztay 
69771b575b74SJoseph Pusztay   PetscFunctionReturn(0);
69781b575b74SJoseph Pusztay }
69791b575b74SJoseph Pusztay 
69801b575b74SJoseph Pusztay 
69811b575b74SJoseph Pusztay 
69827cf37e64SBarry Smith /*@C
69837cf37e64SBarry Smith    TSMonitorError - Monitors progress of the TS solvers by printing the 2 norm of the error at each timestep
69847cf37e64SBarry Smith 
69857cf37e64SBarry Smith    Collective on TS
69867cf37e64SBarry Smith 
69877cf37e64SBarry Smith    Input Parameters:
69887cf37e64SBarry Smith +  ts - the TS context
69897cf37e64SBarry Smith .  step - current time-step
69907cf37e64SBarry Smith .  ptime - current time
69917cf37e64SBarry Smith .  u - current solution
69927cf37e64SBarry Smith -  dctx - unused context
69937cf37e64SBarry Smith 
69947cf37e64SBarry Smith    Level: intermediate
69957cf37e64SBarry Smith 
69967cf37e64SBarry Smith    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
69977cf37e64SBarry Smith 
69987cf37e64SBarry Smith    Options Database Keys:
69997cf37e64SBarry Smith .  -ts_monitor_error - create a graphical monitor of error history
70007cf37e64SBarry Smith 
70017cf37e64SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
70027cf37e64SBarry Smith @*/
7003edbaebb3SBarry Smith PetscErrorCode  TSMonitorError(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
70047cf37e64SBarry Smith {
70057cf37e64SBarry Smith   PetscErrorCode    ierr;
70067cf37e64SBarry Smith   Vec               y;
70077cf37e64SBarry Smith   PetscReal         nrm;
7008edbaebb3SBarry Smith   PetscBool         flg;
70097cf37e64SBarry Smith 
70107cf37e64SBarry Smith   PetscFunctionBegin;
70117cf37e64SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
70127cf37e64SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
70137cf37e64SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
7014edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERASCII,&flg);CHKERRQ(ierr);
7015edbaebb3SBarry Smith   if (flg) {
70167cf37e64SBarry Smith     ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
7017edbaebb3SBarry Smith     ierr = PetscViewerASCIIPrintf(vf->viewer,"2-norm of error %g\n",(double)nrm);CHKERRQ(ierr);
7018edbaebb3SBarry Smith   }
7019edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERDRAW,&flg);CHKERRQ(ierr);
7020edbaebb3SBarry Smith   if (flg) {
7021edbaebb3SBarry Smith     ierr = VecView(y,vf->viewer);CHKERRQ(ierr);
7022edbaebb3SBarry Smith   }
7023edbaebb3SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
70247cf37e64SBarry Smith   PetscFunctionReturn(0);
70257cf37e64SBarry Smith }
70267cf37e64SBarry Smith 
7027201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7028201da799SBarry Smith {
7029201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7030201da799SBarry Smith   PetscReal      x   = ptime,y;
7031201da799SBarry Smith   PetscErrorCode ierr;
7032201da799SBarry Smith   PetscInt       its;
7033201da799SBarry Smith 
7034201da799SBarry Smith   PetscFunctionBegin;
703563e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7036201da799SBarry Smith   if (!n) {
7037201da799SBarry Smith     PetscDrawAxis axis;
7038201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7039201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
7040201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7041201da799SBarry Smith     ctx->snes_its = 0;
7042201da799SBarry Smith   }
7043201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
7044201da799SBarry Smith   y    = its - ctx->snes_its;
7045201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
70463fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7047201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
70486934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7049201da799SBarry Smith   }
7050201da799SBarry Smith   ctx->snes_its = its;
7051201da799SBarry Smith   PetscFunctionReturn(0);
7052201da799SBarry Smith }
7053201da799SBarry Smith 
7054201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7055201da799SBarry Smith {
7056201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7057201da799SBarry Smith   PetscReal      x   = ptime,y;
7058201da799SBarry Smith   PetscErrorCode ierr;
7059201da799SBarry Smith   PetscInt       its;
7060201da799SBarry Smith 
7061201da799SBarry Smith   PetscFunctionBegin;
706263e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7063201da799SBarry Smith   if (!n) {
7064201da799SBarry Smith     PetscDrawAxis axis;
7065201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7066201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
7067201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7068201da799SBarry Smith     ctx->ksp_its = 0;
7069201da799SBarry Smith   }
7070201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
7071201da799SBarry Smith   y    = its - ctx->ksp_its;
7072201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
707399fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7074201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
70756934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7076201da799SBarry Smith   }
7077201da799SBarry Smith   ctx->ksp_its = its;
7078201da799SBarry Smith   PetscFunctionReturn(0);
7079201da799SBarry Smith }
7080f9c1d6abSBarry Smith 
7081f9c1d6abSBarry Smith /*@
7082f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
7083f9c1d6abSBarry Smith 
7084d083f849SBarry Smith    Collective on TS
7085f9c1d6abSBarry Smith 
7086f9c1d6abSBarry Smith    Input Parameters:
7087f9c1d6abSBarry Smith +  ts - the TS context
7088f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
7089f9c1d6abSBarry Smith 
7090f9c1d6abSBarry Smith    Output Parameters:
7091f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
7092f9c1d6abSBarry Smith 
7093f9c1d6abSBarry Smith    Level: developer
7094f9c1d6abSBarry Smith 
7095f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
7096f9c1d6abSBarry Smith @*/
7097f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
7098f9c1d6abSBarry Smith {
7099f9c1d6abSBarry Smith   PetscErrorCode ierr;
7100f9c1d6abSBarry Smith 
7101f9c1d6abSBarry Smith   PetscFunctionBegin;
7102f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7103ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
7104f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
7105f9c1d6abSBarry Smith   PetscFunctionReturn(0);
7106f9c1d6abSBarry Smith }
710724655328SShri 
7108b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
7109b3d3934dSBarry Smith /*@C
7110b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
7111b3d3934dSBarry Smith 
7112b3d3934dSBarry Smith    Collective on TS
7113b3d3934dSBarry Smith 
7114b3d3934dSBarry Smith    Input Parameters:
7115b3d3934dSBarry Smith .  ts  - the ODE solver object
7116b3d3934dSBarry Smith 
7117b3d3934dSBarry Smith    Output Parameter:
7118b3d3934dSBarry Smith .  ctx - the context
7119b3d3934dSBarry Smith 
7120b3d3934dSBarry Smith    Level: intermediate
7121b3d3934dSBarry Smith 
7122b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
7123b3d3934dSBarry Smith 
7124b3d3934dSBarry Smith @*/
7125b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
7126b3d3934dSBarry Smith {
7127b3d3934dSBarry Smith   PetscErrorCode ierr;
7128b3d3934dSBarry Smith 
7129b3d3934dSBarry Smith   PetscFunctionBegin;
7130a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
7131b3d3934dSBarry Smith   PetscFunctionReturn(0);
7132b3d3934dSBarry Smith }
7133b3d3934dSBarry Smith 
7134b3d3934dSBarry Smith /*@C
7135b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
7136b3d3934dSBarry Smith 
7137b3d3934dSBarry Smith    Collective on TS
7138b3d3934dSBarry Smith 
7139b3d3934dSBarry Smith    Input Parameters:
7140b3d3934dSBarry Smith +  ts - the TS context
7141b3d3934dSBarry Smith .  step - current time-step
7142b3d3934dSBarry Smith .  ptime - current time
71437db568b7SBarry Smith .  u  - current solution
71447db568b7SBarry Smith -  dctx - the envelope context
7145b3d3934dSBarry Smith 
7146b3d3934dSBarry Smith    Options Database:
7147b3d3934dSBarry Smith .  -ts_monitor_envelope
7148b3d3934dSBarry Smith 
7149b3d3934dSBarry Smith    Level: intermediate
7150b3d3934dSBarry Smith 
715195452b02SPatrick Sanan    Notes:
715295452b02SPatrick Sanan     after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
7153b3d3934dSBarry Smith 
71547db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
7155b3d3934dSBarry Smith @*/
71567db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7157b3d3934dSBarry Smith {
7158b3d3934dSBarry Smith   PetscErrorCode       ierr;
71597db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
7160b3d3934dSBarry Smith 
7161b3d3934dSBarry Smith   PetscFunctionBegin;
7162b3d3934dSBarry Smith   if (!ctx->max) {
7163b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
7164b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
7165b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
7166b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
7167b3d3934dSBarry Smith   } else {
7168b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
7169b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
7170b3d3934dSBarry Smith   }
7171b3d3934dSBarry Smith   PetscFunctionReturn(0);
7172b3d3934dSBarry Smith }
7173b3d3934dSBarry Smith 
7174b3d3934dSBarry Smith /*@C
7175b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
7176b3d3934dSBarry Smith 
7177b3d3934dSBarry Smith    Collective on TS
7178b3d3934dSBarry Smith 
7179b3d3934dSBarry Smith    Input Parameter:
7180b3d3934dSBarry Smith .  ts - the TS context
7181b3d3934dSBarry Smith 
7182b3d3934dSBarry Smith    Output Parameter:
7183b3d3934dSBarry Smith +  max - the maximum values
7184b3d3934dSBarry Smith -  min - the minimum values
7185b3d3934dSBarry Smith 
718695452b02SPatrick Sanan    Notes:
718795452b02SPatrick Sanan     If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
71887db568b7SBarry Smith 
7189b3d3934dSBarry Smith    Level: intermediate
7190b3d3934dSBarry Smith 
7191b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7192b3d3934dSBarry Smith @*/
7193b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
7194b3d3934dSBarry Smith {
7195b3d3934dSBarry Smith   PetscInt i;
7196b3d3934dSBarry Smith 
7197b3d3934dSBarry Smith   PetscFunctionBegin;
7198b3d3934dSBarry Smith   if (max) *max = NULL;
7199b3d3934dSBarry Smith   if (min) *min = NULL;
7200b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7201b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
72025537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7203b3d3934dSBarry Smith       if (max) *max = ctx->max;
7204b3d3934dSBarry Smith       if (min) *min = ctx->min;
7205b3d3934dSBarry Smith       break;
7206b3d3934dSBarry Smith     }
7207b3d3934dSBarry Smith   }
7208b3d3934dSBarry Smith   PetscFunctionReturn(0);
7209b3d3934dSBarry Smith }
7210b3d3934dSBarry Smith 
7211b3d3934dSBarry Smith /*@C
7212b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7213b3d3934dSBarry Smith 
7214b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7215b3d3934dSBarry Smith 
7216b3d3934dSBarry Smith    Input Parameter:
7217b3d3934dSBarry Smith .  ctx - the monitor context
7218b3d3934dSBarry Smith 
7219b3d3934dSBarry Smith    Level: intermediate
7220b3d3934dSBarry Smith 
72217db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7222b3d3934dSBarry Smith @*/
7223b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7224b3d3934dSBarry Smith {
7225b3d3934dSBarry Smith   PetscErrorCode ierr;
7226b3d3934dSBarry Smith 
7227b3d3934dSBarry Smith   PetscFunctionBegin;
7228b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7229b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7230b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7231b3d3934dSBarry Smith   PetscFunctionReturn(0);
7232b3d3934dSBarry Smith }
7233f2dee214SBarry Smith 
723424655328SShri /*@
7235dcb233daSLisandro Dalcin    TSRestartStep - Flags the solver to restart the next step
7236dcb233daSLisandro Dalcin 
7237dcb233daSLisandro Dalcin    Collective on TS
7238dcb233daSLisandro Dalcin 
7239dcb233daSLisandro Dalcin    Input Parameter:
7240dcb233daSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
7241dcb233daSLisandro Dalcin 
7242dcb233daSLisandro Dalcin    Level: advanced
7243dcb233daSLisandro Dalcin 
7244dcb233daSLisandro Dalcin    Notes:
7245dcb233daSLisandro Dalcin    Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of
7246dcb233daSLisandro Dalcin    discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution
7247dcb233daSLisandro Dalcin    vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For
7248dcb233daSLisandro Dalcin    the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce
7249dcb233daSLisandro Dalcin    discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with
7250dcb233daSLisandro Dalcin    discontinuous source terms).
7251dcb233daSLisandro Dalcin 
7252dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep()
7253dcb233daSLisandro Dalcin @*/
7254dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts)
7255dcb233daSLisandro Dalcin {
7256dcb233daSLisandro Dalcin   PetscFunctionBegin;
7257dcb233daSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7258dcb233daSLisandro Dalcin   ts->steprestart = PETSC_TRUE;
7259dcb233daSLisandro Dalcin   PetscFunctionReturn(0);
7260dcb233daSLisandro Dalcin }
7261dcb233daSLisandro Dalcin 
7262dcb233daSLisandro Dalcin /*@
726324655328SShri    TSRollBack - Rolls back one time step
726424655328SShri 
726524655328SShri    Collective on TS
726624655328SShri 
726724655328SShri    Input Parameter:
726824655328SShri .  ts - the TS context obtained from TSCreate()
726924655328SShri 
727024655328SShri    Level: advanced
727124655328SShri 
727224655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
727324655328SShri @*/
727424655328SShri PetscErrorCode  TSRollBack(TS ts)
727524655328SShri {
727624655328SShri   PetscErrorCode ierr;
727724655328SShri 
727824655328SShri   PetscFunctionBegin;
727924655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7280b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
728124655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
728224655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
728324655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
728424655328SShri   ts->ptime = ts->ptime_prev;
7285be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
72862808aa04SLisandro Dalcin   ts->steps--;
7287b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
728824655328SShri   PetscFunctionReturn(0);
728924655328SShri }
7290aeb4809dSShri Abhyankar 
7291ff22ae23SHong Zhang /*@
7292ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7293ff22ae23SHong Zhang 
7294ff22ae23SHong Zhang    Input Parameter:
7295ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7296ff22ae23SHong Zhang 
72970429704eSStefano Zampini    Output Parameters:
72980429704eSStefano Zampini +  ns - the number of stages
72990429704eSStefano Zampini -  Y - the current stage vectors
73000429704eSStefano Zampini 
7301ff22ae23SHong Zhang    Level: advanced
7302ff22ae23SHong Zhang 
73030429704eSStefano Zampini    Notes: Both ns and Y can be NULL.
73040429704eSStefano Zampini 
7305ff22ae23SHong Zhang .seealso: TSCreate()
7306ff22ae23SHong Zhang @*/
7307ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7308ff22ae23SHong Zhang {
7309ff22ae23SHong Zhang   PetscErrorCode ierr;
7310ff22ae23SHong Zhang 
7311ff22ae23SHong Zhang   PetscFunctionBegin;
7312ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
73130429704eSStefano Zampini   if (ns) PetscValidPointer(ns,2);
73140429704eSStefano Zampini   if (Y) PetscValidPointer(Y,3);
73150429704eSStefano Zampini   if (!ts->ops->getstages) {
73160429704eSStefano Zampini     if (ns) *ns = 0;
73170429704eSStefano Zampini     if (Y) *Y = NULL;
73180429704eSStefano Zampini   } else {
7319ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7320ff22ae23SHong Zhang   }
7321ff22ae23SHong Zhang   PetscFunctionReturn(0);
7322ff22ae23SHong Zhang }
7323ff22ae23SHong Zhang 
7324847ff0e1SMatthew G. Knepley /*@C
7325847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7326847ff0e1SMatthew G. Knepley 
7327847ff0e1SMatthew G. Knepley   Collective on SNES
7328847ff0e1SMatthew G. Knepley 
7329847ff0e1SMatthew G. Knepley   Input Parameters:
7330847ff0e1SMatthew G. Knepley + ts - the TS context
7331847ff0e1SMatthew G. Knepley . t - current timestep
7332847ff0e1SMatthew G. Knepley . U - state vector
7333847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7334847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7335847ff0e1SMatthew G. Knepley - ctx - an optional user context
7336847ff0e1SMatthew G. Knepley 
7337847ff0e1SMatthew G. Knepley   Output Parameters:
7338847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7339847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7340847ff0e1SMatthew G. Knepley 
7341847ff0e1SMatthew G. Knepley   Level: intermediate
7342847ff0e1SMatthew G. Knepley 
7343847ff0e1SMatthew G. Knepley   Notes:
7344847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7345847ff0e1SMatthew G. Knepley 
7346847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7347847ff0e1SMatthew G. Knepley 
7348847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7349847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7350847ff0e1SMatthew G. Knepley 
7351847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7352847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7353847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7354847ff0e1SMatthew G. Knepley 
7355847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7356847ff0e1SMatthew G. Knepley @*/
7357847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7358847ff0e1SMatthew G. Knepley {
7359847ff0e1SMatthew G. Knepley   SNES           snes;
7360847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7361847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7362847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
7363847ff0e1SMatthew G. Knepley 
7364847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
7365c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
7366847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
7367847ff0e1SMatthew G. Knepley   if (!color) {
7368847ff0e1SMatthew G. Knepley     DM         dm;
7369847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
7370847ff0e1SMatthew G. Knepley 
7371847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
7372847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
7373847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
7374847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
7375847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7376847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7377847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7378847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7379847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7380847ff0e1SMatthew G. Knepley     } else {
7381847ff0e1SMatthew G. Knepley       MatColoring mc;
7382847ff0e1SMatthew G. Knepley 
7383847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
7384847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
7385847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
7386847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
7387847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
7388847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
7389847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7390847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7391847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7392847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7393847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7394847ff0e1SMatthew G. Knepley     }
7395847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
7396847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
7397847ff0e1SMatthew G. Knepley   }
7398847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
7399847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
7400847ff0e1SMatthew G. Knepley   if (J != B) {
7401847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7402847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7403847ff0e1SMatthew G. Knepley   }
7404847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
7405847ff0e1SMatthew G. Knepley }
740693b34091SDebojyoti Ghosh 
7407cb9d8021SPierre Barbier de Reuille /*@
74086bc98fa9SBarry Smith     TSSetFunctionDomainError - Set a function that tests if the current state vector is valid
7409cb9d8021SPierre Barbier de Reuille 
7410cb9d8021SPierre Barbier de Reuille     Input Parameters:
74116bc98fa9SBarry Smith +    ts - the TS context
74126bc98fa9SBarry Smith -    func - function called within TSFunctionDomainError
74136bc98fa9SBarry Smith 
74146bc98fa9SBarry Smith     Calling sequence of func:
74156bc98fa9SBarry Smith $     PetscErrorCode func(TS ts,PetscReal time,Vec state,PetscBool reject)
74166bc98fa9SBarry Smith 
74176bc98fa9SBarry Smith +   ts - the TS context
74186bc98fa9SBarry Smith .   time - the current time (of the stage)
74196bc98fa9SBarry Smith .   state - the state to check if it is valid
74206bc98fa9SBarry Smith -   reject - (output parameter) PETSC_FALSE if the state is acceptable, PETSC_TRUE if not acceptable
7421cb9d8021SPierre Barbier de Reuille 
7422cb9d8021SPierre Barbier de Reuille     Level: intermediate
7423cb9d8021SPierre Barbier de Reuille 
74246bc98fa9SBarry Smith     Notes:
74256bc98fa9SBarry Smith       If an implicit ODE solver is being used then, in addition to providing this routine, the
74266bc98fa9SBarry Smith       user's code should call SNESSetFunctionDomainError() when domain errors occur during
74276bc98fa9SBarry Smith       function evaluations where the functions are provided by TSSetIFunction() or TSSetRHSFunction().
74286bc98fa9SBarry Smith       Use TSGetSNES() to obtain the SNES object
74296bc98fa9SBarry Smith 
74306bc98fa9SBarry Smith     Developer Notes:
74316bc98fa9SBarry Smith       The naming of this function is inconsistent with the SNESSetFunctionDomainError()
74326bc98fa9SBarry Smith       since one takes a function pointer and the other does not.
74336bc98fa9SBarry Smith 
74346bc98fa9SBarry Smith .seealso: TSAdaptCheckStage(), TSFunctionDomainError(), SNESSetFunctionDomainError(), TSGetSNES()
7435cb9d8021SPierre Barbier de Reuille @*/
7436cb9d8021SPierre Barbier de Reuille 
7437d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
7438cb9d8021SPierre Barbier de Reuille {
7439cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7440cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7441cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
7442cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7443cb9d8021SPierre Barbier de Reuille }
7444cb9d8021SPierre Barbier de Reuille 
7445cb9d8021SPierre Barbier de Reuille /*@
74466bc98fa9SBarry Smith     TSFunctionDomainError - Checks if the current state is valid
7447cb9d8021SPierre Barbier de Reuille 
7448cb9d8021SPierre Barbier de Reuille     Input Parameters:
74496bc98fa9SBarry Smith +    ts - the TS context
74506bc98fa9SBarry Smith .    stagetime - time of the simulation
74516bc98fa9SBarry Smith -    Y - state vector to check.
7452cb9d8021SPierre Barbier de Reuille 
7453cb9d8021SPierre Barbier de Reuille     Output Parameter:
74546bc98fa9SBarry Smith .    accept - Set to PETSC_FALSE if the current state vector is valid.
7455cb9d8021SPierre Barbier de Reuille 
7456cb9d8021SPierre Barbier de Reuille     Note:
74576bc98fa9SBarry Smith     This function is called by the TS integration routines and calls the user provided function (set with TSSetFunctionDomainError())
74586bc98fa9SBarry Smith     to check if the current state is valid.
745996a0c994SBarry Smith 
74606bc98fa9SBarry Smith     Level: developer
74616bc98fa9SBarry Smith 
74626bc98fa9SBarry Smith .seealso: TSSetFunctionDomainError()
7463cb9d8021SPierre Barbier de Reuille @*/
7464d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
7465cb9d8021SPierre Barbier de Reuille {
7466cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7467cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7468cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
7469cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
7470d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
7471cb9d8021SPierre Barbier de Reuille   }
7472cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7473cb9d8021SPierre Barbier de Reuille }
74741ceb14c0SBarry Smith 
747593b34091SDebojyoti Ghosh /*@C
7476e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
747793b34091SDebojyoti Ghosh 
7478d083f849SBarry Smith   Collective
747993b34091SDebojyoti Ghosh 
748093b34091SDebojyoti Ghosh   Input Parameter:
748193b34091SDebojyoti Ghosh . tsin    - The input TS
748293b34091SDebojyoti Ghosh 
748393b34091SDebojyoti Ghosh   Output Parameter:
7484e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
748593b34091SDebojyoti Ghosh 
74865eca1a21SEmil Constantinescu   Notes:
74875eca1a21SEmil 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.
74885eca1a21SEmil Constantinescu 
7489928bb9adSStefano 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);
74905eca1a21SEmil Constantinescu 
74915eca1a21SEmil Constantinescu   Level: developer
749293b34091SDebojyoti Ghosh 
7493e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
749493b34091SDebojyoti Ghosh @*/
7495baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
749693b34091SDebojyoti Ghosh {
749793b34091SDebojyoti Ghosh   TS             t;
749893b34091SDebojyoti Ghosh   PetscErrorCode ierr;
7499dc846ba4SSatish Balay   SNES           snes_start;
7500dc846ba4SSatish Balay   DM             dm;
7501dc846ba4SSatish Balay   TSType         type;
750293b34091SDebojyoti Ghosh 
750393b34091SDebojyoti Ghosh   PetscFunctionBegin;
750493b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
750593b34091SDebojyoti Ghosh   *tsout = NULL;
750693b34091SDebojyoti Ghosh 
75077a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
750893b34091SDebojyoti Ghosh 
750993b34091SDebojyoti Ghosh   /* General TS description */
751093b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
751193b34091SDebojyoti Ghosh   t->setupcalled       = 0;
751293b34091SDebojyoti Ghosh   t->ksp_its           = 0;
751393b34091SDebojyoti Ghosh   t->snes_its          = 0;
751493b34091SDebojyoti Ghosh   t->nwork             = 0;
75157d51462cSStefano Zampini   t->rhsjacobian.time  = PETSC_MIN_REAL;
751693b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
751793b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
751893b34091SDebojyoti Ghosh 
751934561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
752034561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
7521d15a3a53SEmil Constantinescu 
752293b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
752393b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
752493b34091SDebojyoti Ghosh 
752593b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
752651699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
752793b34091SDebojyoti Ghosh 
7528e7069c78SShri   t->trajectory = tsin->trajectory;
7529e7069c78SShri   ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr);
7530e7069c78SShri 
7531e7069c78SShri   t->event = tsin->event;
75326b10a48eSSatish Balay   if (t->event) t->event->refct++;
7533e7069c78SShri 
753493b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
753593b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
7536e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
753793b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
753893b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
753993b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
754093b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
754193b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
754293b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
754393b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
754493b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
754593b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
754693b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
754793b34091SDebojyoti Ghosh 
754893b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
754993b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
755093b34091SDebojyoti Ghosh 
755193b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
755293b34091SDebojyoti Ghosh 
755393b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
755493b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
755593b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
755693b34091SDebojyoti Ghosh 
755793b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
755893b34091SDebojyoti Ghosh 
75590d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
75600d4fed19SBarry Smith     PetscInt i;
75610d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
75620d4fed19SBarry Smith     for (i=0; i<10; i++) {
75630d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
75640d4fed19SBarry Smith     }
75650d4fed19SBarry Smith   }
756693b34091SDebojyoti Ghosh   *tsout = t;
756793b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
756893b34091SDebojyoti Ghosh }
7569f3b1f45cSBarry Smith 
7570f3b1f45cSBarry Smith static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void* ctx,Vec x,Vec y)
7571f3b1f45cSBarry Smith {
7572f3b1f45cSBarry Smith   PetscErrorCode ierr;
7573f3b1f45cSBarry Smith   TS             ts = (TS) ctx;
7574f3b1f45cSBarry Smith 
7575f3b1f45cSBarry Smith   PetscFunctionBegin;
7576f3b1f45cSBarry Smith   ierr = TSComputeRHSFunction(ts,0,x,y);CHKERRQ(ierr);
7577f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7578f3b1f45cSBarry Smith }
7579f3b1f45cSBarry Smith 
7580f3b1f45cSBarry Smith /*@
7581f3b1f45cSBarry Smith     TSRHSJacobianTest - Compares the multiply routine provided to the MATSHELL with differencing on the TS given RHS function.
7582f3b1f45cSBarry Smith 
7583d083f849SBarry Smith    Logically Collective on TS
7584f3b1f45cSBarry Smith 
7585f3b1f45cSBarry Smith     Input Parameters:
7586f3b1f45cSBarry Smith     TS - the time stepping routine
7587f3b1f45cSBarry Smith 
7588f3b1f45cSBarry Smith    Output Parameter:
7589f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
7590f3b1f45cSBarry Smith 
7591f3b1f45cSBarry Smith    Options Database:
7592f3b1f45cSBarry Smith  .   -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator
7593f3b1f45cSBarry Smith 
7594f3b1f45cSBarry Smith    Level: advanced
7595f3b1f45cSBarry Smith 
759695452b02SPatrick Sanan    Notes:
759795452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
7598f3b1f45cSBarry Smith 
7599f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTestTranspose()
7600f3b1f45cSBarry Smith @*/
7601f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTest(TS ts,PetscBool *flg)
7602f3b1f45cSBarry Smith {
7603f3b1f45cSBarry Smith   Mat            J,B;
7604f3b1f45cSBarry Smith   PetscErrorCode ierr;
7605f3b1f45cSBarry Smith   TSRHSJacobian  func;
7606f3b1f45cSBarry Smith   void*          ctx;
7607f3b1f45cSBarry Smith 
7608f3b1f45cSBarry Smith   PetscFunctionBegin;
7609f3b1f45cSBarry Smith   ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr);
7610f3b1f45cSBarry Smith   ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr);
7611f3b1f45cSBarry Smith   ierr = MatShellTestMult(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr);
7612f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7613f3b1f45cSBarry Smith }
7614f3b1f45cSBarry Smith 
7615f3b1f45cSBarry Smith /*@C
7616f3b1f45cSBarry Smith     TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the MATSHELL with differencing on the TS given RHS function.
7617f3b1f45cSBarry Smith 
7618d083f849SBarry Smith    Logically Collective on TS
7619f3b1f45cSBarry Smith 
7620f3b1f45cSBarry Smith     Input Parameters:
7621f3b1f45cSBarry Smith     TS - the time stepping routine
7622f3b1f45cSBarry Smith 
7623f3b1f45cSBarry Smith    Output Parameter:
7624f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
7625f3b1f45cSBarry Smith 
7626f3b1f45cSBarry Smith    Options Database:
7627f3b1f45cSBarry Smith .   -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator
7628f3b1f45cSBarry Smith 
762995452b02SPatrick Sanan    Notes:
763095452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
7631f3b1f45cSBarry Smith 
7632f3b1f45cSBarry Smith    Level: advanced
7633f3b1f45cSBarry Smith 
7634f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTest()
7635f3b1f45cSBarry Smith @*/
7636f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTestTranspose(TS ts,PetscBool *flg)
7637f3b1f45cSBarry Smith {
7638f3b1f45cSBarry Smith   Mat            J,B;
7639f3b1f45cSBarry Smith   PetscErrorCode ierr;
7640f3b1f45cSBarry Smith   void           *ctx;
7641f3b1f45cSBarry Smith   TSRHSJacobian  func;
7642f3b1f45cSBarry Smith 
7643f3b1f45cSBarry Smith   PetscFunctionBegin;
7644f3b1f45cSBarry Smith   ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr);
7645f3b1f45cSBarry Smith   ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr);
7646f3b1f45cSBarry Smith   ierr = MatShellTestMultTranspose(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr);
7647f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7648f3b1f45cSBarry Smith }
76490fe4d17eSHong Zhang 
76500fe4d17eSHong Zhang /*@
76510fe4d17eSHong Zhang   TSSetUseSplitRHSFunction - Use the split RHSFunction when a multirate method is used.
76520fe4d17eSHong Zhang 
76530fe4d17eSHong Zhang   Logically collective
76540fe4d17eSHong Zhang 
76550fe4d17eSHong Zhang   Input Parameter:
76560fe4d17eSHong Zhang +  ts - timestepping context
76570fe4d17eSHong Zhang -  use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used
76580fe4d17eSHong Zhang 
76590fe4d17eSHong Zhang   Options Database:
76600fe4d17eSHong Zhang .   -ts_use_splitrhsfunction - <true,false>
76610fe4d17eSHong Zhang 
76620fe4d17eSHong Zhang   Notes:
76630fe4d17eSHong Zhang     This is only useful for multirate methods
76640fe4d17eSHong Zhang 
76650fe4d17eSHong Zhang   Level: intermediate
76660fe4d17eSHong Zhang 
76670fe4d17eSHong Zhang .seealso: TSGetUseSplitRHSFunction()
76680fe4d17eSHong Zhang @*/
76690fe4d17eSHong Zhang PetscErrorCode TSSetUseSplitRHSFunction(TS ts, PetscBool use_splitrhsfunction)
76700fe4d17eSHong Zhang {
76710fe4d17eSHong Zhang   PetscFunctionBegin;
76720fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
76730fe4d17eSHong Zhang   ts->use_splitrhsfunction = use_splitrhsfunction;
76740fe4d17eSHong Zhang   PetscFunctionReturn(0);
76750fe4d17eSHong Zhang }
76760fe4d17eSHong Zhang 
76770fe4d17eSHong Zhang /*@
76780fe4d17eSHong Zhang   TSGetUseSplitRHSFunction - Gets whether to use the split RHSFunction when a multirate method is used.
76790fe4d17eSHong Zhang 
76800fe4d17eSHong Zhang   Not collective
76810fe4d17eSHong Zhang 
76820fe4d17eSHong Zhang   Input Parameter:
76830fe4d17eSHong Zhang .  ts - timestepping context
76840fe4d17eSHong Zhang 
76850fe4d17eSHong Zhang   Output Parameter:
76860fe4d17eSHong Zhang .  use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used
76870fe4d17eSHong Zhang 
76880fe4d17eSHong Zhang   Level: intermediate
76890fe4d17eSHong Zhang 
76900fe4d17eSHong Zhang .seealso: TSSetUseSplitRHSFunction()
76910fe4d17eSHong Zhang @*/
76920fe4d17eSHong Zhang PetscErrorCode TSGetUseSplitRHSFunction(TS ts, PetscBool *use_splitrhsfunction)
76930fe4d17eSHong Zhang {
76940fe4d17eSHong Zhang   PetscFunctionBegin;
76950fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
76960fe4d17eSHong Zhang   *use_splitrhsfunction = ts->use_splitrhsfunction;
76970fe4d17eSHong Zhang   PetscFunctionReturn(0);
76980fe4d17eSHong Zhang }
7699