xref: /petsc/src/ts/interface/ts.c (revision 0ed3bfb6ec21ed29e56fd524d353af30e5ebf413)
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>
6d763cef2SBarry Smith 
7d5ba7fb7SMatthew Knepley /* Logging support */
8d74926cbSBarry Smith PetscClassId  TS_CLASSID, DMTS_CLASSID;
98d0ad7a8SHong Zhang PetscLogEvent TS_AdjointStep, TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
10d405a339SMatthew Knepley 
11feed9e9dSBarry Smith const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0};
1249354f04SShri Abhyankar 
132d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx {
142d5ee99bSBarry Smith   PetscViewer   viewer;
152d5ee99bSBarry Smith   Vec           initialsolution;
162d5ee99bSBarry Smith   PetscBool     showinitial;
172d5ee99bSBarry Smith   PetscInt      howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
182d5ee99bSBarry Smith   PetscBool     showtimestepandtime;
192d5ee99bSBarry Smith };
202d5ee99bSBarry Smith 
21fde5950dSBarry Smith /*@C
22fde5950dSBarry Smith    TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
23fde5950dSBarry Smith 
24fde5950dSBarry Smith    Collective on TS
25fde5950dSBarry Smith 
26fde5950dSBarry Smith    Input Parameters:
27fde5950dSBarry Smith +  ts - TS object you wish to monitor
28fde5950dSBarry Smith .  name - the monitor type one is seeking
29fde5950dSBarry Smith .  help - message indicating what monitoring is done
30fde5950dSBarry Smith .  manual - manual page for the monitor
31fde5950dSBarry Smith .  monitor - the monitor function
32fde5950dSBarry 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
33fde5950dSBarry Smith 
34fde5950dSBarry Smith    Level: developer
35fde5950dSBarry Smith 
36fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
37fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
38fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
39fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
40fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
41fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
42fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
43fde5950dSBarry Smith @*/
44721cd6eeSBarry 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*))
45fde5950dSBarry Smith {
46fde5950dSBarry Smith   PetscErrorCode    ierr;
47fde5950dSBarry Smith   PetscViewer       viewer;
48fde5950dSBarry Smith   PetscViewerFormat format;
49fde5950dSBarry Smith   PetscBool         flg;
50fde5950dSBarry Smith 
51fde5950dSBarry Smith   PetscFunctionBegin;
52fde5950dSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
53fde5950dSBarry Smith   if (flg) {
54721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
55721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
56721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
57fde5950dSBarry Smith     if (monitorsetup) {
58721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
59fde5950dSBarry Smith     }
60721cd6eeSBarry Smith     ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr);
61fde5950dSBarry Smith   }
62fde5950dSBarry Smith   PetscFunctionReturn(0);
63fde5950dSBarry Smith }
64fde5950dSBarry Smith 
65fde5950dSBarry Smith /*@C
66e875c4f7SBarry Smith    TSAdjointMonitorSensi - monitors the first lambda sensitivity
67287c2655SBarry Smith 
68287c2655SBarry Smith    Level: intermediate
69287c2655SBarry Smith 
70287c2655SBarry Smith .keywords: TS, set, monitor
71287c2655SBarry Smith 
72287c2655SBarry Smith .seealso: TSAdjointMonitorSet()
73287c2655SBarry Smith @*/
74f4c7b390SBarry Smith PetscErrorCode TSAdjointMonitorSensi(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
75287c2655SBarry Smith {
76287c2655SBarry Smith   PetscErrorCode ierr;
77287c2655SBarry Smith   PetscViewer    viewer = vf->viewer;
78287c2655SBarry Smith 
79287c2655SBarry Smith   PetscFunctionBegin;
80287c2655SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
81287c2655SBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
82287c2655SBarry Smith   ierr = VecView(lambda[0],viewer);CHKERRQ(ierr);
83287c2655SBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
84287c2655SBarry Smith   PetscFunctionReturn(0);
85287c2655SBarry Smith }
86287c2655SBarry Smith 
87287c2655SBarry Smith /*@C
88fde5950dSBarry Smith    TSAdjointMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
89fde5950dSBarry Smith 
90fde5950dSBarry Smith    Collective on TS
91fde5950dSBarry Smith 
92fde5950dSBarry Smith    Input Parameters:
93fde5950dSBarry Smith +  ts - TS object you wish to monitor
94fde5950dSBarry Smith .  name - the monitor type one is seeking
95fde5950dSBarry Smith .  help - message indicating what monitoring is done
96fde5950dSBarry Smith .  manual - manual page for the monitor
97fde5950dSBarry Smith .  monitor - the monitor function
98fde5950dSBarry 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
99fde5950dSBarry Smith 
100fde5950dSBarry Smith    Level: developer
101fde5950dSBarry Smith 
102fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
103fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
104fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
105fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
106fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
107fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
108fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
109fde5950dSBarry Smith @*/
110721cd6eeSBarry Smith PetscErrorCode  TSAdjointMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*))
111fde5950dSBarry Smith {
112fde5950dSBarry Smith   PetscErrorCode    ierr;
113fde5950dSBarry Smith   PetscViewer       viewer;
114fde5950dSBarry Smith   PetscViewerFormat format;
115fde5950dSBarry Smith   PetscBool         flg;
116fde5950dSBarry Smith 
117fde5950dSBarry Smith   PetscFunctionBegin;
118fde5950dSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
119fde5950dSBarry Smith   if (flg) {
120721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
121721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
122721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
123fde5950dSBarry Smith     if (monitorsetup) {
124721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
125fde5950dSBarry Smith     }
126721cd6eeSBarry Smith     ierr = TSAdjointMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr);
127fde5950dSBarry Smith   }
128fde5950dSBarry Smith   PetscFunctionReturn(0);
129fde5950dSBarry Smith }
130fde5950dSBarry Smith 
1312ffb9264SLisandro Dalcin static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt,TSAdaptType default_type)
1322ffb9264SLisandro Dalcin {
1332ffb9264SLisandro Dalcin   PetscErrorCode ierr;
1342ffb9264SLisandro Dalcin 
1352ffb9264SLisandro Dalcin   PetscFunctionBegin;
136b92453a8SLisandro Dalcin   PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1);
137b92453a8SLisandro Dalcin   PetscValidCharPointer(default_type,2);
1382ffb9264SLisandro Dalcin   if (!((PetscObject)adapt)->type_name) {
1392ffb9264SLisandro Dalcin     ierr = TSAdaptSetType(adapt,default_type);CHKERRQ(ierr);
1402ffb9264SLisandro Dalcin   }
1412ffb9264SLisandro Dalcin   PetscFunctionReturn(0);
1422ffb9264SLisandro Dalcin }
1432ffb9264SLisandro Dalcin 
144bdad233fSMatthew Knepley /*@
145bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
146bdad233fSMatthew Knepley 
147bdad233fSMatthew Knepley    Collective on TS
148bdad233fSMatthew Knepley 
149bdad233fSMatthew Knepley    Input Parameter:
150bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
151bdad233fSMatthew Knepley 
152bdad233fSMatthew Knepley    Options Database Keys:
153b6a60446SDebojyoti Ghosh +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE
154ef222394SBarry Smith .  -ts_save_trajectory - checkpoint the solution at each time-step
155ef85077eSLisandro Dalcin .  -ts_max_time <time> - maximum time to compute to
156ef85077eSLisandro Dalcin .  -ts_max_steps <steps> - maximum number of time-steps to take
157ef85077eSLisandro Dalcin .  -ts_init_time <time> - initial time to start computation
158ef85077eSLisandro Dalcin .  -ts_final_time <time> - final time to compute to
1593e4cdcaaSBarry Smith .  -ts_dt <dt> - initial time step
160a3cdaa26SBarry 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
161a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
162a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
163a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
164a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
165a3cdaa26SBarry Smith .  -ts_atol <atol> Absolute tolerance for local truncation error
166ef222394SBarry Smith .  -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
167847ff0e1SMatthew G. Knepley .  -ts_fd_color - Use finite differences with coloring to compute IJacobian
168bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
169de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
170de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
1716934998bSLisandro Dalcin .  -ts_monitor_lg_timestep - Monitor timestep size graphically
1728b668821SLisandro Dalcin .  -ts_monitor_lg_timestep_log - Monitor log timestep size graphically
173de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
174de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
175de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
176de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
1773e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
1783e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
179fde5950dSBarry Smith .  -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep
180e4160dc7SJulian Andrej .  -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu)
181110eb670SHong Zhang .  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
182110eb670SHong Zhang .  -ts_adjoint_monitor - print information at each adjoint time step
18353ea634cSHong Zhang -  -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically
18453ea634cSHong Zhang 
18591b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
186bdad233fSMatthew Knepley 
187bdad233fSMatthew Knepley    Level: beginner
188bdad233fSMatthew Knepley 
189bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
190bdad233fSMatthew Knepley 
191a313700dSBarry Smith .seealso: TSGetType()
192bdad233fSMatthew Knepley @*/
1937087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
194bdad233fSMatthew Knepley {
195bc952696SBarry Smith   PetscBool              opt,flg,tflg;
196dfbe8321SBarry Smith   PetscErrorCode         ierr;
197eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
19831748224SBarry Smith   PetscReal              time_step;
19949354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
200d1212d36SBarry Smith   char                   dir[16];
201cd11d68dSLisandro Dalcin   TSIFunction            ifun;
2026991f827SBarry Smith   const char             *defaultType;
2036991f827SBarry Smith   char                   typeName[256];
204bdad233fSMatthew Knepley 
205bdad233fSMatthew Knepley   PetscFunctionBegin;
2060700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2076991f827SBarry Smith 
2086991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
209cd11d68dSLisandro Dalcin   ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
210cd11d68dSLisandro Dalcin 
211cd11d68dSLisandro Dalcin   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
212cd11d68dSLisandro Dalcin   if (((PetscObject)ts)->type_name)
213cd11d68dSLisandro Dalcin     defaultType = ((PetscObject)ts)->type_name;
214cd11d68dSLisandro Dalcin   else
215cd11d68dSLisandro Dalcin     defaultType = ifun ? TSBEULER : TSEULER;
2166991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr);
2176991f827SBarry Smith   if (opt) {
2186991f827SBarry Smith     ierr = TSSetType(ts,typeName);CHKERRQ(ierr);
2196991f827SBarry Smith   } else {
2206991f827SBarry Smith     ierr = TSSetType(ts,defaultType);CHKERRQ(ierr);
2216991f827SBarry Smith   }
222bdad233fSMatthew Knepley 
223bdad233fSMatthew Knepley   /* Handle generic TS options */
224ef85077eSLisandro Dalcin   ierr = PetscOptionsReal("-ts_max_time","Maximum time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
22519eac22cSLisandro Dalcin   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetMaxSteps",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
2260298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
227ef85077eSLisandro Dalcin   ierr = PetscOptionsReal("-ts_final_time","Final time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
22831748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
229cd11d68dSLisandro Dalcin   if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);}
23049354f04SShri 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);
23149354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
2320298fd71SBarry 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);
2330298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
2340298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
2350298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
2360298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
237bdad233fSMatthew Knepley 
23856f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
23956f85f32SBarry Smith   {
24056f85f32SBarry Smith   PetscBool set;
24156f85f32SBarry Smith   flg  = PETSC_FALSE;
24256f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
24356f85f32SBarry Smith   if (set) {
24456f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
24556f85f32SBarry Smith   }
24656f85f32SBarry Smith   }
24756f85f32SBarry Smith #endif
24856f85f32SBarry Smith 
249bdad233fSMatthew Knepley   /* Monitor options */
250cd11d68dSLisandro Dalcin   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr);
251fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr);
252fde5950dSBarry Smith   ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);CHKERRQ(ierr);
253e875c4f7SBarry Smith   ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor_sensi","Monitor sensitivity in the adjoint computation","TSAdjointMonitorSensi",TSAdjointMonitorSensi,NULL);CHKERRQ(ierr);
254fde5950dSBarry Smith 
2555180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
2565180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
2575180491cSLisandro Dalcin 
2584f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
259b3603a34SBarry Smith   if (opt) {
2600b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2613923b477SBarry Smith     PetscInt       howoften = 1;
262b3603a34SBarry Smith 
2630298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
2646ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2654f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
266bdad233fSMatthew Knepley   }
2676ba87a44SLisandro Dalcin 
2684f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
269ef20d060SBarry Smith   if (opt) {
2700b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2713923b477SBarry Smith     PetscInt       howoften = 1;
272ef20d060SBarry Smith 
2730298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
2746ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2754f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
276ef20d060SBarry Smith   }
2776934998bSLisandro Dalcin 
2786934998bSLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2796934998bSLisandro Dalcin   if (opt) {
2806934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
2816934998bSLisandro Dalcin     PetscInt       howoften = 1;
2826934998bSLisandro Dalcin 
2836934998bSLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2846ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2856934998bSLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2866934998bSLisandro Dalcin   }
2878b668821SLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2888b668821SLisandro Dalcin   if (opt) {
2898b668821SLisandro Dalcin     TSMonitorLGCtx ctx;
2908b668821SLisandro Dalcin     PetscInt       howoften = 1;
2918b668821SLisandro Dalcin 
2928b668821SLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2938b668821SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2948b668821SLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2958b668821SLisandro Dalcin     ctx->semilogy = PETSC_TRUE;
2968b668821SLisandro Dalcin   }
2978b668821SLisandro Dalcin 
298201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
299201da799SBarry Smith   if (opt) {
300201da799SBarry Smith     TSMonitorLGCtx ctx;
301201da799SBarry Smith     PetscInt       howoften = 1;
302201da799SBarry Smith 
3030298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
3046ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
305201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
306201da799SBarry Smith   }
307201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
308201da799SBarry Smith   if (opt) {
309201da799SBarry Smith     TSMonitorLGCtx ctx;
310201da799SBarry Smith     PetscInt       howoften = 1;
311201da799SBarry Smith 
3120298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
3136ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
314201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
315201da799SBarry Smith   }
3168189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
3178189c53fSBarry Smith   if (opt) {
3188189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
3198189c53fSBarry Smith     PetscInt          howoften = 1;
3208189c53fSBarry Smith 
3210298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
3226934998bSLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3238189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
3248189c53fSBarry Smith   }
325ef20d060SBarry Smith   opt  = PETSC_FALSE;
3260dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
327a7cc72afSBarry Smith   if (opt) {
32883a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
32983a4ac43SBarry Smith     PetscInt         howoften = 1;
330a80ad3e0SBarry Smith 
3310298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
332*0ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
33383a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
334bdad233fSMatthew Knepley   }
335fb1732b5SBarry Smith   opt  = PETSC_FALSE;
3369110b2e7SHong Zhang   ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr);
3379110b2e7SHong Zhang   if (opt) {
3389110b2e7SHong Zhang     TSMonitorDrawCtx ctx;
3399110b2e7SHong Zhang     PetscInt         howoften = 1;
3409110b2e7SHong Zhang 
3419110b2e7SHong Zhang     ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr);
3426934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3439110b2e7SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3449110b2e7SHong Zhang   }
3459110b2e7SHong Zhang   opt  = PETSC_FALSE;
3462d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
3472d5ee99bSBarry Smith   if (opt) {
3482d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
3492d5ee99bSBarry Smith     PetscReal        bounds[4];
3502d5ee99bSBarry Smith     PetscInt         n = 4;
3512d5ee99bSBarry Smith     PetscDraw        draw;
3526934998bSLisandro Dalcin     PetscDrawAxis    axis;
3532d5ee99bSBarry Smith 
3542d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
3552d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
3566934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr);
3572d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
3586934998bSLisandro Dalcin     ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr);
3596934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
3606934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
3612d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3622d5ee99bSBarry Smith   }
3632d5ee99bSBarry Smith   opt  = PETSC_FALSE;
3640dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
3653a471f94SBarry Smith   if (opt) {
36683a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
36783a4ac43SBarry Smith     PetscInt         howoften = 1;
3683a471f94SBarry Smith 
3690298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
370*0ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
37183a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3723a471f94SBarry Smith   }
373*0ed3bfb6SBarry Smith   opt  = PETSC_FALSE;
374*0ed3bfb6SBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt);CHKERRQ(ierr);
375*0ed3bfb6SBarry Smith   if (opt) {
376*0ed3bfb6SBarry Smith     TSMonitorDrawCtx ctx;
377*0ed3bfb6SBarry Smith     PetscInt         howoften = 1;
378*0ed3bfb6SBarry Smith 
379*0ed3bfb6SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL);CHKERRQ(ierr);
380*0ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
381*0ed3bfb6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
382*0ed3bfb6SBarry Smith   }
383fde5950dSBarry Smith 
384ed81e22dSJed Brown   opt  = PETSC_FALSE;
38591b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
386ed81e22dSJed Brown   if (flg) {
387ed81e22dSJed Brown     const char *ptr,*ptr2;
388ed81e22dSJed Brown     char       *filetemplate;
389ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
390ed81e22dSJed Brown     /* Do some cursory validation of the input. */
391ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
392ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
393ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
394ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
395ce94432eSBarry 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");
396ed81e22dSJed Brown       if (ptr2) break;
397ed81e22dSJed Brown     }
398ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
399ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
400ed81e22dSJed Brown   }
401bdad233fSMatthew Knepley 
402d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
403d1212d36SBarry Smith   if (flg) {
404d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
405d1212d36SBarry Smith     int                  ray = 0;
406d1212d36SBarry Smith     DMDADirection        ddir;
407d1212d36SBarry Smith     DM                   da;
408d1212d36SBarry Smith     PetscMPIInt          rank;
409d1212d36SBarry Smith 
410ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
411d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
412d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
413ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
414d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
415d1212d36SBarry Smith 
416d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
417b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
418d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
419d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
420ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
421d1212d36SBarry Smith     if (!rank) {
422d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
423d1212d36SBarry Smith     }
42451b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
425d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
426d1212d36SBarry Smith   }
42751b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
42851b4a12fSMatthew G. Knepley   if (flg) {
42951b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
43051b4a12fSMatthew G. Knepley     int                 ray = 0;
43151b4a12fSMatthew G. Knepley     DMDADirection       ddir;
43251b4a12fSMatthew G. Knepley     DM                  da;
43351b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
434d1212d36SBarry Smith 
43551b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
43651b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
43751b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
43851b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
43951b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
4401c3436cfSJed Brown 
44151b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
442b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
44351b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
44451b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
44551b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
44651b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
44751b4a12fSMatthew G. Knepley   }
448a7a1495cSBarry Smith 
449b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
450b3d3934dSBarry Smith   if (opt) {
451b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
452b3d3934dSBarry Smith 
453b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
454b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
455b3d3934dSBarry Smith   }
456b3d3934dSBarry Smith 
457847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
458847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
459847ff0e1SMatthew G. Knepley   if (flg) {
460847ff0e1SMatthew G. Knepley     DM   dm;
461847ff0e1SMatthew G. Knepley     DMTS tdm;
462847ff0e1SMatthew G. Knepley 
463847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
464847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
465847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
466847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
467847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
468847ff0e1SMatthew G. Knepley   }
469847ff0e1SMatthew G. Knepley 
470d763cef2SBarry Smith   /* Handle specific TS options */
471d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
4726991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
473d763cef2SBarry Smith   }
474fbc52257SHong Zhang 
475a7bdc993SLisandro Dalcin   /* Handle TSAdapt options */
476a7bdc993SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
477a7bdc993SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
478a7bdc993SLisandro Dalcin   ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr);
479a7bdc993SLisandro Dalcin 
48068bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
4814f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
48268bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
48368bece0bSHong Zhang   if (tflg) {
48468bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
48568bece0bSHong Zhang   }
4864f122a70SLisandro Dalcin   tflg = ts->adjoint_solve ? PETSC_TRUE : PETSC_FALSE;
48768bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
48868bece0bSHong Zhang   if (flg) {
48968bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
49068bece0bSHong Zhang     ts->adjoint_solve = tflg;
49168bece0bSHong Zhang   }
492d763cef2SBarry Smith 
493d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
4940633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
495fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
496d763cef2SBarry Smith 
4974f122a70SLisandro Dalcin   if (ts->trajectory) {
4984f122a70SLisandro Dalcin     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
499d763cef2SBarry Smith   }
50068bece0bSHong Zhang 
5014f122a70SLisandro Dalcin   ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr);
5024f122a70SLisandro Dalcin   if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);}
5034f122a70SLisandro Dalcin   ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
504d763cef2SBarry Smith   PetscFunctionReturn(0);
505d763cef2SBarry Smith }
506d763cef2SBarry Smith 
507d2daff3dSHong Zhang /*@
50878fbdcc8SBarry Smith    TSGetTrajectory - Gets the trajectory from a TS if it exists
50978fbdcc8SBarry Smith 
51078fbdcc8SBarry Smith    Collective on TS
51178fbdcc8SBarry Smith 
51278fbdcc8SBarry Smith    Input Parameters:
51378fbdcc8SBarry Smith .  ts - the TS context obtained from TSCreate()
51478fbdcc8SBarry Smith 
51578fbdcc8SBarry Smith    Output Parameters;
51678fbdcc8SBarry Smith .  tr - the TSTrajectory object, if it exists
51778fbdcc8SBarry Smith 
51878fbdcc8SBarry Smith    Note: This routine should be called after all TS options have been set
51978fbdcc8SBarry Smith 
52078fbdcc8SBarry Smith    Level: advanced
52178fbdcc8SBarry Smith 
52278fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate()
52378fbdcc8SBarry Smith 
52478fbdcc8SBarry Smith .keywords: TS, set, checkpoint,
52578fbdcc8SBarry Smith @*/
52678fbdcc8SBarry Smith PetscErrorCode  TSGetTrajectory(TS ts,TSTrajectory *tr)
52778fbdcc8SBarry Smith {
52878fbdcc8SBarry Smith   PetscFunctionBegin;
52978fbdcc8SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53078fbdcc8SBarry Smith   *tr = ts->trajectory;
53178fbdcc8SBarry Smith   PetscFunctionReturn(0);
53278fbdcc8SBarry Smith }
53378fbdcc8SBarry Smith 
53478fbdcc8SBarry Smith /*@
535bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
536d2daff3dSHong Zhang 
537d2daff3dSHong Zhang    Collective on TS
538d2daff3dSHong Zhang 
539d2daff3dSHong Zhang    Input Parameters:
540bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
541bc952696SBarry Smith 
54278fbdcc8SBarry Smith    Options Database:
54378fbdcc8SBarry Smith +  -ts_save_trajectory - saves the trajectory to a file
54478fbdcc8SBarry Smith -  -ts_trajectory_type type
54578fbdcc8SBarry Smith 
54668bece0bSHong Zhang Note: This routine should be called after all TS options have been set
547d2daff3dSHong Zhang 
54878fbdcc8SBarry Smith     The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/bin/PetscBinaryIOTrajectory.py and
54978fbdcc8SBarry Smith    MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m
55078fbdcc8SBarry Smith 
551d2daff3dSHong Zhang    Level: intermediate
552d2daff3dSHong Zhang 
55378fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectoryType, TSSetTrajectoryType()
554d2daff3dSHong Zhang 
555bc952696SBarry Smith .keywords: TS, set, checkpoint,
556d2daff3dSHong Zhang @*/
557bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
558d2daff3dSHong Zhang {
559bc952696SBarry Smith   PetscErrorCode ierr;
560bc952696SBarry Smith 
561d2daff3dSHong Zhang   PetscFunctionBegin;
562d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
563bc952696SBarry Smith   if (!ts->trajectory) {
564bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
565bc952696SBarry Smith   }
566d2daff3dSHong Zhang   PetscFunctionReturn(0);
567d2daff3dSHong Zhang }
568d2daff3dSHong Zhang 
569a7a1495cSBarry Smith /*@
570a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
571a7a1495cSBarry Smith       set with TSSetRHSJacobian().
572a7a1495cSBarry Smith 
573a7a1495cSBarry Smith    Collective on TS and Vec
574a7a1495cSBarry Smith 
575a7a1495cSBarry Smith    Input Parameters:
576316643e7SJed Brown +  ts - the TS context
577a7a1495cSBarry Smith .  t - current timestep
5780910c330SBarry Smith -  U - input vector
579a7a1495cSBarry Smith 
580a7a1495cSBarry Smith    Output Parameters:
581a7a1495cSBarry Smith +  A - Jacobian matrix
582a7a1495cSBarry Smith .  B - optional preconditioning matrix
583a7a1495cSBarry Smith -  flag - flag indicating matrix structure
584a7a1495cSBarry Smith 
585a7a1495cSBarry Smith    Notes:
586a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
587a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
588a7a1495cSBarry Smith 
58994b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
590a7a1495cSBarry Smith    flag parameter.
591a7a1495cSBarry Smith 
592a7a1495cSBarry Smith    Level: developer
593a7a1495cSBarry Smith 
594a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
595a7a1495cSBarry Smith 
59694b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
597a7a1495cSBarry Smith @*/
598d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
599a7a1495cSBarry Smith {
600dfbe8321SBarry Smith   PetscErrorCode   ierr;
601270bf2e7SJed Brown   PetscObjectState Ustate;
6026c1e1eecSBarry Smith   PetscObjectId    Uid;
60324989b8cSPeter Brune   DM               dm;
604942e3340SBarry Smith   DMTS             tsdm;
60524989b8cSPeter Brune   TSRHSJacobian    rhsjacobianfunc;
60624989b8cSPeter Brune   void             *ctx;
60724989b8cSPeter Brune   TSIJacobian      ijacobianfunc;
608b2df71adSDebojyoti Ghosh   TSRHSFunction    rhsfunction;
609a7a1495cSBarry Smith 
610a7a1495cSBarry Smith   PetscFunctionBegin;
6110700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6120910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6130910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
61424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
615942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
61624989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
6170298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
618b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
61959e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
6206c1e1eecSBarry Smith   ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr);
6216c1e1eecSBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
6220e4ef248SJed Brown     PetscFunctionReturn(0);
623f8ede8e7SJed Brown   }
624d90be118SSean Farley 
625ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
626d90be118SSean Farley 
627e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
62894ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
62994ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
630303f9b21SStefano Zampini     if (B && A != B) {
63194ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
63294ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
633e1244c69SJed Brown     }
634e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
635e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
636e1244c69SJed Brown   }
637e1244c69SJed Brown 
63824989b8cSPeter Brune   if (rhsjacobianfunc) {
6396cd88445SBarry Smith     PetscBool missing;
64094ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
641a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
642d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
643a7a1495cSBarry Smith     PetscStackPop;
64494ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
6456cd88445SBarry Smith     if (A) {
6466cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
6476cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
6486cd88445SBarry Smith     }
6496cd88445SBarry Smith     if (B && B != A) {
6506cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
6516cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
6526cd88445SBarry Smith     }
653ef66eb69SBarry Smith   } else {
65494ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
65594ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
656ef66eb69SBarry Smith   }
6570e4ef248SJed Brown   ts->rhsjacobian.time       = t;
6587f79407eSBarry Smith   ierr                       = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr);
65959e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
660a7a1495cSBarry Smith   PetscFunctionReturn(0);
661a7a1495cSBarry Smith }
662a7a1495cSBarry Smith 
663316643e7SJed Brown /*@
664d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
665d763cef2SBarry Smith 
666316643e7SJed Brown    Collective on TS and Vec
667316643e7SJed Brown 
668316643e7SJed Brown    Input Parameters:
669316643e7SJed Brown +  ts - the TS context
670316643e7SJed Brown .  t - current time
6710910c330SBarry Smith -  U - state vector
672316643e7SJed Brown 
673316643e7SJed Brown    Output Parameter:
674316643e7SJed Brown .  y - right hand side
675316643e7SJed Brown 
676316643e7SJed Brown    Note:
677316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
678316643e7SJed Brown    is used internally within the nonlinear solvers.
679316643e7SJed Brown 
680316643e7SJed Brown    Level: developer
681316643e7SJed Brown 
682316643e7SJed Brown .keywords: TS, compute
683316643e7SJed Brown 
684316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
685316643e7SJed Brown @*/
6860910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
687d763cef2SBarry Smith {
688dfbe8321SBarry Smith   PetscErrorCode ierr;
68924989b8cSPeter Brune   TSRHSFunction  rhsfunction;
69024989b8cSPeter Brune   TSIFunction    ifunction;
69124989b8cSPeter Brune   void           *ctx;
69224989b8cSPeter Brune   DM             dm;
69324989b8cSPeter Brune 
694d763cef2SBarry Smith   PetscFunctionBegin;
6950700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6960910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6970700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
69824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
69924989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
7000298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
701d763cef2SBarry Smith 
702ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
703d763cef2SBarry Smith 
7040910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
70524989b8cSPeter Brune   if (rhsfunction) {
706d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
7070910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
708d763cef2SBarry Smith     PetscStackPop;
709214bc6a2SJed Brown   } else {
710214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
711b2cd27e8SJed Brown   }
71244a41b28SSean Farley 
7130910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
714d763cef2SBarry Smith   PetscFunctionReturn(0);
715d763cef2SBarry Smith }
716d763cef2SBarry Smith 
717ef20d060SBarry Smith /*@
718ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
719ef20d060SBarry Smith 
720ef20d060SBarry Smith    Collective on TS and Vec
721ef20d060SBarry Smith 
722ef20d060SBarry Smith    Input Parameters:
723ef20d060SBarry Smith +  ts - the TS context
724ef20d060SBarry Smith -  t - current time
725ef20d060SBarry Smith 
726ef20d060SBarry Smith    Output Parameter:
7270910c330SBarry Smith .  U - the solution
728ef20d060SBarry Smith 
729ef20d060SBarry Smith    Note:
730ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
731ef20d060SBarry Smith    is used internally within the nonlinear solvers.
732ef20d060SBarry Smith 
733ef20d060SBarry Smith    Level: developer
734ef20d060SBarry Smith 
735ef20d060SBarry Smith .keywords: TS, compute
736ef20d060SBarry Smith 
737abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
738ef20d060SBarry Smith @*/
7390910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
740ef20d060SBarry Smith {
741ef20d060SBarry Smith   PetscErrorCode     ierr;
742ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
743ef20d060SBarry Smith   void               *ctx;
744ef20d060SBarry Smith   DM                 dm;
745ef20d060SBarry Smith 
746ef20d060SBarry Smith   PetscFunctionBegin;
747ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7480910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
749ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
750ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
751ef20d060SBarry Smith 
752ef20d060SBarry Smith   if (solutionfunction) {
7539b7cd975SBarry Smith     PetscStackPush("TS user solution function");
7540910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
755ef20d060SBarry Smith     PetscStackPop;
756ef20d060SBarry Smith   }
757ef20d060SBarry Smith   PetscFunctionReturn(0);
758ef20d060SBarry Smith }
7599b7cd975SBarry Smith /*@
7609b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
7619b7cd975SBarry Smith 
7629b7cd975SBarry Smith    Collective on TS and Vec
7639b7cd975SBarry Smith 
7649b7cd975SBarry Smith    Input Parameters:
7659b7cd975SBarry Smith +  ts - the TS context
7669b7cd975SBarry Smith -  t - current time
7679b7cd975SBarry Smith 
7689b7cd975SBarry Smith    Output Parameter:
7699b7cd975SBarry Smith .  U - the function value
7709b7cd975SBarry Smith 
7719b7cd975SBarry Smith    Note:
7729b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
7739b7cd975SBarry Smith    is used internally within the nonlinear solvers.
7749b7cd975SBarry Smith 
7759b7cd975SBarry Smith    Level: developer
7769b7cd975SBarry Smith 
7779b7cd975SBarry Smith .keywords: TS, compute
7789b7cd975SBarry Smith 
7799b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7809b7cd975SBarry Smith @*/
7819b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7829b7cd975SBarry Smith {
7839b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7849b7cd975SBarry Smith   void               *ctx;
7859b7cd975SBarry Smith   DM                 dm;
7869b7cd975SBarry Smith 
7879b7cd975SBarry Smith   PetscFunctionBegin;
7889b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7899b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7909b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7919b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7929b7cd975SBarry Smith 
7939b7cd975SBarry Smith   if (forcing) {
7949b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
7959b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
7969b7cd975SBarry Smith     PetscStackPop;
7979b7cd975SBarry Smith   }
7989b7cd975SBarry Smith   PetscFunctionReturn(0);
7999b7cd975SBarry Smith }
800ef20d060SBarry Smith 
801214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
802214bc6a2SJed Brown {
8032dd45cf8SJed Brown   Vec            F;
804214bc6a2SJed Brown   PetscErrorCode ierr;
805214bc6a2SJed Brown 
806214bc6a2SJed Brown   PetscFunctionBegin;
8070298fd71SBarry Smith   *Frhs = NULL;
8080298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
809214bc6a2SJed Brown   if (!ts->Frhs) {
8102dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
811214bc6a2SJed Brown   }
812214bc6a2SJed Brown   *Frhs = ts->Frhs;
813214bc6a2SJed Brown   PetscFunctionReturn(0);
814214bc6a2SJed Brown }
815214bc6a2SJed Brown 
816214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
817214bc6a2SJed Brown {
818214bc6a2SJed Brown   Mat            A,B;
8192dd45cf8SJed Brown   PetscErrorCode ierr;
82041a1d4d2SBarry Smith   TSIJacobian    ijacobian;
821214bc6a2SJed Brown 
822214bc6a2SJed Brown   PetscFunctionBegin;
823c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
824c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
82541a1d4d2SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr);
826214bc6a2SJed Brown   if (Arhs) {
827214bc6a2SJed Brown     if (!ts->Arhs) {
82841a1d4d2SBarry Smith       if (ijacobian) {
829214bc6a2SJed Brown         ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
83041a1d4d2SBarry Smith       } else {
83141a1d4d2SBarry Smith         ts->Arhs = A;
83241a1d4d2SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
83341a1d4d2SBarry Smith       }
8343565c898SBarry Smith     } else {
8353565c898SBarry Smith       PetscBool flg;
8363565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
8373565c898SBarry Smith       /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */
8383565c898SBarry Smith       if (flg && !ijacobian && ts->Arhs == ts->Brhs){
8393565c898SBarry Smith         ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr);
8403565c898SBarry Smith         ts->Arhs = A;
8413565c898SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
8423565c898SBarry Smith       }
843214bc6a2SJed Brown     }
844214bc6a2SJed Brown     *Arhs = ts->Arhs;
845214bc6a2SJed Brown   }
846214bc6a2SJed Brown   if (Brhs) {
847214bc6a2SJed Brown     if (!ts->Brhs) {
848bdb70873SJed Brown       if (A != B) {
84941a1d4d2SBarry Smith         if (ijacobian) {
850214bc6a2SJed Brown           ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
851bdb70873SJed Brown         } else {
85241a1d4d2SBarry Smith           ts->Brhs = B;
85341a1d4d2SBarry Smith           ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
85441a1d4d2SBarry Smith         }
85541a1d4d2SBarry Smith       } else {
856bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
85751699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
858bdb70873SJed Brown       }
859214bc6a2SJed Brown     }
860214bc6a2SJed Brown     *Brhs = ts->Brhs;
861214bc6a2SJed Brown   }
862214bc6a2SJed Brown   PetscFunctionReturn(0);
863214bc6a2SJed Brown }
864214bc6a2SJed Brown 
865316643e7SJed Brown /*@
8660910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
867316643e7SJed Brown 
868316643e7SJed Brown    Collective on TS and Vec
869316643e7SJed Brown 
870316643e7SJed Brown    Input Parameters:
871316643e7SJed Brown +  ts - the TS context
872316643e7SJed Brown .  t - current time
8730910c330SBarry Smith .  U - state vector
8740910c330SBarry Smith .  Udot - time derivative of state vector
875214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
876316643e7SJed Brown 
877316643e7SJed Brown    Output Parameter:
878316643e7SJed Brown .  Y - right hand side
879316643e7SJed Brown 
880316643e7SJed Brown    Note:
881316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
882316643e7SJed Brown    is used internally within the nonlinear solvers.
883316643e7SJed Brown 
884316643e7SJed Brown    If the user did did not write their equations in implicit form, this
885316643e7SJed Brown    function recasts them in implicit form.
886316643e7SJed Brown 
887316643e7SJed Brown    Level: developer
888316643e7SJed Brown 
889316643e7SJed Brown .keywords: TS, compute
890316643e7SJed Brown 
891316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
892316643e7SJed Brown @*/
8930910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
894316643e7SJed Brown {
895316643e7SJed Brown   PetscErrorCode ierr;
89624989b8cSPeter Brune   TSIFunction    ifunction;
89724989b8cSPeter Brune   TSRHSFunction  rhsfunction;
89824989b8cSPeter Brune   void           *ctx;
89924989b8cSPeter Brune   DM             dm;
900316643e7SJed Brown 
901316643e7SJed Brown   PetscFunctionBegin;
9020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9030910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9040910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
9050700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
906316643e7SJed Brown 
90724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
90824989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
9090298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
91024989b8cSPeter Brune 
911ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
912d90be118SSean Farley 
9130910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
91424989b8cSPeter Brune   if (ifunction) {
915316643e7SJed Brown     PetscStackPush("TS user implicit function");
9160910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
917316643e7SJed Brown     PetscStackPop;
918214bc6a2SJed Brown   }
919214bc6a2SJed Brown   if (imex) {
92024989b8cSPeter Brune     if (!ifunction) {
9210910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
9222dd45cf8SJed Brown     }
92324989b8cSPeter Brune   } else if (rhsfunction) {
92424989b8cSPeter Brune     if (ifunction) {
925214bc6a2SJed Brown       Vec Frhs;
926214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
9270910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
928214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
9292dd45cf8SJed Brown     } else {
9300910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
9310910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
932316643e7SJed Brown     }
9334a6899ffSJed Brown   }
9340910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
935316643e7SJed Brown   PetscFunctionReturn(0);
936316643e7SJed Brown }
937316643e7SJed Brown 
938316643e7SJed Brown /*@
939316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
940316643e7SJed Brown 
941316643e7SJed Brown    Collective on TS and Vec
942316643e7SJed Brown 
943316643e7SJed Brown    Input
944316643e7SJed Brown       Input Parameters:
945316643e7SJed Brown +  ts - the TS context
946316643e7SJed Brown .  t - current timestep
9470910c330SBarry Smith .  U - state vector
9480910c330SBarry Smith .  Udot - time derivative of state vector
949214bc6a2SJed Brown .  shift - shift to apply, see note below
950214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
951316643e7SJed Brown 
952316643e7SJed Brown    Output Parameters:
953316643e7SJed Brown +  A - Jacobian matrix
9543565c898SBarry Smith -  B - matrix from which the preconditioner is constructed; often the same as A
955316643e7SJed Brown 
956316643e7SJed Brown    Notes:
9570910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
958316643e7SJed Brown 
9590910c330SBarry Smith    dF/dU + shift*dF/dUdot
960316643e7SJed Brown 
961316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
962316643e7SJed Brown    is used internally within the nonlinear solvers.
963316643e7SJed Brown 
964316643e7SJed Brown    Level: developer
965316643e7SJed Brown 
966316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
967316643e7SJed Brown 
968316643e7SJed Brown .seealso:  TSSetIJacobian()
96963495f91SJed Brown @*/
970d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
971316643e7SJed Brown {
972316643e7SJed Brown   PetscErrorCode ierr;
97324989b8cSPeter Brune   TSIJacobian    ijacobian;
97424989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
97524989b8cSPeter Brune   DM             dm;
97624989b8cSPeter Brune   void           *ctx;
977316643e7SJed Brown 
978316643e7SJed Brown   PetscFunctionBegin;
9790700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9800910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9810910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
982316643e7SJed Brown   PetscValidPointer(A,6);
98394ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
984316643e7SJed Brown   PetscValidPointer(B,7);
98594ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
98624989b8cSPeter Brune 
98724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
98824989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
9890298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
99024989b8cSPeter Brune 
991ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
992316643e7SJed Brown 
99394ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
99424989b8cSPeter Brune   if (ijacobian) {
9956cd88445SBarry Smith     PetscBool missing;
996316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
997d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
998316643e7SJed Brown     PetscStackPop;
9996cd88445SBarry Smith     ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
10006cd88445SBarry Smith     if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
10013565c898SBarry Smith     if (B != A) {
10026cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
10036cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
10046cd88445SBarry Smith     }
10054a6899ffSJed Brown   }
1006214bc6a2SJed Brown   if (imex) {
1007b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
10084c26be97Sstefano_zampini       PetscBool assembled;
100994ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
10104c26be97Sstefano_zampini       ierr = MatAssembled(A,&assembled);CHKERRQ(ierr);
10114c26be97Sstefano_zampini       if (!assembled) {
10124c26be97Sstefano_zampini         ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10134c26be97Sstefano_zampini         ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10144c26be97Sstefano_zampini       }
101594ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
101694ab13aaSBarry Smith       if (A != B) {
101794ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
10184c26be97Sstefano_zampini         ierr = MatAssembled(B,&assembled);CHKERRQ(ierr);
10194c26be97Sstefano_zampini         if (!assembled) {
10204c26be97Sstefano_zampini           ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10214c26be97Sstefano_zampini           ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10224c26be97Sstefano_zampini         }
102394ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
1024214bc6a2SJed Brown       }
1025214bc6a2SJed Brown     }
1026214bc6a2SJed Brown   } else {
1027e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
1028e1244c69SJed Brown     if (rhsjacobian) {
1029214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
1030d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
1031e1244c69SJed Brown     }
103294ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
10333565c898SBarry Smith       PetscBool flg;
1034e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
1035e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
10363565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
10373565c898SBarry Smith       /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */
10383565c898SBarry Smith       if (!flg) {
103994ab13aaSBarry Smith         ierr = MatScale(A,-1);CHKERRQ(ierr);
104094ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
10413565c898SBarry Smith       }
104294ab13aaSBarry Smith       if (A != B) {
104394ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
104494ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
1045316643e7SJed Brown       }
1046e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
1047e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1048e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
104994ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
105094ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
105194ab13aaSBarry Smith         if (A != B) {
105294ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
105394ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
1054214bc6a2SJed Brown         }
1055316643e7SJed Brown       }
105694ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
105794ab13aaSBarry Smith       if (A != B) {
105894ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
1059316643e7SJed Brown       }
1060316643e7SJed Brown     }
1061316643e7SJed Brown   }
106294ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
1063316643e7SJed Brown   PetscFunctionReturn(0);
1064316643e7SJed Brown }
1065316643e7SJed Brown 
1066d763cef2SBarry Smith /*@C
1067d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
1068b5abc632SBarry Smith     where U_t = G(t,u).
1069d763cef2SBarry Smith 
10703f9fe445SBarry Smith     Logically Collective on TS
1071d763cef2SBarry Smith 
1072d763cef2SBarry Smith     Input Parameters:
1073d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
10740298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
1075d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
1076d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
10770298fd71SBarry Smith           function evaluation routine (may be NULL)
1078d763cef2SBarry Smith 
1079d763cef2SBarry Smith     Calling sequence of func:
108087828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
1081d763cef2SBarry Smith 
1082d763cef2SBarry Smith +   t - current timestep
1083d763cef2SBarry Smith .   u - input vector
1084d763cef2SBarry Smith .   F - function vector
1085d763cef2SBarry Smith -   ctx - [optional] user-defined function context
1086d763cef2SBarry Smith 
1087d763cef2SBarry Smith     Level: beginner
1088d763cef2SBarry Smith 
10892bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
10902bbac0d3SBarry Smith 
1091d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1092d763cef2SBarry Smith 
1093ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
1094d763cef2SBarry Smith @*/
1095089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
1096d763cef2SBarry Smith {
1097089b2837SJed Brown   PetscErrorCode ierr;
1098089b2837SJed Brown   SNES           snes;
10990298fd71SBarry Smith   Vec            ralloc = NULL;
110024989b8cSPeter Brune   DM             dm;
1101d763cef2SBarry Smith 
1102089b2837SJed Brown   PetscFunctionBegin;
11030700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1104ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
110524989b8cSPeter Brune 
110624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
110724989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1108089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1109e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1110e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1111e856ceecSJed Brown     r = ralloc;
1112e856ceecSJed Brown   }
1113089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1114e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1115d763cef2SBarry Smith   PetscFunctionReturn(0);
1116d763cef2SBarry Smith }
1117d763cef2SBarry Smith 
1118ef20d060SBarry Smith /*@C
1119abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1120ef20d060SBarry Smith 
1121ef20d060SBarry Smith     Logically Collective on TS
1122ef20d060SBarry Smith 
1123ef20d060SBarry Smith     Input Parameters:
1124ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1125ef20d060SBarry Smith .   f - routine for evaluating the solution
1126ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
11270298fd71SBarry Smith           function evaluation routine (may be NULL)
1128ef20d060SBarry Smith 
1129ef20d060SBarry Smith     Calling sequence of func:
1130ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
1131ef20d060SBarry Smith 
1132ef20d060SBarry Smith +   t - current timestep
1133ef20d060SBarry Smith .   u - output vector
1134ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1135ef20d060SBarry Smith 
1136*0ed3bfb6SBarry Smith     Options Database:
1137*0ed3bfb6SBarry Smith +  -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction()
1138*0ed3bfb6SBarry Smith -  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
1139*0ed3bfb6SBarry Smith 
1140abd5a294SJed Brown     Notes:
1141abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1142abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1143abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1144abd5a294SJed Brown 
11454f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1146abd5a294SJed Brown 
1147ef20d060SBarry Smith     Level: beginner
1148ef20d060SBarry Smith 
1149ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1150ef20d060SBarry Smith 
1151*0ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError()
1152ef20d060SBarry Smith @*/
1153ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1154ef20d060SBarry Smith {
1155ef20d060SBarry Smith   PetscErrorCode ierr;
1156ef20d060SBarry Smith   DM             dm;
1157ef20d060SBarry Smith 
1158ef20d060SBarry Smith   PetscFunctionBegin;
1159ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1160ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1161ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1162ef20d060SBarry Smith   PetscFunctionReturn(0);
1163ef20d060SBarry Smith }
1164ef20d060SBarry Smith 
11659b7cd975SBarry Smith /*@C
11669b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
11679b7cd975SBarry Smith 
11689b7cd975SBarry Smith     Logically Collective on TS
11699b7cd975SBarry Smith 
11709b7cd975SBarry Smith     Input Parameters:
11719b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
1172e162b725SBarry Smith .   func - routine for evaluating the forcing function
11739b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
11740298fd71SBarry Smith           function evaluation routine (may be NULL)
11759b7cd975SBarry Smith 
11769b7cd975SBarry Smith     Calling sequence of func:
1177e162b725SBarry Smith $     func (TS ts,PetscReal t,Vec f,void *ctx);
11789b7cd975SBarry Smith 
11799b7cd975SBarry Smith +   t - current timestep
1180e162b725SBarry Smith .   f - output vector
11819b7cd975SBarry Smith -   ctx - [optional] user-defined function context
11829b7cd975SBarry Smith 
11839b7cd975SBarry Smith     Notes:
11849b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
1185e162b725SBarry 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
1186e162b725SBarry Smith     definition of the problem you are solving and hence possibly introducing bugs.
1187e162b725SBarry Smith 
1188e162b725SBarry Smith     This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0
1189e162b725SBarry Smith 
1190e162b725SBarry 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
1191e162b725SBarry Smith     parameters can be passed in the ctx variable.
11929b7cd975SBarry Smith 
11939b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
11949b7cd975SBarry Smith 
11959b7cd975SBarry Smith     Level: beginner
11969b7cd975SBarry Smith 
11979b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
11989b7cd975SBarry Smith 
11999b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
12009b7cd975SBarry Smith @*/
1201e162b725SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx)
12029b7cd975SBarry Smith {
12039b7cd975SBarry Smith   PetscErrorCode ierr;
12049b7cd975SBarry Smith   DM             dm;
12059b7cd975SBarry Smith 
12069b7cd975SBarry Smith   PetscFunctionBegin;
12079b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
12089b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1209e162b725SBarry Smith   ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr);
12109b7cd975SBarry Smith   PetscFunctionReturn(0);
12119b7cd975SBarry Smith }
12129b7cd975SBarry Smith 
1213d763cef2SBarry Smith /*@C
1214f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1215b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1216d763cef2SBarry Smith 
12173f9fe445SBarry Smith    Logically Collective on TS
1218d763cef2SBarry Smith 
1219d763cef2SBarry Smith    Input Parameters:
1220d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1221e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1222e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1223d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1224d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
12250298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1226d763cef2SBarry Smith 
1227f7ab8db6SBarry Smith    Calling sequence of f:
1228ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1229d763cef2SBarry Smith 
1230d763cef2SBarry Smith +  t - current timestep
1231d763cef2SBarry Smith .  u - input vector
1232e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1233e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1234d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1235d763cef2SBarry Smith 
12366cd88445SBarry Smith    Notes:
12376cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
12386cd88445SBarry Smith 
12396cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1240ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1241d763cef2SBarry Smith 
1242d763cef2SBarry Smith    Level: beginner
1243d763cef2SBarry Smith 
1244d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1245d763cef2SBarry Smith 
1246ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1247d763cef2SBarry Smith 
1248d763cef2SBarry Smith @*/
1249e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1250d763cef2SBarry Smith {
1251277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1252089b2837SJed Brown   SNES           snes;
125324989b8cSPeter Brune   DM             dm;
125424989b8cSPeter Brune   TSIJacobian    ijacobian;
1255277b19d0SLisandro Dalcin 
1256d763cef2SBarry Smith   PetscFunctionBegin;
12570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1258e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1259e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1260e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1261e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1262d763cef2SBarry Smith 
126324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
126424989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1265e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1266e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1267e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1268e1244c69SJed Brown   }
12690298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1270089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12715f659677SPeter Brune   if (!ijacobian) {
1272e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
12730e4ef248SJed Brown   }
1274e5d3d808SBarry Smith   if (Amat) {
1275e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
12760e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1277e5d3d808SBarry Smith     ts->Arhs = Amat;
12780e4ef248SJed Brown   }
1279e5d3d808SBarry Smith   if (Pmat) {
1280e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
12810e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1282e5d3d808SBarry Smith     ts->Brhs = Pmat;
12830e4ef248SJed Brown   }
1284d763cef2SBarry Smith   PetscFunctionReturn(0);
1285d763cef2SBarry Smith }
1286d763cef2SBarry Smith 
1287316643e7SJed Brown /*@C
1288b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1289316643e7SJed Brown 
12903f9fe445SBarry Smith    Logically Collective on TS
1291316643e7SJed Brown 
1292316643e7SJed Brown    Input Parameters:
1293316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
12940298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1295316643e7SJed Brown .  f   - the function evaluation routine
12960298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1297316643e7SJed Brown 
1298316643e7SJed Brown    Calling sequence of f:
1299316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1300316643e7SJed Brown 
1301316643e7SJed Brown +  t   - time at step/stage being solved
1302316643e7SJed Brown .  u   - state vector
1303316643e7SJed Brown .  u_t - time derivative of state vector
1304316643e7SJed Brown .  F   - function vector
1305316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1306316643e7SJed Brown 
1307316643e7SJed Brown    Important:
13082bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1309316643e7SJed Brown 
1310316643e7SJed Brown    Level: beginner
1311316643e7SJed Brown 
1312316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1313316643e7SJed Brown 
1314d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1315316643e7SJed Brown @*/
131651699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1317316643e7SJed Brown {
1318089b2837SJed Brown   PetscErrorCode ierr;
1319089b2837SJed Brown   SNES           snes;
132051699248SLisandro Dalcin   Vec            ralloc = NULL;
132124989b8cSPeter Brune   DM             dm;
1322316643e7SJed Brown 
1323316643e7SJed Brown   PetscFunctionBegin;
13240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
132551699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
132624989b8cSPeter Brune 
132724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
132824989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
132924989b8cSPeter Brune 
1330089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
133151699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
133251699248SLisandro Dalcin     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
133351699248SLisandro Dalcin     r  = ralloc;
1334e856ceecSJed Brown   }
133551699248SLisandro Dalcin   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
133651699248SLisandro Dalcin   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1337089b2837SJed Brown   PetscFunctionReturn(0);
1338089b2837SJed Brown }
1339089b2837SJed Brown 
1340089b2837SJed Brown /*@C
1341089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1342089b2837SJed Brown 
1343089b2837SJed Brown    Not Collective
1344089b2837SJed Brown 
1345089b2837SJed Brown    Input Parameter:
1346089b2837SJed Brown .  ts - the TS context
1347089b2837SJed Brown 
1348089b2837SJed Brown    Output Parameter:
13490298fd71SBarry Smith +  r - vector to hold residual (or NULL)
13500298fd71SBarry Smith .  func - the function to compute residual (or NULL)
13510298fd71SBarry Smith -  ctx - the function context (or NULL)
1352089b2837SJed Brown 
1353089b2837SJed Brown    Level: advanced
1354089b2837SJed Brown 
1355089b2837SJed Brown .keywords: TS, nonlinear, get, function
1356089b2837SJed Brown 
1357089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1358089b2837SJed Brown @*/
1359089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1360089b2837SJed Brown {
1361089b2837SJed Brown   PetscErrorCode ierr;
1362089b2837SJed Brown   SNES           snes;
136324989b8cSPeter Brune   DM             dm;
1364089b2837SJed Brown 
1365089b2837SJed Brown   PetscFunctionBegin;
1366089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1367089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13680298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
136924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
137024989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1371089b2837SJed Brown   PetscFunctionReturn(0);
1372089b2837SJed Brown }
1373089b2837SJed Brown 
1374089b2837SJed Brown /*@C
1375089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1376089b2837SJed Brown 
1377089b2837SJed Brown    Not Collective
1378089b2837SJed Brown 
1379089b2837SJed Brown    Input Parameter:
1380089b2837SJed Brown .  ts - the TS context
1381089b2837SJed Brown 
1382089b2837SJed Brown    Output Parameter:
13830298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
13840298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
13850298fd71SBarry Smith -  ctx - the function context (or NULL)
1386089b2837SJed Brown 
1387089b2837SJed Brown    Level: advanced
1388089b2837SJed Brown 
1389089b2837SJed Brown .keywords: TS, nonlinear, get, function
1390089b2837SJed Brown 
13912bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1392089b2837SJed Brown @*/
1393089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1394089b2837SJed Brown {
1395089b2837SJed Brown   PetscErrorCode ierr;
1396089b2837SJed Brown   SNES           snes;
139724989b8cSPeter Brune   DM             dm;
1398089b2837SJed Brown 
1399089b2837SJed Brown   PetscFunctionBegin;
1400089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1401089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
14020298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
140324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
140424989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1405316643e7SJed Brown   PetscFunctionReturn(0);
1406316643e7SJed Brown }
1407316643e7SJed Brown 
1408316643e7SJed Brown /*@C
1409a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1410ae8867d6SBarry Smith         provided with TSSetIFunction().
1411316643e7SJed Brown 
14123f9fe445SBarry Smith    Logically Collective on TS
1413316643e7SJed Brown 
1414316643e7SJed Brown    Input Parameters:
1415316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1416e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1417e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1418316643e7SJed Brown .  f   - the Jacobian evaluation routine
14190298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1420316643e7SJed Brown 
1421316643e7SJed Brown    Calling sequence of f:
1422ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1423316643e7SJed Brown 
1424316643e7SJed Brown +  t    - time at step/stage being solved
14251b4a444bSJed Brown .  U    - state vector
14261b4a444bSJed Brown .  U_t  - time derivative of state vector
1427316643e7SJed Brown .  a    - shift
1428e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1429e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1430316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1431316643e7SJed Brown 
1432316643e7SJed Brown    Notes:
1433e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1434316643e7SJed Brown 
1435895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1436895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1437895c21f2SBarry Smith 
1438a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1439b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1440a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1441a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1442a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1443a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1444a4f0a591SBarry Smith 
14456cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
14466cd88445SBarry Smith 
14476cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1448ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1449ca5f011dSBarry Smith 
1450316643e7SJed Brown    Level: beginner
1451316643e7SJed Brown 
1452316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1453316643e7SJed Brown 
1454ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1455316643e7SJed Brown 
1456316643e7SJed Brown @*/
1457e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1458316643e7SJed Brown {
1459316643e7SJed Brown   PetscErrorCode ierr;
1460089b2837SJed Brown   SNES           snes;
146124989b8cSPeter Brune   DM             dm;
1462316643e7SJed Brown 
1463316643e7SJed Brown   PetscFunctionBegin;
14640700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1465e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1466e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1467e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1468e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
146924989b8cSPeter Brune 
147024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
147124989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
147224989b8cSPeter Brune 
1473089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1474e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1475316643e7SJed Brown   PetscFunctionReturn(0);
1476316643e7SJed Brown }
1477316643e7SJed Brown 
1478e1244c69SJed Brown /*@
1479e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1480e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1481e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1482e1244c69SJed Brown    not been changed by the TS.
1483e1244c69SJed Brown 
1484e1244c69SJed Brown    Logically Collective
1485e1244c69SJed Brown 
1486e1244c69SJed Brown    Input Arguments:
1487e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1488e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1489e1244c69SJed Brown 
1490e1244c69SJed Brown    Level: intermediate
1491e1244c69SJed Brown 
1492e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1493e1244c69SJed Brown @*/
1494e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1495e1244c69SJed Brown {
1496e1244c69SJed Brown   PetscFunctionBegin;
1497e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1498e1244c69SJed Brown   PetscFunctionReturn(0);
1499e1244c69SJed Brown }
1500e1244c69SJed Brown 
1501efe9872eSLisandro Dalcin /*@C
1502efe9872eSLisandro Dalcin    TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1503efe9872eSLisandro Dalcin 
1504efe9872eSLisandro Dalcin    Logically Collective on TS
1505efe9872eSLisandro Dalcin 
1506efe9872eSLisandro Dalcin    Input Parameters:
1507efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1508efe9872eSLisandro Dalcin .  F   - vector to hold the residual (or NULL to have it created internally)
1509efe9872eSLisandro Dalcin .  fun - the function evaluation routine
1510efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1511efe9872eSLisandro Dalcin 
1512efe9872eSLisandro Dalcin    Calling sequence of fun:
1513efe9872eSLisandro Dalcin $  fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx);
1514efe9872eSLisandro Dalcin 
1515efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1516efe9872eSLisandro Dalcin .  U    - state vector
1517efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1518efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1519efe9872eSLisandro Dalcin .  F    - function vector
1520efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine (may be NULL)
1521efe9872eSLisandro Dalcin 
1522efe9872eSLisandro Dalcin    Level: beginner
1523efe9872eSLisandro Dalcin 
1524efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function
1525efe9872eSLisandro Dalcin 
1526efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian()
1527efe9872eSLisandro Dalcin @*/
1528efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx)
1529efe9872eSLisandro Dalcin {
1530efe9872eSLisandro Dalcin   DM             dm;
1531efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1532efe9872eSLisandro Dalcin 
1533efe9872eSLisandro Dalcin   PetscFunctionBegin;
1534efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1535efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2);
1536efe9872eSLisandro Dalcin   ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr);
1537efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1538efe9872eSLisandro Dalcin   ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1539efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1540efe9872eSLisandro Dalcin }
1541efe9872eSLisandro Dalcin 
1542efe9872eSLisandro Dalcin /*@C
1543efe9872eSLisandro Dalcin   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1544efe9872eSLisandro Dalcin 
1545efe9872eSLisandro Dalcin   Not Collective
1546efe9872eSLisandro Dalcin 
1547efe9872eSLisandro Dalcin   Input Parameter:
1548efe9872eSLisandro Dalcin . ts - the TS context
1549efe9872eSLisandro Dalcin 
1550efe9872eSLisandro Dalcin   Output Parameter:
1551efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL)
1552efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL)
1553efe9872eSLisandro Dalcin - ctx - the function context (or NULL)
1554efe9872eSLisandro Dalcin 
1555efe9872eSLisandro Dalcin   Level: advanced
1556efe9872eSLisandro Dalcin 
1557efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function
1558efe9872eSLisandro Dalcin 
1559efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction()
1560efe9872eSLisandro Dalcin @*/
1561efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1562efe9872eSLisandro Dalcin {
1563efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1564efe9872eSLisandro Dalcin   SNES           snes;
1565efe9872eSLisandro Dalcin   DM             dm;
1566efe9872eSLisandro Dalcin 
1567efe9872eSLisandro Dalcin   PetscFunctionBegin;
1568efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1569efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1570efe9872eSLisandro Dalcin   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1571efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1572efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1573efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1574efe9872eSLisandro Dalcin }
1575efe9872eSLisandro Dalcin 
1576efe9872eSLisandro Dalcin /*@C
1577bc77d74cSLisandro Dalcin    TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1578efe9872eSLisandro Dalcin         where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1579efe9872eSLisandro Dalcin 
1580efe9872eSLisandro Dalcin    Logically Collective on TS
1581efe9872eSLisandro Dalcin 
1582efe9872eSLisandro Dalcin    Input Parameters:
1583efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1584efe9872eSLisandro Dalcin .  J   - Jacobian matrix
1585efe9872eSLisandro Dalcin .  P   - preconditioning matrix for J (may be same as J)
1586efe9872eSLisandro Dalcin .  jac - the Jacobian evaluation routine
1587efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1588efe9872eSLisandro Dalcin 
1589efe9872eSLisandro Dalcin    Calling sequence of jac:
1590bc77d74cSLisandro Dalcin $  jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx);
1591efe9872eSLisandro Dalcin 
1592efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1593efe9872eSLisandro Dalcin .  U    - state vector
1594efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1595efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1596efe9872eSLisandro Dalcin .  v    - shift for U_t
1597efe9872eSLisandro Dalcin .  a    - shift for U_tt
1598efe9872eSLisandro 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
1599efe9872eSLisandro Dalcin .  P    - preconditioning matrix for J, may be same as J
1600efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine
1601efe9872eSLisandro Dalcin 
1602efe9872eSLisandro Dalcin    Notes:
1603efe9872eSLisandro Dalcin    The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1604efe9872eSLisandro Dalcin 
1605efe9872eSLisandro Dalcin    The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1606efe9872eSLisandro 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.
1607efe9872eSLisandro Dalcin    The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1608bc77d74cSLisandro Dalcin    parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1609efe9872eSLisandro Dalcin 
1610efe9872eSLisandro Dalcin    Level: beginner
1611efe9872eSLisandro Dalcin 
1612efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian
1613efe9872eSLisandro Dalcin 
1614efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1615efe9872eSLisandro Dalcin @*/
1616efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1617efe9872eSLisandro Dalcin {
1618efe9872eSLisandro Dalcin   DM             dm;
1619efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1620efe9872eSLisandro Dalcin 
1621efe9872eSLisandro Dalcin   PetscFunctionBegin;
1622efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1623efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2);
1624efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3);
1625efe9872eSLisandro Dalcin   ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr);
1626efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1627efe9872eSLisandro Dalcin   ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1628efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1629efe9872eSLisandro Dalcin }
1630efe9872eSLisandro Dalcin 
1631efe9872eSLisandro Dalcin /*@C
1632efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1633efe9872eSLisandro Dalcin 
1634efe9872eSLisandro Dalcin   Not Collective, but parallel objects are returned if TS is parallel
1635efe9872eSLisandro Dalcin 
1636efe9872eSLisandro Dalcin   Input Parameter:
1637efe9872eSLisandro Dalcin . ts  - The TS context obtained from TSCreate()
1638efe9872eSLisandro Dalcin 
1639efe9872eSLisandro Dalcin   Output Parameters:
1640efe9872eSLisandro Dalcin + J  - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1641efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J
1642efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1643efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1644efe9872eSLisandro Dalcin 
1645efe9872eSLisandro Dalcin   Notes: You can pass in NULL for any return argument you do not need.
1646efe9872eSLisandro Dalcin 
1647efe9872eSLisandro Dalcin   Level: advanced
1648efe9872eSLisandro Dalcin 
164980275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
1650efe9872eSLisandro Dalcin 
1651efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian
1652efe9872eSLisandro Dalcin @*/
1653efe9872eSLisandro Dalcin PetscErrorCode  TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1654efe9872eSLisandro Dalcin {
1655efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1656efe9872eSLisandro Dalcin   SNES           snes;
1657efe9872eSLisandro Dalcin   DM             dm;
1658efe9872eSLisandro Dalcin 
1659efe9872eSLisandro Dalcin   PetscFunctionBegin;
1660efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1661efe9872eSLisandro Dalcin   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
1662efe9872eSLisandro Dalcin   ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr);
1663efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1664efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1665efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1666efe9872eSLisandro Dalcin }
1667efe9872eSLisandro Dalcin 
1668efe9872eSLisandro Dalcin /*@
1669efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1670efe9872eSLisandro Dalcin 
1671efe9872eSLisandro Dalcin   Collective on TS and Vec
1672efe9872eSLisandro Dalcin 
1673efe9872eSLisandro Dalcin   Input Parameters:
1674efe9872eSLisandro Dalcin + ts - the TS context
1675efe9872eSLisandro Dalcin . t - current time
1676efe9872eSLisandro Dalcin . U - state vector
1677efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t)
1678efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt)
1679efe9872eSLisandro Dalcin 
1680efe9872eSLisandro Dalcin   Output Parameter:
1681efe9872eSLisandro Dalcin . F - the residual vector
1682efe9872eSLisandro Dalcin 
1683efe9872eSLisandro Dalcin   Note:
1684efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1685efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1686efe9872eSLisandro Dalcin 
1687efe9872eSLisandro Dalcin   Level: developer
1688efe9872eSLisandro Dalcin 
1689efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector
1690efe9872eSLisandro Dalcin 
1691efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1692efe9872eSLisandro Dalcin @*/
1693efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1694efe9872eSLisandro Dalcin {
1695efe9872eSLisandro Dalcin   DM             dm;
1696efe9872eSLisandro Dalcin   TSI2Function   I2Function;
1697efe9872eSLisandro Dalcin   void           *ctx;
1698efe9872eSLisandro Dalcin   TSRHSFunction  rhsfunction;
1699efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1700efe9872eSLisandro Dalcin 
1701efe9872eSLisandro Dalcin   PetscFunctionBegin;
1702efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1703efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1704efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1705efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1706efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F,VEC_CLASSID,6);
1707efe9872eSLisandro Dalcin 
1708efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1709efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr);
1710efe9872eSLisandro Dalcin   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
1711efe9872eSLisandro Dalcin 
1712efe9872eSLisandro Dalcin   if (!I2Function) {
1713efe9872eSLisandro Dalcin     ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr);
1714efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1715efe9872eSLisandro Dalcin   }
1716efe9872eSLisandro Dalcin 
1717efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1718efe9872eSLisandro Dalcin 
1719efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit function");
1720efe9872eSLisandro Dalcin   ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr);
1721efe9872eSLisandro Dalcin   PetscStackPop;
1722efe9872eSLisandro Dalcin 
1723efe9872eSLisandro Dalcin   if (rhsfunction) {
1724efe9872eSLisandro Dalcin     Vec Frhs;
1725efe9872eSLisandro Dalcin     ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
1726efe9872eSLisandro Dalcin     ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
1727efe9872eSLisandro Dalcin     ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr);
1728efe9872eSLisandro Dalcin   }
1729efe9872eSLisandro Dalcin 
1730efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1731efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1732efe9872eSLisandro Dalcin }
1733efe9872eSLisandro Dalcin 
1734efe9872eSLisandro Dalcin /*@
1735efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1736efe9872eSLisandro Dalcin 
1737efe9872eSLisandro Dalcin   Collective on TS and Vec
1738efe9872eSLisandro Dalcin 
1739efe9872eSLisandro Dalcin   Input Parameters:
1740efe9872eSLisandro Dalcin + ts - the TS context
1741efe9872eSLisandro Dalcin . t - current timestep
1742efe9872eSLisandro Dalcin . U - state vector
1743efe9872eSLisandro Dalcin . V - time derivative of state vector
1744efe9872eSLisandro Dalcin . A - second time derivative of state vector
1745efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1746efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1747efe9872eSLisandro Dalcin 
1748efe9872eSLisandro Dalcin   Output Parameters:
1749efe9872eSLisandro Dalcin + J - Jacobian matrix
1750efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1751efe9872eSLisandro Dalcin 
1752efe9872eSLisandro Dalcin   Notes:
1753efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1754efe9872eSLisandro Dalcin 
1755efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1756efe9872eSLisandro Dalcin 
1757efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1758efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1759efe9872eSLisandro Dalcin 
1760efe9872eSLisandro Dalcin   Level: developer
1761efe9872eSLisandro Dalcin 
1762efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix
1763efe9872eSLisandro Dalcin 
1764efe9872eSLisandro Dalcin .seealso:  TSSetI2Jacobian()
1765efe9872eSLisandro Dalcin @*/
1766efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1767efe9872eSLisandro Dalcin {
1768efe9872eSLisandro Dalcin   DM             dm;
1769efe9872eSLisandro Dalcin   TSI2Jacobian   I2Jacobian;
1770efe9872eSLisandro Dalcin   void           *ctx;
1771efe9872eSLisandro Dalcin   TSRHSJacobian  rhsjacobian;
1772efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1773efe9872eSLisandro Dalcin 
1774efe9872eSLisandro Dalcin   PetscFunctionBegin;
1775efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1776efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1777efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1778efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1779efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J,MAT_CLASSID,8);
1780efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P,MAT_CLASSID,9);
1781efe9872eSLisandro Dalcin 
1782efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1783efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr);
1784efe9872eSLisandro Dalcin   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
1785efe9872eSLisandro Dalcin 
1786efe9872eSLisandro Dalcin   if (!I2Jacobian) {
1787efe9872eSLisandro Dalcin     ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr);
1788efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1789efe9872eSLisandro Dalcin   }
1790efe9872eSLisandro Dalcin 
1791efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1792efe9872eSLisandro Dalcin 
1793efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit Jacobian");
1794efe9872eSLisandro Dalcin   ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr);
1795efe9872eSLisandro Dalcin   PetscStackPop;
1796efe9872eSLisandro Dalcin 
1797efe9872eSLisandro Dalcin   if (rhsjacobian) {
1798efe9872eSLisandro Dalcin     Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1799efe9872eSLisandro Dalcin     ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr);
1800efe9872eSLisandro Dalcin     ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr);
1801efe9872eSLisandro Dalcin     ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr);
1802efe9872eSLisandro Dalcin     if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);}
1803efe9872eSLisandro Dalcin   }
1804efe9872eSLisandro Dalcin 
1805efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1806efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1807efe9872eSLisandro Dalcin }
1808efe9872eSLisandro Dalcin 
1809efe9872eSLisandro Dalcin /*@
1810efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1811efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1812efe9872eSLisandro Dalcin 
1813efe9872eSLisandro Dalcin    Logically Collective on TS and Vec
1814efe9872eSLisandro Dalcin 
1815efe9872eSLisandro Dalcin    Input Parameters:
1816efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1817efe9872eSLisandro Dalcin .  u - the solution vector
1818efe9872eSLisandro Dalcin -  v - the time derivative vector
1819efe9872eSLisandro Dalcin 
1820efe9872eSLisandro Dalcin    Level: beginner
1821efe9872eSLisandro Dalcin 
1822efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions
1823efe9872eSLisandro Dalcin @*/
1824efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1825efe9872eSLisandro Dalcin {
1826efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1827efe9872eSLisandro Dalcin 
1828efe9872eSLisandro Dalcin   PetscFunctionBegin;
1829efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1830efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1831efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1832efe9872eSLisandro Dalcin   ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
1833efe9872eSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr);
1834efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
1835efe9872eSLisandro Dalcin   ts->vec_dot = v;
1836efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1837efe9872eSLisandro Dalcin }
1838efe9872eSLisandro Dalcin 
1839efe9872eSLisandro Dalcin /*@
1840efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1841efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1842efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1843efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1844efe9872eSLisandro Dalcin 
1845efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1846efe9872eSLisandro Dalcin 
1847efe9872eSLisandro Dalcin    Input Parameter:
1848efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1849efe9872eSLisandro Dalcin 
1850efe9872eSLisandro Dalcin    Output Parameter:
1851efe9872eSLisandro Dalcin +  u - the vector containing the solution
1852efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1853efe9872eSLisandro Dalcin 
1854efe9872eSLisandro Dalcin    Level: intermediate
1855efe9872eSLisandro Dalcin 
1856efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1857efe9872eSLisandro Dalcin 
1858efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution
1859efe9872eSLisandro Dalcin @*/
1860efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1861efe9872eSLisandro Dalcin {
1862efe9872eSLisandro Dalcin   PetscFunctionBegin;
1863efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1864efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1865efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1866efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1867efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1868efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1869efe9872eSLisandro Dalcin }
1870efe9872eSLisandro Dalcin 
187155849f57SBarry Smith /*@C
187255849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
187355849f57SBarry Smith 
187455849f57SBarry Smith   Collective on PetscViewer
187555849f57SBarry Smith 
187655849f57SBarry Smith   Input Parameters:
187755849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
187855849f57SBarry Smith            some related function before a call to TSLoad().
187955849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
188055849f57SBarry Smith 
188155849f57SBarry Smith    Level: intermediate
188255849f57SBarry Smith 
188355849f57SBarry Smith   Notes:
188455849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
188555849f57SBarry Smith 
188655849f57SBarry Smith   Notes for advanced users:
188755849f57SBarry Smith   Most users should not need to know the details of the binary storage
188855849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
188955849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
189055849f57SBarry Smith   format is
189155849f57SBarry Smith .vb
189255849f57SBarry Smith      has not yet been determined
189355849f57SBarry Smith .ve
189455849f57SBarry Smith 
189555849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
189655849f57SBarry Smith @*/
1897f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
189855849f57SBarry Smith {
189955849f57SBarry Smith   PetscErrorCode ierr;
190055849f57SBarry Smith   PetscBool      isbinary;
190155849f57SBarry Smith   PetscInt       classid;
190255849f57SBarry Smith   char           type[256];
19032d53ad75SBarry Smith   DMTS           sdm;
1904ad6bc421SBarry Smith   DM             dm;
190555849f57SBarry Smith 
190655849f57SBarry Smith   PetscFunctionBegin;
1907f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
190855849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
190955849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
191055849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
191155849f57SBarry Smith 
1912060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1913ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1914060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1915f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1916f2c2a1b9SBarry Smith   if (ts->ops->load) {
1917f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1918f2c2a1b9SBarry Smith   }
1919ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1920ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1921ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1922f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1923f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
19242d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19252d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
192655849f57SBarry Smith   PetscFunctionReturn(0);
192755849f57SBarry Smith }
192855849f57SBarry Smith 
19299804daf3SBarry Smith #include <petscdraw.h>
1930e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1931e04113cfSBarry Smith #include <petscviewersaws.h>
1932f05ece33SBarry Smith #endif
19337e2c5f70SBarry Smith /*@C
1934d763cef2SBarry Smith     TSView - Prints the TS data structure.
1935d763cef2SBarry Smith 
19364c49b128SBarry Smith     Collective on TS
1937d763cef2SBarry Smith 
1938d763cef2SBarry Smith     Input Parameters:
1939d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1940d763cef2SBarry Smith -   viewer - visualization context
1941d763cef2SBarry Smith 
1942d763cef2SBarry Smith     Options Database Key:
1943d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1944d763cef2SBarry Smith 
1945d763cef2SBarry Smith     Notes:
1946d763cef2SBarry Smith     The available visualization contexts include
1947b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1948b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1949d763cef2SBarry Smith          output where only the first processor opens
1950d763cef2SBarry Smith          the file.  All other processors send their
1951d763cef2SBarry Smith          data to the first processor to print.
1952d763cef2SBarry Smith 
1953d763cef2SBarry Smith     The user can open an alternative visualization context with
1954b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1955d763cef2SBarry Smith 
1956d763cef2SBarry Smith     Level: beginner
1957d763cef2SBarry Smith 
1958d763cef2SBarry Smith .keywords: TS, timestep, view
1959d763cef2SBarry Smith 
1960b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1961d763cef2SBarry Smith @*/
19627087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1963d763cef2SBarry Smith {
1964dfbe8321SBarry Smith   PetscErrorCode ierr;
196519fd82e9SBarry Smith   TSType         type;
19662b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
19672d53ad75SBarry Smith   DMTS           sdm;
1968e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1969536b137fSBarry Smith   PetscBool      issaws;
1970f05ece33SBarry Smith #endif
1971d763cef2SBarry Smith 
1972d763cef2SBarry Smith   PetscFunctionBegin;
19730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
19743050cee2SBarry Smith   if (!viewer) {
1975ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
19763050cee2SBarry Smith   }
19770700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1978c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1979fd16b177SBarry Smith 
1980251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1981251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
198255849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
19832b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1984e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1985536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1986f05ece33SBarry Smith #endif
198732077d6dSBarry Smith   if (iascii) {
1988dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
1989efd4aadfSBarry Smith     if (ts->ops->view) {
1990efd4aadfSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1991efd4aadfSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1992efd4aadfSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1993efd4aadfSBarry Smith     }
1994ef85077eSLisandro Dalcin     if (ts->max_steps < PETSC_MAX_INT) {
199577431f27SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
1996ef85077eSLisandro Dalcin     }
1997ef85077eSLisandro Dalcin     if (ts->max_time < PETSC_MAX_REAL) {
19987c8652ddSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1999ef85077eSLisandro Dalcin     }
2000efd4aadfSBarry Smith     if (ts->usessnes) {
2001efd4aadfSBarry Smith       PetscBool lin;
2002d763cef2SBarry Smith       if (ts->problem_type == TS_NONLINEAR) {
20035ef26d82SJed Brown         ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
2004d763cef2SBarry Smith       }
20055ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
2006efd4aadfSBarry Smith       ierr = PetscObjectTypeCompare((PetscObject)ts->snes,SNESKSPONLY,&lin);CHKERRQ(ierr);
2007efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr);
2008efd4aadfSBarry Smith     }
2009193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
2010a0af407cSBarry Smith     if (ts->vrtol) {
2011a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of relative error tolerances, ");CHKERRQ(ierr);
2012a0af407cSBarry Smith     } else {
2013a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr);
2014a0af407cSBarry Smith     }
2015a0af407cSBarry Smith     if (ts->vatol) {
2016a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of absolute error tolerances\n");CHKERRQ(ierr);
2017a0af407cSBarry Smith     } else {
2018a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr);
2019a0af407cSBarry Smith     }
2020efd4aadfSBarry Smith     ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);
2021efd4aadfSBarry Smith     if (ts->snes && ts->usessnes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
20222d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
20232d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
20240f5bd95cSBarry Smith   } else if (isstring) {
2025a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
2026b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
202755849f57SBarry Smith   } else if (isbinary) {
202855849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
202955849f57SBarry Smith     MPI_Comm    comm;
203055849f57SBarry Smith     PetscMPIInt rank;
203155849f57SBarry Smith     char        type[256];
203255849f57SBarry Smith 
203355849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
203455849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
203555849f57SBarry Smith     if (!rank) {
203655849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
203755849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
203855849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
203955849f57SBarry Smith     }
204055849f57SBarry Smith     if (ts->ops->view) {
204155849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
204255849f57SBarry Smith     }
2043efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2044f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
2045f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
20462d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
20472d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
20482b0a91c0SBarry Smith   } else if (isdraw) {
20492b0a91c0SBarry Smith     PetscDraw draw;
20502b0a91c0SBarry Smith     char      str[36];
205189fd9fafSBarry Smith     PetscReal x,y,bottom,h;
20522b0a91c0SBarry Smith 
20532b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
20542b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
20552b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
20562b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
205751fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
205889fd9fafSBarry Smith     bottom = y - h;
20592b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
20602b0a91c0SBarry Smith     if (ts->ops->view) {
20612b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
20622b0a91c0SBarry Smith     }
2063efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2064efd4aadfSBarry Smith     if (ts->snes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
20652b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2066e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2067536b137fSBarry Smith   } else if (issaws) {
2068d45a07a7SBarry Smith     PetscMPIInt rank;
20692657e9d9SBarry Smith     const char  *name;
20702657e9d9SBarry Smith 
20712657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
2072d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
2073d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
2074d45a07a7SBarry Smith       char       dir[1024];
2075d45a07a7SBarry Smith 
2076e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
2077a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
20782657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
20792657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
20802657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
2081d763cef2SBarry Smith     }
20820acecf5bSBarry Smith     if (ts->ops->view) {
20830acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
20840acecf5bSBarry Smith     }
2085f05ece33SBarry Smith #endif
2086f05ece33SBarry Smith   }
2087f05ece33SBarry Smith 
2088b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2089251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
2090b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2091d763cef2SBarry Smith   PetscFunctionReturn(0);
2092d763cef2SBarry Smith }
2093d763cef2SBarry Smith 
2094b07ff414SBarry Smith /*@
2095d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2096d763cef2SBarry Smith    the timesteppers.
2097d763cef2SBarry Smith 
20983f9fe445SBarry Smith    Logically Collective on TS
2099d763cef2SBarry Smith 
2100d763cef2SBarry Smith    Input Parameters:
2101d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2102d763cef2SBarry Smith -  usrP - optional user context
2103d763cef2SBarry Smith 
2104daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2105daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2106daf670e6SBarry Smith 
2107d763cef2SBarry Smith    Level: intermediate
2108d763cef2SBarry Smith 
2109d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
2110d763cef2SBarry Smith 
2111d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2112d763cef2SBarry Smith @*/
21137087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2114d763cef2SBarry Smith {
2115d763cef2SBarry Smith   PetscFunctionBegin;
21160700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2117d763cef2SBarry Smith   ts->user = usrP;
2118d763cef2SBarry Smith   PetscFunctionReturn(0);
2119d763cef2SBarry Smith }
2120d763cef2SBarry Smith 
2121b07ff414SBarry Smith /*@
2122d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2123d763cef2SBarry Smith     timestepper.
2124d763cef2SBarry Smith 
2125d763cef2SBarry Smith     Not Collective
2126d763cef2SBarry Smith 
2127d763cef2SBarry Smith     Input Parameter:
2128d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2129d763cef2SBarry Smith 
2130d763cef2SBarry Smith     Output Parameter:
2131d763cef2SBarry Smith .   usrP - user context
2132d763cef2SBarry Smith 
2133daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2134daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2135daf670e6SBarry Smith 
2136d763cef2SBarry Smith     Level: intermediate
2137d763cef2SBarry Smith 
2138d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
2139d763cef2SBarry Smith 
2140d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2141d763cef2SBarry Smith @*/
2142e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2143d763cef2SBarry Smith {
2144d763cef2SBarry Smith   PetscFunctionBegin;
21450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2146e71120c6SJed Brown   *(void**)usrP = ts->user;
2147d763cef2SBarry Smith   PetscFunctionReturn(0);
2148d763cef2SBarry Smith }
2149d763cef2SBarry Smith 
2150d763cef2SBarry Smith /*@
215180275a0aSLisandro Dalcin    TSGetStepNumber - Gets the number of steps completed.
2152d763cef2SBarry Smith 
2153d763cef2SBarry Smith    Not Collective
2154d763cef2SBarry Smith 
2155d763cef2SBarry Smith    Input Parameter:
2156d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2157d763cef2SBarry Smith 
2158d763cef2SBarry Smith    Output Parameter:
215980275a0aSLisandro Dalcin .  steps - number of steps completed so far
2160d763cef2SBarry Smith 
2161d763cef2SBarry Smith    Level: intermediate
2162d763cef2SBarry Smith 
2163d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
21649be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2165d763cef2SBarry Smith @*/
216680275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps)
2167d763cef2SBarry Smith {
2168d763cef2SBarry Smith   PetscFunctionBegin;
21690700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
217080275a0aSLisandro Dalcin   PetscValidIntPointer(steps,2);
217180275a0aSLisandro Dalcin   *steps = ts->steps;
217280275a0aSLisandro Dalcin   PetscFunctionReturn(0);
217380275a0aSLisandro Dalcin }
217480275a0aSLisandro Dalcin 
217580275a0aSLisandro Dalcin /*@
217680275a0aSLisandro Dalcin    TSSetStepNumber - Sets the number of steps completed.
217780275a0aSLisandro Dalcin 
217880275a0aSLisandro Dalcin    Logically Collective on TS
217980275a0aSLisandro Dalcin 
218080275a0aSLisandro Dalcin    Input Parameters:
218180275a0aSLisandro Dalcin +  ts - the TS context
218280275a0aSLisandro Dalcin -  steps - number of steps completed so far
218380275a0aSLisandro Dalcin 
218480275a0aSLisandro Dalcin    Notes:
218580275a0aSLisandro Dalcin    For most uses of the TS solvers the user need not explicitly call
218680275a0aSLisandro Dalcin    TSSetStepNumber(), as the step counter is appropriately updated in
218780275a0aSLisandro Dalcin    TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to
218880275a0aSLisandro Dalcin    reinitialize timestepping by setting the step counter to zero (and time
218980275a0aSLisandro Dalcin    to the initial time) to solve a similar problem with different initial
219080275a0aSLisandro Dalcin    conditions or parameters. Other possible use case is to continue
219180275a0aSLisandro Dalcin    timestepping from a previously interrupted run in such a way that TS
219280275a0aSLisandro Dalcin    monitors will be called with a initial nonzero step counter.
219380275a0aSLisandro Dalcin 
219480275a0aSLisandro Dalcin    Level: advanced
219580275a0aSLisandro Dalcin 
219680275a0aSLisandro Dalcin .keywords: TS, timestep, set, iteration, number
219780275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution()
219880275a0aSLisandro Dalcin @*/
219980275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps)
220080275a0aSLisandro Dalcin {
220180275a0aSLisandro Dalcin   PetscFunctionBegin;
220280275a0aSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
220380275a0aSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,steps,2);
220480275a0aSLisandro Dalcin   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative");
220580275a0aSLisandro Dalcin   ts->steps = steps;
2206d763cef2SBarry Smith   PetscFunctionReturn(0);
2207d763cef2SBarry Smith }
2208d763cef2SBarry Smith 
2209d763cef2SBarry Smith /*@
2210d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2211d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2212d763cef2SBarry Smith 
22133f9fe445SBarry Smith    Logically Collective on TS
2214d763cef2SBarry Smith 
2215d763cef2SBarry Smith    Input Parameters:
2216d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2217d763cef2SBarry Smith -  time_step - the size of the timestep
2218d763cef2SBarry Smith 
2219d763cef2SBarry Smith    Level: intermediate
2220d763cef2SBarry Smith 
2221aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime()
2222d763cef2SBarry Smith 
2223d763cef2SBarry Smith .keywords: TS, set, timestep
2224d763cef2SBarry Smith @*/
22257087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2226d763cef2SBarry Smith {
2227d763cef2SBarry Smith   PetscFunctionBegin;
22280700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2229c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2230d763cef2SBarry Smith   ts->time_step = time_step;
2231d763cef2SBarry Smith   PetscFunctionReturn(0);
2232d763cef2SBarry Smith }
2233d763cef2SBarry Smith 
2234a43b19c4SJed Brown /*@
223549354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
223649354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
223749354f04SShri Abhyankar      or just return at the final time TS computed.
2238a43b19c4SJed Brown 
2239a43b19c4SJed Brown   Logically Collective on TS
2240a43b19c4SJed Brown 
2241a43b19c4SJed Brown    Input Parameter:
2242a43b19c4SJed Brown +   ts - the time-step context
224349354f04SShri Abhyankar -   eftopt - exact final time option
2244a43b19c4SJed Brown 
2245feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2246feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2247feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2248feed9e9dSBarry Smith 
2249feed9e9dSBarry Smith    Options Database:
2250feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2251feed9e9dSBarry Smith 
2252ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2253ee346746SBarry Smith     then the final time you selected.
2254ee346746SBarry Smith 
2255a43b19c4SJed Brown    Level: beginner
2256a43b19c4SJed Brown 
2257f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime()
2258a43b19c4SJed Brown @*/
225949354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2260a43b19c4SJed Brown {
2261a43b19c4SJed Brown   PetscFunctionBegin;
2262a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
226349354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
226449354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2265a43b19c4SJed Brown   PetscFunctionReturn(0);
2266a43b19c4SJed Brown }
2267a43b19c4SJed Brown 
2268d763cef2SBarry Smith /*@
2269f6953c82SLisandro Dalcin    TSGetExactFinalTime - Gets the exact final time option.
2270f6953c82SLisandro Dalcin 
2271f6953c82SLisandro Dalcin    Not Collective
2272f6953c82SLisandro Dalcin 
2273f6953c82SLisandro Dalcin    Input Parameter:
2274f6953c82SLisandro Dalcin .  ts - the TS context
2275f6953c82SLisandro Dalcin 
2276f6953c82SLisandro Dalcin    Output Parameter:
2277f6953c82SLisandro Dalcin .  eftopt - exact final time option
2278f6953c82SLisandro Dalcin 
2279f6953c82SLisandro Dalcin    Level: beginner
2280f6953c82SLisandro Dalcin 
2281f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime()
2282f6953c82SLisandro Dalcin @*/
2283f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt)
2284f6953c82SLisandro Dalcin {
2285f6953c82SLisandro Dalcin   PetscFunctionBegin;
2286f6953c82SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2287f6953c82SLisandro Dalcin   PetscValidPointer(eftopt,2);
2288f6953c82SLisandro Dalcin   *eftopt = ts->exact_final_time;
2289f6953c82SLisandro Dalcin   PetscFunctionReturn(0);
2290f6953c82SLisandro Dalcin }
2291f6953c82SLisandro Dalcin 
2292f6953c82SLisandro Dalcin /*@
2293d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2294d763cef2SBarry Smith 
2295d763cef2SBarry Smith    Not Collective
2296d763cef2SBarry Smith 
2297d763cef2SBarry Smith    Input Parameter:
2298d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2299d763cef2SBarry Smith 
2300d763cef2SBarry Smith    Output Parameter:
2301d763cef2SBarry Smith .  dt - the current timestep size
2302d763cef2SBarry Smith 
2303d763cef2SBarry Smith    Level: intermediate
2304d763cef2SBarry Smith 
2305aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime()
2306d763cef2SBarry Smith 
2307d763cef2SBarry Smith .keywords: TS, get, timestep
2308d763cef2SBarry Smith @*/
23097087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2310d763cef2SBarry Smith {
2311d763cef2SBarry Smith   PetscFunctionBegin;
23120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2313f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2314d763cef2SBarry Smith   *dt = ts->time_step;
2315d763cef2SBarry Smith   PetscFunctionReturn(0);
2316d763cef2SBarry Smith }
2317d763cef2SBarry Smith 
2318d8e5e3e6SSatish Balay /*@
2319d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2320d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2321d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2322d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2323d763cef2SBarry Smith 
2324d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2325d763cef2SBarry Smith 
2326d763cef2SBarry Smith    Input Parameter:
2327d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2328d763cef2SBarry Smith 
2329d763cef2SBarry Smith    Output Parameter:
2330d763cef2SBarry Smith .  v - the vector containing the solution
2331d763cef2SBarry Smith 
233263e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
233363e21af5SBarry Smith    final time. It returns the solution at the next timestep.
233463e21af5SBarry Smith 
2335d763cef2SBarry Smith    Level: intermediate
2336d763cef2SBarry Smith 
2337*0ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction()
2338d763cef2SBarry Smith 
2339d763cef2SBarry Smith .keywords: TS, timestep, get, solution
2340d763cef2SBarry Smith @*/
23417087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2342d763cef2SBarry Smith {
2343d763cef2SBarry Smith   PetscFunctionBegin;
23440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
23454482741eSBarry Smith   PetscValidPointer(v,2);
23468737fe31SLisandro Dalcin   *v = ts->vec_sol;
2347d763cef2SBarry Smith   PetscFunctionReturn(0);
2348d763cef2SBarry Smith }
2349d763cef2SBarry Smith 
235003fe5f5eSDebojyoti Ghosh /*@
2351b2bf4f3aSDebojyoti Ghosh    TSGetSolutionComponents - Returns any solution components at the present
235203fe5f5eSDebojyoti Ghosh    timestep, if available for the time integration method being used.
2353b2bf4f3aSDebojyoti Ghosh    Solution components are quantities that share the same size and
235403fe5f5eSDebojyoti Ghosh    structure as the solution vector.
235503fe5f5eSDebojyoti Ghosh 
235603fe5f5eSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
235703fe5f5eSDebojyoti Ghosh 
235803fe5f5eSDebojyoti Ghosh    Parameters :
235903fe5f5eSDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
2360b2bf4f3aSDebojyoti Ghosh .  n - If v is PETSC_NULL, then the number of solution components is
2361b2bf4f3aSDebojyoti Ghosh        returned through n, else the n-th solution component is
236203fe5f5eSDebojyoti Ghosh        returned in v.
2363b2bf4f3aSDebojyoti Ghosh .  v - the vector containing the n-th solution component
236403fe5f5eSDebojyoti Ghosh        (may be PETSC_NULL to use this function to find out
2365b2bf4f3aSDebojyoti Ghosh         the number of solutions components).
236603fe5f5eSDebojyoti Ghosh 
23674cdd57e5SDebojyoti Ghosh    Level: advanced
236803fe5f5eSDebojyoti Ghosh 
236903fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution()
237003fe5f5eSDebojyoti Ghosh 
237103fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution
237203fe5f5eSDebojyoti Ghosh @*/
2373b2bf4f3aSDebojyoti Ghosh PetscErrorCode  TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v)
237403fe5f5eSDebojyoti Ghosh {
237503fe5f5eSDebojyoti Ghosh   PetscErrorCode ierr;
237603fe5f5eSDebojyoti Ghosh 
237703fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
237803fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2379b2bf4f3aSDebojyoti Ghosh   if (!ts->ops->getsolutioncomponents) *n = 0;
238003fe5f5eSDebojyoti Ghosh   else {
2381b2bf4f3aSDebojyoti Ghosh     ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr);
238203fe5f5eSDebojyoti Ghosh   }
238303fe5f5eSDebojyoti Ghosh   PetscFunctionReturn(0);
238403fe5f5eSDebojyoti Ghosh }
238503fe5f5eSDebojyoti Ghosh 
23864cdd57e5SDebojyoti Ghosh /*@
23874cdd57e5SDebojyoti Ghosh    TSGetAuxSolution - Returns an auxiliary solution at the present
23884cdd57e5SDebojyoti Ghosh    timestep, if available for the time integration method being used.
23894cdd57e5SDebojyoti Ghosh 
23904cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
23914cdd57e5SDebojyoti Ghosh 
23924cdd57e5SDebojyoti Ghosh    Parameters :
23934cdd57e5SDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
23944cdd57e5SDebojyoti Ghosh .  v - the vector containing the auxiliary solution
23954cdd57e5SDebojyoti Ghosh 
23964cdd57e5SDebojyoti Ghosh    Level: intermediate
23974cdd57e5SDebojyoti Ghosh 
23984cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution()
23994cdd57e5SDebojyoti Ghosh 
24004cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, solution
24014cdd57e5SDebojyoti Ghosh @*/
24024cdd57e5SDebojyoti Ghosh PetscErrorCode  TSGetAuxSolution(TS ts,Vec *v)
24034cdd57e5SDebojyoti Ghosh {
24044cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
24054cdd57e5SDebojyoti Ghosh 
24064cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
24074cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2408f6356ec7SDebojyoti Ghosh   if (ts->ops->getauxsolution) {
24094cdd57e5SDebojyoti Ghosh     ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr);
2410f6356ec7SDebojyoti Ghosh   } else {
2411f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v); CHKERRQ(ierr);
2412f6356ec7SDebojyoti Ghosh   }
24134cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
24144cdd57e5SDebojyoti Ghosh }
24154cdd57e5SDebojyoti Ghosh 
24164cdd57e5SDebojyoti Ghosh /*@
24174cdd57e5SDebojyoti Ghosh    TSGetTimeError - Returns the estimated error vector, if the chosen
24184cdd57e5SDebojyoti Ghosh    TSType has an error estimation functionality.
24194cdd57e5SDebojyoti Ghosh 
24204cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
24214cdd57e5SDebojyoti Ghosh 
24229657682dSDebojyoti Ghosh    Note: MUST call after TSSetUp()
24239657682dSDebojyoti Ghosh 
24244cdd57e5SDebojyoti Ghosh    Parameters :
24254cdd57e5SDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
2426657c1e31SEmil Constantinescu .  n - current estimate (n=0) or previous one (n=-1)
24274cdd57e5SDebojyoti Ghosh .  v - the vector containing the error (same size as the solution).
24284cdd57e5SDebojyoti Ghosh 
24294cdd57e5SDebojyoti Ghosh    Level: intermediate
24304cdd57e5SDebojyoti Ghosh 
243157df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError()
24324cdd57e5SDebojyoti Ghosh 
24334cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, error
24344cdd57e5SDebojyoti Ghosh @*/
24350a01e1b2SEmil Constantinescu PetscErrorCode  TSGetTimeError(TS ts,PetscInt n,Vec *v)
24364cdd57e5SDebojyoti Ghosh {
24374cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
24384cdd57e5SDebojyoti Ghosh 
24394cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
24404cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2441f6356ec7SDebojyoti Ghosh   if (ts->ops->gettimeerror) {
24420a01e1b2SEmil Constantinescu     ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr);
2443f6356ec7SDebojyoti Ghosh   } else {
2444f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v);CHKERRQ(ierr);
2445f6356ec7SDebojyoti Ghosh   }
24464cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
24474cdd57e5SDebojyoti Ghosh }
24484cdd57e5SDebojyoti Ghosh 
244957df6a1bSDebojyoti Ghosh /*@
245057df6a1bSDebojyoti Ghosh    TSSetTimeError - Sets the estimated error vector, if the chosen
245157df6a1bSDebojyoti Ghosh    TSType has an error estimation functionality. This can be used
245257df6a1bSDebojyoti Ghosh    to restart such a time integrator with a given error vector.
245357df6a1bSDebojyoti Ghosh 
245457df6a1bSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
245557df6a1bSDebojyoti Ghosh 
245657df6a1bSDebojyoti Ghosh    Parameters :
245757df6a1bSDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
245857df6a1bSDebojyoti Ghosh .  v - the vector containing the error (same size as the solution).
245957df6a1bSDebojyoti Ghosh 
246057df6a1bSDebojyoti Ghosh    Level: intermediate
246157df6a1bSDebojyoti Ghosh 
246257df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError)
246357df6a1bSDebojyoti Ghosh 
246457df6a1bSDebojyoti Ghosh .keywords: TS, timestep, get, error
246557df6a1bSDebojyoti Ghosh @*/
246657df6a1bSDebojyoti Ghosh PetscErrorCode  TSSetTimeError(TS ts,Vec v)
246757df6a1bSDebojyoti Ghosh {
246857df6a1bSDebojyoti Ghosh   PetscErrorCode ierr;
246957df6a1bSDebojyoti Ghosh 
247057df6a1bSDebojyoti Ghosh   PetscFunctionBegin;
247157df6a1bSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24729657682dSDebojyoti Ghosh   if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first");
247357df6a1bSDebojyoti Ghosh   if (ts->ops->settimeerror) {
247457df6a1bSDebojyoti Ghosh     ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr);
247557df6a1bSDebojyoti Ghosh   }
247657df6a1bSDebojyoti Ghosh   PetscFunctionReturn(0);
247757df6a1bSDebojyoti Ghosh }
247857df6a1bSDebojyoti Ghosh 
2479c235aa8dSHong Zhang /*@
2480dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
2481c235aa8dSHong Zhang 
2482c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
2483c235aa8dSHong Zhang 
2484c235aa8dSHong Zhang    Input Parameter:
2485c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
2486c235aa8dSHong Zhang 
2487c235aa8dSHong Zhang    Output Parameter:
2488abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
2489abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
2490c235aa8dSHong Zhang 
2491c235aa8dSHong Zhang    Level: intermediate
2492c235aa8dSHong Zhang 
2493c235aa8dSHong Zhang .seealso: TSGetTimeStep()
2494c235aa8dSHong Zhang 
2495c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
2496c235aa8dSHong Zhang @*/
2497dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
2498c235aa8dSHong Zhang {
2499c235aa8dSHong Zhang   PetscFunctionBegin;
2500c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2501abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
2502abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
2503abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
2504c235aa8dSHong Zhang   PetscFunctionReturn(0);
2505c235aa8dSHong Zhang }
2506c235aa8dSHong Zhang 
2507bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
2508d8e5e3e6SSatish Balay /*@
2509bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2510d763cef2SBarry Smith 
2511bdad233fSMatthew Knepley   Not collective
2512d763cef2SBarry Smith 
2513bdad233fSMatthew Knepley   Input Parameters:
2514bdad233fSMatthew Knepley + ts   - The TS
2515bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2516d763cef2SBarry Smith .vb
25170910c330SBarry Smith          U_t - A U = 0      (linear)
25180910c330SBarry Smith          U_t - A(t) U = 0   (linear)
25190910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2520d763cef2SBarry Smith .ve
2521d763cef2SBarry Smith 
2522d763cef2SBarry Smith    Level: beginner
2523d763cef2SBarry Smith 
2524bdad233fSMatthew Knepley .keywords: TS, problem type
2525bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2526d763cef2SBarry Smith @*/
25277087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2528a7cc72afSBarry Smith {
25299e2a6581SJed Brown   PetscErrorCode ierr;
25309e2a6581SJed Brown 
2531d763cef2SBarry Smith   PetscFunctionBegin;
25320700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2533bdad233fSMatthew Knepley   ts->problem_type = type;
25349e2a6581SJed Brown   if (type == TS_LINEAR) {
25359e2a6581SJed Brown     SNES snes;
25369e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
25379e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
25389e2a6581SJed Brown   }
2539d763cef2SBarry Smith   PetscFunctionReturn(0);
2540d763cef2SBarry Smith }
2541d763cef2SBarry Smith 
2542bdad233fSMatthew Knepley /*@C
2543bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2544bdad233fSMatthew Knepley 
2545bdad233fSMatthew Knepley   Not collective
2546bdad233fSMatthew Knepley 
2547bdad233fSMatthew Knepley   Input Parameter:
2548bdad233fSMatthew Knepley . ts   - The TS
2549bdad233fSMatthew Knepley 
2550bdad233fSMatthew Knepley   Output Parameter:
2551bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2552bdad233fSMatthew Knepley .vb
2553089b2837SJed Brown          M U_t = A U
2554089b2837SJed Brown          M(t) U_t = A(t) U
2555b5abc632SBarry Smith          F(t,U,U_t)
2556bdad233fSMatthew Knepley .ve
2557bdad233fSMatthew Knepley 
2558bdad233fSMatthew Knepley    Level: beginner
2559bdad233fSMatthew Knepley 
2560bdad233fSMatthew Knepley .keywords: TS, problem type
2561bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2562bdad233fSMatthew Knepley @*/
25637087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2564a7cc72afSBarry Smith {
2565bdad233fSMatthew Knepley   PetscFunctionBegin;
25660700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
25674482741eSBarry Smith   PetscValidIntPointer(type,2);
2568bdad233fSMatthew Knepley   *type = ts->problem_type;
2569bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2570bdad233fSMatthew Knepley }
2571d763cef2SBarry Smith 
2572d763cef2SBarry Smith /*@
2573d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
2574d763cef2SBarry Smith    of a timestepper.
2575d763cef2SBarry Smith 
2576d763cef2SBarry Smith    Collective on TS
2577d763cef2SBarry Smith 
2578d763cef2SBarry Smith    Input Parameter:
2579d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2580d763cef2SBarry Smith 
2581d763cef2SBarry Smith    Notes:
2582d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2583d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2584141bd67dSStefano Zampini    the call to TSStep() or TSSolve().  However, if one wishes to control this
2585d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2586141bd67dSStefano Zampini    and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve().
2587d763cef2SBarry Smith 
2588d763cef2SBarry Smith    Level: advanced
2589d763cef2SBarry Smith 
2590d763cef2SBarry Smith .keywords: TS, timestep, setup
2591d763cef2SBarry Smith 
2592141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve()
2593d763cef2SBarry Smith @*/
25947087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2595d763cef2SBarry Smith {
2596dfbe8321SBarry Smith   PetscErrorCode ierr;
25976c6b9e74SPeter Brune   DM             dm;
25986c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2599d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2600cd11d68dSLisandro Dalcin   TSIFunction    ifun;
26016c6b9e74SPeter Brune   TSIJacobian    ijac;
2602efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
26036c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
26042ffb9264SLisandro Dalcin   PetscBool      isnone;
2605d763cef2SBarry Smith 
2606d763cef2SBarry Smith   PetscFunctionBegin;
26070700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2608277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2609277b19d0SLisandro Dalcin 
26107adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2611cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
2612cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
2613d763cef2SBarry Smith   }
2614277b19d0SLisandro Dalcin 
2615277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
2616277b19d0SLisandro Dalcin 
2617e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
2618e1244c69SJed Brown     Mat Amat,Pmat;
2619e1244c69SJed Brown     SNES snes;
2620e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2621e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2622e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2623e1244c69SJed Brown      * have displaced the RHS matrix */
2624e1244c69SJed Brown     if (Amat == ts->Arhs) {
2625abc0d4abSBarry 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 */
2626abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2627e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2628e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2629e1244c69SJed Brown     }
2630e1244c69SJed Brown     if (Pmat == ts->Brhs) {
2631abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2632e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2633e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2634e1244c69SJed Brown     }
2635e1244c69SJed Brown   }
26362ffb9264SLisandro Dalcin 
26372ffb9264SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
26382ffb9264SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
26392ffb9264SLisandro Dalcin 
2640277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2641000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2642277b19d0SLisandro Dalcin   }
2643277b19d0SLisandro Dalcin 
26442ffb9264SLisandro Dalcin   /* Attempt to check/preset a default value for the exact final time option */
26452ffb9264SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr);
26462ffb9264SLisandro Dalcin   if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED)
26472ffb9264SLisandro Dalcin     ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP;
26482ffb9264SLisandro Dalcin 
2649a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
26506c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
26516c6b9e74SPeter Brune    */
26526c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
26530298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
26546c6b9e74SPeter Brune   if (!func) {
26556c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
26566c6b9e74SPeter Brune   }
2657a6772fa2SLisandro 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.
26586c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
26596c6b9e74SPeter Brune    */
26600298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
26610298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
2662efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr);
26630298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
2664efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
26656c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
26666c6b9e74SPeter Brune   }
2667c0517034SDebojyoti Ghosh 
2668c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2669c0517034SDebojyoti Ghosh   if (ts->ops->startingmethod) {
2670c0517034SDebojyoti Ghosh     ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr);
2671c0517034SDebojyoti Ghosh   }
2672c0517034SDebojyoti Ghosh 
2673277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2674277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2675277b19d0SLisandro Dalcin }
2676277b19d0SLisandro Dalcin 
2677f6a906c0SBarry Smith /*@
2678f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
2679f6a906c0SBarry Smith    of an adjoint solver
2680f6a906c0SBarry Smith 
2681f6a906c0SBarry Smith    Collective on TS
2682f6a906c0SBarry Smith 
2683f6a906c0SBarry Smith    Input Parameter:
2684f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
2685f6a906c0SBarry Smith 
2686f6a906c0SBarry Smith    Level: advanced
2687f6a906c0SBarry Smith 
2688f6a906c0SBarry Smith .keywords: TS, timestep, setup
2689f6a906c0SBarry Smith 
2690947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
2691f6a906c0SBarry Smith @*/
2692f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
2693f6a906c0SBarry Smith {
2694f6a906c0SBarry Smith   PetscErrorCode ierr;
2695f6a906c0SBarry Smith 
2696f6a906c0SBarry Smith   PetscFunctionBegin;
2697f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2698f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
269923706b9aSHong Zhang   if (!ts->vecs_sensi) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
2700c5767687SHong Zhang   if (ts->vecs_sensip && !ts->Jacp) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"Must call TSAdjointSetRHSJacobian() first");
2701d8151eeaSBarry Smith 
2702947abb85SHong Zhang   if (ts->vec_costintegral) { /* if there is integral in the cost function */
2703d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2704d8151eeaSBarry Smith     if (ts->vecs_sensip){
2705d8151eeaSBarry Smith       ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2706d8151eeaSBarry Smith     }
2707947abb85SHong Zhang   }
2708d8151eeaSBarry Smith 
270942f2b339SBarry Smith   if (ts->ops->adjointsetup) {
271042f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
2711f6a906c0SBarry Smith   }
2712f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
2713f6a906c0SBarry Smith   PetscFunctionReturn(0);
2714f6a906c0SBarry Smith }
2715f6a906c0SBarry Smith 
2716277b19d0SLisandro Dalcin /*@
2717277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2718277b19d0SLisandro Dalcin 
2719277b19d0SLisandro Dalcin    Collective on TS
2720277b19d0SLisandro Dalcin 
2721277b19d0SLisandro Dalcin    Input Parameter:
2722277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2723277b19d0SLisandro Dalcin 
2724277b19d0SLisandro Dalcin    Level: beginner
2725277b19d0SLisandro Dalcin 
2726277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2727277b19d0SLisandro Dalcin 
2728277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2729277b19d0SLisandro Dalcin @*/
2730277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2731277b19d0SLisandro Dalcin {
2732277b19d0SLisandro Dalcin   PetscErrorCode ierr;
2733277b19d0SLisandro Dalcin 
2734277b19d0SLisandro Dalcin   PetscFunctionBegin;
2735277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2736b18ea86cSHong Zhang 
2737277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2738277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2739277b19d0SLisandro Dalcin   }
2740277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2741e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2742bbd56ea5SKarl Rupp 
27434e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
27444e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2745214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
27466bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2747efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
2748e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2749e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
275038637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2751bbd56ea5SKarl Rupp 
2752d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2753d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2754715f1b00SHong Zhang 
2755ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
27562c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
275736eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2758715f1b00SHong Zhang 
2759022c081aSHong Zhang   ierr = PetscFree(ts->vecs_fwdsensipacked);CHKERRQ(ierr);
2760022c081aSHong Zhang 
2761277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2762d763cef2SBarry Smith   PetscFunctionReturn(0);
2763d763cef2SBarry Smith }
2764d763cef2SBarry Smith 
2765d8e5e3e6SSatish Balay /*@
2766d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2767d763cef2SBarry Smith    with TSCreate().
2768d763cef2SBarry Smith 
2769d763cef2SBarry Smith    Collective on TS
2770d763cef2SBarry Smith 
2771d763cef2SBarry Smith    Input Parameter:
2772d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2773d763cef2SBarry Smith 
2774d763cef2SBarry Smith    Level: beginner
2775d763cef2SBarry Smith 
2776d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2777d763cef2SBarry Smith 
2778d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2779d763cef2SBarry Smith @*/
27806bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2781d763cef2SBarry Smith {
27826849ba73SBarry Smith   PetscErrorCode ierr;
2783d763cef2SBarry Smith 
2784d763cef2SBarry Smith   PetscFunctionBegin;
27856bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
27866bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
27876bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2788d763cef2SBarry Smith 
27896bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2790277b19d0SLisandro Dalcin 
2791e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2792e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
27936bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
27946d4c513bSLisandro Dalcin 
2795bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2796bc952696SBarry Smith 
279784df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
27986427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
27996427ac75SLisandro Dalcin 
28006bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
28016bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
28026bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
28030dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
28046d4c513bSLisandro Dalcin 
2805a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2806d763cef2SBarry Smith   PetscFunctionReturn(0);
2807d763cef2SBarry Smith }
2808d763cef2SBarry Smith 
2809d8e5e3e6SSatish Balay /*@
2810d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2811d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2812d763cef2SBarry Smith 
2813d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2814d763cef2SBarry Smith 
2815d763cef2SBarry Smith    Input Parameter:
2816d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2817d763cef2SBarry Smith 
2818d763cef2SBarry Smith    Output Parameter:
2819d763cef2SBarry Smith .  snes - the nonlinear solver context
2820d763cef2SBarry Smith 
2821d763cef2SBarry Smith    Notes:
2822d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2823d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
282494b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2825d763cef2SBarry Smith 
2826d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
28270298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2828d763cef2SBarry Smith 
2829d763cef2SBarry Smith    Level: beginner
2830d763cef2SBarry Smith 
2831d763cef2SBarry Smith .keywords: timestep, get, SNES
2832d763cef2SBarry Smith @*/
28337087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2834d763cef2SBarry Smith {
2835d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2836d372ba47SLisandro Dalcin 
2837d763cef2SBarry Smith   PetscFunctionBegin;
28380700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28394482741eSBarry Smith   PetscValidPointer(snes,2);
2840d372ba47SLisandro Dalcin   if (!ts->snes) {
2841ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
28420298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
28433bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2844d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2845496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
28469e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
28479e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
28489e2a6581SJed Brown     }
2849d372ba47SLisandro Dalcin   }
2850d763cef2SBarry Smith   *snes = ts->snes;
2851d763cef2SBarry Smith   PetscFunctionReturn(0);
2852d763cef2SBarry Smith }
2853d763cef2SBarry Smith 
2854deb2cd25SJed Brown /*@
2855deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2856deb2cd25SJed Brown 
2857deb2cd25SJed Brown    Collective
2858deb2cd25SJed Brown 
2859deb2cd25SJed Brown    Input Parameter:
2860deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2861deb2cd25SJed Brown -  snes - the nonlinear solver context
2862deb2cd25SJed Brown 
2863deb2cd25SJed Brown    Notes:
2864deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2865deb2cd25SJed Brown 
2866deb2cd25SJed Brown    Level: developer
2867deb2cd25SJed Brown 
2868deb2cd25SJed Brown .keywords: timestep, set, SNES
2869deb2cd25SJed Brown @*/
2870deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2871deb2cd25SJed Brown {
2872deb2cd25SJed Brown   PetscErrorCode ierr;
2873d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2874deb2cd25SJed Brown 
2875deb2cd25SJed Brown   PetscFunctionBegin;
2876deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2877deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2878deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2879deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2880bbd56ea5SKarl Rupp 
2881deb2cd25SJed Brown   ts->snes = snes;
2882bbd56ea5SKarl Rupp 
28830298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
28840298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2885740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
28860298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2887740132f1SEmil Constantinescu   }
2888deb2cd25SJed Brown   PetscFunctionReturn(0);
2889deb2cd25SJed Brown }
2890deb2cd25SJed Brown 
2891d8e5e3e6SSatish Balay /*@
289294b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2893d763cef2SBarry Smith    a TS (timestepper) context.
2894d763cef2SBarry Smith 
289594b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2896d763cef2SBarry Smith 
2897d763cef2SBarry Smith    Input Parameter:
2898d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2899d763cef2SBarry Smith 
2900d763cef2SBarry Smith    Output Parameter:
290194b7f48cSBarry Smith .  ksp - the nonlinear solver context
2902d763cef2SBarry Smith 
2903d763cef2SBarry Smith    Notes:
290494b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2905d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2906d763cef2SBarry Smith    KSP and PC contexts as well.
2907d763cef2SBarry Smith 
290894b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
29090298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2910d763cef2SBarry Smith 
2911d763cef2SBarry Smith    Level: beginner
2912d763cef2SBarry Smith 
291394b7f48cSBarry Smith .keywords: timestep, get, KSP
2914d763cef2SBarry Smith @*/
29157087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2916d763cef2SBarry Smith {
2917d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2918089b2837SJed Brown   SNES           snes;
2919d372ba47SLisandro Dalcin 
2920d763cef2SBarry Smith   PetscFunctionBegin;
29210700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29224482741eSBarry Smith   PetscValidPointer(ksp,2);
292317186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2924e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2925089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2926089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2927d763cef2SBarry Smith   PetscFunctionReturn(0);
2928d763cef2SBarry Smith }
2929d763cef2SBarry Smith 
2930d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2931d763cef2SBarry Smith 
2932adb62b0dSMatthew Knepley /*@
2933618ce8baSLisandro Dalcin    TSSetMaxSteps - Sets the maximum number of steps to use.
2934618ce8baSLisandro Dalcin 
2935618ce8baSLisandro Dalcin    Logically Collective on TS
2936618ce8baSLisandro Dalcin 
2937618ce8baSLisandro Dalcin    Input Parameters:
2938618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2939618ce8baSLisandro Dalcin -  maxsteps - maximum number of steps to use
2940618ce8baSLisandro Dalcin 
2941618ce8baSLisandro Dalcin    Options Database Keys:
2942618ce8baSLisandro Dalcin .  -ts_max_steps <maxsteps> - Sets maxsteps
2943618ce8baSLisandro Dalcin 
2944618ce8baSLisandro Dalcin    Notes:
2945618ce8baSLisandro Dalcin    The default maximum number of steps is 5000
2946618ce8baSLisandro Dalcin 
2947618ce8baSLisandro Dalcin    Level: intermediate
2948618ce8baSLisandro Dalcin 
2949618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, steps
2950618ce8baSLisandro Dalcin 
2951618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime()
2952618ce8baSLisandro Dalcin @*/
2953618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps)
2954618ce8baSLisandro Dalcin {
2955618ce8baSLisandro Dalcin   PetscFunctionBegin;
2956618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2957618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2958618ce8baSLisandro Dalcin   if (maxsteps < 0 ) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative");
2959618ce8baSLisandro Dalcin   ts->max_steps = maxsteps;
2960618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2961618ce8baSLisandro Dalcin }
2962618ce8baSLisandro Dalcin 
2963618ce8baSLisandro Dalcin /*@
2964618ce8baSLisandro Dalcin    TSGetMaxSteps - Gets the maximum number of steps to use.
2965618ce8baSLisandro Dalcin 
2966618ce8baSLisandro Dalcin    Not Collective
2967618ce8baSLisandro Dalcin 
2968618ce8baSLisandro Dalcin    Input Parameters:
2969618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2970618ce8baSLisandro Dalcin 
2971618ce8baSLisandro Dalcin    Output Parameter:
2972618ce8baSLisandro Dalcin .  maxsteps - maximum number of steps to use
2973618ce8baSLisandro Dalcin 
2974618ce8baSLisandro Dalcin    Level: advanced
2975618ce8baSLisandro Dalcin 
2976618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, steps
2977618ce8baSLisandro Dalcin 
2978618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime()
2979618ce8baSLisandro Dalcin @*/
2980618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps)
2981618ce8baSLisandro Dalcin {
2982618ce8baSLisandro Dalcin   PetscFunctionBegin;
2983618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2984618ce8baSLisandro Dalcin   PetscValidIntPointer(maxsteps,2);
2985618ce8baSLisandro Dalcin   *maxsteps = ts->max_steps;
2986618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2987618ce8baSLisandro Dalcin }
2988618ce8baSLisandro Dalcin 
2989618ce8baSLisandro Dalcin /*@
2990618ce8baSLisandro Dalcin    TSSetMaxTime - Sets the maximum (or final) time for timestepping.
2991618ce8baSLisandro Dalcin 
2992618ce8baSLisandro Dalcin    Logically Collective on TS
2993618ce8baSLisandro Dalcin 
2994618ce8baSLisandro Dalcin    Input Parameters:
2995618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2996618ce8baSLisandro Dalcin -  maxtime - final time to step to
2997618ce8baSLisandro Dalcin 
2998618ce8baSLisandro Dalcin    Options Database Keys:
2999ef85077eSLisandro Dalcin .  -ts_max_time <maxtime> - Sets maxtime
3000618ce8baSLisandro Dalcin 
3001618ce8baSLisandro Dalcin    Notes:
3002618ce8baSLisandro Dalcin    The default maximum time is 5.0
3003618ce8baSLisandro Dalcin 
3004618ce8baSLisandro Dalcin    Level: intermediate
3005618ce8baSLisandro Dalcin 
3006618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, time
3007618ce8baSLisandro Dalcin 
3008618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime()
3009618ce8baSLisandro Dalcin @*/
3010618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime)
3011618ce8baSLisandro Dalcin {
3012618ce8baSLisandro Dalcin   PetscFunctionBegin;
3013618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3014618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveReal(ts,maxtime,2);
3015618ce8baSLisandro Dalcin   ts->max_time = maxtime;
3016618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3017618ce8baSLisandro Dalcin }
3018618ce8baSLisandro Dalcin 
3019618ce8baSLisandro Dalcin /*@
3020618ce8baSLisandro Dalcin    TSGetMaxTime - Gets the maximum (or final) time for timestepping.
3021618ce8baSLisandro Dalcin 
3022618ce8baSLisandro Dalcin    Not Collective
3023618ce8baSLisandro Dalcin 
3024618ce8baSLisandro Dalcin    Input Parameters:
3025618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
3026618ce8baSLisandro Dalcin 
3027618ce8baSLisandro Dalcin    Output Parameter:
3028618ce8baSLisandro Dalcin .  maxtime - final time to step to
3029618ce8baSLisandro Dalcin 
3030618ce8baSLisandro Dalcin    Level: advanced
3031618ce8baSLisandro Dalcin 
3032618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, time
3033618ce8baSLisandro Dalcin 
3034618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps()
3035618ce8baSLisandro Dalcin @*/
3036618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime)
3037618ce8baSLisandro Dalcin {
3038618ce8baSLisandro Dalcin   PetscFunctionBegin;
3039618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3040618ce8baSLisandro Dalcin   PetscValidRealPointer(maxtime,2);
3041618ce8baSLisandro Dalcin   *maxtime = ts->max_time;
3042618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3043618ce8baSLisandro Dalcin }
3044618ce8baSLisandro Dalcin 
3045618ce8baSLisandro Dalcin /*@
3046aaa6c58dSLisandro Dalcin    TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep().
3047edc382c3SSatish Balay 
3048edc382c3SSatish Balay    Level: deprecated
3049edc382c3SSatish Balay 
3050aaa6c58dSLisandro Dalcin @*/
3051aaa6c58dSLisandro Dalcin PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
3052aaa6c58dSLisandro Dalcin {
3053aaa6c58dSLisandro Dalcin   PetscErrorCode ierr;
3054aaa6c58dSLisandro Dalcin   PetscFunctionBegin;
3055aaa6c58dSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3056aaa6c58dSLisandro Dalcin   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
3057aaa6c58dSLisandro Dalcin   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
3058aaa6c58dSLisandro Dalcin   PetscFunctionReturn(0);
3059aaa6c58dSLisandro Dalcin }
3060aaa6c58dSLisandro Dalcin 
3061aaa6c58dSLisandro Dalcin /*@
306219eac22cSLisandro Dalcin    TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime().
3063edc382c3SSatish Balay 
3064edc382c3SSatish Balay    Level: deprecated
3065edc382c3SSatish Balay 
3066adb62b0dSMatthew Knepley @*/
30677087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
3068adb62b0dSMatthew Knepley {
3069adb62b0dSMatthew Knepley   PetscFunctionBegin;
30700700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3071abc0a331SBarry Smith   if (maxsteps) {
30724482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
3073adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
3074adb62b0dSMatthew Knepley   }
3075abc0a331SBarry Smith   if (maxtime) {
30764482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
3077adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
3078adb62b0dSMatthew Knepley   }
3079adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
3080adb62b0dSMatthew Knepley }
3081adb62b0dSMatthew Knepley 
3082d763cef2SBarry Smith /*@
308319eac22cSLisandro Dalcin    TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime().
3084edc382c3SSatish Balay 
3085edc382c3SSatish Balay    Level: deprecated
3086edc382c3SSatish Balay 
3087d763cef2SBarry Smith @*/
30887087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
3089d763cef2SBarry Smith {
3090d763cef2SBarry Smith   PetscFunctionBegin;
30910700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3092c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
3093c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
309439b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
309539b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
3096d763cef2SBarry Smith   PetscFunctionReturn(0);
3097d763cef2SBarry Smith }
3098d763cef2SBarry Smith 
3099d763cef2SBarry Smith /*@
31005c5f5948SLisandro Dalcin    TSGetTimeStepNumber - Deprecated, use TSGetStepNumber().
3101edc382c3SSatish Balay 
3102edc382c3SSatish Balay    Level: deprecated
3103edc382c3SSatish Balay 
31045c5f5948SLisandro Dalcin @*/
3105e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31065c5f5948SLisandro Dalcin 
310719eac22cSLisandro Dalcin /*@
31084f4e0956SLisandro Dalcin    TSGetTotalSteps - Deprecated, use TSGetStepNumber().
3109edc382c3SSatish Balay 
3110edc382c3SSatish Balay    Level: deprecated
3111edc382c3SSatish Balay 
31124f4e0956SLisandro Dalcin @*/
31134f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31144f4e0956SLisandro Dalcin 
31154f4e0956SLisandro Dalcin /*@
3116d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
3117d763cef2SBarry Smith    for use by the TS routines.
3118d763cef2SBarry Smith 
31193f9fe445SBarry Smith    Logically Collective on TS and Vec
3120d763cef2SBarry Smith 
3121d763cef2SBarry Smith    Input Parameters:
3122d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
31230910c330SBarry Smith -  u - the solution vector
3124d763cef2SBarry Smith 
3125d763cef2SBarry Smith    Level: beginner
3126d763cef2SBarry Smith 
3127715f1b00SHong Zhang .keywords: TS, timestep, set, solution, initial values
3128*0ed3bfb6SBarry Smith 
3129*0ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate()
3130d763cef2SBarry Smith @*/
31310910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
3132d763cef2SBarry Smith {
31338737fe31SLisandro Dalcin   PetscErrorCode ierr;
3134496e6a7aSJed Brown   DM             dm;
31358737fe31SLisandro Dalcin 
3136d763cef2SBarry Smith   PetscFunctionBegin;
31370700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31380910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
31390910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
31406bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
31410910c330SBarry Smith   ts->vec_sol = u;
3142bbd56ea5SKarl Rupp 
3143496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
31440910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
3145d763cef2SBarry Smith   PetscFunctionReturn(0);
3146d763cef2SBarry Smith }
3147d763cef2SBarry Smith 
314873b18844SBarry Smith /*@
314973b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
315073b18844SBarry Smith 
315173b18844SBarry Smith    Logically Collective on TS
315273b18844SBarry Smith 
315373b18844SBarry Smith    Input Parameters:
315473b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
315573b18844SBarry Smith .  steps - number of steps to use
315673b18844SBarry Smith 
315773b18844SBarry Smith    Level: intermediate
315873b18844SBarry Smith 
315973b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
316073b18844SBarry Smith           so as to integrate back to less than the original timestep
316173b18844SBarry Smith 
316273b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
316373b18844SBarry Smith 
316473b18844SBarry Smith .seealso: TSSetExactFinalTime()
316573b18844SBarry Smith @*/
316673b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
316773b18844SBarry Smith {
316873b18844SBarry Smith   PetscFunctionBegin;
316973b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
317073b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
317173b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
31722808aa04SLisandro Dalcin   if (steps > ts->steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps");
317373b18844SBarry Smith   ts->adjoint_max_steps = steps;
317473b18844SBarry Smith   PetscFunctionReturn(0);
317573b18844SBarry Smith }
317673b18844SBarry Smith 
3177c235aa8dSHong Zhang /*@
3178715f1b00SHong Zhang    TSSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial values and w.r.t. the problem parameters
31790cf82b59SBarry Smith       for use by the TSAdjoint routines.
3180c235aa8dSHong Zhang 
3181c235aa8dSHong Zhang    Logically Collective on TS and Vec
3182c235aa8dSHong Zhang 
3183c235aa8dSHong Zhang    Input Parameters:
3184c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
3185abc2977eSBarry Smith .  lambda - gradients with respect to the initial condition variables, the dimension and parallel layout of these vectors is the same as the ODE solution vector
3186abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
3187c235aa8dSHong Zhang 
3188c235aa8dSHong Zhang    Level: beginner
3189c235aa8dSHong Zhang 
3190abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
31910cf82b59SBarry Smith 
31921585b412SBarry Smith    After TSAdjointSolve() is called the lamba and the mu contain the computed sensitivities
31931585b412SBarry Smith 
3194715f1b00SHong Zhang .keywords: TS, timestep, set, sensitivity, initial values
3195c235aa8dSHong Zhang @*/
3196dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
3197c235aa8dSHong Zhang {
3198c235aa8dSHong Zhang   PetscFunctionBegin;
3199c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3200abc2977eSBarry Smith   PetscValidPointer(lambda,2);
3201abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
3202abc2977eSBarry Smith   ts->vecs_sensip = mu;
3203dfb21088SHong Zhang   if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostIntegrand");
3204abc2977eSBarry Smith   ts->numcost  = numcost;
3205ad8e2604SHong Zhang   PetscFunctionReturn(0);
3206ad8e2604SHong Zhang }
3207ad8e2604SHong Zhang 
3208ad8e2604SHong Zhang /*@C
32090cf82b59SBarry Smith   TSAdjointSetRHSJacobian - Sets the function that computes the Jacobian of G w.r.t. the parameters p where y_t = G(y,p,t), as well as the location to store the matrix.
3210ad8e2604SHong Zhang 
3211ad8e2604SHong Zhang   Logically Collective on TS
3212ad8e2604SHong Zhang 
3213ad8e2604SHong Zhang   Input Parameters:
3214ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
3215ad8e2604SHong Zhang - func - The function
3216ad8e2604SHong Zhang 
3217ad8e2604SHong Zhang   Calling sequence of func:
32180cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
321905755b9cSHong Zhang +   t - current timestep
32200cf82b59SBarry Smith .   y - input vector (current ODE solution)
322105755b9cSHong Zhang .   A - output matrix
322205755b9cSHong Zhang -   ctx - [optional] user-defined function context
3223ad8e2604SHong Zhang 
3224ad8e2604SHong Zhang   Level: intermediate
3225ad8e2604SHong Zhang 
32260cf82b59SBarry Smith   Notes: Amat has the same number of rows and the same row parallel layout as u, Amat has the same number of columns and parallel layout as p
32270cf82b59SBarry Smith 
3228ad8e2604SHong Zhang .keywords: TS, sensitivity
3229ad8e2604SHong Zhang .seealso:
3230ad8e2604SHong Zhang @*/
32315bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
3232ad8e2604SHong Zhang {
3233ad8e2604SHong Zhang   PetscErrorCode ierr;
3234ad8e2604SHong Zhang 
3235ad8e2604SHong Zhang   PetscFunctionBegin;
3236ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
323723706b9aSHong Zhang   PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
3238ad8e2604SHong Zhang 
3239ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
3240ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
3241ad8e2604SHong Zhang   if(Amat) {
3242ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
3243ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
3244ad8e2604SHong Zhang     ts->Jacp = Amat;
3245ad8e2604SHong Zhang   }
3246ad8e2604SHong Zhang   PetscFunctionReturn(0);
3247ad8e2604SHong Zhang }
3248ad8e2604SHong Zhang 
32490cf82b59SBarry Smith /*@C
32505bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
3251ad8e2604SHong Zhang 
3252ad8e2604SHong Zhang   Collective on TS
3253ad8e2604SHong Zhang 
3254ad8e2604SHong Zhang   Input Parameters:
3255ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
3256ad8e2604SHong Zhang 
3257ad8e2604SHong Zhang   Level: developer
3258ad8e2604SHong Zhang 
3259ad8e2604SHong Zhang .keywords: TS, sensitivity
32605bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
3261ad8e2604SHong Zhang @*/
32625bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
3263ad8e2604SHong Zhang {
3264ad8e2604SHong Zhang   PetscErrorCode ierr;
3265ad8e2604SHong Zhang 
3266ad8e2604SHong Zhang   PetscFunctionBegin;
3267ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3268ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
3269ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
3270ad8e2604SHong Zhang 
3271ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
3272ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
3273ad8e2604SHong Zhang   PetscStackPop;
3274c235aa8dSHong Zhang   PetscFunctionReturn(0);
3275c235aa8dSHong Zhang }
3276c235aa8dSHong Zhang 
32776fd0887fSHong Zhang /*@C
3278dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
32796fd0887fSHong Zhang 
32806fd0887fSHong Zhang     Logically Collective on TS
32816fd0887fSHong Zhang 
32826fd0887fSHong Zhang     Input Parameters:
32836fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
3284abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
32853d1d12c6SHong Zhang .   costintegral - vector that stores the integral values
32860cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
3287b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
3288b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
3289feaa1ddbSSatish Balay .   fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run
3290b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
32916fd0887fSHong Zhang 
32920cf82b59SBarry Smith     Calling sequence of rf:
32933d1d12c6SHong Zhang $   PetscErrorCode rf(TS ts,PetscReal t,Vec y,Vec f,void *ctx);
32946fd0887fSHong Zhang 
3295b612ec54SBarry Smith     Calling sequence of drdyf:
32960cf82b59SBarry Smith $   PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
3297b612ec54SBarry Smith 
3298b612ec54SBarry Smith     Calling sequence of drdpf:
32990cf82b59SBarry Smith $   PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
3300b612ec54SBarry Smith 
3301b612ec54SBarry Smith     Level: intermediate
33026fd0887fSHong Zhang 
3303715f1b00SHong Zhang     Notes: For optimization there is usually a single cost function (numcost = 1). For sensitivities there may be multiple cost functions
33040cf82b59SBarry Smith 
33056fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
33066fd0887fSHong Zhang 
3307dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
33086fd0887fSHong Zhang @*/
33093d1d12c6SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost,Vec costintegral,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
3310d8151eeaSBarry Smith                                                           PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
3311b1cb36f3SHong Zhang                                                           PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),
3312b1cb36f3SHong Zhang                                                           PetscBool fwd,void *ctx)
33136fd0887fSHong Zhang {
33146fd0887fSHong Zhang   PetscErrorCode ierr;
33156fd0887fSHong Zhang 
33166fd0887fSHong Zhang   PetscFunctionBegin;
33176fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33183d1d12c6SHong Zhang   if (costintegral) PetscValidHeaderSpecific(costintegral,VEC_CLASSID,3);
3319715f1b00SHong Zhang   if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostGradients() or TSForwardSetIntegralGradients()");
3320c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
33216fd0887fSHong Zhang 
33223d1d12c6SHong Zhang   if (costintegral) {
33233d1d12c6SHong Zhang     ierr = PetscObjectReference((PetscObject)costintegral);CHKERRQ(ierr);
33243d1d12c6SHong Zhang     ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
33253d1d12c6SHong Zhang     ts->vec_costintegral = costintegral;
3326afe7b317SHong Zhang   } else {
3327afe7b317SHong Zhang     if (!ts->vec_costintegral) { /* Create a seq vec if user does not provide one */
3328afe7b317SHong Zhang       ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
3329afe7b317SHong Zhang     } else {
3330afe7b317SHong Zhang       ierr = VecSet(ts->vec_costintegral,0.0);CHKERRQ(ierr);
3331afe7b317SHong Zhang     }
3332afe7b317SHong Zhang   }
3333afe7b317SHong Zhang   if (!ts->vec_costintegrand) {
33342c39e106SBarry Smith     ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
3335afe7b317SHong Zhang   } else {
3336afe7b317SHong Zhang     ierr = VecSet(ts->vec_costintegrand,0.0);CHKERRQ(ierr);
3337afe7b317SHong Zhang   }
3338afe7b317SHong Zhang   ts->costintegralfwd  = fwd; /* Evaluate the cost integral in forward run if fwd is true */
33390cf82b59SBarry Smith   ts->costintegrand    = rf;
334005755b9cSHong Zhang   ts->costintegrandctx = ctx;
3341b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
3342b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
33436fd0887fSHong Zhang   PetscFunctionReturn(0);
33446fd0887fSHong Zhang }
33456fd0887fSHong Zhang 
334636eaed60SHong Zhang /*@
3347dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
334836eaed60SHong Zhang    It is valid to call the routine after a backward run.
334936eaed60SHong Zhang 
335036eaed60SHong Zhang    Not Collective
335136eaed60SHong Zhang 
335236eaed60SHong Zhang    Input Parameter:
335336eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
335436eaed60SHong Zhang 
335536eaed60SHong Zhang    Output Parameter:
33562c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
335736eaed60SHong Zhang 
335836eaed60SHong Zhang    Level: intermediate
335936eaed60SHong Zhang 
3360dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
336136eaed60SHong Zhang 
336236eaed60SHong Zhang .keywords: TS, sensitivity analysis
336336eaed60SHong Zhang @*/
3364dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
336536eaed60SHong Zhang {
336636eaed60SHong Zhang   PetscFunctionBegin;
336736eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
336836eaed60SHong Zhang   PetscValidPointer(v,2);
33692c39e106SBarry Smith   *v = ts->vec_costintegral;
337036eaed60SHong Zhang   PetscFunctionReturn(0);
337136eaed60SHong Zhang }
337236eaed60SHong Zhang 
33736fd0887fSHong Zhang /*@
3374022c081aSHong Zhang    TSComputeCostIntegrand - Evaluates the integral function in the cost functions.
33756fd0887fSHong Zhang 
33766fd0887fSHong Zhang    Input Parameters:
33776fd0887fSHong Zhang +  ts - the TS context
33786fd0887fSHong Zhang .  t - current time
33790cf82b59SBarry Smith -  y - state vector, i.e. current solution
33806fd0887fSHong Zhang 
33816fd0887fSHong Zhang    Output Parameter:
3382abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
33836fd0887fSHong Zhang 
33846fd0887fSHong Zhang    Note:
33856fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
33866fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
33876fd0887fSHong Zhang 
33886fd0887fSHong Zhang    Level: developer
33896fd0887fSHong Zhang 
33906fd0887fSHong Zhang .keywords: TS, compute
33916fd0887fSHong Zhang 
3392dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
33936fd0887fSHong Zhang @*/
3394022c081aSHong Zhang PetscErrorCode TSComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
33956fd0887fSHong Zhang {
33966fd0887fSHong Zhang   PetscErrorCode ierr;
33976fd0887fSHong Zhang 
33986fd0887fSHong Zhang   PetscFunctionBegin;
33996fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34000cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
34016fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
34026fd0887fSHong Zhang 
34030cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
3404e4680132SHong Zhang   if (ts->costintegrand) {
3405e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
34060cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
34076fd0887fSHong Zhang     PetscStackPop;
34086fd0887fSHong Zhang   } else {
34096fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
34106fd0887fSHong Zhang   }
34116fd0887fSHong Zhang 
34120cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
34136fd0887fSHong Zhang   PetscFunctionReturn(0);
34146fd0887fSHong Zhang }
34156fd0887fSHong Zhang 
341605755b9cSHong Zhang /*@
3417d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
341805755b9cSHong Zhang 
341905755b9cSHong Zhang   Collective on TS
342005755b9cSHong Zhang 
342105755b9cSHong Zhang   Input Parameters:
342205755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
342305755b9cSHong Zhang 
342405755b9cSHong Zhang   Notes:
3425d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
342605755b9cSHong Zhang   so most users would not generally call this routine themselves.
342705755b9cSHong Zhang 
342805755b9cSHong Zhang   Level: developer
342905755b9cSHong Zhang 
343005755b9cSHong Zhang .keywords: TS, sensitivity
3431d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
343205755b9cSHong Zhang @*/
34330cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
343405755b9cSHong Zhang {
343505755b9cSHong Zhang   PetscErrorCode ierr;
343605755b9cSHong Zhang 
343705755b9cSHong Zhang   PetscFunctionBegin;
343805755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34390cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
344005755b9cSHong Zhang 
344105755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
34420cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
344305755b9cSHong Zhang   PetscStackPop;
344405755b9cSHong Zhang   PetscFunctionReturn(0);
344505755b9cSHong Zhang }
344605755b9cSHong Zhang 
344705755b9cSHong Zhang /*@
3448d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
344905755b9cSHong Zhang 
345005755b9cSHong Zhang   Collective on TS
345105755b9cSHong Zhang 
345205755b9cSHong Zhang   Input Parameters:
345305755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
345405755b9cSHong Zhang 
345505755b9cSHong Zhang   Notes:
345605755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
345705755b9cSHong Zhang   so most users would not generally call this routine themselves.
345805755b9cSHong Zhang 
345905755b9cSHong Zhang   Level: developer
346005755b9cSHong Zhang 
346105755b9cSHong Zhang .keywords: TS, sensitivity
3462d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
346305755b9cSHong Zhang @*/
34640cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
346505755b9cSHong Zhang {
346605755b9cSHong Zhang   PetscErrorCode ierr;
346705755b9cSHong Zhang 
346805755b9cSHong Zhang   PetscFunctionBegin;
346905755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34700cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
347105755b9cSHong Zhang 
347205755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
34730cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
347405755b9cSHong Zhang   PetscStackPop;
347505755b9cSHong Zhang   PetscFunctionReturn(0);
347605755b9cSHong Zhang }
347705755b9cSHong Zhang 
3478ac226902SBarry Smith /*@C
3479000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
34803f2090d5SJed Brown   called once at the beginning of each time step.
3481000e7ae3SMatthew Knepley 
34823f9fe445SBarry Smith   Logically Collective on TS
3483000e7ae3SMatthew Knepley 
3484000e7ae3SMatthew Knepley   Input Parameters:
3485000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3486000e7ae3SMatthew Knepley - func - The function
3487000e7ae3SMatthew Knepley 
3488000e7ae3SMatthew Knepley   Calling sequence of func:
3489000e7ae3SMatthew Knepley . func (TS ts);
3490000e7ae3SMatthew Knepley 
3491000e7ae3SMatthew Knepley   Level: intermediate
3492000e7ae3SMatthew Knepley 
3493000e7ae3SMatthew Knepley .keywords: TS, timestep
3494dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep()
3495000e7ae3SMatthew Knepley @*/
34967087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3497000e7ae3SMatthew Knepley {
3498000e7ae3SMatthew Knepley   PetscFunctionBegin;
34990700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3500ae60f76fSBarry Smith   ts->prestep = func;
3501000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3502000e7ae3SMatthew Knepley }
3503000e7ae3SMatthew Knepley 
350409ee8438SJed Brown /*@
35053f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
35063f2090d5SJed Brown 
35073f2090d5SJed Brown   Collective on TS
35083f2090d5SJed Brown 
35093f2090d5SJed Brown   Input Parameters:
35103f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
35113f2090d5SJed Brown 
35123f2090d5SJed Brown   Notes:
35133f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
35143f2090d5SJed Brown   so most users would not generally call this routine themselves.
35153f2090d5SJed Brown 
35163f2090d5SJed Brown   Level: developer
35173f2090d5SJed Brown 
35183f2090d5SJed Brown .keywords: TS, timestep
35199be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
35203f2090d5SJed Brown @*/
35217087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
35223f2090d5SJed Brown {
35233f2090d5SJed Brown   PetscErrorCode ierr;
35243f2090d5SJed Brown 
35253f2090d5SJed Brown   PetscFunctionBegin;
35260700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3527ae60f76fSBarry Smith   if (ts->prestep) {
35285efd42a4SStefano Zampini     Vec              U;
35295efd42a4SStefano Zampini     PetscObjectState sprev,spost;
35305efd42a4SStefano Zampini 
35315efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
35325efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3533ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
35345efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3535dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3536312ce896SJed Brown   }
35373f2090d5SJed Brown   PetscFunctionReturn(0);
35383f2090d5SJed Brown }
35393f2090d5SJed Brown 
3540b8123daeSJed Brown /*@C
3541b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3542b8123daeSJed Brown   called once at the beginning of each stage.
3543b8123daeSJed Brown 
3544b8123daeSJed Brown   Logically Collective on TS
3545b8123daeSJed Brown 
3546b8123daeSJed Brown   Input Parameters:
3547b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3548b8123daeSJed Brown - func - The function
3549b8123daeSJed Brown 
3550b8123daeSJed Brown   Calling sequence of func:
3551b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
3552b8123daeSJed Brown 
3553b8123daeSJed Brown   Level: intermediate
3554b8123daeSJed Brown 
3555b8123daeSJed Brown   Note:
3556b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
355780275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
3558b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3559b8123daeSJed Brown 
3560b8123daeSJed Brown .keywords: TS, timestep
35619be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3562b8123daeSJed Brown @*/
3563b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3564b8123daeSJed Brown {
3565b8123daeSJed Brown   PetscFunctionBegin;
3566b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3567ae60f76fSBarry Smith   ts->prestage = func;
3568b8123daeSJed Brown   PetscFunctionReturn(0);
3569b8123daeSJed Brown }
3570b8123daeSJed Brown 
35719be3e283SDebojyoti Ghosh /*@C
35729be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
35739be3e283SDebojyoti Ghosh   called once at the end of each stage.
35749be3e283SDebojyoti Ghosh 
35759be3e283SDebojyoti Ghosh   Logically Collective on TS
35769be3e283SDebojyoti Ghosh 
35779be3e283SDebojyoti Ghosh   Input Parameters:
35789be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
35799be3e283SDebojyoti Ghosh - func - The function
35809be3e283SDebojyoti Ghosh 
35819be3e283SDebojyoti Ghosh   Calling sequence of func:
35829be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
35839be3e283SDebojyoti Ghosh 
35849be3e283SDebojyoti Ghosh   Level: intermediate
35859be3e283SDebojyoti Ghosh 
35869be3e283SDebojyoti Ghosh   Note:
35879be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
358880275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
35899be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
35909be3e283SDebojyoti Ghosh 
35919be3e283SDebojyoti Ghosh .keywords: TS, timestep
35929be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
35939be3e283SDebojyoti Ghosh @*/
35949be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
35959be3e283SDebojyoti Ghosh {
35969be3e283SDebojyoti Ghosh   PetscFunctionBegin;
35979be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
35989be3e283SDebojyoti Ghosh   ts->poststage = func;
35999be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
36009be3e283SDebojyoti Ghosh }
36019be3e283SDebojyoti Ghosh 
3602c688d042SShri Abhyankar /*@C
3603c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3604c688d042SShri Abhyankar   called once at the end of each step evaluation.
3605c688d042SShri Abhyankar 
3606c688d042SShri Abhyankar   Logically Collective on TS
3607c688d042SShri Abhyankar 
3608c688d042SShri Abhyankar   Input Parameters:
3609c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3610c688d042SShri Abhyankar - func - The function
3611c688d042SShri Abhyankar 
3612c688d042SShri Abhyankar   Calling sequence of func:
3613c688d042SShri Abhyankar . PetscErrorCode func(TS ts);
3614c688d042SShri Abhyankar 
3615c688d042SShri Abhyankar   Level: intermediate
3616c688d042SShri Abhyankar 
3617c688d042SShri Abhyankar   Note:
36181785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
36191785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3620e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3621e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3622e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3623c688d042SShri Abhyankar 
3624c688d042SShri Abhyankar .keywords: TS, timestep
3625c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3626c688d042SShri Abhyankar @*/
3627c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3628c688d042SShri Abhyankar {
3629c688d042SShri Abhyankar   PetscFunctionBegin;
3630c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3631c688d042SShri Abhyankar   ts->postevaluate = func;
3632c688d042SShri Abhyankar   PetscFunctionReturn(0);
3633c688d042SShri Abhyankar }
3634c688d042SShri Abhyankar 
3635b8123daeSJed Brown /*@
3636b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3637b8123daeSJed Brown 
3638b8123daeSJed Brown   Collective on TS
3639b8123daeSJed Brown 
3640b8123daeSJed Brown   Input Parameters:
3641b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
36429be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3643b8123daeSJed Brown 
3644b8123daeSJed Brown   Notes:
3645b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3646b8123daeSJed Brown   most users would not generally call this routine themselves.
3647b8123daeSJed Brown 
3648b8123daeSJed Brown   Level: developer
3649b8123daeSJed Brown 
3650b8123daeSJed Brown .keywords: TS, timestep
36519be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3652b8123daeSJed Brown @*/
3653b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3654b8123daeSJed Brown {
3655b8123daeSJed Brown   PetscErrorCode ierr;
3656b8123daeSJed Brown 
3657b8123daeSJed Brown   PetscFunctionBegin;
3658b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3659ae60f76fSBarry Smith   if (ts->prestage) {
3660ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3661b8123daeSJed Brown   }
3662b8123daeSJed Brown   PetscFunctionReturn(0);
3663b8123daeSJed Brown }
3664b8123daeSJed Brown 
36659be3e283SDebojyoti Ghosh /*@
36669be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
36679be3e283SDebojyoti Ghosh 
36689be3e283SDebojyoti Ghosh   Collective on TS
36699be3e283SDebojyoti Ghosh 
36709be3e283SDebojyoti Ghosh   Input Parameters:
36719be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
36729be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
36739be3e283SDebojyoti Ghosh   stageindex  - Stage number
36749be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
36759be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
36769be3e283SDebojyoti Ghosh 
36779be3e283SDebojyoti Ghosh   Notes:
36789be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
36799be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
36809be3e283SDebojyoti Ghosh 
36819be3e283SDebojyoti Ghosh   Level: developer
36829be3e283SDebojyoti Ghosh 
36839be3e283SDebojyoti Ghosh .keywords: TS, timestep
36849be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
36859be3e283SDebojyoti Ghosh @*/
36869be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
36879be3e283SDebojyoti Ghosh {
36889be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
36899be3e283SDebojyoti Ghosh 
36909be3e283SDebojyoti Ghosh   PetscFunctionBegin;
36919be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
36924beae5d8SLisandro Dalcin   if (ts->poststage) {
36939be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
36949be3e283SDebojyoti Ghosh   }
36959be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
36969be3e283SDebojyoti Ghosh }
36979be3e283SDebojyoti Ghosh 
3698c688d042SShri Abhyankar /*@
3699c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3700c688d042SShri Abhyankar 
3701c688d042SShri Abhyankar   Collective on TS
3702c688d042SShri Abhyankar 
3703c688d042SShri Abhyankar   Input Parameters:
3704c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3705c688d042SShri Abhyankar 
3706c688d042SShri Abhyankar   Notes:
3707c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3708c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3709c688d042SShri Abhyankar 
3710c688d042SShri Abhyankar   Level: developer
3711c688d042SShri Abhyankar 
3712c688d042SShri Abhyankar .keywords: TS, timestep
3713c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3714c688d042SShri Abhyankar @*/
3715c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3716c688d042SShri Abhyankar {
3717c688d042SShri Abhyankar   PetscErrorCode ierr;
3718c688d042SShri Abhyankar 
3719c688d042SShri Abhyankar   PetscFunctionBegin;
3720c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3721c688d042SShri Abhyankar   if (ts->postevaluate) {
3722dcb233daSLisandro Dalcin     Vec              U;
3723dcb233daSLisandro Dalcin     PetscObjectState sprev,spost;
3724dcb233daSLisandro Dalcin 
3725dcb233daSLisandro Dalcin     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
3726dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3727c688d042SShri Abhyankar     PetscStackCallStandard((*ts->postevaluate),(ts));
3728dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3729dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3730c688d042SShri Abhyankar   }
3731c688d042SShri Abhyankar   PetscFunctionReturn(0);
3732c688d042SShri Abhyankar }
3733c688d042SShri Abhyankar 
3734ac226902SBarry Smith /*@C
3735000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
37363f2090d5SJed Brown   called once at the end of each time step.
3737000e7ae3SMatthew Knepley 
37383f9fe445SBarry Smith   Logically Collective on TS
3739000e7ae3SMatthew Knepley 
3740000e7ae3SMatthew Knepley   Input Parameters:
3741000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3742000e7ae3SMatthew Knepley - func - The function
3743000e7ae3SMatthew Knepley 
3744000e7ae3SMatthew Knepley   Calling sequence of func:
3745b8123daeSJed Brown $ func (TS ts);
3746000e7ae3SMatthew Knepley 
37471785ff2aSShri Abhyankar   Notes:
37481785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
37491785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
37501785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
37511785ff2aSShri Abhyankar 
3752000e7ae3SMatthew Knepley   Level: intermediate
3753000e7ae3SMatthew Knepley 
3754000e7ae3SMatthew Knepley .keywords: TS, timestep
3755dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep()
3756000e7ae3SMatthew Knepley @*/
37577087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3758000e7ae3SMatthew Knepley {
3759000e7ae3SMatthew Knepley   PetscFunctionBegin;
37600700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3761ae60f76fSBarry Smith   ts->poststep = func;
3762000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3763000e7ae3SMatthew Knepley }
3764000e7ae3SMatthew Knepley 
376509ee8438SJed Brown /*@
37663f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
37673f2090d5SJed Brown 
37683f2090d5SJed Brown   Collective on TS
37693f2090d5SJed Brown 
37703f2090d5SJed Brown   Input Parameters:
37713f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
37723f2090d5SJed Brown 
37733f2090d5SJed Brown   Notes:
37743f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
37753f2090d5SJed Brown   so most users would not generally call this routine themselves.
37763f2090d5SJed Brown 
37773f2090d5SJed Brown   Level: developer
37783f2090d5SJed Brown 
37793f2090d5SJed Brown .keywords: TS, timestep
37803f2090d5SJed Brown @*/
37817087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
37823f2090d5SJed Brown {
37833f2090d5SJed Brown   PetscErrorCode ierr;
37843f2090d5SJed Brown 
37853f2090d5SJed Brown   PetscFunctionBegin;
37860700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3787ae60f76fSBarry Smith   if (ts->poststep) {
37885efd42a4SStefano Zampini     Vec              U;
37895efd42a4SStefano Zampini     PetscObjectState sprev,spost;
37905efd42a4SStefano Zampini 
37915efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
37925efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3793ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
37945efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3795dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
379672ac3e02SJed Brown   }
37973f2090d5SJed Brown   PetscFunctionReturn(0);
37983f2090d5SJed Brown }
37993f2090d5SJed Brown 
3800d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3801d763cef2SBarry Smith 
3802d763cef2SBarry Smith /*@C
3803a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3804d763cef2SBarry Smith    timestep to display the iteration's  progress.
3805d763cef2SBarry Smith 
38063f9fe445SBarry Smith    Logically Collective on TS
3807d763cef2SBarry Smith 
3808d763cef2SBarry Smith    Input Parameters:
3809d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3810e213d8f1SJed Brown .  monitor - monitoring routine
3811329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
38120298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3813b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
38140298fd71SBarry Smith           (may be NULL)
3815d763cef2SBarry Smith 
3816e213d8f1SJed Brown    Calling sequence of monitor:
3817dcb233daSLisandro Dalcin $    PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3818d763cef2SBarry Smith 
3819d763cef2SBarry Smith +    ts - the TS context
382063e21af5SBarry 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)
38211f06c33eSBarry Smith .    time - current time
38220910c330SBarry Smith .    u - current iterate
3823d763cef2SBarry Smith -    mctx - [optional] monitoring context
3824d763cef2SBarry Smith 
3825d763cef2SBarry Smith    Notes:
3826d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3827d763cef2SBarry Smith    already has been loaded.
3828d763cef2SBarry Smith 
3829025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
3830025f1a04SBarry Smith 
3831d763cef2SBarry Smith    Level: intermediate
3832d763cef2SBarry Smith 
3833d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3834d763cef2SBarry Smith 
3835a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3836d763cef2SBarry Smith @*/
3837c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3838d763cef2SBarry Smith {
383978064530SBarry Smith   PetscErrorCode ierr;
384078064530SBarry Smith   PetscInt       i;
384178064530SBarry Smith   PetscBool      identical;
384278064530SBarry Smith 
3843d763cef2SBarry Smith   PetscFunctionBegin;
38440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
384578064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
384678064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
384778064530SBarry Smith     if (identical) PetscFunctionReturn(0);
384878064530SBarry Smith   }
384917186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3850d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
38518704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3852d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3853d763cef2SBarry Smith   PetscFunctionReturn(0);
3854d763cef2SBarry Smith }
3855d763cef2SBarry Smith 
3856d763cef2SBarry Smith /*@C
3857a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3858d763cef2SBarry Smith 
38593f9fe445SBarry Smith    Logically Collective on TS
3860d763cef2SBarry Smith 
3861d763cef2SBarry Smith    Input Parameters:
3862d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3863d763cef2SBarry Smith 
3864d763cef2SBarry Smith    Notes:
3865d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3866d763cef2SBarry Smith 
3867d763cef2SBarry Smith    Level: intermediate
3868d763cef2SBarry Smith 
3869d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3870d763cef2SBarry Smith 
3871a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3872d763cef2SBarry Smith @*/
38737087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3874d763cef2SBarry Smith {
3875d952e501SBarry Smith   PetscErrorCode ierr;
3876d952e501SBarry Smith   PetscInt       i;
3877d952e501SBarry Smith 
3878d763cef2SBarry Smith   PetscFunctionBegin;
38790700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3880d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
38818704b422SBarry Smith     if (ts->monitordestroy[i]) {
38828704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3883d952e501SBarry Smith     }
3884d952e501SBarry Smith   }
3885d763cef2SBarry Smith   ts->numbermonitors = 0;
3886d763cef2SBarry Smith   PetscFunctionReturn(0);
3887d763cef2SBarry Smith }
3888d763cef2SBarry Smith 
3889721cd6eeSBarry Smith /*@C
3890721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
38915516499fSSatish Balay 
38925516499fSSatish Balay    Level: intermediate
389341251cbbSSatish Balay 
38945516499fSSatish Balay .keywords: TS, set, monitor
38955516499fSSatish Balay 
389663e21af5SBarry Smith .seealso:  TSMonitorSet()
389741251cbbSSatish Balay @*/
3898721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3899d763cef2SBarry Smith {
3900dfbe8321SBarry Smith   PetscErrorCode ierr;
3901721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
390241aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3903d132466eSBarry Smith 
3904d763cef2SBarry Smith   PetscFunctionBegin;
39054d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
390641aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
390741aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3908721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
390941aca3d6SBarry Smith   if (iascii) {
3910649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
391163e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
391263e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
391363e21af5SBarry Smith     } else {
39148392e04aSShri 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);
391563e21af5SBarry Smith     }
3916649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
391741aca3d6SBarry Smith   } else if (ibinary) {
391841aca3d6SBarry Smith     PetscMPIInt rank;
391941aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
392041aca3d6SBarry Smith     if (!rank) {
3921450a797fSBarry Smith       PetscBool skipHeader;
3922450a797fSBarry Smith       PetscInt  classid = REAL_FILE_CLASSID;
3923450a797fSBarry Smith 
3924450a797fSBarry Smith       ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr);
3925450a797fSBarry Smith       if (!skipHeader) {
3926450a797fSBarry Smith          ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
3927450a797fSBarry Smith        }
392841aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
392941aca3d6SBarry Smith     } else {
393041aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
393141aca3d6SBarry Smith     }
393241aca3d6SBarry Smith   }
3933721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3934d763cef2SBarry Smith   PetscFunctionReturn(0);
3935d763cef2SBarry Smith }
3936d763cef2SBarry Smith 
39379110b2e7SHong Zhang /*@C
39389110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
39399110b2e7SHong Zhang    timestep to display the iteration's  progress.
39409110b2e7SHong Zhang 
39419110b2e7SHong Zhang    Logically Collective on TS
39429110b2e7SHong Zhang 
39439110b2e7SHong Zhang    Input Parameters:
39449110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
39459110b2e7SHong Zhang .  adjointmonitor - monitoring routine
39469110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
39479110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
39489110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
39499110b2e7SHong Zhang           (may be NULL)
39509110b2e7SHong Zhang 
39519110b2e7SHong Zhang    Calling sequence of monitor:
39529110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
39539110b2e7SHong Zhang 
39549110b2e7SHong Zhang +    ts - the TS context
39559110b2e7SHong Zhang .    steps - iteration number (after the final time step the monitor routine is called with a step of -1, this is at the final time which may have
39569110b2e7SHong Zhang                                been interpolated to)
39579110b2e7SHong Zhang .    time - current time
39589110b2e7SHong Zhang .    u - current iterate
39599110b2e7SHong Zhang .    numcost - number of cost functionos
39609110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
39619110b2e7SHong Zhang .    mu - sensitivities to parameters
39629110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
39639110b2e7SHong Zhang 
39649110b2e7SHong Zhang    Notes:
39659110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
39669110b2e7SHong Zhang    already has been loaded.
39679110b2e7SHong Zhang 
39689110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
39699110b2e7SHong Zhang 
39709110b2e7SHong Zhang    Level: intermediate
39719110b2e7SHong Zhang 
39729110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
39739110b2e7SHong Zhang 
39749110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
39759110b2e7SHong Zhang @*/
39769110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
39779110b2e7SHong Zhang {
397878064530SBarry Smith   PetscErrorCode ierr;
397978064530SBarry Smith   PetscInt       i;
398078064530SBarry Smith   PetscBool      identical;
398178064530SBarry Smith 
39829110b2e7SHong Zhang   PetscFunctionBegin;
39839110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
398478064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
398578064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr);
398678064530SBarry Smith     if (identical) PetscFunctionReturn(0);
398778064530SBarry Smith   }
39889110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
39899110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
39909110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
39919110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
39929110b2e7SHong Zhang   PetscFunctionReturn(0);
39939110b2e7SHong Zhang }
39949110b2e7SHong Zhang 
39959110b2e7SHong Zhang /*@C
39969110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
39979110b2e7SHong Zhang 
39989110b2e7SHong Zhang    Logically Collective on TS
39999110b2e7SHong Zhang 
40009110b2e7SHong Zhang    Input Parameters:
40019110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
40029110b2e7SHong Zhang 
40039110b2e7SHong Zhang    Notes:
40049110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
40059110b2e7SHong Zhang 
40069110b2e7SHong Zhang    Level: intermediate
40079110b2e7SHong Zhang 
40089110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
40099110b2e7SHong Zhang 
40109110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
40119110b2e7SHong Zhang @*/
40129110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
40139110b2e7SHong Zhang {
40149110b2e7SHong Zhang   PetscErrorCode ierr;
40159110b2e7SHong Zhang   PetscInt       i;
40169110b2e7SHong Zhang 
40179110b2e7SHong Zhang   PetscFunctionBegin;
40189110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
40199110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
40209110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
40219110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
40229110b2e7SHong Zhang     }
40239110b2e7SHong Zhang   }
40249110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
40259110b2e7SHong Zhang   PetscFunctionReturn(0);
40269110b2e7SHong Zhang }
40279110b2e7SHong Zhang 
4028721cd6eeSBarry Smith /*@C
4029721cd6eeSBarry Smith    TSAdjointMonitorDefault - the default monitor of adjoint computations
4030110eb670SHong Zhang 
4031110eb670SHong Zhang    Level: intermediate
4032110eb670SHong Zhang 
4033110eb670SHong Zhang .keywords: TS, set, monitor
4034110eb670SHong Zhang 
4035110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
4036110eb670SHong Zhang @*/
4037721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
4038110eb670SHong Zhang {
4039110eb670SHong Zhang   PetscErrorCode ierr;
4040721cd6eeSBarry Smith   PetscViewer    viewer = vf->viewer;
4041110eb670SHong Zhang 
4042110eb670SHong Zhang   PetscFunctionBegin;
4043110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
4044721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
4045110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
4046110eb670SHong Zhang   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr);
4047110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
4048721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
4049110eb670SHong Zhang   PetscFunctionReturn(0);
4050110eb670SHong Zhang }
4051110eb670SHong Zhang 
4052cd652676SJed Brown /*@
4053cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
4054cd652676SJed Brown 
4055cd652676SJed Brown    Collective on TS
4056cd652676SJed Brown 
4057cd652676SJed Brown    Input Argument:
4058cd652676SJed Brown +  ts - time stepping context
4059cd652676SJed Brown -  t - time to interpolate to
4060cd652676SJed Brown 
4061cd652676SJed Brown    Output Argument:
40620910c330SBarry Smith .  U - state at given time
4063cd652676SJed Brown 
4064cd652676SJed Brown    Level: intermediate
4065cd652676SJed Brown 
4066cd652676SJed Brown    Developer Notes:
4067cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
4068cd652676SJed Brown 
4069cd652676SJed Brown .keywords: TS, set
4070cd652676SJed Brown 
4071874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
4072cd652676SJed Brown @*/
40730910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
4074cd652676SJed Brown {
4075cd652676SJed Brown   PetscErrorCode ierr;
4076cd652676SJed Brown 
4077cd652676SJed Brown   PetscFunctionBegin;
4078cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4079b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4080be5899b3SLisandro 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);
4081ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
40820910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
4083cd652676SJed Brown   PetscFunctionReturn(0);
4084cd652676SJed Brown }
4085cd652676SJed Brown 
4086d763cef2SBarry Smith /*@
40876d9e5789SSean Farley    TSStep - Steps one time step
4088d763cef2SBarry Smith 
4089d763cef2SBarry Smith    Collective on TS
4090d763cef2SBarry Smith 
4091d763cef2SBarry Smith    Input Parameter:
4092d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4093d763cef2SBarry Smith 
409427829d71SBarry Smith    Level: developer
4095d763cef2SBarry Smith 
4096b8123daeSJed Brown    Notes:
409727829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
409827829d71SBarry Smith 
4099b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
4100b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
4101b8123daeSJed Brown 
410219eac22cSLisandro Dalcin    This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the
410319eac22cSLisandro Dalcin    time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
410425cb2221SBarry Smith 
4105d763cef2SBarry Smith .keywords: TS, timestep, solve
4106d763cef2SBarry Smith 
41079be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
4108d763cef2SBarry Smith @*/
4109193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
4110d763cef2SBarry Smith {
4111dfbe8321SBarry Smith   PetscErrorCode   ierr;
4112fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
4113be5899b3SLisandro Dalcin   PetscReal        ptime;
4114d763cef2SBarry Smith 
4115d763cef2SBarry Smith   PetscFunctionBegin;
41160700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4117fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
4118fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
4119fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
4120fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
4121fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
4122fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
4123302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
4124fffbeea8SBarry Smith 
4125d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
412668bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4127d405a339SMatthew Knepley 
4128ef85077eSLisandro 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>");
4129a6772fa2SLisandro 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()");
4130be5899b3SLisandro 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");
4131a6772fa2SLisandro Dalcin 
4132be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
4133be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
41342808aa04SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
4135e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
4136d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
4137193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
4138d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
4139be5899b3SLisandro Dalcin   ts->ptime_prev = ptime;
41402808aa04SLisandro Dalcin   ts->steps++;
4141be5899b3SLisandro Dalcin   ts->steprollback = PETSC_FALSE;
414228d5b5d6SLisandro Dalcin   ts->steprestart  = PETSC_FALSE;
4143362cd11cSLisandro Dalcin 
4144362cd11cSLisandro Dalcin   if (ts->reason < 0) {
4145cef5090cSJed Brown     if (ts->errorifstepfailed) {
414608c7845fSBarry Smith       if (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]);
414708c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
4148d2daff3dSHong Zhang     }
414908c7845fSBarry Smith   } else if (!ts->reason) {
415008c7845fSBarry Smith     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
415108c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
415208c7845fSBarry Smith   }
415308c7845fSBarry Smith   PetscFunctionReturn(0);
415408c7845fSBarry Smith }
415508c7845fSBarry Smith 
415608c7845fSBarry Smith /*@
4157b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
415808c7845fSBarry Smith 
415908c7845fSBarry Smith    Collective on TS
416008c7845fSBarry Smith 
416108c7845fSBarry Smith    Input Parameter:
416208c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
416308c7845fSBarry Smith 
41646a4d4014SLisandro Dalcin    Level: intermediate
41656a4d4014SLisandro Dalcin 
4166b957a604SHong Zhang .keywords: TS, adjoint, step
41676a4d4014SLisandro Dalcin 
4168b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
41696a4d4014SLisandro Dalcin @*/
417008c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
41716a4d4014SLisandro Dalcin {
417208c7845fSBarry Smith   DM               dm;
41736a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
41746a4d4014SLisandro Dalcin 
41756a4d4014SLisandro Dalcin   PetscFunctionBegin;
41764a2ae208SSatish Balay   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
417708c7845fSBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
417808c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
4179d763cef2SBarry Smith 
4180685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr);
4181d763cef2SBarry Smith 
4182be5899b3SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
4183be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime;
418442f2b339SBarry Smith   if (!ts->ops->adjointstep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed because the adjoint of  %s has not been implemented, try other time stepping methods for adjoint sensitivity analysis",((PetscObject)ts)->type_name);
4185be5899b3SLisandro Dalcin   ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
418642f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
41878d0ad7a8SHong Zhang   ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
41882808aa04SLisandro Dalcin   ts->adjoint_steps++; ts->steps--;
4189362cd11cSLisandro Dalcin 
4190362cd11cSLisandro Dalcin   if (ts->reason < 0) {
4191cef5090cSJed Brown     if (ts->errorifstepfailed) {
41926c4ed002SBarry Smith       if (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]);
41936c4ed002SBarry Smith       else if (ts->reason == TS_DIVERGED_STEP_REJECTED) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_reject or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
41946c4ed002SBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
4195cef5090cSJed Brown     }
4196362cd11cSLisandro Dalcin   } else if (!ts->reason) {
41972808aa04SLisandro Dalcin     if (ts->adjoint_steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
4198362cd11cSLisandro Dalcin   }
4199d763cef2SBarry Smith   PetscFunctionReturn(0);
4200d763cef2SBarry Smith }
4201d763cef2SBarry Smith 
42027cbde773SLisandro Dalcin /*@
42037cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
42047cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
42057cbde773SLisandro Dalcin 
42067cbde773SLisandro Dalcin    Collective on TS
42077cbde773SLisandro Dalcin 
42087cbde773SLisandro Dalcin    Input Arguments:
42097cbde773SLisandro Dalcin +  ts - time stepping context
42107cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
42117cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
42127cbde773SLisandro Dalcin 
42137cbde773SLisandro Dalcin    Output Arguments:
42147cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
42157cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
42167cbde773SLisandro Dalcin 
42177cbde773SLisandro Dalcin    Level: advanced
42187cbde773SLisandro Dalcin 
42197cbde773SLisandro Dalcin    Notes:
42207cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
42217cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
42227cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
42237cbde773SLisandro Dalcin 
42247cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
42257cbde773SLisandro Dalcin @*/
42267cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
42277cbde773SLisandro Dalcin {
42287cbde773SLisandro Dalcin   PetscErrorCode ierr;
42297cbde773SLisandro Dalcin 
42307cbde773SLisandro Dalcin   PetscFunctionBegin;
42317cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
42327cbde773SLisandro Dalcin   PetscValidType(ts,1);
42337cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
42347cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
42357cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
42367cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
42377cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
42387cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
42397cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
42407cbde773SLisandro Dalcin   PetscFunctionReturn(0);
42417cbde773SLisandro Dalcin }
42427cbde773SLisandro Dalcin 
424305175c85SJed Brown /*@
424405175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
424505175c85SJed Brown 
42461c3436cfSJed Brown    Collective on TS
424705175c85SJed Brown 
424805175c85SJed Brown    Input Arguments:
42491c3436cfSJed Brown +  ts - time stepping context
42501c3436cfSJed Brown .  order - desired order of accuracy
42510298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
425205175c85SJed Brown 
425305175c85SJed Brown    Output Arguments:
42540910c330SBarry Smith .  U - state at the end of the current step
425505175c85SJed Brown 
425605175c85SJed Brown    Level: advanced
425705175c85SJed Brown 
4258108c343cSJed Brown    Notes:
4259108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
4260108c343cSJed 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.
4261108c343cSJed Brown 
42621c3436cfSJed Brown .seealso: TSStep(), TSAdapt
426305175c85SJed Brown @*/
42640910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
426505175c85SJed Brown {
426605175c85SJed Brown   PetscErrorCode ierr;
426705175c85SJed Brown 
426805175c85SJed Brown   PetscFunctionBegin;
426905175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
427005175c85SJed Brown   PetscValidType(ts,1);
42710910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4272ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
42730910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
427405175c85SJed Brown   PetscFunctionReturn(0);
427505175c85SJed Brown }
427605175c85SJed Brown 
4277b1cb36f3SHong Zhang /*@
4278b1cb36f3SHong Zhang    TSForwardCostIntegral - Evaluate the cost integral in the forward run.
4279b1cb36f3SHong Zhang 
4280b1cb36f3SHong Zhang    Collective on TS
4281b1cb36f3SHong Zhang 
4282b1cb36f3SHong Zhang    Input Arguments:
4283b1cb36f3SHong Zhang .  ts - time stepping context
4284b1cb36f3SHong Zhang 
4285b1cb36f3SHong Zhang    Level: advanced
4286b1cb36f3SHong Zhang 
4287b1cb36f3SHong Zhang    Notes:
4288b1cb36f3SHong Zhang    This function cannot be called until TSStep() has been completed.
4289b1cb36f3SHong Zhang 
4290b1cb36f3SHong Zhang .seealso: TSSolve(), TSAdjointCostIntegral()
4291b1cb36f3SHong Zhang @*/
4292b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts)
4293b1cb36f3SHong Zhang {
4294b1cb36f3SHong Zhang   PetscErrorCode ierr;
4295b1cb36f3SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4296b1cb36f3SHong Zhang   if (!ts->ops->forwardintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the forward run",((PetscObject)ts)->type_name);
4297b1cb36f3SHong Zhang   ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr);
4298b1cb36f3SHong Zhang   PetscFunctionReturn(0);
4299b1cb36f3SHong Zhang }
4300d67e68b7SBarry Smith 
4301d763cef2SBarry Smith /*@
4302d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
4303d763cef2SBarry Smith 
4304d763cef2SBarry Smith    Collective on TS
4305d763cef2SBarry Smith 
4306d763cef2SBarry Smith    Input Parameter:
4307d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
430863e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
430963e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
43105a3a76d0SJed Brown 
4311d763cef2SBarry Smith    Level: beginner
4312d763cef2SBarry Smith 
43135a3a76d0SJed Brown    Notes:
43145a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
43155a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
43165a3a76d0SJed Brown    stepped over the final time.
43175a3a76d0SJed Brown 
4318d763cef2SBarry Smith .keywords: TS, timestep, solve
4319d763cef2SBarry Smith 
432063e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
4321d763cef2SBarry Smith @*/
4322cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
4323d763cef2SBarry Smith {
4324b06615a5SLisandro Dalcin   Vec               solution;
4325d763cef2SBarry Smith   PetscErrorCode    ierr;
4326d763cef2SBarry Smith 
4327d763cef2SBarry Smith   PetscFunctionBegin;
4328d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4329f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
4330feed9e9dSBarry Smith 
4331ee41a567SStefano 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 */
43320910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
4333b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
4334b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
4335b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
43365a3a76d0SJed Brown     }
43370910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
4338715f1b00SHong Zhang     if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
4339bbd56ea5SKarl Rupp   } else if (u) {
43400910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
43415a3a76d0SJed Brown   }
4342b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
434368bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4344a6772fa2SLisandro Dalcin 
4345ef85077eSLisandro 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>");
4346a6772fa2SLisandro 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()");
4347a6772fa2SLisandro 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");
4348a6772fa2SLisandro Dalcin 
4349715f1b00SHong Zhang   if (ts->forward_solve) {
4350715f1b00SHong Zhang     ierr = TSForwardSetUp(ts);CHKERRQ(ierr);
4351715f1b00SHong Zhang   }
4352715f1b00SHong Zhang 
4353e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
4354715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
4355e7069c78SShri      TSTrajectory to incorrectly save the output files
4356e7069c78SShri   */
4357715f1b00SHong Zhang   /* reset time step and iteration counters */
43582808aa04SLisandro Dalcin   if (!ts->steps) {
43595ef26d82SJed Brown     ts->ksp_its           = 0;
43605ef26d82SJed Brown     ts->snes_its          = 0;
4361c610991cSLisandro Dalcin     ts->num_snes_failures = 0;
4362c610991cSLisandro Dalcin     ts->reject            = 0;
43632808aa04SLisandro Dalcin     ts->steprestart       = PETSC_TRUE;
43642808aa04SLisandro Dalcin     ts->steprollback      = PETSC_FALSE;
43652808aa04SLisandro Dalcin   }
436610bc0e4dSStefano Zampini   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && ts->ptime + ts->time_step > ts->max_time) ts->time_step = ts->max_time - ts->ptime;
4367193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
4368193ac0bcSJed Brown 
4369ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
4370f05ece33SBarry Smith 
4371193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
4372193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
4373a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4374cc708dedSBarry Smith     ts->solvetime = ts->ptime;
4375a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
4376be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
4377db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
4378db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
4379e7069c78SShri 
43802808aa04SLisandro Dalcin     if (!ts->steps) {
43812808aa04SLisandro Dalcin       ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
43826427ac75SLisandro Dalcin       ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
43832808aa04SLisandro Dalcin     }
43846427ac75SLisandro Dalcin 
4385e1a7a14fSJed Brown     while (!ts->reason) {
43862808aa04SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
43879687d888SLisandro Dalcin       if (!ts->steprollback) {
43889687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
43899687d888SLisandro Dalcin       }
4390193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
4391e783b05fSHong Zhang       if (ts->vec_costintegral && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */
4392b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
4393b1cb36f3SHong Zhang       }
439458818c2dSLisandro Dalcin       if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */
4395715f1b00SHong Zhang         ierr = TSForwardStep(ts);CHKERRQ(ierr);
4396715f1b00SHong Zhang       }
439710b82f12SShri Abhyankar       ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
4398e783b05fSHong 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. */
439958818c2dSLisandro Dalcin       if (ts->steprollback) {
440058818c2dSLisandro Dalcin         ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
440158818c2dSLisandro Dalcin       }
4402e783b05fSHong Zhang       if (!ts->steprollback) {
44032808aa04SLisandro Dalcin         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
44041eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
4405aeb4809dSShri Abhyankar       }
4406193ac0bcSJed Brown     }
44072808aa04SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
44086427ac75SLisandro Dalcin 
440949354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
44100910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
4411cc708dedSBarry Smith       ts->solvetime = ts->max_time;
4412b06615a5SLisandro Dalcin       solution = u;
441363e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
44140574a7fbSJed Brown     } else {
4415ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4416cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4417b06615a5SLisandro Dalcin       solution = ts->vec_sol;
44180574a7fbSJed Brown     }
4419193ac0bcSJed Brown   }
4420d2daff3dSHong Zhang 
4421ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
442263e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
442356f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
4424ef222394SBarry Smith   if (ts->adjoint_solve) {
4425ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
44262b0a91c0SBarry Smith   }
4427d763cef2SBarry Smith   PetscFunctionReturn(0);
4428d763cef2SBarry Smith }
4429d763cef2SBarry Smith 
4430b1cb36f3SHong Zhang /*@
4431b1cb36f3SHong Zhang  TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run.
4432b1cb36f3SHong Zhang 
4433b1cb36f3SHong Zhang  Collective on TS
4434b1cb36f3SHong Zhang 
4435b1cb36f3SHong Zhang  Input Arguments:
4436b1cb36f3SHong Zhang  .  ts - time stepping context
4437b1cb36f3SHong Zhang 
4438b1cb36f3SHong Zhang  Level: advanced
4439b1cb36f3SHong Zhang 
4440b1cb36f3SHong Zhang  Notes:
4441b1cb36f3SHong Zhang  This function cannot be called until TSAdjointStep() has been completed.
4442b1cb36f3SHong Zhang 
4443b1cb36f3SHong Zhang  .seealso: TSAdjointSolve(), TSAdjointStep
4444b1cb36f3SHong Zhang  @*/
4445b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts)
4446b1cb36f3SHong Zhang {
4447b1cb36f3SHong Zhang     PetscErrorCode ierr;
4448b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4449b1cb36f3SHong Zhang     if (!ts->ops->adjointintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the adjoint run",((PetscObject)ts)->type_name);
4450b1cb36f3SHong Zhang     ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr);
4451b1cb36f3SHong Zhang     PetscFunctionReturn(0);
4452b1cb36f3SHong Zhang }
4453b1cb36f3SHong Zhang 
4454c88f2d44SBarry Smith /*@
4455c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
4456c88f2d44SBarry Smith 
4457c88f2d44SBarry Smith    Collective on TS
4458c88f2d44SBarry Smith 
4459c88f2d44SBarry Smith    Input Parameter:
44602c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
4461c88f2d44SBarry Smith 
4462e87fd094SBarry Smith    Options Database:
4463715f1b00SHong Zhang . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial values
4464e87fd094SBarry Smith 
4465c88f2d44SBarry Smith    Level: intermediate
4466c88f2d44SBarry Smith 
4467c88f2d44SBarry Smith    Notes:
4468c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
4469c88f2d44SBarry Smith 
447073b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
447173b18844SBarry Smith 
4472c88f2d44SBarry Smith .keywords: TS, timestep, solve
4473c88f2d44SBarry Smith 
4474b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
4475c88f2d44SBarry Smith @*/
44762c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
4477c88f2d44SBarry Smith {
4478c88f2d44SBarry Smith   PetscErrorCode    ierr;
4479c88f2d44SBarry Smith 
4480c88f2d44SBarry Smith   PetscFunctionBegin;
4481c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4482c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
448368bece0bSHong Zhang 
4484c88f2d44SBarry Smith   /* reset time step and iteration counters */
44852808aa04SLisandro Dalcin   ts->adjoint_steps     = 0;
4486c88f2d44SBarry Smith   ts->ksp_its           = 0;
4487c88f2d44SBarry Smith   ts->snes_its          = 0;
4488c88f2d44SBarry Smith   ts->num_snes_failures = 0;
4489c88f2d44SBarry Smith   ts->reject            = 0;
4490c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
4491c88f2d44SBarry Smith 
44922808aa04SLisandro Dalcin   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->steps;
44932808aa04SLisandro Dalcin   if (ts->adjoint_steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
4494c88f2d44SBarry Smith 
4495c88f2d44SBarry Smith   while (!ts->reason) {
44962808aa04SLisandro Dalcin     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->steps,&ts->ptime);CHKERRQ(ierr);
44972808aa04SLisandro Dalcin     ierr = TSAdjointMonitor(ts,ts->steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
44986427ac75SLisandro Dalcin     ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr);
4499616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
4500b1cb36f3SHong Zhang     if (ts->vec_costintegral && !ts->costintegralfwd) {
4501b1cb36f3SHong Zhang       ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr);
4502b1cb36f3SHong Zhang     }
4503c88f2d44SBarry Smith   }
45042808aa04SLisandro Dalcin   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->steps,&ts->ptime);CHKERRQ(ierr);
45052808aa04SLisandro Dalcin   ierr = TSAdjointMonitor(ts,ts->steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
4506c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
4507e210cd0eSHong Zhang   ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr);
4508685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
450911e1d5c3SBarry Smith   ts->adjoint_max_steps = 0;
4510c88f2d44SBarry Smith   PetscFunctionReturn(0);
4511c88f2d44SBarry Smith }
4512c88f2d44SBarry Smith 
45137db568b7SBarry Smith /*@C
4514228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4515228d79bcSJed Brown 
4516228d79bcSJed Brown    Collective on TS
4517228d79bcSJed Brown 
4518228d79bcSJed Brown    Input Parameters:
4519228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
4520228d79bcSJed Brown .  step - step number that has just completed
4521228d79bcSJed Brown .  ptime - model time of the state
45220910c330SBarry Smith -  u - state at the current model time
4523228d79bcSJed Brown 
4524228d79bcSJed Brown    Notes:
45257db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
45267db568b7SBarry Smith    Users would almost never call this routine directly.
4527228d79bcSJed Brown 
452863e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
452963e21af5SBarry Smith 
45307db568b7SBarry Smith    Level: developer
4531228d79bcSJed Brown 
4532228d79bcSJed Brown .keywords: TS, timestep
4533228d79bcSJed Brown @*/
45340910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4535d763cef2SBarry Smith {
4536d6152f81SLisandro Dalcin   DM             dm;
4537a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
4538d6152f81SLisandro Dalcin   PetscErrorCode ierr;
4539d763cef2SBarry Smith 
4540d763cef2SBarry Smith   PetscFunctionBegin;
4541b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4542b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4543d6152f81SLisandro Dalcin 
4544d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
4545d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
4546d6152f81SLisandro Dalcin 
45475edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
4548d763cef2SBarry Smith   for (i=0; i<n; i++) {
45490910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
4550d763cef2SBarry Smith   }
45515edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
4552d763cef2SBarry Smith   PetscFunctionReturn(0);
4553d763cef2SBarry Smith }
4554d763cef2SBarry Smith 
45557db568b7SBarry Smith /*@C
45569110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
45579110b2e7SHong Zhang 
45589110b2e7SHong Zhang    Collective on TS
45599110b2e7SHong Zhang 
45609110b2e7SHong Zhang    Input Parameters:
45619110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
45629110b2e7SHong Zhang .  step - step number that has just completed
45639110b2e7SHong Zhang .  ptime - model time of the state
45649110b2e7SHong Zhang .  u - state at the current model time
45659110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
45669110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
45679110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
45689110b2e7SHong Zhang 
45699110b2e7SHong Zhang    Notes:
45707db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
45717db568b7SBarry Smith    Users would almost never call this routine directly.
45729110b2e7SHong Zhang 
45737db568b7SBarry Smith    Level: developer
45749110b2e7SHong Zhang 
45759110b2e7SHong Zhang .keywords: TS, timestep
45769110b2e7SHong Zhang @*/
45779110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
45789110b2e7SHong Zhang {
45799110b2e7SHong Zhang   PetscErrorCode ierr;
45809110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
45819110b2e7SHong Zhang 
45829110b2e7SHong Zhang   PetscFunctionBegin;
45839110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45849110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
45859110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
45869110b2e7SHong Zhang   for (i=0; i<n; i++) {
45879110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
45889110b2e7SHong Zhang   }
45899110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
45909110b2e7SHong Zhang   PetscFunctionReturn(0);
45919110b2e7SHong Zhang }
45929110b2e7SHong Zhang 
4593d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
4594d763cef2SBarry Smith /*@C
45957db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4596a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
4597d763cef2SBarry Smith 
4598d763cef2SBarry Smith    Collective on TS
4599d763cef2SBarry Smith 
4600d763cef2SBarry Smith    Input Parameters:
4601d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
4602d763cef2SBarry Smith .  label - the title to put in the title bar
46037c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
4604a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
4605a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4606d763cef2SBarry Smith 
4607d763cef2SBarry Smith    Output Parameter:
46080b039ecaSBarry Smith .  ctx - the context
4609d763cef2SBarry Smith 
4610d763cef2SBarry Smith    Options Database Key:
46114f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
46128b668821SLisandro Dalcin +  -ts_monitor_lg_timestep_log - automatically sets line graph monitor
46137db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
46147db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
46157db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
46167db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4617b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4618d763cef2SBarry Smith 
4619d763cef2SBarry Smith    Notes:
4620a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
4621d763cef2SBarry Smith 
46227db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
46237db568b7SBarry Smith 
46247db568b7SBarry 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
46257db568b7SBarry 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
46267db568b7SBarry Smith    as the first argument.
46277db568b7SBarry Smith 
46287db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
46297db568b7SBarry Smith 
4630d763cef2SBarry Smith    Level: intermediate
4631d763cef2SBarry Smith 
46327db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
4633d763cef2SBarry Smith 
46347db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
46357db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
46367db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
46377db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
46387db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
46397c922b88SBarry Smith 
4640d763cef2SBarry Smith @*/
4641a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4642d763cef2SBarry Smith {
46437f52daa2SLisandro Dalcin   PetscDraw      draw;
4644dfbe8321SBarry Smith   PetscErrorCode ierr;
4645d763cef2SBarry Smith 
4646d763cef2SBarry Smith   PetscFunctionBegin;
4647b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
46487f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
46497f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
46507f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
4651287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
46527f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
4653a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
4654d763cef2SBarry Smith   PetscFunctionReturn(0);
4655d763cef2SBarry Smith }
4656d763cef2SBarry Smith 
4657b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4658d763cef2SBarry Smith {
46590b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4660c32365f1SBarry Smith   PetscReal      x   = ptime,y;
4661dfbe8321SBarry Smith   PetscErrorCode ierr;
4662d763cef2SBarry Smith 
4663d763cef2SBarry Smith   PetscFunctionBegin;
466463e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
4665b06615a5SLisandro Dalcin   if (!step) {
4666a9f9c1f6SBarry Smith     PetscDrawAxis axis;
46678b668821SLisandro Dalcin     const char *ylabel = ctx->semilogy ? "Log Time Step" : "Time Step";
4668a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
46698b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time",ylabel);CHKERRQ(ierr);
4670a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4671a9f9c1f6SBarry Smith   }
4672c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
46738b668821SLisandro Dalcin   if (ctx->semilogy) y = PetscLog10Real(y);
46740b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
4675b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
46760b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
46776934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
46783923b477SBarry Smith   }
4679d763cef2SBarry Smith   PetscFunctionReturn(0);
4680d763cef2SBarry Smith }
4681d763cef2SBarry Smith 
4682d763cef2SBarry Smith /*@C
4683a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4684a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
4685d763cef2SBarry Smith 
46860b039ecaSBarry Smith    Collective on TSMonitorLGCtx
4687d763cef2SBarry Smith 
4688d763cef2SBarry Smith    Input Parameter:
46890b039ecaSBarry Smith .  ctx - the monitor context
4690d763cef2SBarry Smith 
4691d763cef2SBarry Smith    Level: intermediate
4692d763cef2SBarry Smith 
4693d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
4694d763cef2SBarry Smith 
46954f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
4696d763cef2SBarry Smith @*/
4697a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4698d763cef2SBarry Smith {
4699dfbe8321SBarry Smith   PetscErrorCode ierr;
4700d763cef2SBarry Smith 
4701d763cef2SBarry Smith   PetscFunctionBegin;
47027684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
47037684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
47047684fa3eSBarry Smith   }
47050b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
470631152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
4707387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
4708387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
4709387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
47100b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
4711d763cef2SBarry Smith   PetscFunctionReturn(0);
4712d763cef2SBarry Smith }
4713d763cef2SBarry Smith 
4714d763cef2SBarry Smith /*@
4715b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4716d763cef2SBarry Smith 
4717d763cef2SBarry Smith    Not Collective
4718d763cef2SBarry Smith 
4719d763cef2SBarry Smith    Input Parameter:
4720d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4721d763cef2SBarry Smith 
4722d763cef2SBarry Smith    Output Parameter:
472319eac22cSLisandro Dalcin .  t  - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime().
4724d763cef2SBarry Smith 
4725d763cef2SBarry Smith    Level: beginner
4726d763cef2SBarry Smith 
4727b8123daeSJed Brown    Note:
4728b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
47299be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4730b8123daeSJed Brown 
4731aaa6c58dSLisandro Dalcin .seealso:  TSGetSolveTime(), TSSetTime(), TSGetTimeStep()
4732d763cef2SBarry Smith 
4733d763cef2SBarry Smith .keywords: TS, get, time
4734d763cef2SBarry Smith @*/
47357087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4736d763cef2SBarry Smith {
4737d763cef2SBarry Smith   PetscFunctionBegin;
47380700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4739f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4740d763cef2SBarry Smith   *t = ts->ptime;
4741d763cef2SBarry Smith   PetscFunctionReturn(0);
4742d763cef2SBarry Smith }
4743d763cef2SBarry Smith 
4744e5e524a1SHong Zhang /*@
4745e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4746e5e524a1SHong Zhang 
4747e5e524a1SHong Zhang    Not Collective
4748e5e524a1SHong Zhang 
4749e5e524a1SHong Zhang    Input Parameter:
4750e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4751e5e524a1SHong Zhang 
4752e5e524a1SHong Zhang    Output Parameter:
4753e5e524a1SHong Zhang .  t  - the previous time
4754e5e524a1SHong Zhang 
4755e5e524a1SHong Zhang    Level: beginner
4756e5e524a1SHong Zhang 
4757aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep()
4758e5e524a1SHong Zhang 
4759e5e524a1SHong Zhang .keywords: TS, get, time
4760e5e524a1SHong Zhang @*/
4761e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4762e5e524a1SHong Zhang {
4763e5e524a1SHong Zhang   PetscFunctionBegin;
4764e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4765e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4766e5e524a1SHong Zhang   *t = ts->ptime_prev;
4767e5e524a1SHong Zhang   PetscFunctionReturn(0);
4768e5e524a1SHong Zhang }
4769e5e524a1SHong Zhang 
47706a4d4014SLisandro Dalcin /*@
47716a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
47726a4d4014SLisandro Dalcin 
47733f9fe445SBarry Smith    Logically Collective on TS
47746a4d4014SLisandro Dalcin 
47756a4d4014SLisandro Dalcin    Input Parameters:
47766a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
47776a4d4014SLisandro Dalcin -  time - the time
47786a4d4014SLisandro Dalcin 
47796a4d4014SLisandro Dalcin    Level: intermediate
47806a4d4014SLisandro Dalcin 
478119eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps()
47826a4d4014SLisandro Dalcin 
47836a4d4014SLisandro Dalcin .keywords: TS, set, time
47846a4d4014SLisandro Dalcin @*/
47857087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
47866a4d4014SLisandro Dalcin {
47876a4d4014SLisandro Dalcin   PetscFunctionBegin;
47880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4789c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
47906a4d4014SLisandro Dalcin   ts->ptime = t;
47916a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
47926a4d4014SLisandro Dalcin }
47936a4d4014SLisandro Dalcin 
4794d763cef2SBarry Smith /*@C
4795d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4796d763cef2SBarry Smith    TS options in the database.
4797d763cef2SBarry Smith 
47983f9fe445SBarry Smith    Logically Collective on TS
4799d763cef2SBarry Smith 
4800d763cef2SBarry Smith    Input Parameter:
4801d763cef2SBarry Smith +  ts     - The TS context
4802d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4803d763cef2SBarry Smith 
4804d763cef2SBarry Smith    Notes:
4805d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4806d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4807d763cef2SBarry Smith    hyphen.
4808d763cef2SBarry Smith 
4809d763cef2SBarry Smith    Level: advanced
4810d763cef2SBarry Smith 
4811d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
4812d763cef2SBarry Smith 
4813d763cef2SBarry Smith .seealso: TSSetFromOptions()
4814d763cef2SBarry Smith 
4815d763cef2SBarry Smith @*/
48167087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4817d763cef2SBarry Smith {
4818dfbe8321SBarry Smith   PetscErrorCode ierr;
4819089b2837SJed Brown   SNES           snes;
4820d763cef2SBarry Smith 
4821d763cef2SBarry Smith   PetscFunctionBegin;
48220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4823d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4824089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4825089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4826d763cef2SBarry Smith   PetscFunctionReturn(0);
4827d763cef2SBarry Smith }
4828d763cef2SBarry Smith 
4829d763cef2SBarry Smith /*@C
4830d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4831d763cef2SBarry Smith    TS options in the database.
4832d763cef2SBarry Smith 
48333f9fe445SBarry Smith    Logically Collective on TS
4834d763cef2SBarry Smith 
4835d763cef2SBarry Smith    Input Parameter:
4836d763cef2SBarry Smith +  ts     - The TS context
4837d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4838d763cef2SBarry Smith 
4839d763cef2SBarry Smith    Notes:
4840d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4841d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4842d763cef2SBarry Smith    hyphen.
4843d763cef2SBarry Smith 
4844d763cef2SBarry Smith    Level: advanced
4845d763cef2SBarry Smith 
4846d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
4847d763cef2SBarry Smith 
4848d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4849d763cef2SBarry Smith 
4850d763cef2SBarry Smith @*/
48517087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4852d763cef2SBarry Smith {
4853dfbe8321SBarry Smith   PetscErrorCode ierr;
4854089b2837SJed Brown   SNES           snes;
4855d763cef2SBarry Smith 
4856d763cef2SBarry Smith   PetscFunctionBegin;
48570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4858d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4859089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4860089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4861d763cef2SBarry Smith   PetscFunctionReturn(0);
4862d763cef2SBarry Smith }
4863d763cef2SBarry Smith 
4864d763cef2SBarry Smith /*@C
4865d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4866d763cef2SBarry Smith    TS options in the database.
4867d763cef2SBarry Smith 
4868d763cef2SBarry Smith    Not Collective
4869d763cef2SBarry Smith 
4870d763cef2SBarry Smith    Input Parameter:
4871d763cef2SBarry Smith .  ts - The TS context
4872d763cef2SBarry Smith 
4873d763cef2SBarry Smith    Output Parameter:
4874d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4875d763cef2SBarry Smith 
4876d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
4877d763cef2SBarry Smith    sufficient length to hold the prefix.
4878d763cef2SBarry Smith 
4879d763cef2SBarry Smith    Level: intermediate
4880d763cef2SBarry Smith 
4881d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
4882d763cef2SBarry Smith 
4883d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4884d763cef2SBarry Smith @*/
48857087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4886d763cef2SBarry Smith {
4887dfbe8321SBarry Smith   PetscErrorCode ierr;
4888d763cef2SBarry Smith 
4889d763cef2SBarry Smith   PetscFunctionBegin;
48900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48914482741eSBarry Smith   PetscValidPointer(prefix,2);
4892d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4893d763cef2SBarry Smith   PetscFunctionReturn(0);
4894d763cef2SBarry Smith }
4895d763cef2SBarry Smith 
4896d763cef2SBarry Smith /*@C
4897d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4898d763cef2SBarry Smith 
4899d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4900d763cef2SBarry Smith 
4901d763cef2SBarry Smith    Input Parameter:
4902d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4903d763cef2SBarry Smith 
4904d763cef2SBarry Smith    Output Parameters:
4905e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4906e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4907e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4908e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4909d763cef2SBarry Smith 
49100298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
4911d763cef2SBarry Smith 
4912d763cef2SBarry Smith    Level: intermediate
4913d763cef2SBarry Smith 
491480275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
4915d763cef2SBarry Smith 
4916d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
4917d763cef2SBarry Smith @*/
4918e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4919d763cef2SBarry Smith {
4920089b2837SJed Brown   PetscErrorCode ierr;
492124989b8cSPeter Brune   DM             dm;
4922089b2837SJed Brown 
4923d763cef2SBarry Smith   PetscFunctionBegin;
492423a57915SBarry Smith   if (Amat || Pmat) {
492523a57915SBarry Smith     SNES snes;
4926089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
492723a57915SBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4928e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
492923a57915SBarry Smith   }
493024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
493124989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4932d763cef2SBarry Smith   PetscFunctionReturn(0);
4933d763cef2SBarry Smith }
4934d763cef2SBarry Smith 
49352eca1d9cSJed Brown /*@C
49362eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
49372eca1d9cSJed Brown 
49382eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
49392eca1d9cSJed Brown 
49402eca1d9cSJed Brown    Input Parameter:
49412eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
49422eca1d9cSJed Brown 
49432eca1d9cSJed Brown    Output Parameters:
4944e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4945e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
49462eca1d9cSJed Brown .  f   - The function to compute the matrices
49472eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
49482eca1d9cSJed Brown 
49490298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
49502eca1d9cSJed Brown 
49512eca1d9cSJed Brown    Level: advanced
49522eca1d9cSJed Brown 
495380275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
49542eca1d9cSJed Brown 
49552eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
49562eca1d9cSJed Brown @*/
4957e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
49582eca1d9cSJed Brown {
4959089b2837SJed Brown   PetscErrorCode ierr;
496024989b8cSPeter Brune   DM             dm;
49610910c330SBarry Smith 
49622eca1d9cSJed Brown   PetscFunctionBegin;
4963c0aab802Sstefano_zampini   if (Amat || Pmat) {
4964c0aab802Sstefano_zampini     SNES snes;
4965089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4966f7d39f7aSBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4967e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
4968c0aab802Sstefano_zampini   }
496924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
497024989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
49712eca1d9cSJed Brown   PetscFunctionReturn(0);
49722eca1d9cSJed Brown }
49732eca1d9cSJed Brown 
49741713a123SBarry Smith /*@C
497583a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
49761713a123SBarry Smith    VecView() for the solution at each timestep
49771713a123SBarry Smith 
49781713a123SBarry Smith    Collective on TS
49791713a123SBarry Smith 
49801713a123SBarry Smith    Input Parameters:
49811713a123SBarry Smith +  ts - the TS context
49821713a123SBarry Smith .  step - current time-step
4983142b95e3SSatish Balay .  ptime - current time
49840298fd71SBarry Smith -  dummy - either a viewer or NULL
49851713a123SBarry Smith 
498699fdda47SBarry Smith    Options Database:
498799fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
498899fdda47SBarry Smith 
4989387f4636SBarry Smith    Notes: the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
499099fdda47SBarry Smith        will look bad
499199fdda47SBarry Smith 
49921713a123SBarry Smith    Level: intermediate
49931713a123SBarry Smith 
49941713a123SBarry Smith .keywords: TS,  vector, monitor, view
49951713a123SBarry Smith 
4996a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
49971713a123SBarry Smith @*/
49980910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
49991713a123SBarry Smith {
5000dfbe8321SBarry Smith   PetscErrorCode   ierr;
500183a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
5002473a3ab2SBarry Smith   PetscDraw        draw;
50031713a123SBarry Smith 
50041713a123SBarry Smith   PetscFunctionBegin;
50056083293cSBarry Smith   if (!step && ictx->showinitial) {
50066083293cSBarry Smith     if (!ictx->initialsolution) {
50070910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
50081713a123SBarry Smith     }
50090910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
50106083293cSBarry Smith   }
5011b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
50120dcf80beSBarry Smith 
50136083293cSBarry Smith   if (ictx->showinitial) {
50146083293cSBarry Smith     PetscReal pause;
50156083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
50166083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
50176083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
50186083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
50196083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
50206083293cSBarry Smith   }
50210910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
5022473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
502351fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
5024473a3ab2SBarry Smith     char      time[32];
5025473a3ab2SBarry Smith 
5026473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
502785b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
5028473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
5029473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
503051fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
5031473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
5032473a3ab2SBarry Smith   }
5033473a3ab2SBarry Smith 
50346083293cSBarry Smith   if (ictx->showinitial) {
50356083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
50366083293cSBarry Smith   }
50371713a123SBarry Smith   PetscFunctionReturn(0);
50381713a123SBarry Smith }
50391713a123SBarry Smith 
50409110b2e7SHong Zhang /*@C
50419110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
50429110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
50439110b2e7SHong Zhang 
50449110b2e7SHong Zhang    Collective on TS
50459110b2e7SHong Zhang 
50469110b2e7SHong Zhang    Input Parameters:
50479110b2e7SHong Zhang +  ts - the TS context
50489110b2e7SHong Zhang .  step - current time-step
50499110b2e7SHong Zhang .  ptime - current time
50509110b2e7SHong Zhang .  u - current state
50519110b2e7SHong Zhang .  numcost - number of cost functions
50529110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
50539110b2e7SHong Zhang .  mu - sensitivities to parameters
50549110b2e7SHong Zhang -  dummy - either a viewer or NULL
50559110b2e7SHong Zhang 
50569110b2e7SHong Zhang    Level: intermediate
50579110b2e7SHong Zhang 
50589110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
50599110b2e7SHong Zhang 
50609110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
50619110b2e7SHong Zhang @*/
50629110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
50639110b2e7SHong Zhang {
50649110b2e7SHong Zhang   PetscErrorCode   ierr;
50659110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
50669110b2e7SHong Zhang   PetscDraw        draw;
5067a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
5068a0046e2cSSatish Balay   char             time[32];
50699110b2e7SHong Zhang 
50709110b2e7SHong Zhang   PetscFunctionBegin;
50719110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
50729110b2e7SHong Zhang 
50739110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
50749110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
50759110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
50769110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
50779110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
50789110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
50799110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
50809110b2e7SHong Zhang   PetscFunctionReturn(0);
50819110b2e7SHong Zhang }
50829110b2e7SHong Zhang 
50832d5ee99bSBarry Smith /*@C
50842d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
50852d5ee99bSBarry Smith 
50862d5ee99bSBarry Smith    Collective on TS
50872d5ee99bSBarry Smith 
50882d5ee99bSBarry Smith    Input Parameters:
50892d5ee99bSBarry Smith +  ts - the TS context
50902d5ee99bSBarry Smith .  step - current time-step
50912d5ee99bSBarry Smith .  ptime - current time
50922d5ee99bSBarry Smith -  dummy - either a viewer or NULL
50932d5ee99bSBarry Smith 
50942d5ee99bSBarry Smith    Level: intermediate
50952d5ee99bSBarry Smith 
50962d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
50972d5ee99bSBarry Smith 
50982d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
50992d5ee99bSBarry Smith @*/
51002d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
51012d5ee99bSBarry Smith {
51022d5ee99bSBarry Smith   PetscErrorCode    ierr;
51032d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
51042d5ee99bSBarry Smith   PetscDraw         draw;
51056934998bSLisandro Dalcin   PetscDrawAxis     axis;
51062d5ee99bSBarry Smith   PetscInt          n;
51072d5ee99bSBarry Smith   PetscMPIInt       size;
51086934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
51092d5ee99bSBarry Smith   char              time[32];
51102d5ee99bSBarry Smith   const PetscScalar *U;
51112d5ee99bSBarry Smith 
51122d5ee99bSBarry Smith   PetscFunctionBegin;
51136934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
51146934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
51152d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
51166934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
51172d5ee99bSBarry Smith 
51182d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
51196934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
51206934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
51216934998bSLisandro Dalcin   if (!step) {
51226934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
51236934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
51246934998bSLisandro Dalcin   }
51252d5ee99bSBarry Smith 
51262d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
51276934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
51286934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
5129a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
51306934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
51312d5ee99bSBarry Smith 
51326934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
51336934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
51342d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
51354b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
513685b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
51372d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
513851fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
51392d5ee99bSBarry Smith   }
51406934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
51412d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
514256d62c8fSLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
51436934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
51442d5ee99bSBarry Smith   PetscFunctionReturn(0);
51452d5ee99bSBarry Smith }
51462d5ee99bSBarry Smith 
51476083293cSBarry Smith /*@C
514883a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
51496083293cSBarry Smith 
51506083293cSBarry Smith    Collective on TS
51516083293cSBarry Smith 
51526083293cSBarry Smith    Input Parameters:
51536083293cSBarry Smith .    ctx - the monitor context
51546083293cSBarry Smith 
51556083293cSBarry Smith    Level: intermediate
51566083293cSBarry Smith 
51576083293cSBarry Smith .keywords: TS,  vector, monitor, view
51586083293cSBarry Smith 
515983a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
51606083293cSBarry Smith @*/
516183a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
51626083293cSBarry Smith {
51636083293cSBarry Smith   PetscErrorCode ierr;
51646083293cSBarry Smith 
51656083293cSBarry Smith   PetscFunctionBegin;
516683a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
516783a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
516883a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
51696083293cSBarry Smith   PetscFunctionReturn(0);
51706083293cSBarry Smith }
51716083293cSBarry Smith 
51726083293cSBarry Smith /*@C
517383a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
51746083293cSBarry Smith 
51756083293cSBarry Smith    Collective on TS
51766083293cSBarry Smith 
51776083293cSBarry Smith    Input Parameter:
51786083293cSBarry Smith .    ts - time-step context
51796083293cSBarry Smith 
51806083293cSBarry Smith    Output Patameter:
51816083293cSBarry Smith .    ctx - the monitor context
51826083293cSBarry Smith 
518399fdda47SBarry Smith    Options Database:
518499fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
518599fdda47SBarry Smith 
51866083293cSBarry Smith    Level: intermediate
51876083293cSBarry Smith 
51886083293cSBarry Smith .keywords: TS,  vector, monitor, view
51896083293cSBarry Smith 
519083a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
51916083293cSBarry Smith @*/
519283a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
51936083293cSBarry Smith {
51946083293cSBarry Smith   PetscErrorCode   ierr;
51956083293cSBarry Smith 
51966083293cSBarry Smith   PetscFunctionBegin;
5197b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
519883a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
5199e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
5200bbd56ea5SKarl Rupp 
520183a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
5202473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
5203c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
5204473a3ab2SBarry Smith 
5205473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
5206c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
52076083293cSBarry Smith   PetscFunctionReturn(0);
52086083293cSBarry Smith }
52096083293cSBarry Smith 
52103a471f94SBarry Smith /*@C
5211*0ed3bfb6SBarry Smith    TSMonitorDrawSolutionFunction - Monitors progress of the TS solvers by calling
5212*0ed3bfb6SBarry Smith    VecView() for the solution provided by TSSetSolutionFunction() at each timestep
5213*0ed3bfb6SBarry Smith 
5214*0ed3bfb6SBarry Smith    Collective on TS
5215*0ed3bfb6SBarry Smith 
5216*0ed3bfb6SBarry Smith    Input Parameters:
5217*0ed3bfb6SBarry Smith +  ts - the TS context
5218*0ed3bfb6SBarry Smith .  step - current time-step
5219*0ed3bfb6SBarry Smith .  ptime - current time
5220*0ed3bfb6SBarry Smith -  dummy - either a viewer or NULL
5221*0ed3bfb6SBarry Smith 
5222*0ed3bfb6SBarry Smith    Options Database:
5223*0ed3bfb6SBarry Smith .  -ts_monitor_draw_solution_function - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
5224*0ed3bfb6SBarry Smith 
5225*0ed3bfb6SBarry Smith    Level: intermediate
5226*0ed3bfb6SBarry Smith 
5227*0ed3bfb6SBarry Smith .keywords: TS,  vector, monitor, view
5228*0ed3bfb6SBarry Smith 
5229*0ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
5230*0ed3bfb6SBarry Smith @*/
5231*0ed3bfb6SBarry Smith PetscErrorCode  TSMonitorDrawSolutionFunction(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5232*0ed3bfb6SBarry Smith {
5233*0ed3bfb6SBarry Smith   PetscErrorCode   ierr;
5234*0ed3bfb6SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
5235*0ed3bfb6SBarry Smith   PetscViewer      viewer = ctx->viewer;
5236*0ed3bfb6SBarry Smith   Vec              work;
5237*0ed3bfb6SBarry Smith 
5238*0ed3bfb6SBarry Smith   PetscFunctionBegin;
5239*0ed3bfb6SBarry Smith   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
5240*0ed3bfb6SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
5241*0ed3bfb6SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
5242*0ed3bfb6SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
5243*0ed3bfb6SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
5244*0ed3bfb6SBarry Smith   PetscFunctionReturn(0);
5245*0ed3bfb6SBarry Smith }
5246*0ed3bfb6SBarry Smith 
5247*0ed3bfb6SBarry Smith /*@C
524883a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
52493a471f94SBarry Smith    VecView() for the error at each timestep
52503a471f94SBarry Smith 
52513a471f94SBarry Smith    Collective on TS
52523a471f94SBarry Smith 
52533a471f94SBarry Smith    Input Parameters:
52543a471f94SBarry Smith +  ts - the TS context
52553a471f94SBarry Smith .  step - current time-step
52563a471f94SBarry Smith .  ptime - current time
52570298fd71SBarry Smith -  dummy - either a viewer or NULL
52583a471f94SBarry Smith 
5259*0ed3bfb6SBarry Smith    Options Database:
5260*0ed3bfb6SBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
5261*0ed3bfb6SBarry Smith 
52623a471f94SBarry Smith    Level: intermediate
52633a471f94SBarry Smith 
52643a471f94SBarry Smith .keywords: TS,  vector, monitor, view
52653a471f94SBarry Smith 
5266*0ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
52673a471f94SBarry Smith @*/
52680910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
52693a471f94SBarry Smith {
52703a471f94SBarry Smith   PetscErrorCode   ierr;
527183a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
527283a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
52733a471f94SBarry Smith   Vec              work;
52743a471f94SBarry Smith 
52753a471f94SBarry Smith   PetscFunctionBegin;
5276b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
52770910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
52783a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
52790910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
52803a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
52813a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
52823a471f94SBarry Smith   PetscFunctionReturn(0);
52833a471f94SBarry Smith }
52843a471f94SBarry Smith 
5285af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
52866c699258SBarry Smith /*@
52872a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
52886c699258SBarry Smith 
52893f9fe445SBarry Smith    Logically Collective on TS and DM
52906c699258SBarry Smith 
52916c699258SBarry Smith    Input Parameters:
52922a808120SBarry Smith +  ts - the ODE integrator object
52932a808120SBarry Smith -  dm - the dm, cannot be NULL
52946c699258SBarry Smith 
52956c699258SBarry Smith    Level: intermediate
52966c699258SBarry Smith 
52976c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
52986c699258SBarry Smith @*/
52997087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
53006c699258SBarry Smith {
53016c699258SBarry Smith   PetscErrorCode ierr;
5302089b2837SJed Brown   SNES           snes;
5303942e3340SBarry Smith   DMTS           tsdm;
53046c699258SBarry Smith 
53056c699258SBarry Smith   PetscFunctionBegin;
53060700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53072a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
530870663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
5309942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
53102a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
5311942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
5312942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
531324989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
531424989b8cSPeter Brune         tsdm->originaldm = dm;
531524989b8cSPeter Brune       }
531624989b8cSPeter Brune     }
53176bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
531824989b8cSPeter Brune   }
53196c699258SBarry Smith   ts->dm = dm;
5320bbd56ea5SKarl Rupp 
5321089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5322089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
53236c699258SBarry Smith   PetscFunctionReturn(0);
53246c699258SBarry Smith }
53256c699258SBarry Smith 
53266c699258SBarry Smith /*@
53276c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
53286c699258SBarry Smith 
53293f9fe445SBarry Smith    Not Collective
53306c699258SBarry Smith 
53316c699258SBarry Smith    Input Parameter:
53326c699258SBarry Smith . ts - the preconditioner context
53336c699258SBarry Smith 
53346c699258SBarry Smith    Output Parameter:
53356c699258SBarry Smith .  dm - the dm
53366c699258SBarry Smith 
53376c699258SBarry Smith    Level: intermediate
53386c699258SBarry Smith 
53396c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
53406c699258SBarry Smith @*/
53417087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
53426c699258SBarry Smith {
5343496e6a7aSJed Brown   PetscErrorCode ierr;
5344496e6a7aSJed Brown 
53456c699258SBarry Smith   PetscFunctionBegin;
53460700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5347496e6a7aSJed Brown   if (!ts->dm) {
5348ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
5349496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
5350496e6a7aSJed Brown   }
53516c699258SBarry Smith   *dm = ts->dm;
53526c699258SBarry Smith   PetscFunctionReturn(0);
53536c699258SBarry Smith }
53541713a123SBarry Smith 
53550f5c6efeSJed Brown /*@
53560f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
53570f5c6efeSJed Brown 
53583f9fe445SBarry Smith    Logically Collective on SNES
53590f5c6efeSJed Brown 
53600f5c6efeSJed Brown    Input Parameter:
5361d42a1c89SJed Brown + snes - nonlinear solver
53620910c330SBarry Smith . U - the current state at which to evaluate the residual
5363d42a1c89SJed Brown - ctx - user context, must be a TS
53640f5c6efeSJed Brown 
53650f5c6efeSJed Brown    Output Parameter:
53660f5c6efeSJed Brown . F - the nonlinear residual
53670f5c6efeSJed Brown 
53680f5c6efeSJed Brown    Notes:
53690f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
53700f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
53710f5c6efeSJed Brown 
53720f5c6efeSJed Brown    Level: advanced
53730f5c6efeSJed Brown 
53740f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
53750f5c6efeSJed Brown @*/
53760910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
53770f5c6efeSJed Brown {
53780f5c6efeSJed Brown   TS             ts = (TS)ctx;
53790f5c6efeSJed Brown   PetscErrorCode ierr;
53800f5c6efeSJed Brown 
53810f5c6efeSJed Brown   PetscFunctionBegin;
53820f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
53830910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
53840f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
53850f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
53860910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
53870f5c6efeSJed Brown   PetscFunctionReturn(0);
53880f5c6efeSJed Brown }
53890f5c6efeSJed Brown 
53900f5c6efeSJed Brown /*@
53910f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
53920f5c6efeSJed Brown 
53930f5c6efeSJed Brown    Collective on SNES
53940f5c6efeSJed Brown 
53950f5c6efeSJed Brown    Input Parameter:
53960f5c6efeSJed Brown + snes - nonlinear solver
53970910c330SBarry Smith . U - the current state at which to evaluate the residual
53980f5c6efeSJed Brown - ctx - user context, must be a TS
53990f5c6efeSJed Brown 
54000f5c6efeSJed Brown    Output Parameter:
54010f5c6efeSJed Brown + A - the Jacobian
54020f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
54030f5c6efeSJed Brown - flag - indicates any structure change in the matrix
54040f5c6efeSJed Brown 
54050f5c6efeSJed Brown    Notes:
54060f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
54070f5c6efeSJed Brown 
54080f5c6efeSJed Brown    Level: developer
54090f5c6efeSJed Brown 
54100f5c6efeSJed Brown .seealso: SNESSetJacobian()
54110f5c6efeSJed Brown @*/
5412d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
54130f5c6efeSJed Brown {
54140f5c6efeSJed Brown   TS             ts = (TS)ctx;
54150f5c6efeSJed Brown   PetscErrorCode ierr;
54160f5c6efeSJed Brown 
54170f5c6efeSJed Brown   PetscFunctionBegin;
54180f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
54190910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
54200f5c6efeSJed Brown   PetscValidPointer(A,3);
542194ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
54220f5c6efeSJed Brown   PetscValidPointer(B,4);
542394ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
54240f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
5425d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
54260f5c6efeSJed Brown   PetscFunctionReturn(0);
54270f5c6efeSJed Brown }
5428325fc9f4SBarry Smith 
54290e4ef248SJed Brown /*@C
54309ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
54310e4ef248SJed Brown 
54320e4ef248SJed Brown    Collective on TS
54330e4ef248SJed Brown 
54340e4ef248SJed Brown    Input Arguments:
54350e4ef248SJed Brown +  ts - time stepping context
54360e4ef248SJed Brown .  t - time at which to evaluate
54370910c330SBarry Smith .  U - state at which to evaluate
54380e4ef248SJed Brown -  ctx - context
54390e4ef248SJed Brown 
54400e4ef248SJed Brown    Output Arguments:
54410e4ef248SJed Brown .  F - right hand side
54420e4ef248SJed Brown 
54430e4ef248SJed Brown    Level: intermediate
54440e4ef248SJed Brown 
54450e4ef248SJed Brown    Notes:
54460e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
54470e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
54480e4ef248SJed Brown 
54490e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
54500e4ef248SJed Brown @*/
54510910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
54520e4ef248SJed Brown {
54530e4ef248SJed Brown   PetscErrorCode ierr;
54540e4ef248SJed Brown   Mat            Arhs,Brhs;
54550e4ef248SJed Brown 
54560e4ef248SJed Brown   PetscFunctionBegin;
54570e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
5458d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
54590910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
54600e4ef248SJed Brown   PetscFunctionReturn(0);
54610e4ef248SJed Brown }
54620e4ef248SJed Brown 
54630e4ef248SJed Brown /*@C
54640e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
54650e4ef248SJed Brown 
54660e4ef248SJed Brown    Collective on TS
54670e4ef248SJed Brown 
54680e4ef248SJed Brown    Input Arguments:
54690e4ef248SJed Brown +  ts - time stepping context
54700e4ef248SJed Brown .  t - time at which to evaluate
54710910c330SBarry Smith .  U - state at which to evaluate
54720e4ef248SJed Brown -  ctx - context
54730e4ef248SJed Brown 
54740e4ef248SJed Brown    Output Arguments:
54750e4ef248SJed Brown +  A - pointer to operator
54760e4ef248SJed Brown .  B - pointer to preconditioning matrix
54770e4ef248SJed Brown -  flg - matrix structure flag
54780e4ef248SJed Brown 
54790e4ef248SJed Brown    Level: intermediate
54800e4ef248SJed Brown 
54810e4ef248SJed Brown    Notes:
54820e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
54830e4ef248SJed Brown 
54840e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
54850e4ef248SJed Brown @*/
5486d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
54870e4ef248SJed Brown {
54880e4ef248SJed Brown   PetscFunctionBegin;
54890e4ef248SJed Brown   PetscFunctionReturn(0);
54900e4ef248SJed Brown }
54910e4ef248SJed Brown 
54920026cea9SSean Farley /*@C
54930026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
54940026cea9SSean Farley 
54950026cea9SSean Farley    Collective on TS
54960026cea9SSean Farley 
54970026cea9SSean Farley    Input Arguments:
54980026cea9SSean Farley +  ts - time stepping context
54990026cea9SSean Farley .  t - time at which to evaluate
55000910c330SBarry Smith .  U - state at which to evaluate
55010910c330SBarry Smith .  Udot - time derivative of state vector
55020026cea9SSean Farley -  ctx - context
55030026cea9SSean Farley 
55040026cea9SSean Farley    Output Arguments:
55050026cea9SSean Farley .  F - left hand side
55060026cea9SSean Farley 
55070026cea9SSean Farley    Level: intermediate
55080026cea9SSean Farley 
55090026cea9SSean Farley    Notes:
55100910c330SBarry 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
55110026cea9SSean Farley    user is required to write their own TSComputeIFunction.
55120026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
55130026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
55140026cea9SSean Farley 
55159ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
55169ae8fd06SBarry Smith 
55179ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
55180026cea9SSean Farley @*/
55190910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
55200026cea9SSean Farley {
55210026cea9SSean Farley   PetscErrorCode ierr;
55220026cea9SSean Farley   Mat            A,B;
55230026cea9SSean Farley 
55240026cea9SSean Farley   PetscFunctionBegin;
55250298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
5526d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
55270910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
55280026cea9SSean Farley   PetscFunctionReturn(0);
55290026cea9SSean Farley }
55300026cea9SSean Farley 
55310026cea9SSean Farley /*@C
5532b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
55330026cea9SSean Farley 
55340026cea9SSean Farley    Collective on TS
55350026cea9SSean Farley 
55360026cea9SSean Farley    Input Arguments:
55370026cea9SSean Farley +  ts - time stepping context
55380026cea9SSean Farley .  t - time at which to evaluate
55390910c330SBarry Smith .  U - state at which to evaluate
55400910c330SBarry Smith .  Udot - time derivative of state vector
55410026cea9SSean Farley .  shift - shift to apply
55420026cea9SSean Farley -  ctx - context
55430026cea9SSean Farley 
55440026cea9SSean Farley    Output Arguments:
55450026cea9SSean Farley +  A - pointer to operator
55460026cea9SSean Farley .  B - pointer to preconditioning matrix
55470026cea9SSean Farley -  flg - matrix structure flag
55480026cea9SSean Farley 
5549b41af12eSJed Brown    Level: advanced
55500026cea9SSean Farley 
55510026cea9SSean Farley    Notes:
55520026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
55530026cea9SSean Farley 
5554b41af12eSJed Brown    It is only appropriate for problems of the form
5555b41af12eSJed Brown 
5556b41af12eSJed Brown $     M Udot = F(U,t)
5557b41af12eSJed Brown 
5558b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
5559b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5560b41af12eSJed Brown   an implicit operator of the form
5561b41af12eSJed Brown 
5562b41af12eSJed Brown $    shift*M + J
5563b41af12eSJed Brown 
5564b41af12eSJed 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
5565b41af12eSJed Brown   a copy of M or reassemble it when requested.
5566b41af12eSJed Brown 
55670026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
55680026cea9SSean Farley @*/
5569d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
55700026cea9SSean Farley {
5571b41af12eSJed Brown   PetscErrorCode ierr;
5572b41af12eSJed Brown 
55730026cea9SSean Farley   PetscFunctionBegin;
557494ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
5575b41af12eSJed Brown   ts->ijacobian.shift = shift;
55760026cea9SSean Farley   PetscFunctionReturn(0);
55770026cea9SSean Farley }
5578b41af12eSJed Brown 
5579e817cc15SEmil Constantinescu /*@
5580e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
5581e817cc15SEmil Constantinescu 
5582e817cc15SEmil Constantinescu    Not Collective
5583e817cc15SEmil Constantinescu 
5584e817cc15SEmil Constantinescu    Input Parameter:
5585e817cc15SEmil Constantinescu .  ts - the TS context
5586e817cc15SEmil Constantinescu 
5587e817cc15SEmil Constantinescu    Output Parameter:
55884e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
5589e817cc15SEmil Constantinescu 
5590e817cc15SEmil Constantinescu    Level: beginner
5591e817cc15SEmil Constantinescu 
5592e817cc15SEmil Constantinescu .keywords: TS, equation type
5593e817cc15SEmil Constantinescu 
5594e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
5595e817cc15SEmil Constantinescu @*/
5596e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
5597e817cc15SEmil Constantinescu {
5598e817cc15SEmil Constantinescu   PetscFunctionBegin;
5599e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5600e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
5601e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
5602e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5603e817cc15SEmil Constantinescu }
5604e817cc15SEmil Constantinescu 
5605e817cc15SEmil Constantinescu /*@
5606e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
5607e817cc15SEmil Constantinescu 
5608e817cc15SEmil Constantinescu    Not Collective
5609e817cc15SEmil Constantinescu 
5610e817cc15SEmil Constantinescu    Input Parameter:
5611e817cc15SEmil Constantinescu +  ts - the TS context
56121297b224SEmil Constantinescu -  equation_type - see TSEquationType
5613e817cc15SEmil Constantinescu 
5614e817cc15SEmil Constantinescu    Level: advanced
5615e817cc15SEmil Constantinescu 
5616e817cc15SEmil Constantinescu .keywords: TS, equation type
5617e817cc15SEmil Constantinescu 
5618e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
5619e817cc15SEmil Constantinescu @*/
5620e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
5621e817cc15SEmil Constantinescu {
5622e817cc15SEmil Constantinescu   PetscFunctionBegin;
5623e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5624e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
5625e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5626e817cc15SEmil Constantinescu }
56270026cea9SSean Farley 
56284af1b03aSJed Brown /*@
56294af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
56304af1b03aSJed Brown 
56314af1b03aSJed Brown    Not Collective
56324af1b03aSJed Brown 
56334af1b03aSJed Brown    Input Parameter:
56344af1b03aSJed Brown .  ts - the TS context
56354af1b03aSJed Brown 
56364af1b03aSJed Brown    Output Parameter:
56374af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
56384af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
56394af1b03aSJed Brown 
5640487e0bb9SJed Brown    Level: beginner
56414af1b03aSJed Brown 
5642cd652676SJed Brown    Notes:
5643cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
56444af1b03aSJed Brown 
56454af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
56464af1b03aSJed Brown 
56474af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
56484af1b03aSJed Brown @*/
56494af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
56504af1b03aSJed Brown {
56514af1b03aSJed Brown   PetscFunctionBegin;
56524af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
56534af1b03aSJed Brown   PetscValidPointer(reason,2);
56544af1b03aSJed Brown   *reason = ts->reason;
56554af1b03aSJed Brown   PetscFunctionReturn(0);
56564af1b03aSJed Brown }
56574af1b03aSJed Brown 
5658d6ad946cSShri Abhyankar /*@
5659d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5660d6ad946cSShri Abhyankar 
5661d6ad946cSShri Abhyankar    Not Collective
5662d6ad946cSShri Abhyankar 
5663d6ad946cSShri Abhyankar    Input Parameter:
5664d6ad946cSShri Abhyankar +  ts - the TS context
5665d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5666d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
5667d6ad946cSShri Abhyankar 
5668f5abba47SShri Abhyankar    Level: advanced
5669d6ad946cSShri Abhyankar 
5670d6ad946cSShri Abhyankar    Notes:
5671d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
5672d6ad946cSShri Abhyankar 
5673d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
5674d6ad946cSShri Abhyankar 
5675d6ad946cSShri Abhyankar .seealso: TSConvergedReason
5676d6ad946cSShri Abhyankar @*/
5677d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
5678d6ad946cSShri Abhyankar {
5679d6ad946cSShri Abhyankar   PetscFunctionBegin;
5680d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5681d6ad946cSShri Abhyankar   ts->reason = reason;
5682d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
5683d6ad946cSShri Abhyankar }
5684d6ad946cSShri Abhyankar 
5685cc708dedSBarry Smith /*@
5686cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
5687cc708dedSBarry Smith 
5688cc708dedSBarry Smith    Not Collective
5689cc708dedSBarry Smith 
5690cc708dedSBarry Smith    Input Parameter:
5691cc708dedSBarry Smith .  ts - the TS context
5692cc708dedSBarry Smith 
5693cc708dedSBarry Smith    Output Parameter:
569419eac22cSLisandro Dalcin .  ftime - the final time. This time corresponds to the final time set with TSSetMaxTime()
5695cc708dedSBarry Smith 
5696487e0bb9SJed Brown    Level: beginner
5697cc708dedSBarry Smith 
5698cc708dedSBarry Smith    Notes:
5699cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
5700cc708dedSBarry Smith 
5701cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
5702cc708dedSBarry Smith 
5703cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
5704cc708dedSBarry Smith @*/
5705cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
5706cc708dedSBarry Smith {
5707cc708dedSBarry Smith   PetscFunctionBegin;
5708cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5709cc708dedSBarry Smith   PetscValidPointer(ftime,2);
5710cc708dedSBarry Smith   *ftime = ts->solvetime;
5711cc708dedSBarry Smith   PetscFunctionReturn(0);
5712cc708dedSBarry Smith }
5713cc708dedSBarry Smith 
57142c18e0fdSBarry Smith /*@
57155ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
57169f67acb7SJed Brown    used by the time integrator.
57179f67acb7SJed Brown 
57189f67acb7SJed Brown    Not Collective
57199f67acb7SJed Brown 
57209f67acb7SJed Brown    Input Parameter:
57219f67acb7SJed Brown .  ts - TS context
57229f67acb7SJed Brown 
57239f67acb7SJed Brown    Output Parameter:
57249f67acb7SJed Brown .  nits - number of nonlinear iterations
57259f67acb7SJed Brown 
57269f67acb7SJed Brown    Notes:
57279f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
57289f67acb7SJed Brown 
57299f67acb7SJed Brown    Level: intermediate
57309f67acb7SJed Brown 
57319f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
57329f67acb7SJed Brown 
57335ef26d82SJed Brown .seealso:  TSGetKSPIterations()
57349f67acb7SJed Brown @*/
57355ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
57369f67acb7SJed Brown {
57379f67acb7SJed Brown   PetscFunctionBegin;
57389f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
57399f67acb7SJed Brown   PetscValidIntPointer(nits,2);
57405ef26d82SJed Brown   *nits = ts->snes_its;
57419f67acb7SJed Brown   PetscFunctionReturn(0);
57429f67acb7SJed Brown }
57439f67acb7SJed Brown 
57449f67acb7SJed Brown /*@
57455ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
57469f67acb7SJed Brown    used by the time integrator.
57479f67acb7SJed Brown 
57489f67acb7SJed Brown    Not Collective
57499f67acb7SJed Brown 
57509f67acb7SJed Brown    Input Parameter:
57519f67acb7SJed Brown .  ts - TS context
57529f67acb7SJed Brown 
57539f67acb7SJed Brown    Output Parameter:
57549f67acb7SJed Brown .  lits - number of linear iterations
57559f67acb7SJed Brown 
57569f67acb7SJed Brown    Notes:
57579f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
57589f67acb7SJed Brown 
57599f67acb7SJed Brown    Level: intermediate
57609f67acb7SJed Brown 
57619f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
57629f67acb7SJed Brown 
57635ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
57649f67acb7SJed Brown @*/
57655ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
57669f67acb7SJed Brown {
57679f67acb7SJed Brown   PetscFunctionBegin;
57689f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
57699f67acb7SJed Brown   PetscValidIntPointer(lits,2);
57705ef26d82SJed Brown   *lits = ts->ksp_its;
57719f67acb7SJed Brown   PetscFunctionReturn(0);
57729f67acb7SJed Brown }
57739f67acb7SJed Brown 
5774cef5090cSJed Brown /*@
5775cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5776cef5090cSJed Brown 
5777cef5090cSJed Brown    Not Collective
5778cef5090cSJed Brown 
5779cef5090cSJed Brown    Input Parameter:
5780cef5090cSJed Brown .  ts - TS context
5781cef5090cSJed Brown 
5782cef5090cSJed Brown    Output Parameter:
5783cef5090cSJed Brown .  rejects - number of steps rejected
5784cef5090cSJed Brown 
5785cef5090cSJed Brown    Notes:
5786cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5787cef5090cSJed Brown 
5788cef5090cSJed Brown    Level: intermediate
5789cef5090cSJed Brown 
5790cef5090cSJed Brown .keywords: TS, get, number
5791cef5090cSJed Brown 
57925ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5793cef5090cSJed Brown @*/
5794cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5795cef5090cSJed Brown {
5796cef5090cSJed Brown   PetscFunctionBegin;
5797cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5798cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5799cef5090cSJed Brown   *rejects = ts->reject;
5800cef5090cSJed Brown   PetscFunctionReturn(0);
5801cef5090cSJed Brown }
5802cef5090cSJed Brown 
5803cef5090cSJed Brown /*@
5804cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5805cef5090cSJed Brown 
5806cef5090cSJed Brown    Not Collective
5807cef5090cSJed Brown 
5808cef5090cSJed Brown    Input Parameter:
5809cef5090cSJed Brown .  ts - TS context
5810cef5090cSJed Brown 
5811cef5090cSJed Brown    Output Parameter:
5812cef5090cSJed Brown .  fails - number of failed nonlinear solves
5813cef5090cSJed Brown 
5814cef5090cSJed Brown    Notes:
5815cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5816cef5090cSJed Brown 
5817cef5090cSJed Brown    Level: intermediate
5818cef5090cSJed Brown 
5819cef5090cSJed Brown .keywords: TS, get, number
5820cef5090cSJed Brown 
58215ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5822cef5090cSJed Brown @*/
5823cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5824cef5090cSJed Brown {
5825cef5090cSJed Brown   PetscFunctionBegin;
5826cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5827cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5828cef5090cSJed Brown   *fails = ts->num_snes_failures;
5829cef5090cSJed Brown   PetscFunctionReturn(0);
5830cef5090cSJed Brown }
5831cef5090cSJed Brown 
5832cef5090cSJed Brown /*@
5833cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5834cef5090cSJed Brown 
5835cef5090cSJed Brown    Not Collective
5836cef5090cSJed Brown 
5837cef5090cSJed Brown    Input Parameter:
5838cef5090cSJed Brown +  ts - TS context
5839cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5840cef5090cSJed Brown 
5841cef5090cSJed Brown    Notes:
5842cef5090cSJed Brown    The counter is reset to zero for each step
5843cef5090cSJed Brown 
5844cef5090cSJed Brown    Options Database Key:
5845cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5846cef5090cSJed Brown 
5847cef5090cSJed Brown    Level: intermediate
5848cef5090cSJed Brown 
5849cef5090cSJed Brown .keywords: TS, set, maximum, number
5850cef5090cSJed Brown 
58515ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5852cef5090cSJed Brown @*/
5853cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5854cef5090cSJed Brown {
5855cef5090cSJed Brown   PetscFunctionBegin;
5856cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5857cef5090cSJed Brown   ts->max_reject = rejects;
5858cef5090cSJed Brown   PetscFunctionReturn(0);
5859cef5090cSJed Brown }
5860cef5090cSJed Brown 
5861cef5090cSJed Brown /*@
5862cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5863cef5090cSJed Brown 
5864cef5090cSJed Brown    Not Collective
5865cef5090cSJed Brown 
5866cef5090cSJed Brown    Input Parameter:
5867cef5090cSJed Brown +  ts - TS context
5868cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5869cef5090cSJed Brown 
5870cef5090cSJed Brown    Notes:
5871cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5872cef5090cSJed Brown 
5873cef5090cSJed Brown    Options Database Key:
5874cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5875cef5090cSJed Brown 
5876cef5090cSJed Brown    Level: intermediate
5877cef5090cSJed Brown 
5878cef5090cSJed Brown .keywords: TS, set, maximum, number
5879cef5090cSJed Brown 
58805ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5881cef5090cSJed Brown @*/
5882cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5883cef5090cSJed Brown {
5884cef5090cSJed Brown   PetscFunctionBegin;
5885cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5886cef5090cSJed Brown   ts->max_snes_failures = fails;
5887cef5090cSJed Brown   PetscFunctionReturn(0);
5888cef5090cSJed Brown }
5889cef5090cSJed Brown 
5890cef5090cSJed Brown /*@
5891cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5892cef5090cSJed Brown 
5893cef5090cSJed Brown    Not Collective
5894cef5090cSJed Brown 
5895cef5090cSJed Brown    Input Parameter:
5896cef5090cSJed Brown +  ts - TS context
5897cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5898cef5090cSJed Brown 
5899cef5090cSJed Brown    Options Database Key:
5900cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5901cef5090cSJed Brown 
5902cef5090cSJed Brown    Level: intermediate
5903cef5090cSJed Brown 
5904cef5090cSJed Brown .keywords: TS, set, error
5905cef5090cSJed Brown 
59065ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5907cef5090cSJed Brown @*/
5908cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5909cef5090cSJed Brown {
5910cef5090cSJed Brown   PetscFunctionBegin;
5911cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5912cef5090cSJed Brown   ts->errorifstepfailed = err;
5913cef5090cSJed Brown   PetscFunctionReturn(0);
5914cef5090cSJed Brown }
5915cef5090cSJed Brown 
5916fb1732b5SBarry Smith /*@C
5917fde5950dSBarry 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
5918fb1732b5SBarry Smith 
5919fb1732b5SBarry Smith    Collective on TS
5920fb1732b5SBarry Smith 
5921fb1732b5SBarry Smith    Input Parameters:
5922fb1732b5SBarry Smith +  ts - the TS context
5923fb1732b5SBarry Smith .  step - current time-step
5924fb1732b5SBarry Smith .  ptime - current time
59250910c330SBarry Smith .  u - current state
5926721cd6eeSBarry Smith -  vf - viewer and its format
5927fb1732b5SBarry Smith 
5928fb1732b5SBarry Smith    Level: intermediate
5929fb1732b5SBarry Smith 
5930fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
5931fb1732b5SBarry Smith 
5932fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5933fb1732b5SBarry Smith @*/
5934721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5935fb1732b5SBarry Smith {
5936fb1732b5SBarry Smith   PetscErrorCode ierr;
5937fb1732b5SBarry Smith 
5938fb1732b5SBarry Smith   PetscFunctionBegin;
5939721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5940721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5941721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5942ed81e22dSJed Brown   PetscFunctionReturn(0);
5943ed81e22dSJed Brown }
5944ed81e22dSJed Brown 
5945ed81e22dSJed Brown /*@C
5946ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5947ed81e22dSJed Brown 
5948ed81e22dSJed Brown    Collective on TS
5949ed81e22dSJed Brown 
5950ed81e22dSJed Brown    Input Parameters:
5951ed81e22dSJed Brown +  ts - the TS context
5952ed81e22dSJed Brown .  step - current time-step
5953ed81e22dSJed Brown .  ptime - current time
59540910c330SBarry Smith .  u - current state
5955ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5956ed81e22dSJed Brown 
5957ed81e22dSJed Brown    Level: intermediate
5958ed81e22dSJed Brown 
5959ed81e22dSJed Brown    Notes:
5960ed81e22dSJed 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.
5961ed81e22dSJed Brown    These are named according to the file name template.
5962ed81e22dSJed Brown 
5963ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5964ed81e22dSJed Brown 
5965ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5966ed81e22dSJed Brown 
5967ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5968ed81e22dSJed Brown @*/
59690910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5970ed81e22dSJed Brown {
5971ed81e22dSJed Brown   PetscErrorCode ierr;
5972ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5973ed81e22dSJed Brown   PetscViewer    viewer;
5974ed81e22dSJed Brown 
5975ed81e22dSJed Brown   PetscFunctionBegin;
597663e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
59778caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5978ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
59790910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5980ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5981ed81e22dSJed Brown   PetscFunctionReturn(0);
5982ed81e22dSJed Brown }
5983ed81e22dSJed Brown 
5984ed81e22dSJed Brown /*@C
5985ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5986ed81e22dSJed Brown 
5987ed81e22dSJed Brown    Collective on TS
5988ed81e22dSJed Brown 
5989ed81e22dSJed Brown    Input Parameters:
5990ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5991ed81e22dSJed Brown 
5992ed81e22dSJed Brown    Level: intermediate
5993ed81e22dSJed Brown 
5994ed81e22dSJed Brown    Note:
5995ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5996ed81e22dSJed Brown 
5997ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5998ed81e22dSJed Brown 
5999ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
6000ed81e22dSJed Brown @*/
6001ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
6002ed81e22dSJed Brown {
6003ed81e22dSJed Brown   PetscErrorCode ierr;
6004ed81e22dSJed Brown 
6005ed81e22dSJed Brown   PetscFunctionBegin;
6006ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
6007fb1732b5SBarry Smith   PetscFunctionReturn(0);
6008fb1732b5SBarry Smith }
6009fb1732b5SBarry Smith 
601084df9cb4SJed Brown /*@
6011552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
601284df9cb4SJed Brown 
6013ed81e22dSJed Brown    Collective on TS if controller has not been created yet
601484df9cb4SJed Brown 
601584df9cb4SJed Brown    Input Arguments:
6016ed81e22dSJed Brown .  ts - time stepping context
601784df9cb4SJed Brown 
601884df9cb4SJed Brown    Output Arguments:
6019ed81e22dSJed Brown .  adapt - adaptive controller
602084df9cb4SJed Brown 
602184df9cb4SJed Brown    Level: intermediate
602284df9cb4SJed Brown 
6023ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
602484df9cb4SJed Brown @*/
6025552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
602684df9cb4SJed Brown {
602784df9cb4SJed Brown   PetscErrorCode ierr;
602884df9cb4SJed Brown 
602984df9cb4SJed Brown   PetscFunctionBegin;
603084df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6031bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
603284df9cb4SJed Brown   if (!ts->adapt) {
6033ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
60343bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
60351c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
603684df9cb4SJed Brown   }
6037bec58848SLisandro Dalcin   *adapt = ts->adapt;
603884df9cb4SJed Brown   PetscFunctionReturn(0);
603984df9cb4SJed Brown }
6040d6ebe24aSShri Abhyankar 
60411c3436cfSJed Brown /*@
60421c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
60431c3436cfSJed Brown 
60441c3436cfSJed Brown    Logically Collective
60451c3436cfSJed Brown 
60461c3436cfSJed Brown    Input Arguments:
60471c3436cfSJed Brown +  ts - time integration context
60481c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
60490298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
60501c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
60510298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
60521c3436cfSJed Brown 
6053a3cdaa26SBarry Smith    Options Database keys:
6054a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
6055a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
6056a3cdaa26SBarry Smith 
60573ff766beSShri Abhyankar    Notes:
60583ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
60593ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
60603ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
60613ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
60623ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
60633ff766beSShri Abhyankar    differential variables.
60643ff766beSShri Abhyankar 
60651c3436cfSJed Brown    Level: beginner
60661c3436cfSJed Brown 
6067c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
60681c3436cfSJed Brown @*/
60691c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
60701c3436cfSJed Brown {
60711c3436cfSJed Brown   PetscErrorCode ierr;
60721c3436cfSJed Brown 
60731c3436cfSJed Brown   PetscFunctionBegin;
6074c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
60751c3436cfSJed Brown   if (vatol) {
60761c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
60771c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
60781c3436cfSJed Brown     ts->vatol = vatol;
60791c3436cfSJed Brown   }
6080c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
60811c3436cfSJed Brown   if (vrtol) {
60821c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
60831c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
60841c3436cfSJed Brown     ts->vrtol = vrtol;
60851c3436cfSJed Brown   }
60861c3436cfSJed Brown   PetscFunctionReturn(0);
60871c3436cfSJed Brown }
60881c3436cfSJed Brown 
6089c5033834SJed Brown /*@
6090c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
6091c5033834SJed Brown 
6092c5033834SJed Brown    Logically Collective
6093c5033834SJed Brown 
6094c5033834SJed Brown    Input Arguments:
6095c5033834SJed Brown .  ts - time integration context
6096c5033834SJed Brown 
6097c5033834SJed Brown    Output Arguments:
60980298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
60990298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
61000298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
61010298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
6102c5033834SJed Brown 
6103c5033834SJed Brown    Level: beginner
6104c5033834SJed Brown 
6105c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
6106c5033834SJed Brown @*/
6107c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
6108c5033834SJed Brown {
6109c5033834SJed Brown   PetscFunctionBegin;
6110c5033834SJed Brown   if (atol)  *atol  = ts->atol;
6111c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
6112c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
6113c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
6114c5033834SJed Brown   PetscFunctionReturn(0);
6115c5033834SJed Brown }
6116c5033834SJed Brown 
61179c6b16b5SShri Abhyankar /*@
6118a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
61199c6b16b5SShri Abhyankar 
61209c6b16b5SShri Abhyankar    Collective on TS
61219c6b16b5SShri Abhyankar 
61229c6b16b5SShri Abhyankar    Input Arguments:
61239c6b16b5SShri Abhyankar +  ts - time stepping context
6124a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6125a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
61269c6b16b5SShri Abhyankar 
61279c6b16b5SShri Abhyankar    Output Arguments:
61287453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
61297453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
61307453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
61319c6b16b5SShri Abhyankar 
61329c6b16b5SShri Abhyankar    Level: developer
61339c6b16b5SShri Abhyankar 
6134deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
61359c6b16b5SShri Abhyankar @*/
61367453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
61379c6b16b5SShri Abhyankar {
61389c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
61399c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
61407453f775SEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
61417453f775SEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
61429c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
61437453f775SEmil Constantinescu   PetscReal         sum,suma,sumr,gsum,gsuma,gsumr,diff;
61447453f775SEmil Constantinescu   PetscReal         tol,tola,tolr;
61457453f775SEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
61469c6b16b5SShri Abhyankar 
61479c6b16b5SShri Abhyankar   PetscFunctionBegin;
61489c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6149a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
6150a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
6151a4868fbcSLisandro Dalcin   PetscValidType(U,2);
6152a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
6153a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
6154a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
61558a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
61568a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
6157a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
61589c6b16b5SShri Abhyankar 
61599c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
61609c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
61619c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
61629c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
61639c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
61647453f775SEmil Constantinescu   sum  = 0.; n_loc  = 0;
61657453f775SEmil Constantinescu   suma = 0.; na_loc = 0;
61667453f775SEmil Constantinescu   sumr = 0.; nr_loc = 0;
61679c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
61689c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
61699c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61709c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61719c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
61727453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
61737453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
61747453f775SEmil Constantinescu       if(tola>0.){
61757453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
61767453f775SEmil Constantinescu         na_loc++;
61777453f775SEmil Constantinescu       }
61787453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61797453f775SEmil Constantinescu       if(tolr>0.){
61807453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
61817453f775SEmil Constantinescu         nr_loc++;
61827453f775SEmil Constantinescu       }
61837453f775SEmil Constantinescu       tol=tola+tolr;
61847453f775SEmil Constantinescu       if(tol>0.){
61857453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
61867453f775SEmil Constantinescu         n_loc++;
61877453f775SEmil Constantinescu       }
61889c6b16b5SShri Abhyankar     }
61899c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61909c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61919c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
61929c6b16b5SShri Abhyankar     const PetscScalar *atol;
61939c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61949c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
61957453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
61967453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
61977453f775SEmil Constantinescu       if(tola>0.){
61987453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
61997453f775SEmil Constantinescu         na_loc++;
62007453f775SEmil Constantinescu       }
62017453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62027453f775SEmil Constantinescu       if(tolr>0.){
62037453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
62047453f775SEmil Constantinescu         nr_loc++;
62057453f775SEmil Constantinescu       }
62067453f775SEmil Constantinescu       tol=tola+tolr;
62077453f775SEmil Constantinescu       if(tol>0.){
62087453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
62097453f775SEmil Constantinescu         n_loc++;
62107453f775SEmil Constantinescu       }
62119c6b16b5SShri Abhyankar     }
62129c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
62139c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
62149c6b16b5SShri Abhyankar     const PetscScalar *rtol;
62159c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62169c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
62177453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
62187453f775SEmil Constantinescu       tola = ts->atol;
62197453f775SEmil Constantinescu       if(tola>0.){
62207453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
62217453f775SEmil Constantinescu         na_loc++;
62227453f775SEmil Constantinescu       }
62237453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62247453f775SEmil Constantinescu       if(tolr>0.){
62257453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
62267453f775SEmil Constantinescu         nr_loc++;
62277453f775SEmil Constantinescu       }
62287453f775SEmil Constantinescu       tol=tola+tolr;
62297453f775SEmil Constantinescu       if(tol>0.){
62307453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
62317453f775SEmil Constantinescu         n_loc++;
62327453f775SEmil Constantinescu       }
62339c6b16b5SShri Abhyankar     }
62349c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62359c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
62369c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
62377453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
62387453f775SEmil Constantinescu      tola = ts->atol;
62397453f775SEmil Constantinescu       if(tola>0.){
62407453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
62417453f775SEmil Constantinescu         na_loc++;
62427453f775SEmil Constantinescu       }
62437453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62447453f775SEmil Constantinescu       if(tolr>0.){
62457453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
62467453f775SEmil Constantinescu         nr_loc++;
62477453f775SEmil Constantinescu       }
62487453f775SEmil Constantinescu       tol=tola+tolr;
62497453f775SEmil Constantinescu       if(tol>0.){
62507453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
62517453f775SEmil Constantinescu         n_loc++;
62527453f775SEmil Constantinescu       }
62539c6b16b5SShri Abhyankar     }
62549c6b16b5SShri Abhyankar   }
62559c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
62569c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
62579c6b16b5SShri Abhyankar 
62587453f775SEmil Constantinescu   err_loc[0] = sum;
62597453f775SEmil Constantinescu   err_loc[1] = suma;
62607453f775SEmil Constantinescu   err_loc[2] = sumr;
62617453f775SEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
62627453f775SEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
62637453f775SEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
62647453f775SEmil Constantinescu 
6265a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
62667453f775SEmil Constantinescu 
62677453f775SEmil Constantinescu   gsum   = err_glb[0];
62687453f775SEmil Constantinescu   gsuma  = err_glb[1];
62697453f775SEmil Constantinescu   gsumr  = err_glb[2];
62707453f775SEmil Constantinescu   n_glb  = err_glb[3];
62717453f775SEmil Constantinescu   na_glb = err_glb[4];
62727453f775SEmil Constantinescu   nr_glb = err_glb[5];
62737453f775SEmil Constantinescu 
6274b1316ef9SEmil Constantinescu   *norm  = 0.;
6275b1316ef9SEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
6276b1316ef9SEmil Constantinescu   *norma = 0.;
6277b1316ef9SEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
6278b1316ef9SEmil Constantinescu   *normr = 0.;
6279b1316ef9SEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
62809c6b16b5SShri Abhyankar 
62819c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
62827453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
62837453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
62849c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
62859c6b16b5SShri Abhyankar }
62869c6b16b5SShri Abhyankar 
62879c6b16b5SShri Abhyankar /*@
6288a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
62899c6b16b5SShri Abhyankar 
62909c6b16b5SShri Abhyankar    Collective on TS
62919c6b16b5SShri Abhyankar 
62929c6b16b5SShri Abhyankar    Input Arguments:
62939c6b16b5SShri Abhyankar +  ts - time stepping context
6294a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6295a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
62969c6b16b5SShri Abhyankar 
62979c6b16b5SShri Abhyankar    Output Arguments:
62987453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
62997453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
63007453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
63019c6b16b5SShri Abhyankar 
63029c6b16b5SShri Abhyankar    Level: developer
63039c6b16b5SShri Abhyankar 
6304deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
63059c6b16b5SShri Abhyankar @*/
63067453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
63079c6b16b5SShri Abhyankar {
63089c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
63097453f775SEmil Constantinescu   PetscInt          i,n,N,rstart;
63109c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
63117453f775SEmil Constantinescu   PetscReal         max,gmax,maxa,gmaxa,maxr,gmaxr;
63127453f775SEmil Constantinescu   PetscReal         tol,tola,tolr,diff;
63137453f775SEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
63149c6b16b5SShri Abhyankar 
63159c6b16b5SShri Abhyankar   PetscFunctionBegin;
63169c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6317a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
6318a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
6319a4868fbcSLisandro Dalcin   PetscValidType(U,2);
6320a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
6321a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
6322a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
63238a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
63248a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
6325a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
63269c6b16b5SShri Abhyankar 
63279c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
63289c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
63299c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
63309c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
63319c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
63327453f775SEmil Constantinescu 
63337453f775SEmil Constantinescu   max=0.;
63347453f775SEmil Constantinescu   maxa=0.;
63357453f775SEmil Constantinescu   maxr=0.;
63367453f775SEmil Constantinescu 
63377453f775SEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
63389c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
63399c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63409c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63417453f775SEmil Constantinescu 
63427453f775SEmil Constantinescu     for (i=0; i<n; i++) {
63437453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
63447453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
63457453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63467453f775SEmil Constantinescu       tol  = tola+tolr;
63477453f775SEmil Constantinescu       if(tola>0.){
63487453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
63497453f775SEmil Constantinescu       }
63507453f775SEmil Constantinescu       if(tolr>0.){
63517453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
63527453f775SEmil Constantinescu       }
63537453f775SEmil Constantinescu       if(tol>0.){
63547453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
63557453f775SEmil Constantinescu       }
63569c6b16b5SShri Abhyankar     }
63579c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63589c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63599c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
63609c6b16b5SShri Abhyankar     const PetscScalar *atol;
63619c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63627453f775SEmil Constantinescu     for (i=0; i<n; i++) {
63637453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
63647453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
63657453f775SEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63667453f775SEmil Constantinescu       tol  = tola+tolr;
63677453f775SEmil Constantinescu       if(tola>0.){
63687453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
63697453f775SEmil Constantinescu       }
63707453f775SEmil Constantinescu       if(tolr>0.){
63717453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
63727453f775SEmil Constantinescu       }
63737453f775SEmil Constantinescu       if(tol>0.){
63747453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
63757453f775SEmil Constantinescu       }
63769c6b16b5SShri Abhyankar     }
63779c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63789c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
63799c6b16b5SShri Abhyankar     const PetscScalar *rtol;
63809c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63817453f775SEmil Constantinescu 
63827453f775SEmil Constantinescu     for (i=0; i<n; i++) {
63837453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
63847453f775SEmil Constantinescu       tola = ts->atol;
63857453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63867453f775SEmil Constantinescu       tol  = tola+tolr;
63877453f775SEmil Constantinescu       if(tola>0.){
63887453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
63897453f775SEmil Constantinescu       }
63907453f775SEmil Constantinescu       if(tolr>0.){
63917453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
63927453f775SEmil Constantinescu       }
63937453f775SEmil Constantinescu       if(tol>0.){
63947453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
63957453f775SEmil Constantinescu       }
63969c6b16b5SShri Abhyankar     }
63979c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63989c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
63997453f775SEmil Constantinescu 
64007453f775SEmil Constantinescu     for (i=0; i<n; i++) {
64017453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
64027453f775SEmil Constantinescu       tola = ts->atol;
64037453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
64047453f775SEmil Constantinescu       tol  = tola+tolr;
64057453f775SEmil Constantinescu       if(tola>0.){
64067453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
64077453f775SEmil Constantinescu       }
64087453f775SEmil Constantinescu       if(tolr>0.){
64097453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
64107453f775SEmil Constantinescu       }
64117453f775SEmil Constantinescu       if(tol>0.){
64127453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
64137453f775SEmil Constantinescu       }
64149c6b16b5SShri Abhyankar     }
64159c6b16b5SShri Abhyankar   }
64169c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
64179c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
64187453f775SEmil Constantinescu   err_loc[0] = max;
64197453f775SEmil Constantinescu   err_loc[1] = maxa;
64207453f775SEmil Constantinescu   err_loc[2] = maxr;
6421a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
64227453f775SEmil Constantinescu   gmax   = err_glb[0];
64237453f775SEmil Constantinescu   gmaxa  = err_glb[1];
64247453f775SEmil Constantinescu   gmaxr  = err_glb[2];
64259c6b16b5SShri Abhyankar 
64269c6b16b5SShri Abhyankar   *norm = gmax;
64277453f775SEmil Constantinescu   *norma = gmaxa;
64287453f775SEmil Constantinescu   *normr = gmaxr;
64299c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
64307453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
64317453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
64329c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
64339c6b16b5SShri Abhyankar }
64349c6b16b5SShri Abhyankar 
64351c3436cfSJed Brown /*@
64368a175baeSEmil Constantinescu    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
64371c3436cfSJed Brown 
64381c3436cfSJed Brown    Collective on TS
64391c3436cfSJed Brown 
64401c3436cfSJed Brown    Input Arguments:
64411c3436cfSJed Brown +  ts - time stepping context
6442a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6443a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
6444a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
64457619abb3SShri 
64461c3436cfSJed Brown    Output Arguments:
64478a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
64488a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
64498a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
6450a4868fbcSLisandro Dalcin 
6451a4868fbcSLisandro Dalcin    Options Database Keys:
6452a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
6453a4868fbcSLisandro Dalcin 
64541c3436cfSJed Brown    Level: developer
64551c3436cfSJed Brown 
64568a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm
64571c3436cfSJed Brown @*/
64587453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
64591c3436cfSJed Brown {
64608beabaa1SBarry Smith   PetscErrorCode ierr;
64611c3436cfSJed Brown 
64621c3436cfSJed Brown   PetscFunctionBegin;
6463a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
64647453f775SEmil Constantinescu     ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6465a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
64667453f775SEmil Constantinescu     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6467a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
64681c3436cfSJed Brown   PetscFunctionReturn(0);
64691c3436cfSJed Brown }
64701c3436cfSJed Brown 
64718a175baeSEmil Constantinescu 
64728a175baeSEmil Constantinescu /*@
64738a175baeSEmil Constantinescu    TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances
64748a175baeSEmil Constantinescu 
64758a175baeSEmil Constantinescu    Collective on TS
64768a175baeSEmil Constantinescu 
64778a175baeSEmil Constantinescu    Input Arguments:
64788a175baeSEmil Constantinescu +  ts - time stepping context
64798a175baeSEmil Constantinescu .  E - error vector
64808a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
64818a175baeSEmil Constantinescu -  Y - state vector, previous time step
64828a175baeSEmil Constantinescu 
64838a175baeSEmil Constantinescu    Output Arguments:
64848a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
64858a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
64868a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
64878a175baeSEmil Constantinescu 
64888a175baeSEmil Constantinescu    Level: developer
64898a175baeSEmil Constantinescu 
64908a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity()
64918a175baeSEmil Constantinescu @*/
64928a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
64938a175baeSEmil Constantinescu {
64948a175baeSEmil Constantinescu   PetscErrorCode    ierr;
64958a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
64968a175baeSEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
64978a175baeSEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
64988a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
64998a175baeSEmil Constantinescu   PetscReal         err,sum,suma,sumr,gsum,gsuma,gsumr;
65008a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
65018a175baeSEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
65028a175baeSEmil Constantinescu 
65038a175baeSEmil Constantinescu   PetscFunctionBegin;
65048a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
65058a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
65068a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
65078a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
65088a175baeSEmil Constantinescu   PetscValidType(E,2);
65098a175baeSEmil Constantinescu   PetscValidType(U,3);
65108a175baeSEmil Constantinescu   PetscValidType(Y,4);
65118a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
65128a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
65138a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
65148a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
65158a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
65168a175baeSEmil Constantinescu 
65178a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
65188a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
65198a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
65208a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
65218a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
65228a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
65238a175baeSEmil Constantinescu   sum  = 0.; n_loc  = 0;
65248a175baeSEmil Constantinescu   suma = 0.; na_loc = 0;
65258a175baeSEmil Constantinescu   sumr = 0.; nr_loc = 0;
65268a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {
65278a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
65288a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65298a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65308a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65318a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65328a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
65338a175baeSEmil Constantinescu       if(tola>0.){
65348a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
65358a175baeSEmil Constantinescu         na_loc++;
65368a175baeSEmil Constantinescu       }
65378a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65388a175baeSEmil Constantinescu       if(tolr>0.){
65398a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
65408a175baeSEmil Constantinescu         nr_loc++;
65418a175baeSEmil Constantinescu       }
65428a175baeSEmil Constantinescu       tol=tola+tolr;
65438a175baeSEmil Constantinescu       if(tol>0.){
65448a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
65458a175baeSEmil Constantinescu         n_loc++;
65468a175baeSEmil Constantinescu       }
65478a175baeSEmil Constantinescu     }
65488a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65498a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65508a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
65518a175baeSEmil Constantinescu     const PetscScalar *atol;
65528a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65538a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65548a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65558a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
65568a175baeSEmil Constantinescu       if(tola>0.){
65578a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
65588a175baeSEmil Constantinescu         na_loc++;
65598a175baeSEmil Constantinescu       }
65608a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65618a175baeSEmil Constantinescu       if(tolr>0.){
65628a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
65638a175baeSEmil Constantinescu         nr_loc++;
65648a175baeSEmil Constantinescu       }
65658a175baeSEmil Constantinescu       tol=tola+tolr;
65668a175baeSEmil Constantinescu       if(tol>0.){
65678a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
65688a175baeSEmil Constantinescu         n_loc++;
65698a175baeSEmil Constantinescu       }
65708a175baeSEmil Constantinescu     }
65718a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65728a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
65738a175baeSEmil Constantinescu     const PetscScalar *rtol;
65748a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65758a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65768a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65778a175baeSEmil Constantinescu       tola = ts->atol;
65788a175baeSEmil Constantinescu       if(tola>0.){
65798a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
65808a175baeSEmil Constantinescu         na_loc++;
65818a175baeSEmil Constantinescu       }
65828a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65838a175baeSEmil Constantinescu       if(tolr>0.){
65848a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
65858a175baeSEmil Constantinescu         nr_loc++;
65868a175baeSEmil Constantinescu       }
65878a175baeSEmil Constantinescu       tol=tola+tolr;
65888a175baeSEmil Constantinescu       if(tol>0.){
65898a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
65908a175baeSEmil Constantinescu         n_loc++;
65918a175baeSEmil Constantinescu       }
65928a175baeSEmil Constantinescu     }
65938a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65948a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
65958a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65968a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65978a175baeSEmil Constantinescu      tola = ts->atol;
65988a175baeSEmil Constantinescu       if(tola>0.){
65998a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
66008a175baeSEmil Constantinescu         na_loc++;
66018a175baeSEmil Constantinescu       }
66028a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
66038a175baeSEmil Constantinescu       if(tolr>0.){
66048a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
66058a175baeSEmil Constantinescu         nr_loc++;
66068a175baeSEmil Constantinescu       }
66078a175baeSEmil Constantinescu       tol=tola+tolr;
66088a175baeSEmil Constantinescu       if(tol>0.){
66098a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
66108a175baeSEmil Constantinescu         n_loc++;
66118a175baeSEmil Constantinescu       }
66128a175baeSEmil Constantinescu     }
66138a175baeSEmil Constantinescu   }
66148a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
66158a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
66168a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
66178a175baeSEmil Constantinescu 
66188a175baeSEmil Constantinescu   err_loc[0] = sum;
66198a175baeSEmil Constantinescu   err_loc[1] = suma;
66208a175baeSEmil Constantinescu   err_loc[2] = sumr;
66218a175baeSEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
66228a175baeSEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
66238a175baeSEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
66248a175baeSEmil Constantinescu 
6625a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
66268a175baeSEmil Constantinescu 
66278a175baeSEmil Constantinescu   gsum   = err_glb[0];
66288a175baeSEmil Constantinescu   gsuma  = err_glb[1];
66298a175baeSEmil Constantinescu   gsumr  = err_glb[2];
66308a175baeSEmil Constantinescu   n_glb  = err_glb[3];
66318a175baeSEmil Constantinescu   na_glb = err_glb[4];
66328a175baeSEmil Constantinescu   nr_glb = err_glb[5];
66338a175baeSEmil Constantinescu 
66348a175baeSEmil Constantinescu   *norm  = 0.;
66358a175baeSEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
66368a175baeSEmil Constantinescu   *norma = 0.;
66378a175baeSEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
66388a175baeSEmil Constantinescu   *normr = 0.;
66398a175baeSEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
66408a175baeSEmil Constantinescu 
66418a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
66428a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
66438a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
66448a175baeSEmil Constantinescu   PetscFunctionReturn(0);
66458a175baeSEmil Constantinescu }
66468a175baeSEmil Constantinescu 
66478a175baeSEmil Constantinescu /*@
66488a175baeSEmil Constantinescu    TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances
66498a175baeSEmil Constantinescu    Collective on TS
66508a175baeSEmil Constantinescu 
66518a175baeSEmil Constantinescu    Input Arguments:
66528a175baeSEmil Constantinescu +  ts - time stepping context
66538a175baeSEmil Constantinescu .  E - error vector
66548a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
66558a175baeSEmil Constantinescu -  Y - state vector, previous time step
66568a175baeSEmil Constantinescu 
66578a175baeSEmil Constantinescu    Output Arguments:
66588a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
66598a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
66608a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
66618a175baeSEmil Constantinescu 
66628a175baeSEmil Constantinescu    Level: developer
66638a175baeSEmil Constantinescu 
66648a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2()
66658a175baeSEmil Constantinescu @*/
66668a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
66678a175baeSEmil Constantinescu {
66688a175baeSEmil Constantinescu   PetscErrorCode    ierr;
66698a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
66708a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
66718a175baeSEmil Constantinescu   PetscReal         err,max,gmax,maxa,gmaxa,maxr,gmaxr;
66728a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
66738a175baeSEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
66748a175baeSEmil Constantinescu 
66758a175baeSEmil Constantinescu   PetscFunctionBegin;
66768a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
66778a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
66788a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
66798a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
66808a175baeSEmil Constantinescu   PetscValidType(E,2);
66818a175baeSEmil Constantinescu   PetscValidType(U,3);
66828a175baeSEmil Constantinescu   PetscValidType(Y,4);
66838a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
66848a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
66858a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
66868a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
66878a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
66888a175baeSEmil Constantinescu 
66898a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
66908a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
66918a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
66928a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
66938a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
66948a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
66958a175baeSEmil Constantinescu 
66968a175baeSEmil Constantinescu   max=0.;
66978a175baeSEmil Constantinescu   maxa=0.;
66988a175baeSEmil Constantinescu   maxr=0.;
66998a175baeSEmil Constantinescu 
67008a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
67018a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
67028a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67038a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67048a175baeSEmil Constantinescu 
67058a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67068a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67078a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
67088a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67098a175baeSEmil Constantinescu       tol  = tola+tolr;
67108a175baeSEmil Constantinescu       if(tola>0.){
67118a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67128a175baeSEmil Constantinescu       }
67138a175baeSEmil Constantinescu       if(tolr>0.){
67148a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67158a175baeSEmil Constantinescu       }
67168a175baeSEmil Constantinescu       if(tol>0.){
67178a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67188a175baeSEmil Constantinescu       }
67198a175baeSEmil Constantinescu     }
67208a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67218a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67228a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
67238a175baeSEmil Constantinescu     const PetscScalar *atol;
67248a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67258a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67268a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67278a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
67288a175baeSEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67298a175baeSEmil Constantinescu       tol  = tola+tolr;
67308a175baeSEmil Constantinescu       if(tola>0.){
67318a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67328a175baeSEmil Constantinescu       }
67338a175baeSEmil Constantinescu       if(tolr>0.){
67348a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67358a175baeSEmil Constantinescu       }
67368a175baeSEmil Constantinescu       if(tol>0.){
67378a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67388a175baeSEmil Constantinescu       }
67398a175baeSEmil Constantinescu     }
67408a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67418a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
67428a175baeSEmil Constantinescu     const PetscScalar *rtol;
67438a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67448a175baeSEmil Constantinescu 
67458a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67468a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67478a175baeSEmil Constantinescu       tola = ts->atol;
67488a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67498a175baeSEmil Constantinescu       tol  = tola+tolr;
67508a175baeSEmil Constantinescu       if(tola>0.){
67518a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67528a175baeSEmil Constantinescu       }
67538a175baeSEmil Constantinescu       if(tolr>0.){
67548a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67558a175baeSEmil Constantinescu       }
67568a175baeSEmil Constantinescu       if(tol>0.){
67578a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67588a175baeSEmil Constantinescu       }
67598a175baeSEmil Constantinescu     }
67608a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67618a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
67628a175baeSEmil Constantinescu 
67638a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67648a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67658a175baeSEmil Constantinescu       tola = ts->atol;
67668a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67678a175baeSEmil Constantinescu       tol  = tola+tolr;
67688a175baeSEmil Constantinescu       if(tola>0.){
67698a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67708a175baeSEmil Constantinescu       }
67718a175baeSEmil Constantinescu       if(tolr>0.){
67728a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67738a175baeSEmil Constantinescu       }
67748a175baeSEmil Constantinescu       if(tol>0.){
67758a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67768a175baeSEmil Constantinescu       }
67778a175baeSEmil Constantinescu     }
67788a175baeSEmil Constantinescu   }
67798a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
67808a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
67818a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
67828a175baeSEmil Constantinescu   err_loc[0] = max;
67838a175baeSEmil Constantinescu   err_loc[1] = maxa;
67848a175baeSEmil Constantinescu   err_loc[2] = maxr;
6785a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
67868a175baeSEmil Constantinescu   gmax   = err_glb[0];
67878a175baeSEmil Constantinescu   gmaxa  = err_glb[1];
67888a175baeSEmil Constantinescu   gmaxr  = err_glb[2];
67898a175baeSEmil Constantinescu 
67908a175baeSEmil Constantinescu   *norm = gmax;
67918a175baeSEmil Constantinescu   *norma = gmaxa;
67928a175baeSEmil Constantinescu   *normr = gmaxr;
67938a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
67948a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
67958a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
67968a175baeSEmil Constantinescu   PetscFunctionReturn(0);
67978a175baeSEmil Constantinescu }
67988a175baeSEmil Constantinescu 
67998a175baeSEmil Constantinescu /*@
68008a175baeSEmil Constantinescu    TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
68018a175baeSEmil Constantinescu 
68028a175baeSEmil Constantinescu    Collective on TS
68038a175baeSEmil Constantinescu 
68048a175baeSEmil Constantinescu    Input Arguments:
68058a175baeSEmil Constantinescu +  ts - time stepping context
68068a175baeSEmil Constantinescu .  E - error vector
68078a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
68088a175baeSEmil Constantinescu .  Y - state vector, previous time step
68098a175baeSEmil Constantinescu -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
68108a175baeSEmil Constantinescu 
68118a175baeSEmil Constantinescu    Output Arguments:
68128a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
68138a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
68148a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
68158a175baeSEmil Constantinescu 
68168a175baeSEmil Constantinescu    Options Database Keys:
68178a175baeSEmil Constantinescu .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
68188a175baeSEmil Constantinescu 
68198a175baeSEmil Constantinescu    Level: developer
68208a175baeSEmil Constantinescu 
68218a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
68228a175baeSEmil Constantinescu @*/
68238a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
68248a175baeSEmil Constantinescu {
68258a175baeSEmil Constantinescu   PetscErrorCode ierr;
68268a175baeSEmil Constantinescu 
68278a175baeSEmil Constantinescu   PetscFunctionBegin;
68288a175baeSEmil Constantinescu   if (wnormtype == NORM_2) {
68298a175baeSEmil Constantinescu     ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
68308a175baeSEmil Constantinescu   } else if(wnormtype == NORM_INFINITY) {
68318a175baeSEmil Constantinescu     ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
68328a175baeSEmil Constantinescu   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
68338a175baeSEmil Constantinescu   PetscFunctionReturn(0);
68348a175baeSEmil Constantinescu }
68358a175baeSEmil Constantinescu 
68368a175baeSEmil Constantinescu 
68378d59e960SJed Brown /*@
68388d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
68398d59e960SJed Brown 
68408d59e960SJed Brown    Logically Collective on TS
68418d59e960SJed Brown 
68428d59e960SJed Brown    Input Arguments:
68438d59e960SJed Brown +  ts - time stepping context
68448d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
68458d59e960SJed Brown 
68468d59e960SJed Brown    Note:
68478d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
68488d59e960SJed Brown 
68498d59e960SJed Brown    Level: intermediate
68508d59e960SJed Brown 
68518d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
68528d59e960SJed Brown @*/
68538d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
68548d59e960SJed Brown {
68558d59e960SJed Brown   PetscFunctionBegin;
68568d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
68578d59e960SJed Brown   ts->cfltime_local = cfltime;
68588d59e960SJed Brown   ts->cfltime       = -1.;
68598d59e960SJed Brown   PetscFunctionReturn(0);
68608d59e960SJed Brown }
68618d59e960SJed Brown 
68628d59e960SJed Brown /*@
68638d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
68648d59e960SJed Brown 
68658d59e960SJed Brown    Collective on TS
68668d59e960SJed Brown 
68678d59e960SJed Brown    Input Arguments:
68688d59e960SJed Brown .  ts - time stepping context
68698d59e960SJed Brown 
68708d59e960SJed Brown    Output Arguments:
68718d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
68728d59e960SJed Brown 
68738d59e960SJed Brown    Level: advanced
68748d59e960SJed Brown 
68758d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
68768d59e960SJed Brown @*/
68778d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
68788d59e960SJed Brown {
68798d59e960SJed Brown   PetscErrorCode ierr;
68808d59e960SJed Brown 
68818d59e960SJed Brown   PetscFunctionBegin;
68828d59e960SJed Brown   if (ts->cfltime < 0) {
6883b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
68848d59e960SJed Brown   }
68858d59e960SJed Brown   *cfltime = ts->cfltime;
68868d59e960SJed Brown   PetscFunctionReturn(0);
68878d59e960SJed Brown }
68888d59e960SJed Brown 
6889d6ebe24aSShri Abhyankar /*@
6890d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6891d6ebe24aSShri Abhyankar 
6892d6ebe24aSShri Abhyankar    Input Parameters:
6893d6ebe24aSShri Abhyankar .  ts   - the TS context.
6894d6ebe24aSShri Abhyankar .  xl   - lower bound.
6895d6ebe24aSShri Abhyankar .  xu   - upper bound.
6896d6ebe24aSShri Abhyankar 
6897d6ebe24aSShri Abhyankar    Notes:
6898d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6899e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6900d6ebe24aSShri Abhyankar 
69012bd2b0e6SSatish Balay    Level: advanced
69022bd2b0e6SSatish Balay 
6903d6ebe24aSShri Abhyankar @*/
6904d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6905d6ebe24aSShri Abhyankar {
6906d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6907d6ebe24aSShri Abhyankar   SNES           snes;
6908d6ebe24aSShri Abhyankar 
6909d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6910d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6911d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6912d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6913d6ebe24aSShri Abhyankar }
6914d6ebe24aSShri Abhyankar 
6915325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
6916c6db04a5SJed Brown #include <mex.h>
6917325fc9f4SBarry Smith 
6918325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
6919325fc9f4SBarry Smith 
6920325fc9f4SBarry Smith /*
6921325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
6922325fc9f4SBarry Smith                          TSSetFunctionMatlab().
6923325fc9f4SBarry Smith 
6924325fc9f4SBarry Smith    Collective on TS
6925325fc9f4SBarry Smith 
6926325fc9f4SBarry Smith    Input Parameters:
6927325fc9f4SBarry Smith +  snes - the TS context
69280910c330SBarry Smith -  u - input vector
6929325fc9f4SBarry Smith 
6930325fc9f4SBarry Smith    Output Parameter:
6931325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
6932325fc9f4SBarry Smith 
6933325fc9f4SBarry Smith    Notes:
6934325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
6935325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
6936325fc9f4SBarry Smith    themselves.
6937325fc9f4SBarry Smith 
6938325fc9f4SBarry Smith    Level: developer
6939325fc9f4SBarry Smith 
6940325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6941325fc9f4SBarry Smith 
6942325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6943325fc9f4SBarry Smith */
69440910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
6945325fc9f4SBarry Smith {
6946325fc9f4SBarry Smith   PetscErrorCode  ierr;
6947325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6948325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
6949325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
6950325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
6951325fc9f4SBarry Smith 
6952325fc9f4SBarry Smith   PetscFunctionBegin;
6953325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
69540910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
69550910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
6956325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
69570910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
6958325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
6959325fc9f4SBarry Smith 
6960325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
69610910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
69620910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
69630910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
6964bbd56ea5SKarl Rupp 
6965325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6966325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
6967325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6968325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6969325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
6970325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
6971325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
6972325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
6973325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6974325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6975325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6976325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6977325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6978325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6979325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6980325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6981325fc9f4SBarry Smith   PetscFunctionReturn(0);
6982325fc9f4SBarry Smith }
6983325fc9f4SBarry Smith 
6984325fc9f4SBarry Smith /*
6985325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
6986325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
6987e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
6988325fc9f4SBarry Smith 
6989325fc9f4SBarry Smith    Logically Collective on TS
6990325fc9f4SBarry Smith 
6991325fc9f4SBarry Smith    Input Parameters:
6992325fc9f4SBarry Smith +  ts - the TS context
6993325fc9f4SBarry Smith -  func - function evaluation routine
6994325fc9f4SBarry Smith 
6995325fc9f4SBarry Smith    Calling sequence of func:
69960910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
6997325fc9f4SBarry Smith 
6998325fc9f4SBarry Smith    Level: beginner
6999325fc9f4SBarry Smith 
7000325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
7001325fc9f4SBarry Smith 
7002325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
7003325fc9f4SBarry Smith */
7004cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
7005325fc9f4SBarry Smith {
7006325fc9f4SBarry Smith   PetscErrorCode  ierr;
7007325fc9f4SBarry Smith   TSMatlabContext *sctx;
7008325fc9f4SBarry Smith 
7009325fc9f4SBarry Smith   PetscFunctionBegin;
7010325fc9f4SBarry Smith   /* currently sctx is memory bleed */
701195dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
7012325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
7013325fc9f4SBarry Smith   /*
7014325fc9f4SBarry Smith      This should work, but it doesn't
7015325fc9f4SBarry Smith   sctx->ctx = ctx;
7016325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
7017325fc9f4SBarry Smith   */
7018325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
7019bbd56ea5SKarl Rupp 
70200298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
7021325fc9f4SBarry Smith   PetscFunctionReturn(0);
7022325fc9f4SBarry Smith }
7023325fc9f4SBarry Smith 
7024325fc9f4SBarry Smith /*
7025325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
7026325fc9f4SBarry Smith                          TSSetJacobianMatlab().
7027325fc9f4SBarry Smith 
7028325fc9f4SBarry Smith    Collective on TS
7029325fc9f4SBarry Smith 
7030325fc9f4SBarry Smith    Input Parameters:
7031cdcf91faSSean Farley +  ts - the TS context
70320910c330SBarry Smith .  u - input vector
7033325fc9f4SBarry Smith .  A, B - the matrices
7034325fc9f4SBarry Smith -  ctx - user context
7035325fc9f4SBarry Smith 
7036325fc9f4SBarry Smith    Level: developer
7037325fc9f4SBarry Smith 
7038325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
7039325fc9f4SBarry Smith 
7040325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
7041325fc9f4SBarry Smith @*/
7042f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
7043325fc9f4SBarry Smith {
7044325fc9f4SBarry Smith   PetscErrorCode  ierr;
7045325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
7046325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
7047325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
7048325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
7049325fc9f4SBarry Smith 
7050325fc9f4SBarry Smith   PetscFunctionBegin;
7051cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
70520910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
7053325fc9f4SBarry Smith 
70540910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
7055325fc9f4SBarry Smith 
7056cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
70570910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
70580910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
70590910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
70600910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
7061bbd56ea5SKarl Rupp 
7062325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
7063325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
7064325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
7065325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
7066325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
7067325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
7068325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
7069325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
7070325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
7071325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
7072325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
7073325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
7074325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
7075325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
7076325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
7077325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
7078325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
7079325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
7080325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
7081325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
7082325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
7083325fc9f4SBarry Smith   PetscFunctionReturn(0);
7084325fc9f4SBarry Smith }
7085325fc9f4SBarry Smith 
7086325fc9f4SBarry Smith /*
7087325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
7088e3c5b3baSBarry Smith    vector for use by the TS routines in solving ODEs from MATLAB. Here the function is a string containing the name of a MATLAB function
7089325fc9f4SBarry Smith 
7090325fc9f4SBarry Smith    Logically Collective on TS
7091325fc9f4SBarry Smith 
7092325fc9f4SBarry Smith    Input Parameters:
7093cdcf91faSSean Farley +  ts - the TS context
7094325fc9f4SBarry Smith .  A,B - Jacobian matrices
7095325fc9f4SBarry Smith .  func - function evaluation routine
7096325fc9f4SBarry Smith -  ctx - user context
7097325fc9f4SBarry Smith 
7098325fc9f4SBarry Smith    Calling sequence of func:
70990910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
7100325fc9f4SBarry Smith 
7101325fc9f4SBarry Smith    Level: developer
7102325fc9f4SBarry Smith 
7103325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
7104325fc9f4SBarry Smith 
7105325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
7106325fc9f4SBarry Smith */
7107cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
7108325fc9f4SBarry Smith {
7109325fc9f4SBarry Smith   PetscErrorCode  ierr;
7110325fc9f4SBarry Smith   TSMatlabContext *sctx;
7111325fc9f4SBarry Smith 
7112325fc9f4SBarry Smith   PetscFunctionBegin;
7113325fc9f4SBarry Smith   /* currently sctx is memory bleed */
711495dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
7115325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
7116325fc9f4SBarry Smith   /*
7117325fc9f4SBarry Smith      This should work, but it doesn't
7118325fc9f4SBarry Smith   sctx->ctx = ctx;
7119325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
7120325fc9f4SBarry Smith   */
7121325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
7122bbd56ea5SKarl Rupp 
7123cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
7124325fc9f4SBarry Smith   PetscFunctionReturn(0);
7125325fc9f4SBarry Smith }
7126325fc9f4SBarry Smith 
7127b5b1a830SBarry Smith /*
7128b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
7129b5b1a830SBarry Smith 
7130b5b1a830SBarry Smith    Collective on TS
7131b5b1a830SBarry Smith 
7132b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
7133b5b1a830SBarry Smith @*/
71340910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
7135b5b1a830SBarry Smith {
7136b5b1a830SBarry Smith   PetscErrorCode  ierr;
7137b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
7138a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
7139b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
7140b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
7141b5b1a830SBarry Smith 
7142b5b1a830SBarry Smith   PetscFunctionBegin;
7143cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
71440910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
7145b5b1a830SBarry Smith 
7146cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
71470910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
7148bbd56ea5SKarl Rupp 
7149b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
7150b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
7151b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
7152b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
7153b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
7154b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
7155b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
7156b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
7157b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
7158b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
7159b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
7160b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
7161b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
7162b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
7163b5b1a830SBarry Smith   PetscFunctionReturn(0);
7164b5b1a830SBarry Smith }
7165b5b1a830SBarry Smith 
7166b5b1a830SBarry Smith /*
7167b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
7168b5b1a830SBarry Smith 
7169b5b1a830SBarry Smith    Level: developer
7170b5b1a830SBarry Smith 
7171b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
7172b5b1a830SBarry Smith 
7173b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
7174b5b1a830SBarry Smith */
7175cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
7176b5b1a830SBarry Smith {
7177b5b1a830SBarry Smith   PetscErrorCode  ierr;
7178b5b1a830SBarry Smith   TSMatlabContext *sctx;
7179b5b1a830SBarry Smith 
7180b5b1a830SBarry Smith   PetscFunctionBegin;
7181b5b1a830SBarry Smith   /* currently sctx is memory bleed */
718295dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
7183b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
7184b5b1a830SBarry Smith   /*
7185b5b1a830SBarry Smith      This should work, but it doesn't
7186b5b1a830SBarry Smith   sctx->ctx = ctx;
7187b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
7188b5b1a830SBarry Smith   */
7189b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
7190bbd56ea5SKarl Rupp 
71910298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
7192b5b1a830SBarry Smith   PetscFunctionReturn(0);
7193b5b1a830SBarry Smith }
7194325fc9f4SBarry Smith #endif
7195b3603a34SBarry Smith 
7196b3603a34SBarry Smith /*@C
71974f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
7198b3603a34SBarry Smith        in a time based line graph
7199b3603a34SBarry Smith 
7200b3603a34SBarry Smith    Collective on TS
7201b3603a34SBarry Smith 
7202b3603a34SBarry Smith    Input Parameters:
7203b3603a34SBarry Smith +  ts - the TS context
7204b3603a34SBarry Smith .  step - current time-step
7205b3603a34SBarry Smith .  ptime - current time
72067db568b7SBarry Smith .  u - current solution
72077db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
7208b3603a34SBarry Smith 
7209b3d3934dSBarry Smith    Options Database:
72109ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
7211b3d3934dSBarry Smith 
7212b3603a34SBarry Smith    Level: intermediate
7213b3603a34SBarry Smith 
72146934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component solutions in a separate window
7215b3603a34SBarry Smith 
7216b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
7217b3603a34SBarry Smith 
72187db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
72197db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
72207db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
72217db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
7222b3603a34SBarry Smith @*/
72237db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7224b3603a34SBarry Smith {
7225b3603a34SBarry Smith   PetscErrorCode    ierr;
72267db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
7227b3603a34SBarry Smith   const PetscScalar *yy;
722880666b62SBarry Smith   Vec               v;
7229b3603a34SBarry Smith 
7230b3603a34SBarry Smith   PetscFunctionBegin;
723163e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
723258ff32f7SBarry Smith   if (!step) {
7233a9f9c1f6SBarry Smith     PetscDrawAxis axis;
72346934998bSLisandro Dalcin     PetscInt      dim;
7235a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7236a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
7237bab0a581SBarry Smith     if (!ctx->names) {
7238bab0a581SBarry Smith       PetscBool flg;
7239bab0a581SBarry Smith       /* user provides names of variables to plot but no names has been set so assume names are integer values */
7240bab0a581SBarry Smith       ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr);
7241bab0a581SBarry Smith       if (flg) {
7242bab0a581SBarry Smith         PetscInt i,n;
7243bab0a581SBarry Smith         char     **names;
7244bab0a581SBarry Smith         ierr = VecGetSize(u,&n);CHKERRQ(ierr);
7245bab0a581SBarry Smith         ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr);
7246bab0a581SBarry Smith         for (i=0; i<n; i++) {
7247bab0a581SBarry Smith           ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr);
7248bab0a581SBarry Smith           ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr);
7249bab0a581SBarry Smith         }
7250bab0a581SBarry Smith         names[n] = NULL;
7251bab0a581SBarry Smith         ctx->names = names;
7252bab0a581SBarry Smith       }
7253bab0a581SBarry Smith     }
7254387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
7255387f4636SBarry Smith       char      **displaynames;
7256387f4636SBarry Smith       PetscBool flg;
7257387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
725895dccacaSBarry Smith       ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr);
7259387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
7260c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
7261387f4636SBarry Smith       if (flg) {
7262a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
7263387f4636SBarry Smith       }
7264387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
7265387f4636SBarry Smith     }
7266387f4636SBarry Smith     if (ctx->displaynames) {
7267387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
7268387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
7269387f4636SBarry Smith     } else if (ctx->names) {
72700910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
72710b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7272387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
7273b0bc92c6SBarry Smith     } else {
7274b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
7275b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7276387f4636SBarry Smith     }
72770b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
727858ff32f7SBarry Smith   }
72796934998bSLisandro Dalcin 
72806934998bSLisandro Dalcin   if (!ctx->transform) v = u;
72816934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
728280666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
72836934998bSLisandro Dalcin   if (ctx->displaynames) {
72846934998bSLisandro Dalcin     PetscInt i;
72856934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
72866934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
72876934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
72886934998bSLisandro Dalcin   } else {
7289e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
7290e3efe391SJed Brown     PetscInt  i,n;
72916934998bSLisandro Dalcin     PetscReal *yreal;
729280666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
7293785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
7294e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
72950b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
7296e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
7297e3efe391SJed Brown #else
72980b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
7299e3efe391SJed Brown #endif
730080666b62SBarry Smith   }
73016934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
73026934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
73036934998bSLisandro Dalcin 
7304b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
73050b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
73066934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
73073923b477SBarry Smith   }
7308b3603a34SBarry Smith   PetscFunctionReturn(0);
7309b3603a34SBarry Smith }
7310b3603a34SBarry Smith 
7311b037adc7SBarry Smith /*@C
731231152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
7313b037adc7SBarry Smith 
7314b037adc7SBarry Smith    Collective on TS
7315b037adc7SBarry Smith 
7316b037adc7SBarry Smith    Input Parameters:
7317b037adc7SBarry Smith +  ts - the TS context
7318b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
7319b037adc7SBarry Smith 
7320b037adc7SBarry Smith    Level: intermediate
7321b037adc7SBarry Smith 
73227db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
73237db568b7SBarry Smith 
7324b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
7325b037adc7SBarry Smith 
7326a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
7327b037adc7SBarry Smith @*/
732831152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
7329b037adc7SBarry Smith {
7330b037adc7SBarry Smith   PetscErrorCode    ierr;
7331b037adc7SBarry Smith   PetscInt          i;
7332b037adc7SBarry Smith 
7333b037adc7SBarry Smith   PetscFunctionBegin;
7334b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7335b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
73365537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
7337b3d3934dSBarry Smith       break;
7338b3d3934dSBarry Smith     }
7339b3d3934dSBarry Smith   }
7340b3d3934dSBarry Smith   PetscFunctionReturn(0);
7341b3d3934dSBarry Smith }
7342b3d3934dSBarry Smith 
7343e673d494SBarry Smith /*@C
7344e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
7345e673d494SBarry Smith 
7346e673d494SBarry Smith    Collective on TS
7347e673d494SBarry Smith 
7348e673d494SBarry Smith    Input Parameters:
7349e673d494SBarry Smith +  ts - the TS context
7350e673d494SBarry Smith -  names - the names of the components, final string must be NULL
7351e673d494SBarry Smith 
7352e673d494SBarry Smith    Level: intermediate
7353e673d494SBarry Smith 
7354e673d494SBarry Smith .keywords: TS,  vector, monitor, view
7355e673d494SBarry Smith 
7356a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
7357e673d494SBarry Smith @*/
7358e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
7359e673d494SBarry Smith {
7360e673d494SBarry Smith   PetscErrorCode    ierr;
7361e673d494SBarry Smith 
7362e673d494SBarry Smith   PetscFunctionBegin;
7363e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
7364e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
7365e673d494SBarry Smith   PetscFunctionReturn(0);
7366e673d494SBarry Smith }
7367e673d494SBarry Smith 
7368b3d3934dSBarry Smith /*@C
7369b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
7370b3d3934dSBarry Smith 
7371b3d3934dSBarry Smith    Collective on TS
7372b3d3934dSBarry Smith 
7373b3d3934dSBarry Smith    Input Parameter:
7374b3d3934dSBarry Smith .  ts - the TS context
7375b3d3934dSBarry Smith 
7376b3d3934dSBarry Smith    Output Parameter:
7377b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
7378b3d3934dSBarry Smith 
7379b3d3934dSBarry Smith    Level: intermediate
7380b3d3934dSBarry Smith 
73817db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
73827db568b7SBarry Smith 
7383b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7384b3d3934dSBarry Smith 
7385b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7386b3d3934dSBarry Smith @*/
7387b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
7388b3d3934dSBarry Smith {
7389b3d3934dSBarry Smith   PetscInt       i;
7390b3d3934dSBarry Smith 
7391b3d3934dSBarry Smith   PetscFunctionBegin;
7392b3d3934dSBarry Smith   *names = NULL;
7393b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7394b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
73955537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
7396b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
7397b3d3934dSBarry Smith       break;
7398387f4636SBarry Smith     }
7399387f4636SBarry Smith   }
7400387f4636SBarry Smith   PetscFunctionReturn(0);
7401387f4636SBarry Smith }
7402387f4636SBarry Smith 
7403a66092f1SBarry Smith /*@C
7404a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
7405a66092f1SBarry Smith 
7406a66092f1SBarry Smith    Collective on TS
7407a66092f1SBarry Smith 
7408a66092f1SBarry Smith    Input Parameters:
7409a66092f1SBarry Smith +  ctx - the TSMonitorLG context
7410a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
7411a66092f1SBarry Smith 
7412a66092f1SBarry Smith    Level: intermediate
7413a66092f1SBarry Smith 
7414a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
7415a66092f1SBarry Smith 
7416a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
7417a66092f1SBarry Smith @*/
7418a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
7419a66092f1SBarry Smith {
7420a66092f1SBarry Smith   PetscInt          j = 0,k;
7421a66092f1SBarry Smith   PetscErrorCode    ierr;
7422a66092f1SBarry Smith 
7423a66092f1SBarry Smith   PetscFunctionBegin;
7424a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
7425a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
7426a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
7427a66092f1SBarry Smith   while (displaynames[j]) j++;
7428a66092f1SBarry Smith   ctx->ndisplayvariables = j;
7429a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
7430a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
7431a66092f1SBarry Smith   j = 0;
7432a66092f1SBarry Smith   while (displaynames[j]) {
7433a66092f1SBarry Smith     k = 0;
7434a66092f1SBarry Smith     while (ctx->names[k]) {
7435a66092f1SBarry Smith       PetscBool flg;
7436a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
7437a66092f1SBarry Smith       if (flg) {
7438a66092f1SBarry Smith         ctx->displayvariables[j] = k;
7439a66092f1SBarry Smith         break;
7440a66092f1SBarry Smith       }
7441a66092f1SBarry Smith       k++;
7442a66092f1SBarry Smith     }
7443a66092f1SBarry Smith     j++;
7444a66092f1SBarry Smith   }
7445a66092f1SBarry Smith   PetscFunctionReturn(0);
7446a66092f1SBarry Smith }
7447a66092f1SBarry Smith 
7448387f4636SBarry Smith /*@C
7449387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
7450387f4636SBarry Smith 
7451387f4636SBarry Smith    Collective on TS
7452387f4636SBarry Smith 
7453387f4636SBarry Smith    Input Parameters:
7454387f4636SBarry Smith +  ts - the TS context
7455387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
7456387f4636SBarry Smith 
74577db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
74587db568b7SBarry Smith 
7459387f4636SBarry Smith    Level: intermediate
7460387f4636SBarry Smith 
7461387f4636SBarry Smith .keywords: TS,  vector, monitor, view
7462387f4636SBarry Smith 
7463387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
7464387f4636SBarry Smith @*/
7465387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
7466387f4636SBarry Smith {
7467a66092f1SBarry Smith   PetscInt          i;
7468387f4636SBarry Smith   PetscErrorCode    ierr;
7469387f4636SBarry Smith 
7470387f4636SBarry Smith   PetscFunctionBegin;
7471387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7472387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
74735537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
7474b3d3934dSBarry Smith       break;
7475b037adc7SBarry Smith     }
7476b037adc7SBarry Smith   }
7477b037adc7SBarry Smith   PetscFunctionReturn(0);
7478b037adc7SBarry Smith }
7479b037adc7SBarry Smith 
748080666b62SBarry Smith /*@C
748180666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
748280666b62SBarry Smith 
748380666b62SBarry Smith    Collective on TS
748480666b62SBarry Smith 
748580666b62SBarry Smith    Input Parameters:
748680666b62SBarry Smith +  ts - the TS context
748780666b62SBarry Smith .  transform - the transform function
74887684fa3eSBarry Smith .  destroy - function to destroy the optional context
748980666b62SBarry Smith -  ctx - optional context used by transform function
749080666b62SBarry Smith 
74917db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
74927db568b7SBarry Smith 
749380666b62SBarry Smith    Level: intermediate
749480666b62SBarry Smith 
749580666b62SBarry Smith .keywords: TS,  vector, monitor, view
749680666b62SBarry Smith 
7497a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
749880666b62SBarry Smith @*/
74997684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
750080666b62SBarry Smith {
750180666b62SBarry Smith   PetscInt          i;
7502a66092f1SBarry Smith   PetscErrorCode    ierr;
750380666b62SBarry Smith 
750480666b62SBarry Smith   PetscFunctionBegin;
750580666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
750680666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
75075537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
750880666b62SBarry Smith     }
750980666b62SBarry Smith   }
751080666b62SBarry Smith   PetscFunctionReturn(0);
751180666b62SBarry Smith }
751280666b62SBarry Smith 
7513e673d494SBarry Smith /*@C
7514e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
7515e673d494SBarry Smith 
7516e673d494SBarry Smith    Collective on TSLGCtx
7517e673d494SBarry Smith 
7518e673d494SBarry Smith    Input Parameters:
7519e673d494SBarry Smith +  ts - the TS context
7520e673d494SBarry Smith .  transform - the transform function
75217684fa3eSBarry Smith .  destroy - function to destroy the optional context
7522e673d494SBarry Smith -  ctx - optional context used by transform function
7523e673d494SBarry Smith 
7524e673d494SBarry Smith    Level: intermediate
7525e673d494SBarry Smith 
7526e673d494SBarry Smith .keywords: TS,  vector, monitor, view
7527e673d494SBarry Smith 
7528a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
7529e673d494SBarry Smith @*/
75307684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
7531e673d494SBarry Smith {
7532e673d494SBarry Smith   PetscFunctionBegin;
7533e673d494SBarry Smith   ctx->transform    = transform;
75347684fa3eSBarry Smith   ctx->transformdestroy = destroy;
7535e673d494SBarry Smith   ctx->transformctx = tctx;
7536e673d494SBarry Smith   PetscFunctionReturn(0);
7537e673d494SBarry Smith }
7538e673d494SBarry Smith 
7539ef20d060SBarry Smith /*@C
75408b668821SLisandro Dalcin    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the error
7541ef20d060SBarry Smith        in a time based line graph
7542ef20d060SBarry Smith 
7543ef20d060SBarry Smith    Collective on TS
7544ef20d060SBarry Smith 
7545ef20d060SBarry Smith    Input Parameters:
7546ef20d060SBarry Smith +  ts - the TS context
7547ef20d060SBarry Smith .  step - current time-step
7548ef20d060SBarry Smith .  ptime - current time
75497db568b7SBarry Smith .  u - current solution
75507db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
7551ef20d060SBarry Smith 
7552ef20d060SBarry Smith    Level: intermediate
7553ef20d060SBarry Smith 
75546934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component errors in a separate window
7555abd5a294SJed Brown 
7556abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
7557abd5a294SJed Brown 
7558abd5a294SJed Brown    Options Database Keys:
75594f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
7560ef20d060SBarry Smith 
7561ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
7562ef20d060SBarry Smith 
7563abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
7564ef20d060SBarry Smith @*/
75650910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
7566ef20d060SBarry Smith {
7567ef20d060SBarry Smith   PetscErrorCode    ierr;
75680b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
7569ef20d060SBarry Smith   const PetscScalar *yy;
7570ef20d060SBarry Smith   Vec               y;
7571ef20d060SBarry Smith 
7572ef20d060SBarry Smith   PetscFunctionBegin;
7573a9f9c1f6SBarry Smith   if (!step) {
7574a9f9c1f6SBarry Smith     PetscDrawAxis axis;
75756934998bSLisandro Dalcin     PetscInt      dim;
7576a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
75778b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Error");CHKERRQ(ierr);
75780910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
7579a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7580a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7581a9f9c1f6SBarry Smith   }
75820910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
7583ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
75840910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
7585ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
7586e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
7587e3efe391SJed Brown   {
7588e3efe391SJed Brown     PetscReal *yreal;
7589e3efe391SJed Brown     PetscInt  i,n;
7590e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
7591785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
7592e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
75930b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
7594e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
7595e3efe391SJed Brown   }
7596e3efe391SJed Brown #else
75970b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
7598e3efe391SJed Brown #endif
7599ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
7600ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
7601b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
76020b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
76036934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
76043923b477SBarry Smith   }
7605ef20d060SBarry Smith   PetscFunctionReturn(0);
7606ef20d060SBarry Smith }
7607ef20d060SBarry Smith 
7608201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7609201da799SBarry Smith {
7610201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7611201da799SBarry Smith   PetscReal      x   = ptime,y;
7612201da799SBarry Smith   PetscErrorCode ierr;
7613201da799SBarry Smith   PetscInt       its;
7614201da799SBarry Smith 
7615201da799SBarry Smith   PetscFunctionBegin;
761663e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7617201da799SBarry Smith   if (!n) {
7618201da799SBarry Smith     PetscDrawAxis axis;
7619201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7620201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
7621201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7622201da799SBarry Smith     ctx->snes_its = 0;
7623201da799SBarry Smith   }
7624201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
7625201da799SBarry Smith   y    = its - ctx->snes_its;
7626201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
76273fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7628201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
76296934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7630201da799SBarry Smith   }
7631201da799SBarry Smith   ctx->snes_its = its;
7632201da799SBarry Smith   PetscFunctionReturn(0);
7633201da799SBarry Smith }
7634201da799SBarry Smith 
7635201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7636201da799SBarry Smith {
7637201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7638201da799SBarry Smith   PetscReal      x   = ptime,y;
7639201da799SBarry Smith   PetscErrorCode ierr;
7640201da799SBarry Smith   PetscInt       its;
7641201da799SBarry Smith 
7642201da799SBarry Smith   PetscFunctionBegin;
764363e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7644201da799SBarry Smith   if (!n) {
7645201da799SBarry Smith     PetscDrawAxis axis;
7646201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7647201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
7648201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7649201da799SBarry Smith     ctx->ksp_its = 0;
7650201da799SBarry Smith   }
7651201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
7652201da799SBarry Smith   y    = its - ctx->ksp_its;
7653201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
765499fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7655201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
76566934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7657201da799SBarry Smith   }
7658201da799SBarry Smith   ctx->ksp_its = its;
7659201da799SBarry Smith   PetscFunctionReturn(0);
7660201da799SBarry Smith }
7661f9c1d6abSBarry Smith 
7662f9c1d6abSBarry Smith /*@
7663f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
7664f9c1d6abSBarry Smith 
7665f9c1d6abSBarry Smith    Collective on TS and Vec
7666f9c1d6abSBarry Smith 
7667f9c1d6abSBarry Smith    Input Parameters:
7668f9c1d6abSBarry Smith +  ts - the TS context
7669f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
7670f9c1d6abSBarry Smith 
7671f9c1d6abSBarry Smith    Output Parameters:
7672f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
7673f9c1d6abSBarry Smith 
7674f9c1d6abSBarry Smith    Level: developer
7675f9c1d6abSBarry Smith 
7676f9c1d6abSBarry Smith .keywords: TS, compute
7677f9c1d6abSBarry Smith 
7678f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
7679f9c1d6abSBarry Smith @*/
7680f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
7681f9c1d6abSBarry Smith {
7682f9c1d6abSBarry Smith   PetscErrorCode ierr;
7683f9c1d6abSBarry Smith 
7684f9c1d6abSBarry Smith   PetscFunctionBegin;
7685f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7686ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
7687f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
7688f9c1d6abSBarry Smith   PetscFunctionReturn(0);
7689f9c1d6abSBarry Smith }
769024655328SShri 
7691b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
7692b3d3934dSBarry Smith /*@C
7693b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
7694b3d3934dSBarry Smith 
7695b3d3934dSBarry Smith    Collective on TS
7696b3d3934dSBarry Smith 
7697b3d3934dSBarry Smith    Input Parameters:
7698b3d3934dSBarry Smith .  ts  - the ODE solver object
7699b3d3934dSBarry Smith 
7700b3d3934dSBarry Smith    Output Parameter:
7701b3d3934dSBarry Smith .  ctx - the context
7702b3d3934dSBarry Smith 
7703b3d3934dSBarry Smith    Level: intermediate
7704b3d3934dSBarry Smith 
7705b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
7706b3d3934dSBarry Smith 
7707b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
7708b3d3934dSBarry Smith 
7709b3d3934dSBarry Smith @*/
7710b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
7711b3d3934dSBarry Smith {
7712b3d3934dSBarry Smith   PetscErrorCode ierr;
7713b3d3934dSBarry Smith 
7714b3d3934dSBarry Smith   PetscFunctionBegin;
7715a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
7716b3d3934dSBarry Smith   PetscFunctionReturn(0);
7717b3d3934dSBarry Smith }
7718b3d3934dSBarry Smith 
7719b3d3934dSBarry Smith /*@C
7720b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
7721b3d3934dSBarry Smith 
7722b3d3934dSBarry Smith    Collective on TS
7723b3d3934dSBarry Smith 
7724b3d3934dSBarry Smith    Input Parameters:
7725b3d3934dSBarry Smith +  ts - the TS context
7726b3d3934dSBarry Smith .  step - current time-step
7727b3d3934dSBarry Smith .  ptime - current time
77287db568b7SBarry Smith .  u  - current solution
77297db568b7SBarry Smith -  dctx - the envelope context
7730b3d3934dSBarry Smith 
7731b3d3934dSBarry Smith    Options Database:
7732b3d3934dSBarry Smith .  -ts_monitor_envelope
7733b3d3934dSBarry Smith 
7734b3d3934dSBarry Smith    Level: intermediate
7735b3d3934dSBarry Smith 
7736b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
7737b3d3934dSBarry Smith 
7738b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7739b3d3934dSBarry Smith 
77407db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
7741b3d3934dSBarry Smith @*/
77427db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7743b3d3934dSBarry Smith {
7744b3d3934dSBarry Smith   PetscErrorCode       ierr;
77457db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
7746b3d3934dSBarry Smith 
7747b3d3934dSBarry Smith   PetscFunctionBegin;
7748b3d3934dSBarry Smith   if (!ctx->max) {
7749b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
7750b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
7751b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
7752b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
7753b3d3934dSBarry Smith   } else {
7754b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
7755b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
7756b3d3934dSBarry Smith   }
7757b3d3934dSBarry Smith   PetscFunctionReturn(0);
7758b3d3934dSBarry Smith }
7759b3d3934dSBarry Smith 
7760b3d3934dSBarry Smith /*@C
7761b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
7762b3d3934dSBarry Smith 
7763b3d3934dSBarry Smith    Collective on TS
7764b3d3934dSBarry Smith 
7765b3d3934dSBarry Smith    Input Parameter:
7766b3d3934dSBarry Smith .  ts - the TS context
7767b3d3934dSBarry Smith 
7768b3d3934dSBarry Smith    Output Parameter:
7769b3d3934dSBarry Smith +  max - the maximum values
7770b3d3934dSBarry Smith -  min - the minimum values
7771b3d3934dSBarry Smith 
77727db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
77737db568b7SBarry Smith 
7774b3d3934dSBarry Smith    Level: intermediate
7775b3d3934dSBarry Smith 
7776b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7777b3d3934dSBarry Smith 
7778b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7779b3d3934dSBarry Smith @*/
7780b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
7781b3d3934dSBarry Smith {
7782b3d3934dSBarry Smith   PetscInt i;
7783b3d3934dSBarry Smith 
7784b3d3934dSBarry Smith   PetscFunctionBegin;
7785b3d3934dSBarry Smith   if (max) *max = NULL;
7786b3d3934dSBarry Smith   if (min) *min = NULL;
7787b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7788b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
77895537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7790b3d3934dSBarry Smith       if (max) *max = ctx->max;
7791b3d3934dSBarry Smith       if (min) *min = ctx->min;
7792b3d3934dSBarry Smith       break;
7793b3d3934dSBarry Smith     }
7794b3d3934dSBarry Smith   }
7795b3d3934dSBarry Smith   PetscFunctionReturn(0);
7796b3d3934dSBarry Smith }
7797b3d3934dSBarry Smith 
7798b3d3934dSBarry Smith /*@C
7799b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7800b3d3934dSBarry Smith 
7801b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7802b3d3934dSBarry Smith 
7803b3d3934dSBarry Smith    Input Parameter:
7804b3d3934dSBarry Smith .  ctx - the monitor context
7805b3d3934dSBarry Smith 
7806b3d3934dSBarry Smith    Level: intermediate
7807b3d3934dSBarry Smith 
7808b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
7809b3d3934dSBarry Smith 
78107db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7811b3d3934dSBarry Smith @*/
7812b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7813b3d3934dSBarry Smith {
7814b3d3934dSBarry Smith   PetscErrorCode ierr;
7815b3d3934dSBarry Smith 
7816b3d3934dSBarry Smith   PetscFunctionBegin;
7817b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7818b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7819b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7820b3d3934dSBarry Smith   PetscFunctionReturn(0);
7821b3d3934dSBarry Smith }
7822f2dee214SBarry Smith 
782324655328SShri /*@
7824dcb233daSLisandro Dalcin    TSRestartStep - Flags the solver to restart the next step
7825dcb233daSLisandro Dalcin 
7826dcb233daSLisandro Dalcin    Collective on TS
7827dcb233daSLisandro Dalcin 
7828dcb233daSLisandro Dalcin    Input Parameter:
7829dcb233daSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
7830dcb233daSLisandro Dalcin 
7831dcb233daSLisandro Dalcin    Level: advanced
7832dcb233daSLisandro Dalcin 
7833dcb233daSLisandro Dalcin    Notes:
7834dcb233daSLisandro Dalcin    Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of
7835dcb233daSLisandro Dalcin    discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution
7836dcb233daSLisandro Dalcin    vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For
7837dcb233daSLisandro Dalcin    the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce
7838dcb233daSLisandro Dalcin    discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with
7839dcb233daSLisandro Dalcin    discontinuous source terms).
7840dcb233daSLisandro Dalcin 
7841dcb233daSLisandro Dalcin .keywords: TS, timestep, restart
7842dcb233daSLisandro Dalcin 
7843dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep()
7844dcb233daSLisandro Dalcin @*/
7845dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts)
7846dcb233daSLisandro Dalcin {
7847dcb233daSLisandro Dalcin   PetscFunctionBegin;
7848dcb233daSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7849dcb233daSLisandro Dalcin   ts->steprestart = PETSC_TRUE;
7850dcb233daSLisandro Dalcin   PetscFunctionReturn(0);
7851dcb233daSLisandro Dalcin }
7852dcb233daSLisandro Dalcin 
7853dcb233daSLisandro Dalcin /*@
785424655328SShri    TSRollBack - Rolls back one time step
785524655328SShri 
785624655328SShri    Collective on TS
785724655328SShri 
785824655328SShri    Input Parameter:
785924655328SShri .  ts - the TS context obtained from TSCreate()
786024655328SShri 
786124655328SShri    Level: advanced
786224655328SShri 
786324655328SShri .keywords: TS, timestep, rollback
786424655328SShri 
786524655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
786624655328SShri @*/
786724655328SShri PetscErrorCode  TSRollBack(TS ts)
786824655328SShri {
786924655328SShri   PetscErrorCode ierr;
787024655328SShri 
787124655328SShri   PetscFunctionBegin;
787224655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7873b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
787424655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
787524655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
787624655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
787724655328SShri   ts->ptime = ts->ptime_prev;
7878be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
78792808aa04SLisandro Dalcin   ts->steps--;
7880b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
788124655328SShri   PetscFunctionReturn(0);
788224655328SShri }
7883aeb4809dSShri Abhyankar 
7884ff22ae23SHong Zhang /*@
7885ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7886ff22ae23SHong Zhang 
7887ff22ae23SHong Zhang    Input Parameter:
7888ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7889ff22ae23SHong Zhang 
7890ff22ae23SHong Zhang    Level: advanced
7891ff22ae23SHong Zhang 
7892ff22ae23SHong Zhang .keywords: TS, getstages
7893ff22ae23SHong Zhang 
7894ff22ae23SHong Zhang .seealso: TSCreate()
7895ff22ae23SHong Zhang @*/
7896ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7897ff22ae23SHong Zhang {
7898ff22ae23SHong Zhang   PetscErrorCode ierr;
7899ff22ae23SHong Zhang 
7900ff22ae23SHong Zhang   PetscFunctionBegin;
7901ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7902ff22ae23SHong Zhang   PetscValidPointer(ns,2);
7903ff22ae23SHong Zhang 
7904ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
7905ff22ae23SHong Zhang   else {
7906ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7907ff22ae23SHong Zhang   }
7908ff22ae23SHong Zhang   PetscFunctionReturn(0);
7909ff22ae23SHong Zhang }
7910ff22ae23SHong Zhang 
7911847ff0e1SMatthew G. Knepley /*@C
7912847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7913847ff0e1SMatthew G. Knepley 
7914847ff0e1SMatthew G. Knepley   Collective on SNES
7915847ff0e1SMatthew G. Knepley 
7916847ff0e1SMatthew G. Knepley   Input Parameters:
7917847ff0e1SMatthew G. Knepley + ts - the TS context
7918847ff0e1SMatthew G. Knepley . t - current timestep
7919847ff0e1SMatthew G. Knepley . U - state vector
7920847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7921847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7922847ff0e1SMatthew G. Knepley - ctx - an optional user context
7923847ff0e1SMatthew G. Knepley 
7924847ff0e1SMatthew G. Knepley   Output Parameters:
7925847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7926847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7927847ff0e1SMatthew G. Knepley 
7928847ff0e1SMatthew G. Knepley   Level: intermediate
7929847ff0e1SMatthew G. Knepley 
7930847ff0e1SMatthew G. Knepley   Notes:
7931847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7932847ff0e1SMatthew G. Knepley 
7933847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7934847ff0e1SMatthew G. Knepley 
7935847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7936847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7937847ff0e1SMatthew G. Knepley 
7938847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7939847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7940847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7941847ff0e1SMatthew G. Knepley 
7942847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
7943847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7944847ff0e1SMatthew G. Knepley @*/
7945847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7946847ff0e1SMatthew G. Knepley {
7947847ff0e1SMatthew G. Knepley   SNES           snes;
7948847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7949847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7950847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
7951847ff0e1SMatthew G. Knepley 
7952847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
7953c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
7954847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
7955847ff0e1SMatthew G. Knepley   if (!color) {
7956847ff0e1SMatthew G. Knepley     DM         dm;
7957847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
7958847ff0e1SMatthew G. Knepley 
7959847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
7960847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
7961847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
7962847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
7963847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7964847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7965847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7966847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7967847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7968847ff0e1SMatthew G. Knepley     } else {
7969847ff0e1SMatthew G. Knepley       MatColoring mc;
7970847ff0e1SMatthew G. Knepley 
7971847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
7972847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
7973847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
7974847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
7975847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
7976847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
7977847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7978847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7979847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7980847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7981847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7982847ff0e1SMatthew G. Knepley     }
7983847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
7984847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
7985847ff0e1SMatthew G. Knepley   }
7986847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
7987847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
7988847ff0e1SMatthew G. Knepley   if (J != B) {
7989847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7990847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7991847ff0e1SMatthew G. Knepley   }
7992847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
7993847ff0e1SMatthew G. Knepley }
799493b34091SDebojyoti Ghosh 
7995cb9d8021SPierre Barbier de Reuille /*@
7996cb9d8021SPierre Barbier de Reuille     TSSetFunctionDomainError - Set the function testing if the current state vector is valid
7997cb9d8021SPierre Barbier de Reuille 
7998cb9d8021SPierre Barbier de Reuille     Input Parameters:
7999cb9d8021SPierre Barbier de Reuille     ts - the TS context
8000cb9d8021SPierre Barbier de Reuille     func - function called within TSFunctionDomainError
8001cb9d8021SPierre Barbier de Reuille 
8002cb9d8021SPierre Barbier de Reuille     Level: intermediate
8003cb9d8021SPierre Barbier de Reuille 
8004cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain
8005cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
8006cb9d8021SPierre Barbier de Reuille @*/
8007cb9d8021SPierre Barbier de Reuille 
8008d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
8009cb9d8021SPierre Barbier de Reuille {
8010cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
8011cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
8012cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
8013cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
8014cb9d8021SPierre Barbier de Reuille }
8015cb9d8021SPierre Barbier de Reuille 
8016cb9d8021SPierre Barbier de Reuille /*@
8017cb9d8021SPierre Barbier de Reuille     TSFunctionDomainError - Check if the current state is valid
8018cb9d8021SPierre Barbier de Reuille 
8019cb9d8021SPierre Barbier de Reuille     Input Parameters:
8020cb9d8021SPierre Barbier de Reuille     ts - the TS context
8021cb9d8021SPierre Barbier de Reuille     stagetime - time of the simulation
8022d183316bSPierre Barbier de Reuille     Y - state vector to check.
8023cb9d8021SPierre Barbier de Reuille 
8024cb9d8021SPierre Barbier de Reuille     Output Parameter:
8025cb9d8021SPierre Barbier de Reuille     accept - Set to PETSC_FALSE if the current state vector is valid.
8026cb9d8021SPierre Barbier de Reuille 
8027cb9d8021SPierre Barbier de Reuille     Note:
8028cb9d8021SPierre Barbier de Reuille     This function should be used to ensure the state is in a valid part of the space.
8029cb9d8021SPierre Barbier de Reuille     For example, one can ensure here all values are positive.
803096a0c994SBarry Smith 
803196a0c994SBarry Smith     Level: advanced
8032cb9d8021SPierre Barbier de Reuille @*/
8033d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
8034cb9d8021SPierre Barbier de Reuille {
8035cb9d8021SPierre Barbier de Reuille   PetscErrorCode ierr;
8036cb9d8021SPierre Barbier de Reuille 
8037cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
8038cb9d8021SPierre Barbier de Reuille 
8039cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8040cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
8041cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
8042d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
8043cb9d8021SPierre Barbier de Reuille   }
8044cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
8045cb9d8021SPierre Barbier de Reuille }
80461ceb14c0SBarry Smith 
804793b34091SDebojyoti Ghosh /*@C
8048e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
804993b34091SDebojyoti Ghosh 
805093b34091SDebojyoti Ghosh   Collective on MPI_Comm
805193b34091SDebojyoti Ghosh 
805293b34091SDebojyoti Ghosh   Input Parameter:
805393b34091SDebojyoti Ghosh . tsin    - The input TS
805493b34091SDebojyoti Ghosh 
805593b34091SDebojyoti Ghosh   Output Parameter:
8056e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
805793b34091SDebojyoti Ghosh 
80585eca1a21SEmil Constantinescu   Notes:
80595eca1a21SEmil 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.
80605eca1a21SEmil Constantinescu 
8061baa10174SEmil Constantinescu   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); ierr = TSSetSNES(ts,snes_dup);
80625eca1a21SEmil Constantinescu 
80635eca1a21SEmil Constantinescu   Level: developer
806493b34091SDebojyoti Ghosh 
8065e5168f73SEmil Constantinescu .keywords: TS, clone
8066e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
806793b34091SDebojyoti Ghosh @*/
8068baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
806993b34091SDebojyoti Ghosh {
807093b34091SDebojyoti Ghosh   TS             t;
807193b34091SDebojyoti Ghosh   PetscErrorCode ierr;
8072dc846ba4SSatish Balay   SNES           snes_start;
8073dc846ba4SSatish Balay   DM             dm;
8074dc846ba4SSatish Balay   TSType         type;
807593b34091SDebojyoti Ghosh 
807693b34091SDebojyoti Ghosh   PetscFunctionBegin;
807793b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
807893b34091SDebojyoti Ghosh   *tsout = NULL;
807993b34091SDebojyoti Ghosh 
80807a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
808193b34091SDebojyoti Ghosh 
808293b34091SDebojyoti Ghosh   /* General TS description */
808393b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
808493b34091SDebojyoti Ghosh   t->setupcalled       = 0;
808593b34091SDebojyoti Ghosh   t->ksp_its           = 0;
808693b34091SDebojyoti Ghosh   t->snes_its          = 0;
808793b34091SDebojyoti Ghosh   t->nwork             = 0;
808893b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
808993b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
809093b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
809193b34091SDebojyoti Ghosh 
809234561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
809334561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
8094d15a3a53SEmil Constantinescu 
809593b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
809693b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
809793b34091SDebojyoti Ghosh 
809893b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
809951699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
810093b34091SDebojyoti Ghosh 
8101e7069c78SShri   t->trajectory = tsin->trajectory;
8102e7069c78SShri   ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr);
8103e7069c78SShri 
8104e7069c78SShri   t->event = tsin->event;
81056b10a48eSSatish Balay   if (t->event) t->event->refct++;
8106e7069c78SShri 
810793b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
810893b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
8109e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
811093b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
811193b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
811293b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
811393b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
811493b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
811593b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
811693b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
811793b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
811893b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
811993b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
812093b34091SDebojyoti Ghosh 
812193b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
812293b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
812393b34091SDebojyoti Ghosh 
812493b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
812593b34091SDebojyoti Ghosh 
812693b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
812793b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
812893b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
812993b34091SDebojyoti Ghosh 
813093b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
813193b34091SDebojyoti Ghosh 
81320d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
81330d4fed19SBarry Smith     PetscInt i;
81340d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
81350d4fed19SBarry Smith     for (i=0; i<10; i++) {
81360d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
81370d4fed19SBarry Smith     }
81380d4fed19SBarry Smith   }
813993b34091SDebojyoti Ghosh   *tsout = t;
814093b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
814193b34091SDebojyoti Ghosh }
8142