xref: /petsc/src/ts/interface/ts.c (revision edbaebb3784ca01201d2f489ec6a6b4662dd81c8)
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
1717cf37e64SBarry Smith .  -ts_monitor_error - Monitors norm of error
1726934998bSLisandro Dalcin .  -ts_monitor_lg_timestep - Monitor timestep size graphically
1738b668821SLisandro Dalcin .  -ts_monitor_lg_timestep_log - Monitor log timestep size graphically
174de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
175de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
176de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
177de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
1783e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
1793e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
180fde5950dSBarry Smith .  -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep
181e4160dc7SJulian Andrej .  -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu)
182110eb670SHong Zhang .  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
183110eb670SHong Zhang .  -ts_adjoint_monitor - print information at each adjoint time step
18453ea634cSHong Zhang -  -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically
18553ea634cSHong Zhang 
18691b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
187bdad233fSMatthew Knepley 
188bdad233fSMatthew Knepley    Level: beginner
189bdad233fSMatthew Knepley 
190bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
191bdad233fSMatthew Knepley 
192a313700dSBarry Smith .seealso: TSGetType()
193bdad233fSMatthew Knepley @*/
1947087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
195bdad233fSMatthew Knepley {
196bc952696SBarry Smith   PetscBool              opt,flg,tflg;
197dfbe8321SBarry Smith   PetscErrorCode         ierr;
198eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
19931748224SBarry Smith   PetscReal              time_step;
20049354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
201d1212d36SBarry Smith   char                   dir[16];
202cd11d68dSLisandro Dalcin   TSIFunction            ifun;
2036991f827SBarry Smith   const char             *defaultType;
2046991f827SBarry Smith   char                   typeName[256];
205bdad233fSMatthew Knepley 
206bdad233fSMatthew Knepley   PetscFunctionBegin;
2070700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2086991f827SBarry Smith 
2096991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
210cd11d68dSLisandro Dalcin   ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
211cd11d68dSLisandro Dalcin 
212cd11d68dSLisandro Dalcin   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
213cd11d68dSLisandro Dalcin   if (((PetscObject)ts)->type_name)
214cd11d68dSLisandro Dalcin     defaultType = ((PetscObject)ts)->type_name;
215cd11d68dSLisandro Dalcin   else
216cd11d68dSLisandro Dalcin     defaultType = ifun ? TSBEULER : TSEULER;
2176991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr);
2186991f827SBarry Smith   if (opt) {
2196991f827SBarry Smith     ierr = TSSetType(ts,typeName);CHKERRQ(ierr);
2206991f827SBarry Smith   } else {
2216991f827SBarry Smith     ierr = TSSetType(ts,defaultType);CHKERRQ(ierr);
2226991f827SBarry Smith   }
223bdad233fSMatthew Knepley 
224bdad233fSMatthew Knepley   /* Handle generic TS options */
225ef85077eSLisandro Dalcin   ierr = PetscOptionsReal("-ts_max_time","Maximum time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
22619eac22cSLisandro Dalcin   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetMaxSteps",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
2270298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
228ef85077eSLisandro Dalcin   ierr = PetscOptionsReal("-ts_final_time","Final time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
22931748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
230cd11d68dSLisandro Dalcin   if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);}
23149354f04SShri 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);
23249354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
2330298fd71SBarry 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);
2340298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
2350298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
2360298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
2370298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
238bdad233fSMatthew Knepley 
23956f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
24056f85f32SBarry Smith   {
24156f85f32SBarry Smith   PetscBool set;
24256f85f32SBarry Smith   flg  = PETSC_FALSE;
24356f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
24456f85f32SBarry Smith   if (set) {
24556f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
24656f85f32SBarry Smith   }
24756f85f32SBarry Smith   }
24856f85f32SBarry Smith #endif
24956f85f32SBarry Smith 
250bdad233fSMatthew Knepley   /* Monitor options */
251cd11d68dSLisandro Dalcin   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr);
252fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr);
253fde5950dSBarry Smith   ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);CHKERRQ(ierr);
254e875c4f7SBarry Smith   ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor_sensi","Monitor sensitivity in the adjoint computation","TSAdjointMonitorSensi",TSAdjointMonitorSensi,NULL);CHKERRQ(ierr);
255fde5950dSBarry Smith 
2565180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
2575180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
2585180491cSLisandro Dalcin 
2594f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
260b3603a34SBarry Smith   if (opt) {
2610b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2623923b477SBarry Smith     PetscInt       howoften = 1;
263b3603a34SBarry Smith 
2640298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
2656ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2664f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
267bdad233fSMatthew Knepley   }
2686ba87a44SLisandro Dalcin 
2694f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
270ef20d060SBarry Smith   if (opt) {
2710b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2723923b477SBarry Smith     PetscInt       howoften = 1;
273ef20d060SBarry Smith 
2740298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
2756ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2764f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
277ef20d060SBarry Smith   }
278*edbaebb3SBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_error","View the error at each timestep","TSMonitorError",TSMonitorError,NULL);CHKERRQ(ierr);
2797cf37e64SBarry Smith 
2806934998bSLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2816934998bSLisandro Dalcin   if (opt) {
2826934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
2836934998bSLisandro Dalcin     PetscInt       howoften = 1;
2846934998bSLisandro Dalcin 
2856934998bSLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2866ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2876934998bSLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2886934998bSLisandro Dalcin   }
2898b668821SLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2908b668821SLisandro Dalcin   if (opt) {
2918b668821SLisandro Dalcin     TSMonitorLGCtx ctx;
2928b668821SLisandro Dalcin     PetscInt       howoften = 1;
2938b668821SLisandro Dalcin 
2948b668821SLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2958b668821SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2968b668821SLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2978b668821SLisandro Dalcin     ctx->semilogy = PETSC_TRUE;
2988b668821SLisandro Dalcin   }
2998b668821SLisandro Dalcin 
300201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
301201da799SBarry Smith   if (opt) {
302201da799SBarry Smith     TSMonitorLGCtx ctx;
303201da799SBarry Smith     PetscInt       howoften = 1;
304201da799SBarry Smith 
3050298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
3066ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
307201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
308201da799SBarry Smith   }
309201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
310201da799SBarry Smith   if (opt) {
311201da799SBarry Smith     TSMonitorLGCtx ctx;
312201da799SBarry Smith     PetscInt       howoften = 1;
313201da799SBarry Smith 
3140298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
3156ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
316201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
317201da799SBarry Smith   }
3188189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
3198189c53fSBarry Smith   if (opt) {
3208189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
3218189c53fSBarry Smith     PetscInt          howoften = 1;
3228189c53fSBarry Smith 
3230298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
3246934998bSLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3258189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
3268189c53fSBarry Smith   }
327ef20d060SBarry Smith   opt  = PETSC_FALSE;
3280dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
329a7cc72afSBarry Smith   if (opt) {
33083a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
33183a4ac43SBarry Smith     PetscInt         howoften = 1;
332a80ad3e0SBarry Smith 
3330298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
3340ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
33583a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
336bdad233fSMatthew Knepley   }
337fb1732b5SBarry Smith   opt  = PETSC_FALSE;
3389110b2e7SHong Zhang   ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr);
3399110b2e7SHong Zhang   if (opt) {
3409110b2e7SHong Zhang     TSMonitorDrawCtx ctx;
3419110b2e7SHong Zhang     PetscInt         howoften = 1;
3429110b2e7SHong Zhang 
3439110b2e7SHong Zhang     ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr);
3446934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3459110b2e7SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3469110b2e7SHong Zhang   }
3479110b2e7SHong Zhang   opt  = PETSC_FALSE;
3482d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
3492d5ee99bSBarry Smith   if (opt) {
3502d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
3512d5ee99bSBarry Smith     PetscReal        bounds[4];
3522d5ee99bSBarry Smith     PetscInt         n = 4;
3532d5ee99bSBarry Smith     PetscDraw        draw;
3546934998bSLisandro Dalcin     PetscDrawAxis    axis;
3552d5ee99bSBarry Smith 
3562d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
3572d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
3586934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr);
3592d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
3606934998bSLisandro Dalcin     ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr);
3616934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
3626934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
3632d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3642d5ee99bSBarry Smith   }
3652d5ee99bSBarry Smith   opt  = PETSC_FALSE;
3660dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
3673a471f94SBarry Smith   if (opt) {
36883a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
36983a4ac43SBarry Smith     PetscInt         howoften = 1;
3703a471f94SBarry Smith 
3710298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
3720ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
37383a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3743a471f94SBarry Smith   }
3750ed3bfb6SBarry Smith   opt  = PETSC_FALSE;
3760ed3bfb6SBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt);CHKERRQ(ierr);
3770ed3bfb6SBarry Smith   if (opt) {
3780ed3bfb6SBarry Smith     TSMonitorDrawCtx ctx;
3790ed3bfb6SBarry Smith     PetscInt         howoften = 1;
3800ed3bfb6SBarry Smith 
3810ed3bfb6SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL);CHKERRQ(ierr);
3820ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3830ed3bfb6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3840ed3bfb6SBarry Smith   }
385fde5950dSBarry Smith 
386ed81e22dSJed Brown   opt  = PETSC_FALSE;
38791b97e58SBarry 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);
388ed81e22dSJed Brown   if (flg) {
389ed81e22dSJed Brown     const char *ptr,*ptr2;
390ed81e22dSJed Brown     char       *filetemplate;
391ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
392ed81e22dSJed Brown     /* Do some cursory validation of the input. */
393ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
394ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
395ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
396ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
397ce94432eSBarry 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");
398ed81e22dSJed Brown       if (ptr2) break;
399ed81e22dSJed Brown     }
400ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
401ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
402ed81e22dSJed Brown   }
403bdad233fSMatthew Knepley 
404d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
405d1212d36SBarry Smith   if (flg) {
406d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
407d1212d36SBarry Smith     int                  ray = 0;
408d1212d36SBarry Smith     DMDADirection        ddir;
409d1212d36SBarry Smith     DM                   da;
410d1212d36SBarry Smith     PetscMPIInt          rank;
411d1212d36SBarry Smith 
412ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
413d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
414d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
415ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
416d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
417d1212d36SBarry Smith 
418d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
419b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
420d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
421d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
422ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
423d1212d36SBarry Smith     if (!rank) {
424d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
425d1212d36SBarry Smith     }
42651b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
427d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
428d1212d36SBarry Smith   }
42951b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
43051b4a12fSMatthew G. Knepley   if (flg) {
43151b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
43251b4a12fSMatthew G. Knepley     int                 ray = 0;
43351b4a12fSMatthew G. Knepley     DMDADirection       ddir;
43451b4a12fSMatthew G. Knepley     DM                  da;
43551b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
436d1212d36SBarry Smith 
43751b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
43851b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
43951b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
44051b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
44151b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
4421c3436cfSJed Brown 
44351b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
444b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
44551b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
44651b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
44751b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
44851b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
44951b4a12fSMatthew G. Knepley   }
450a7a1495cSBarry Smith 
451b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
452b3d3934dSBarry Smith   if (opt) {
453b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
454b3d3934dSBarry Smith 
455b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
456b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
457b3d3934dSBarry Smith   }
458b3d3934dSBarry Smith 
459847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
460847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
461847ff0e1SMatthew G. Knepley   if (flg) {
462847ff0e1SMatthew G. Knepley     DM   dm;
463847ff0e1SMatthew G. Knepley     DMTS tdm;
464847ff0e1SMatthew G. Knepley 
465847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
466847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
467847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
468847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
469847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
470847ff0e1SMatthew G. Knepley   }
471847ff0e1SMatthew G. Knepley 
472d763cef2SBarry Smith   /* Handle specific TS options */
473d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
4746991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
475d763cef2SBarry Smith   }
476fbc52257SHong Zhang 
477a7bdc993SLisandro Dalcin   /* Handle TSAdapt options */
478a7bdc993SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
479a7bdc993SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
480a7bdc993SLisandro Dalcin   ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr);
481a7bdc993SLisandro Dalcin 
48268bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
4834f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
48468bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
48568bece0bSHong Zhang   if (tflg) {
48668bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
48768bece0bSHong Zhang   }
4884f122a70SLisandro Dalcin   tflg = ts->adjoint_solve ? PETSC_TRUE : PETSC_FALSE;
48968bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
49068bece0bSHong Zhang   if (flg) {
49168bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
49268bece0bSHong Zhang     ts->adjoint_solve = tflg;
49368bece0bSHong Zhang   }
494d763cef2SBarry Smith 
495d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
4960633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
497fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
498d763cef2SBarry Smith 
4994f122a70SLisandro Dalcin   if (ts->trajectory) {
5004f122a70SLisandro Dalcin     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
501d763cef2SBarry Smith   }
50268bece0bSHong Zhang 
5034f122a70SLisandro Dalcin   ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr);
5044f122a70SLisandro Dalcin   if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);}
5054f122a70SLisandro Dalcin   ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
506d763cef2SBarry Smith   PetscFunctionReturn(0);
507d763cef2SBarry Smith }
508d763cef2SBarry Smith 
509d2daff3dSHong Zhang /*@
51078fbdcc8SBarry Smith    TSGetTrajectory - Gets the trajectory from a TS if it exists
51178fbdcc8SBarry Smith 
51278fbdcc8SBarry Smith    Collective on TS
51378fbdcc8SBarry Smith 
51478fbdcc8SBarry Smith    Input Parameters:
51578fbdcc8SBarry Smith .  ts - the TS context obtained from TSCreate()
51678fbdcc8SBarry Smith 
51778fbdcc8SBarry Smith    Output Parameters;
51878fbdcc8SBarry Smith .  tr - the TSTrajectory object, if it exists
51978fbdcc8SBarry Smith 
52078fbdcc8SBarry Smith    Note: This routine should be called after all TS options have been set
52178fbdcc8SBarry Smith 
52278fbdcc8SBarry Smith    Level: advanced
52378fbdcc8SBarry Smith 
52478fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate()
52578fbdcc8SBarry Smith 
52678fbdcc8SBarry Smith .keywords: TS, set, checkpoint,
52778fbdcc8SBarry Smith @*/
52878fbdcc8SBarry Smith PetscErrorCode  TSGetTrajectory(TS ts,TSTrajectory *tr)
52978fbdcc8SBarry Smith {
53078fbdcc8SBarry Smith   PetscFunctionBegin;
53178fbdcc8SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53278fbdcc8SBarry Smith   *tr = ts->trajectory;
53378fbdcc8SBarry Smith   PetscFunctionReturn(0);
53478fbdcc8SBarry Smith }
53578fbdcc8SBarry Smith 
53678fbdcc8SBarry Smith /*@
537bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
538d2daff3dSHong Zhang 
539d2daff3dSHong Zhang    Collective on TS
540d2daff3dSHong Zhang 
541d2daff3dSHong Zhang    Input Parameters:
542bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
543bc952696SBarry Smith 
54478fbdcc8SBarry Smith    Options Database:
54578fbdcc8SBarry Smith +  -ts_save_trajectory - saves the trajectory to a file
54678fbdcc8SBarry Smith -  -ts_trajectory_type type
54778fbdcc8SBarry Smith 
54868bece0bSHong Zhang Note: This routine should be called after all TS options have been set
549d2daff3dSHong Zhang 
55078fbdcc8SBarry Smith     The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/bin/PetscBinaryIOTrajectory.py and
55178fbdcc8SBarry Smith    MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m
55278fbdcc8SBarry Smith 
553d2daff3dSHong Zhang    Level: intermediate
554d2daff3dSHong Zhang 
55578fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectoryType, TSSetTrajectoryType()
556d2daff3dSHong Zhang 
557bc952696SBarry Smith .keywords: TS, set, checkpoint,
558d2daff3dSHong Zhang @*/
559bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
560d2daff3dSHong Zhang {
561bc952696SBarry Smith   PetscErrorCode ierr;
562bc952696SBarry Smith 
563d2daff3dSHong Zhang   PetscFunctionBegin;
564d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
565bc952696SBarry Smith   if (!ts->trajectory) {
566bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
567bc952696SBarry Smith   }
568d2daff3dSHong Zhang   PetscFunctionReturn(0);
569d2daff3dSHong Zhang }
570d2daff3dSHong Zhang 
571a7a1495cSBarry Smith /*@
572a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
573a7a1495cSBarry Smith       set with TSSetRHSJacobian().
574a7a1495cSBarry Smith 
575a7a1495cSBarry Smith    Collective on TS and Vec
576a7a1495cSBarry Smith 
577a7a1495cSBarry Smith    Input Parameters:
578316643e7SJed Brown +  ts - the TS context
579a7a1495cSBarry Smith .  t - current timestep
5800910c330SBarry Smith -  U - input vector
581a7a1495cSBarry Smith 
582a7a1495cSBarry Smith    Output Parameters:
583a7a1495cSBarry Smith +  A - Jacobian matrix
584a7a1495cSBarry Smith .  B - optional preconditioning matrix
585a7a1495cSBarry Smith -  flag - flag indicating matrix structure
586a7a1495cSBarry Smith 
587a7a1495cSBarry Smith    Notes:
588a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
589a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
590a7a1495cSBarry Smith 
59194b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
592a7a1495cSBarry Smith    flag parameter.
593a7a1495cSBarry Smith 
594a7a1495cSBarry Smith    Level: developer
595a7a1495cSBarry Smith 
596a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
597a7a1495cSBarry Smith 
59894b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
599a7a1495cSBarry Smith @*/
600d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
601a7a1495cSBarry Smith {
602dfbe8321SBarry Smith   PetscErrorCode   ierr;
603270bf2e7SJed Brown   PetscObjectState Ustate;
6046c1e1eecSBarry Smith   PetscObjectId    Uid;
60524989b8cSPeter Brune   DM               dm;
606942e3340SBarry Smith   DMTS             tsdm;
60724989b8cSPeter Brune   TSRHSJacobian    rhsjacobianfunc;
60824989b8cSPeter Brune   void             *ctx;
60924989b8cSPeter Brune   TSIJacobian      ijacobianfunc;
610b2df71adSDebojyoti Ghosh   TSRHSFunction    rhsfunction;
611a7a1495cSBarry Smith 
612a7a1495cSBarry Smith   PetscFunctionBegin;
6130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6140910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6150910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
61624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
617942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
61824989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
6190298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
620b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
62159e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
6226c1e1eecSBarry Smith   ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr);
6236c1e1eecSBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
6240e4ef248SJed Brown     PetscFunctionReturn(0);
625f8ede8e7SJed Brown   }
626d90be118SSean Farley 
627ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
628d90be118SSean Farley 
629e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
63094ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
63194ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
632303f9b21SStefano Zampini     if (B && A != B) {
63394ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
63494ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
635e1244c69SJed Brown     }
636e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
637e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
638e1244c69SJed Brown   }
639e1244c69SJed Brown 
64024989b8cSPeter Brune   if (rhsjacobianfunc) {
6416cd88445SBarry Smith     PetscBool missing;
64294ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
643a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
644d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
645a7a1495cSBarry Smith     PetscStackPop;
64694ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
6476cd88445SBarry Smith     if (A) {
6486cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
6496cd88445SBarry 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");
6506cd88445SBarry Smith     }
6516cd88445SBarry Smith     if (B && B != A) {
6526cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
6536cd88445SBarry 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");
6546cd88445SBarry Smith     }
655ef66eb69SBarry Smith   } else {
65694ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
65794ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
658ef66eb69SBarry Smith   }
6590e4ef248SJed Brown   ts->rhsjacobian.time       = t;
6607f79407eSBarry Smith   ierr                       = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr);
66159e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
662a7a1495cSBarry Smith   PetscFunctionReturn(0);
663a7a1495cSBarry Smith }
664a7a1495cSBarry Smith 
665316643e7SJed Brown /*@
666d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
667d763cef2SBarry Smith 
668316643e7SJed Brown    Collective on TS and Vec
669316643e7SJed Brown 
670316643e7SJed Brown    Input Parameters:
671316643e7SJed Brown +  ts - the TS context
672316643e7SJed Brown .  t - current time
6730910c330SBarry Smith -  U - state vector
674316643e7SJed Brown 
675316643e7SJed Brown    Output Parameter:
676316643e7SJed Brown .  y - right hand side
677316643e7SJed Brown 
678316643e7SJed Brown    Note:
679316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
680316643e7SJed Brown    is used internally within the nonlinear solvers.
681316643e7SJed Brown 
682316643e7SJed Brown    Level: developer
683316643e7SJed Brown 
684316643e7SJed Brown .keywords: TS, compute
685316643e7SJed Brown 
686316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
687316643e7SJed Brown @*/
6880910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
689d763cef2SBarry Smith {
690dfbe8321SBarry Smith   PetscErrorCode ierr;
69124989b8cSPeter Brune   TSRHSFunction  rhsfunction;
69224989b8cSPeter Brune   TSIFunction    ifunction;
69324989b8cSPeter Brune   void           *ctx;
69424989b8cSPeter Brune   DM             dm;
69524989b8cSPeter Brune 
696d763cef2SBarry Smith   PetscFunctionBegin;
6970700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6980910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6990700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
70024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
70124989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
7020298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
703d763cef2SBarry Smith 
704ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
705d763cef2SBarry Smith 
7060910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
70724989b8cSPeter Brune   if (rhsfunction) {
708d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
7090910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
710d763cef2SBarry Smith     PetscStackPop;
711214bc6a2SJed Brown   } else {
712214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
713b2cd27e8SJed Brown   }
71444a41b28SSean Farley 
7150910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
716d763cef2SBarry Smith   PetscFunctionReturn(0);
717d763cef2SBarry Smith }
718d763cef2SBarry Smith 
719ef20d060SBarry Smith /*@
720ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
721ef20d060SBarry Smith 
722ef20d060SBarry Smith    Collective on TS and Vec
723ef20d060SBarry Smith 
724ef20d060SBarry Smith    Input Parameters:
725ef20d060SBarry Smith +  ts - the TS context
726ef20d060SBarry Smith -  t - current time
727ef20d060SBarry Smith 
728ef20d060SBarry Smith    Output Parameter:
7290910c330SBarry Smith .  U - the solution
730ef20d060SBarry Smith 
731ef20d060SBarry Smith    Note:
732ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
733ef20d060SBarry Smith    is used internally within the nonlinear solvers.
734ef20d060SBarry Smith 
735ef20d060SBarry Smith    Level: developer
736ef20d060SBarry Smith 
737ef20d060SBarry Smith .keywords: TS, compute
738ef20d060SBarry Smith 
739abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
740ef20d060SBarry Smith @*/
7410910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
742ef20d060SBarry Smith {
743ef20d060SBarry Smith   PetscErrorCode     ierr;
744ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
745ef20d060SBarry Smith   void               *ctx;
746ef20d060SBarry Smith   DM                 dm;
747ef20d060SBarry Smith 
748ef20d060SBarry Smith   PetscFunctionBegin;
749ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7500910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
751ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
752ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
753ef20d060SBarry Smith 
754ef20d060SBarry Smith   if (solutionfunction) {
7559b7cd975SBarry Smith     PetscStackPush("TS user solution function");
7560910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
757ef20d060SBarry Smith     PetscStackPop;
758ef20d060SBarry Smith   }
759ef20d060SBarry Smith   PetscFunctionReturn(0);
760ef20d060SBarry Smith }
7619b7cd975SBarry Smith /*@
7629b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
7639b7cd975SBarry Smith 
7649b7cd975SBarry Smith    Collective on TS and Vec
7659b7cd975SBarry Smith 
7669b7cd975SBarry Smith    Input Parameters:
7679b7cd975SBarry Smith +  ts - the TS context
7689b7cd975SBarry Smith -  t - current time
7699b7cd975SBarry Smith 
7709b7cd975SBarry Smith    Output Parameter:
7719b7cd975SBarry Smith .  U - the function value
7729b7cd975SBarry Smith 
7739b7cd975SBarry Smith    Note:
7749b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
7759b7cd975SBarry Smith    is used internally within the nonlinear solvers.
7769b7cd975SBarry Smith 
7779b7cd975SBarry Smith    Level: developer
7789b7cd975SBarry Smith 
7799b7cd975SBarry Smith .keywords: TS, compute
7809b7cd975SBarry Smith 
7819b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7829b7cd975SBarry Smith @*/
7839b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7849b7cd975SBarry Smith {
7859b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7869b7cd975SBarry Smith   void               *ctx;
7879b7cd975SBarry Smith   DM                 dm;
7889b7cd975SBarry Smith 
7899b7cd975SBarry Smith   PetscFunctionBegin;
7909b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7919b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7929b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7939b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7949b7cd975SBarry Smith 
7959b7cd975SBarry Smith   if (forcing) {
7969b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
7979b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
7989b7cd975SBarry Smith     PetscStackPop;
7999b7cd975SBarry Smith   }
8009b7cd975SBarry Smith   PetscFunctionReturn(0);
8019b7cd975SBarry Smith }
802ef20d060SBarry Smith 
803214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
804214bc6a2SJed Brown {
8052dd45cf8SJed Brown   Vec            F;
806214bc6a2SJed Brown   PetscErrorCode ierr;
807214bc6a2SJed Brown 
808214bc6a2SJed Brown   PetscFunctionBegin;
8090298fd71SBarry Smith   *Frhs = NULL;
8100298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
811214bc6a2SJed Brown   if (!ts->Frhs) {
8122dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
813214bc6a2SJed Brown   }
814214bc6a2SJed Brown   *Frhs = ts->Frhs;
815214bc6a2SJed Brown   PetscFunctionReturn(0);
816214bc6a2SJed Brown }
817214bc6a2SJed Brown 
818214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
819214bc6a2SJed Brown {
820214bc6a2SJed Brown   Mat            A,B;
8212dd45cf8SJed Brown   PetscErrorCode ierr;
82241a1d4d2SBarry Smith   TSIJacobian    ijacobian;
823214bc6a2SJed Brown 
824214bc6a2SJed Brown   PetscFunctionBegin;
825c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
826c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
82741a1d4d2SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr);
828214bc6a2SJed Brown   if (Arhs) {
829214bc6a2SJed Brown     if (!ts->Arhs) {
83041a1d4d2SBarry Smith       if (ijacobian) {
831214bc6a2SJed Brown         ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
83241a1d4d2SBarry Smith       } else {
83341a1d4d2SBarry Smith         ts->Arhs = A;
83441a1d4d2SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
83541a1d4d2SBarry Smith       }
8363565c898SBarry Smith     } else {
8373565c898SBarry Smith       PetscBool flg;
8383565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
8393565c898SBarry Smith       /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */
8403565c898SBarry Smith       if (flg && !ijacobian && ts->Arhs == ts->Brhs){
8413565c898SBarry Smith         ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr);
8423565c898SBarry Smith         ts->Arhs = A;
8433565c898SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
8443565c898SBarry Smith       }
845214bc6a2SJed Brown     }
846214bc6a2SJed Brown     *Arhs = ts->Arhs;
847214bc6a2SJed Brown   }
848214bc6a2SJed Brown   if (Brhs) {
849214bc6a2SJed Brown     if (!ts->Brhs) {
850bdb70873SJed Brown       if (A != B) {
85141a1d4d2SBarry Smith         if (ijacobian) {
852214bc6a2SJed Brown           ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
853bdb70873SJed Brown         } else {
85441a1d4d2SBarry Smith           ts->Brhs = B;
85541a1d4d2SBarry Smith           ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
85641a1d4d2SBarry Smith         }
85741a1d4d2SBarry Smith       } else {
858bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
85951699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
860bdb70873SJed Brown       }
861214bc6a2SJed Brown     }
862214bc6a2SJed Brown     *Brhs = ts->Brhs;
863214bc6a2SJed Brown   }
864214bc6a2SJed Brown   PetscFunctionReturn(0);
865214bc6a2SJed Brown }
866214bc6a2SJed Brown 
867316643e7SJed Brown /*@
8680910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
869316643e7SJed Brown 
870316643e7SJed Brown    Collective on TS and Vec
871316643e7SJed Brown 
872316643e7SJed Brown    Input Parameters:
873316643e7SJed Brown +  ts - the TS context
874316643e7SJed Brown .  t - current time
8750910c330SBarry Smith .  U - state vector
8760910c330SBarry Smith .  Udot - time derivative of state vector
877214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
878316643e7SJed Brown 
879316643e7SJed Brown    Output Parameter:
880316643e7SJed Brown .  Y - right hand side
881316643e7SJed Brown 
882316643e7SJed Brown    Note:
883316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
884316643e7SJed Brown    is used internally within the nonlinear solvers.
885316643e7SJed Brown 
886316643e7SJed Brown    If the user did did not write their equations in implicit form, this
887316643e7SJed Brown    function recasts them in implicit form.
888316643e7SJed Brown 
889316643e7SJed Brown    Level: developer
890316643e7SJed Brown 
891316643e7SJed Brown .keywords: TS, compute
892316643e7SJed Brown 
893316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
894316643e7SJed Brown @*/
8950910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
896316643e7SJed Brown {
897316643e7SJed Brown   PetscErrorCode ierr;
89824989b8cSPeter Brune   TSIFunction    ifunction;
89924989b8cSPeter Brune   TSRHSFunction  rhsfunction;
90024989b8cSPeter Brune   void           *ctx;
90124989b8cSPeter Brune   DM             dm;
902316643e7SJed Brown 
903316643e7SJed Brown   PetscFunctionBegin;
9040700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9050910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9060910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
9070700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
908316643e7SJed Brown 
90924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
91024989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
9110298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
91224989b8cSPeter Brune 
913ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
914d90be118SSean Farley 
9150910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
91624989b8cSPeter Brune   if (ifunction) {
917316643e7SJed Brown     PetscStackPush("TS user implicit function");
9180910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
919316643e7SJed Brown     PetscStackPop;
920214bc6a2SJed Brown   }
921214bc6a2SJed Brown   if (imex) {
92224989b8cSPeter Brune     if (!ifunction) {
9230910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
9242dd45cf8SJed Brown     }
92524989b8cSPeter Brune   } else if (rhsfunction) {
92624989b8cSPeter Brune     if (ifunction) {
927214bc6a2SJed Brown       Vec Frhs;
928214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
9290910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
930214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
9312dd45cf8SJed Brown     } else {
9320910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
9330910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
934316643e7SJed Brown     }
9354a6899ffSJed Brown   }
9360910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
937316643e7SJed Brown   PetscFunctionReturn(0);
938316643e7SJed Brown }
939316643e7SJed Brown 
940316643e7SJed Brown /*@
941316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
942316643e7SJed Brown 
943316643e7SJed Brown    Collective on TS and Vec
944316643e7SJed Brown 
945316643e7SJed Brown    Input
946316643e7SJed Brown       Input Parameters:
947316643e7SJed Brown +  ts - the TS context
948316643e7SJed Brown .  t - current timestep
9490910c330SBarry Smith .  U - state vector
9500910c330SBarry Smith .  Udot - time derivative of state vector
951214bc6a2SJed Brown .  shift - shift to apply, see note below
952214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
953316643e7SJed Brown 
954316643e7SJed Brown    Output Parameters:
955316643e7SJed Brown +  A - Jacobian matrix
9563565c898SBarry Smith -  B - matrix from which the preconditioner is constructed; often the same as A
957316643e7SJed Brown 
958316643e7SJed Brown    Notes:
9590910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
960316643e7SJed Brown 
9610910c330SBarry Smith    dF/dU + shift*dF/dUdot
962316643e7SJed Brown 
963316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
964316643e7SJed Brown    is used internally within the nonlinear solvers.
965316643e7SJed Brown 
966316643e7SJed Brown    Level: developer
967316643e7SJed Brown 
968316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
969316643e7SJed Brown 
970316643e7SJed Brown .seealso:  TSSetIJacobian()
97163495f91SJed Brown @*/
972d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
973316643e7SJed Brown {
974316643e7SJed Brown   PetscErrorCode ierr;
97524989b8cSPeter Brune   TSIJacobian    ijacobian;
97624989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
97724989b8cSPeter Brune   DM             dm;
97824989b8cSPeter Brune   void           *ctx;
979316643e7SJed Brown 
980316643e7SJed Brown   PetscFunctionBegin;
9810700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9820910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9830910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
984316643e7SJed Brown   PetscValidPointer(A,6);
98594ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
986316643e7SJed Brown   PetscValidPointer(B,7);
98794ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
98824989b8cSPeter Brune 
98924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
99024989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
9910298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
99224989b8cSPeter Brune 
993ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
994316643e7SJed Brown 
99594ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
99624989b8cSPeter Brune   if (ijacobian) {
9976cd88445SBarry Smith     PetscBool missing;
998316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
999d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
1000316643e7SJed Brown     PetscStackPop;
10016cd88445SBarry Smith     ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
10026cd88445SBarry 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");
10033565c898SBarry Smith     if (B != A) {
10046cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
10056cd88445SBarry 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");
10066cd88445SBarry Smith     }
10074a6899ffSJed Brown   }
1008214bc6a2SJed Brown   if (imex) {
1009b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
10104c26be97Sstefano_zampini       PetscBool assembled;
101194ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
10124c26be97Sstefano_zampini       ierr = MatAssembled(A,&assembled);CHKERRQ(ierr);
10134c26be97Sstefano_zampini       if (!assembled) {
10144c26be97Sstefano_zampini         ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10154c26be97Sstefano_zampini         ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10164c26be97Sstefano_zampini       }
101794ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
101894ab13aaSBarry Smith       if (A != B) {
101994ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
10204c26be97Sstefano_zampini         ierr = MatAssembled(B,&assembled);CHKERRQ(ierr);
10214c26be97Sstefano_zampini         if (!assembled) {
10224c26be97Sstefano_zampini           ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10234c26be97Sstefano_zampini           ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10244c26be97Sstefano_zampini         }
102594ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
1026214bc6a2SJed Brown       }
1027214bc6a2SJed Brown     }
1028214bc6a2SJed Brown   } else {
1029e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
1030e1244c69SJed Brown     if (rhsjacobian) {
1031214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
1032d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
1033e1244c69SJed Brown     }
103494ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
10353565c898SBarry Smith       PetscBool flg;
1036e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
1037e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
10383565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
10393565c898SBarry Smith       /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */
10403565c898SBarry Smith       if (!flg) {
104194ab13aaSBarry Smith         ierr = MatScale(A,-1);CHKERRQ(ierr);
104294ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
10433565c898SBarry Smith       }
104494ab13aaSBarry Smith       if (A != B) {
104594ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
104694ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
1047316643e7SJed Brown       }
1048e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
1049e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1050e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
105194ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
105294ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
105394ab13aaSBarry Smith         if (A != B) {
105494ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
105594ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
1056214bc6a2SJed Brown         }
1057316643e7SJed Brown       }
105894ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
105994ab13aaSBarry Smith       if (A != B) {
106094ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
1061316643e7SJed Brown       }
1062316643e7SJed Brown     }
1063316643e7SJed Brown   }
106494ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
1065316643e7SJed Brown   PetscFunctionReturn(0);
1066316643e7SJed Brown }
1067316643e7SJed Brown 
1068d763cef2SBarry Smith /*@C
1069d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
1070b5abc632SBarry Smith     where U_t = G(t,u).
1071d763cef2SBarry Smith 
10723f9fe445SBarry Smith     Logically Collective on TS
1073d763cef2SBarry Smith 
1074d763cef2SBarry Smith     Input Parameters:
1075d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
10760298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
1077d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
1078d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
10790298fd71SBarry Smith           function evaluation routine (may be NULL)
1080d763cef2SBarry Smith 
1081d763cef2SBarry Smith     Calling sequence of func:
108287828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
1083d763cef2SBarry Smith 
1084d763cef2SBarry Smith +   t - current timestep
1085d763cef2SBarry Smith .   u - input vector
1086d763cef2SBarry Smith .   F - function vector
1087d763cef2SBarry Smith -   ctx - [optional] user-defined function context
1088d763cef2SBarry Smith 
1089d763cef2SBarry Smith     Level: beginner
1090d763cef2SBarry Smith 
10912bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
10922bbac0d3SBarry Smith 
1093d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1094d763cef2SBarry Smith 
1095ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
1096d763cef2SBarry Smith @*/
1097089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
1098d763cef2SBarry Smith {
1099089b2837SJed Brown   PetscErrorCode ierr;
1100089b2837SJed Brown   SNES           snes;
11010298fd71SBarry Smith   Vec            ralloc = NULL;
110224989b8cSPeter Brune   DM             dm;
1103d763cef2SBarry Smith 
1104089b2837SJed Brown   PetscFunctionBegin;
11050700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1106ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
110724989b8cSPeter Brune 
110824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
110924989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1110089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1111e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1112e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1113e856ceecSJed Brown     r = ralloc;
1114e856ceecSJed Brown   }
1115089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1116e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1117d763cef2SBarry Smith   PetscFunctionReturn(0);
1118d763cef2SBarry Smith }
1119d763cef2SBarry Smith 
1120ef20d060SBarry Smith /*@C
1121abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1122ef20d060SBarry Smith 
1123ef20d060SBarry Smith     Logically Collective on TS
1124ef20d060SBarry Smith 
1125ef20d060SBarry Smith     Input Parameters:
1126ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1127ef20d060SBarry Smith .   f - routine for evaluating the solution
1128ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
11290298fd71SBarry Smith           function evaluation routine (may be NULL)
1130ef20d060SBarry Smith 
1131ef20d060SBarry Smith     Calling sequence of func:
1132ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
1133ef20d060SBarry Smith 
1134ef20d060SBarry Smith +   t - current timestep
1135ef20d060SBarry Smith .   u - output vector
1136ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1137ef20d060SBarry Smith 
11380ed3bfb6SBarry Smith     Options Database:
11390ed3bfb6SBarry Smith +  -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction()
11400ed3bfb6SBarry Smith -  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
11410ed3bfb6SBarry Smith 
1142abd5a294SJed Brown     Notes:
1143abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1144abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1145abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1146abd5a294SJed Brown 
11474f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1148abd5a294SJed Brown 
1149ef20d060SBarry Smith     Level: beginner
1150ef20d060SBarry Smith 
1151ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1152ef20d060SBarry Smith 
11530ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError()
1154ef20d060SBarry Smith @*/
1155ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1156ef20d060SBarry Smith {
1157ef20d060SBarry Smith   PetscErrorCode ierr;
1158ef20d060SBarry Smith   DM             dm;
1159ef20d060SBarry Smith 
1160ef20d060SBarry Smith   PetscFunctionBegin;
1161ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1162ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1163ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1164ef20d060SBarry Smith   PetscFunctionReturn(0);
1165ef20d060SBarry Smith }
1166ef20d060SBarry Smith 
11679b7cd975SBarry Smith /*@C
11689b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
11699b7cd975SBarry Smith 
11709b7cd975SBarry Smith     Logically Collective on TS
11719b7cd975SBarry Smith 
11729b7cd975SBarry Smith     Input Parameters:
11739b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
1174e162b725SBarry Smith .   func - routine for evaluating the forcing function
11759b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
11760298fd71SBarry Smith           function evaluation routine (may be NULL)
11779b7cd975SBarry Smith 
11789b7cd975SBarry Smith     Calling sequence of func:
1179e162b725SBarry Smith $     func (TS ts,PetscReal t,Vec f,void *ctx);
11809b7cd975SBarry Smith 
11819b7cd975SBarry Smith +   t - current timestep
1182e162b725SBarry Smith .   f - output vector
11839b7cd975SBarry Smith -   ctx - [optional] user-defined function context
11849b7cd975SBarry Smith 
11859b7cd975SBarry Smith     Notes:
11869b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
1187e162b725SBarry 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
1188e162b725SBarry Smith     definition of the problem you are solving and hence possibly introducing bugs.
1189e162b725SBarry Smith 
1190e162b725SBarry Smith     This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0
1191e162b725SBarry Smith 
1192e162b725SBarry 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
1193e162b725SBarry Smith     parameters can be passed in the ctx variable.
11949b7cd975SBarry Smith 
11959b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
11969b7cd975SBarry Smith 
11979b7cd975SBarry Smith     Level: beginner
11989b7cd975SBarry Smith 
11999b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
12009b7cd975SBarry Smith 
12019b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
12029b7cd975SBarry Smith @*/
1203e162b725SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx)
12049b7cd975SBarry Smith {
12059b7cd975SBarry Smith   PetscErrorCode ierr;
12069b7cd975SBarry Smith   DM             dm;
12079b7cd975SBarry Smith 
12089b7cd975SBarry Smith   PetscFunctionBegin;
12099b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
12109b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1211e162b725SBarry Smith   ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr);
12129b7cd975SBarry Smith   PetscFunctionReturn(0);
12139b7cd975SBarry Smith }
12149b7cd975SBarry Smith 
1215d763cef2SBarry Smith /*@C
1216f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1217b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1218d763cef2SBarry Smith 
12193f9fe445SBarry Smith    Logically Collective on TS
1220d763cef2SBarry Smith 
1221d763cef2SBarry Smith    Input Parameters:
1222d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1223e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1224e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1225d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1226d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
12270298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1228d763cef2SBarry Smith 
1229f7ab8db6SBarry Smith    Calling sequence of f:
1230ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1231d763cef2SBarry Smith 
1232d763cef2SBarry Smith +  t - current timestep
1233d763cef2SBarry Smith .  u - input vector
1234e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1235e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1236d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1237d763cef2SBarry Smith 
12386cd88445SBarry Smith    Notes:
12396cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
12406cd88445SBarry Smith 
12416cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1242ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1243d763cef2SBarry Smith 
1244d763cef2SBarry Smith    Level: beginner
1245d763cef2SBarry Smith 
1246d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1247d763cef2SBarry Smith 
1248ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1249d763cef2SBarry Smith 
1250d763cef2SBarry Smith @*/
1251e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1252d763cef2SBarry Smith {
1253277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1254089b2837SJed Brown   SNES           snes;
125524989b8cSPeter Brune   DM             dm;
125624989b8cSPeter Brune   TSIJacobian    ijacobian;
1257277b19d0SLisandro Dalcin 
1258d763cef2SBarry Smith   PetscFunctionBegin;
12590700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1260e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1261e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1262e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1263e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1264d763cef2SBarry Smith 
126524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
126624989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1267e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1268e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1269e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1270e1244c69SJed Brown   }
12710298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1272089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12735f659677SPeter Brune   if (!ijacobian) {
1274e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
12750e4ef248SJed Brown   }
1276e5d3d808SBarry Smith   if (Amat) {
1277e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
12780e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1279e5d3d808SBarry Smith     ts->Arhs = Amat;
12800e4ef248SJed Brown   }
1281e5d3d808SBarry Smith   if (Pmat) {
1282e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
12830e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1284e5d3d808SBarry Smith     ts->Brhs = Pmat;
12850e4ef248SJed Brown   }
1286d763cef2SBarry Smith   PetscFunctionReturn(0);
1287d763cef2SBarry Smith }
1288d763cef2SBarry Smith 
1289316643e7SJed Brown /*@C
1290b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1291316643e7SJed Brown 
12923f9fe445SBarry Smith    Logically Collective on TS
1293316643e7SJed Brown 
1294316643e7SJed Brown    Input Parameters:
1295316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
12960298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1297316643e7SJed Brown .  f   - the function evaluation routine
12980298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1299316643e7SJed Brown 
1300316643e7SJed Brown    Calling sequence of f:
1301316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1302316643e7SJed Brown 
1303316643e7SJed Brown +  t   - time at step/stage being solved
1304316643e7SJed Brown .  u   - state vector
1305316643e7SJed Brown .  u_t - time derivative of state vector
1306316643e7SJed Brown .  F   - function vector
1307316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1308316643e7SJed Brown 
1309316643e7SJed Brown    Important:
13102bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1311316643e7SJed Brown 
1312316643e7SJed Brown    Level: beginner
1313316643e7SJed Brown 
1314316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1315316643e7SJed Brown 
1316d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1317316643e7SJed Brown @*/
131851699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1319316643e7SJed Brown {
1320089b2837SJed Brown   PetscErrorCode ierr;
1321089b2837SJed Brown   SNES           snes;
132251699248SLisandro Dalcin   Vec            ralloc = NULL;
132324989b8cSPeter Brune   DM             dm;
1324316643e7SJed Brown 
1325316643e7SJed Brown   PetscFunctionBegin;
13260700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
132751699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
132824989b8cSPeter Brune 
132924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
133024989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
133124989b8cSPeter Brune 
1332089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
133351699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
133451699248SLisandro Dalcin     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
133551699248SLisandro Dalcin     r  = ralloc;
1336e856ceecSJed Brown   }
133751699248SLisandro Dalcin   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
133851699248SLisandro Dalcin   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1339089b2837SJed Brown   PetscFunctionReturn(0);
1340089b2837SJed Brown }
1341089b2837SJed Brown 
1342089b2837SJed Brown /*@C
1343089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1344089b2837SJed Brown 
1345089b2837SJed Brown    Not Collective
1346089b2837SJed Brown 
1347089b2837SJed Brown    Input Parameter:
1348089b2837SJed Brown .  ts - the TS context
1349089b2837SJed Brown 
1350089b2837SJed Brown    Output Parameter:
13510298fd71SBarry Smith +  r - vector to hold residual (or NULL)
13520298fd71SBarry Smith .  func - the function to compute residual (or NULL)
13530298fd71SBarry Smith -  ctx - the function context (or NULL)
1354089b2837SJed Brown 
1355089b2837SJed Brown    Level: advanced
1356089b2837SJed Brown 
1357089b2837SJed Brown .keywords: TS, nonlinear, get, function
1358089b2837SJed Brown 
1359089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1360089b2837SJed Brown @*/
1361089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1362089b2837SJed Brown {
1363089b2837SJed Brown   PetscErrorCode ierr;
1364089b2837SJed Brown   SNES           snes;
136524989b8cSPeter Brune   DM             dm;
1366089b2837SJed Brown 
1367089b2837SJed Brown   PetscFunctionBegin;
1368089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1369089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13700298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
137124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
137224989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1373089b2837SJed Brown   PetscFunctionReturn(0);
1374089b2837SJed Brown }
1375089b2837SJed Brown 
1376089b2837SJed Brown /*@C
1377089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1378089b2837SJed Brown 
1379089b2837SJed Brown    Not Collective
1380089b2837SJed Brown 
1381089b2837SJed Brown    Input Parameter:
1382089b2837SJed Brown .  ts - the TS context
1383089b2837SJed Brown 
1384089b2837SJed Brown    Output Parameter:
13850298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
13860298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
13870298fd71SBarry Smith -  ctx - the function context (or NULL)
1388089b2837SJed Brown 
1389089b2837SJed Brown    Level: advanced
1390089b2837SJed Brown 
1391089b2837SJed Brown .keywords: TS, nonlinear, get, function
1392089b2837SJed Brown 
13932bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1394089b2837SJed Brown @*/
1395089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1396089b2837SJed Brown {
1397089b2837SJed Brown   PetscErrorCode ierr;
1398089b2837SJed Brown   SNES           snes;
139924989b8cSPeter Brune   DM             dm;
1400089b2837SJed Brown 
1401089b2837SJed Brown   PetscFunctionBegin;
1402089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1403089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
14040298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
140524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
140624989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1407316643e7SJed Brown   PetscFunctionReturn(0);
1408316643e7SJed Brown }
1409316643e7SJed Brown 
1410316643e7SJed Brown /*@C
1411a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1412ae8867d6SBarry Smith         provided with TSSetIFunction().
1413316643e7SJed Brown 
14143f9fe445SBarry Smith    Logically Collective on TS
1415316643e7SJed Brown 
1416316643e7SJed Brown    Input Parameters:
1417316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1418e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1419e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1420316643e7SJed Brown .  f   - the Jacobian evaluation routine
14210298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1422316643e7SJed Brown 
1423316643e7SJed Brown    Calling sequence of f:
1424ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1425316643e7SJed Brown 
1426316643e7SJed Brown +  t    - time at step/stage being solved
14271b4a444bSJed Brown .  U    - state vector
14281b4a444bSJed Brown .  U_t  - time derivative of state vector
1429316643e7SJed Brown .  a    - shift
1430e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1431e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1432316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1433316643e7SJed Brown 
1434316643e7SJed Brown    Notes:
1435e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1436316643e7SJed Brown 
1437895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1438895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1439895c21f2SBarry Smith 
1440a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1441b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1442a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1443a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1444a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1445a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1446a4f0a591SBarry Smith 
14476cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
14486cd88445SBarry Smith 
14496cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1450ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1451ca5f011dSBarry Smith 
1452316643e7SJed Brown    Level: beginner
1453316643e7SJed Brown 
1454316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1455316643e7SJed Brown 
1456ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1457316643e7SJed Brown 
1458316643e7SJed Brown @*/
1459e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1460316643e7SJed Brown {
1461316643e7SJed Brown   PetscErrorCode ierr;
1462089b2837SJed Brown   SNES           snes;
146324989b8cSPeter Brune   DM             dm;
1464316643e7SJed Brown 
1465316643e7SJed Brown   PetscFunctionBegin;
14660700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1467e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1468e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1469e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1470e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
147124989b8cSPeter Brune 
147224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
147324989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
147424989b8cSPeter Brune 
1475089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1476e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1477316643e7SJed Brown   PetscFunctionReturn(0);
1478316643e7SJed Brown }
1479316643e7SJed Brown 
1480e1244c69SJed Brown /*@
1481e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1482e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1483e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1484e1244c69SJed Brown    not been changed by the TS.
1485e1244c69SJed Brown 
1486e1244c69SJed Brown    Logically Collective
1487e1244c69SJed Brown 
1488e1244c69SJed Brown    Input Arguments:
1489e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1490e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1491e1244c69SJed Brown 
1492e1244c69SJed Brown    Level: intermediate
1493e1244c69SJed Brown 
1494e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1495e1244c69SJed Brown @*/
1496e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1497e1244c69SJed Brown {
1498e1244c69SJed Brown   PetscFunctionBegin;
1499e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1500e1244c69SJed Brown   PetscFunctionReturn(0);
1501e1244c69SJed Brown }
1502e1244c69SJed Brown 
1503efe9872eSLisandro Dalcin /*@C
1504efe9872eSLisandro Dalcin    TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1505efe9872eSLisandro Dalcin 
1506efe9872eSLisandro Dalcin    Logically Collective on TS
1507efe9872eSLisandro Dalcin 
1508efe9872eSLisandro Dalcin    Input Parameters:
1509efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1510efe9872eSLisandro Dalcin .  F   - vector to hold the residual (or NULL to have it created internally)
1511efe9872eSLisandro Dalcin .  fun - the function evaluation routine
1512efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1513efe9872eSLisandro Dalcin 
1514efe9872eSLisandro Dalcin    Calling sequence of fun:
1515efe9872eSLisandro Dalcin $  fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx);
1516efe9872eSLisandro Dalcin 
1517efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1518efe9872eSLisandro Dalcin .  U    - state vector
1519efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1520efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1521efe9872eSLisandro Dalcin .  F    - function vector
1522efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine (may be NULL)
1523efe9872eSLisandro Dalcin 
1524efe9872eSLisandro Dalcin    Level: beginner
1525efe9872eSLisandro Dalcin 
1526efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function
1527efe9872eSLisandro Dalcin 
1528efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian()
1529efe9872eSLisandro Dalcin @*/
1530efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx)
1531efe9872eSLisandro Dalcin {
1532efe9872eSLisandro Dalcin   DM             dm;
1533efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1534efe9872eSLisandro Dalcin 
1535efe9872eSLisandro Dalcin   PetscFunctionBegin;
1536efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1537efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2);
1538efe9872eSLisandro Dalcin   ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr);
1539efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1540efe9872eSLisandro Dalcin   ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1541efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1542efe9872eSLisandro Dalcin }
1543efe9872eSLisandro Dalcin 
1544efe9872eSLisandro Dalcin /*@C
1545efe9872eSLisandro Dalcin   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1546efe9872eSLisandro Dalcin 
1547efe9872eSLisandro Dalcin   Not Collective
1548efe9872eSLisandro Dalcin 
1549efe9872eSLisandro Dalcin   Input Parameter:
1550efe9872eSLisandro Dalcin . ts - the TS context
1551efe9872eSLisandro Dalcin 
1552efe9872eSLisandro Dalcin   Output Parameter:
1553efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL)
1554efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL)
1555efe9872eSLisandro Dalcin - ctx - the function context (or NULL)
1556efe9872eSLisandro Dalcin 
1557efe9872eSLisandro Dalcin   Level: advanced
1558efe9872eSLisandro Dalcin 
1559efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function
1560efe9872eSLisandro Dalcin 
1561efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction()
1562efe9872eSLisandro Dalcin @*/
1563efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1564efe9872eSLisandro Dalcin {
1565efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1566efe9872eSLisandro Dalcin   SNES           snes;
1567efe9872eSLisandro Dalcin   DM             dm;
1568efe9872eSLisandro Dalcin 
1569efe9872eSLisandro Dalcin   PetscFunctionBegin;
1570efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1571efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1572efe9872eSLisandro Dalcin   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1573efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1574efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1575efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1576efe9872eSLisandro Dalcin }
1577efe9872eSLisandro Dalcin 
1578efe9872eSLisandro Dalcin /*@C
1579bc77d74cSLisandro Dalcin    TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1580efe9872eSLisandro Dalcin         where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1581efe9872eSLisandro Dalcin 
1582efe9872eSLisandro Dalcin    Logically Collective on TS
1583efe9872eSLisandro Dalcin 
1584efe9872eSLisandro Dalcin    Input Parameters:
1585efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1586efe9872eSLisandro Dalcin .  J   - Jacobian matrix
1587efe9872eSLisandro Dalcin .  P   - preconditioning matrix for J (may be same as J)
1588efe9872eSLisandro Dalcin .  jac - the Jacobian evaluation routine
1589efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1590efe9872eSLisandro Dalcin 
1591efe9872eSLisandro Dalcin    Calling sequence of jac:
1592bc77d74cSLisandro Dalcin $  jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx);
1593efe9872eSLisandro Dalcin 
1594efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1595efe9872eSLisandro Dalcin .  U    - state vector
1596efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1597efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1598efe9872eSLisandro Dalcin .  v    - shift for U_t
1599efe9872eSLisandro Dalcin .  a    - shift for U_tt
1600efe9872eSLisandro 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
1601efe9872eSLisandro Dalcin .  P    - preconditioning matrix for J, may be same as J
1602efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine
1603efe9872eSLisandro Dalcin 
1604efe9872eSLisandro Dalcin    Notes:
1605efe9872eSLisandro Dalcin    The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1606efe9872eSLisandro Dalcin 
1607efe9872eSLisandro Dalcin    The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1608efe9872eSLisandro 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.
1609efe9872eSLisandro Dalcin    The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1610bc77d74cSLisandro Dalcin    parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1611efe9872eSLisandro Dalcin 
1612efe9872eSLisandro Dalcin    Level: beginner
1613efe9872eSLisandro Dalcin 
1614efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian
1615efe9872eSLisandro Dalcin 
1616efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1617efe9872eSLisandro Dalcin @*/
1618efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1619efe9872eSLisandro Dalcin {
1620efe9872eSLisandro Dalcin   DM             dm;
1621efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1622efe9872eSLisandro Dalcin 
1623efe9872eSLisandro Dalcin   PetscFunctionBegin;
1624efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1625efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2);
1626efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3);
1627efe9872eSLisandro Dalcin   ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr);
1628efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1629efe9872eSLisandro Dalcin   ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1630efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1631efe9872eSLisandro Dalcin }
1632efe9872eSLisandro Dalcin 
1633efe9872eSLisandro Dalcin /*@C
1634efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1635efe9872eSLisandro Dalcin 
1636efe9872eSLisandro Dalcin   Not Collective, but parallel objects are returned if TS is parallel
1637efe9872eSLisandro Dalcin 
1638efe9872eSLisandro Dalcin   Input Parameter:
1639efe9872eSLisandro Dalcin . ts  - The TS context obtained from TSCreate()
1640efe9872eSLisandro Dalcin 
1641efe9872eSLisandro Dalcin   Output Parameters:
1642efe9872eSLisandro Dalcin + J  - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1643efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J
1644efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1645efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1646efe9872eSLisandro Dalcin 
1647efe9872eSLisandro Dalcin   Notes: You can pass in NULL for any return argument you do not need.
1648efe9872eSLisandro Dalcin 
1649efe9872eSLisandro Dalcin   Level: advanced
1650efe9872eSLisandro Dalcin 
165180275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
1652efe9872eSLisandro Dalcin 
1653efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian
1654efe9872eSLisandro Dalcin @*/
1655efe9872eSLisandro Dalcin PetscErrorCode  TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1656efe9872eSLisandro Dalcin {
1657efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1658efe9872eSLisandro Dalcin   SNES           snes;
1659efe9872eSLisandro Dalcin   DM             dm;
1660efe9872eSLisandro Dalcin 
1661efe9872eSLisandro Dalcin   PetscFunctionBegin;
1662efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1663efe9872eSLisandro Dalcin   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
1664efe9872eSLisandro Dalcin   ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr);
1665efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1666efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1667efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1668efe9872eSLisandro Dalcin }
1669efe9872eSLisandro Dalcin 
1670efe9872eSLisandro Dalcin /*@
1671efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1672efe9872eSLisandro Dalcin 
1673efe9872eSLisandro Dalcin   Collective on TS and Vec
1674efe9872eSLisandro Dalcin 
1675efe9872eSLisandro Dalcin   Input Parameters:
1676efe9872eSLisandro Dalcin + ts - the TS context
1677efe9872eSLisandro Dalcin . t - current time
1678efe9872eSLisandro Dalcin . U - state vector
1679efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t)
1680efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt)
1681efe9872eSLisandro Dalcin 
1682efe9872eSLisandro Dalcin   Output Parameter:
1683efe9872eSLisandro Dalcin . F - the residual vector
1684efe9872eSLisandro Dalcin 
1685efe9872eSLisandro Dalcin   Note:
1686efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1687efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1688efe9872eSLisandro Dalcin 
1689efe9872eSLisandro Dalcin   Level: developer
1690efe9872eSLisandro Dalcin 
1691efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector
1692efe9872eSLisandro Dalcin 
1693efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1694efe9872eSLisandro Dalcin @*/
1695efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1696efe9872eSLisandro Dalcin {
1697efe9872eSLisandro Dalcin   DM             dm;
1698efe9872eSLisandro Dalcin   TSI2Function   I2Function;
1699efe9872eSLisandro Dalcin   void           *ctx;
1700efe9872eSLisandro Dalcin   TSRHSFunction  rhsfunction;
1701efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1702efe9872eSLisandro Dalcin 
1703efe9872eSLisandro Dalcin   PetscFunctionBegin;
1704efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1705efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1706efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1707efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1708efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F,VEC_CLASSID,6);
1709efe9872eSLisandro Dalcin 
1710efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1711efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr);
1712efe9872eSLisandro Dalcin   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
1713efe9872eSLisandro Dalcin 
1714efe9872eSLisandro Dalcin   if (!I2Function) {
1715efe9872eSLisandro Dalcin     ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr);
1716efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1717efe9872eSLisandro Dalcin   }
1718efe9872eSLisandro Dalcin 
1719efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1720efe9872eSLisandro Dalcin 
1721efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit function");
1722efe9872eSLisandro Dalcin   ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr);
1723efe9872eSLisandro Dalcin   PetscStackPop;
1724efe9872eSLisandro Dalcin 
1725efe9872eSLisandro Dalcin   if (rhsfunction) {
1726efe9872eSLisandro Dalcin     Vec Frhs;
1727efe9872eSLisandro Dalcin     ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
1728efe9872eSLisandro Dalcin     ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
1729efe9872eSLisandro Dalcin     ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr);
1730efe9872eSLisandro Dalcin   }
1731efe9872eSLisandro Dalcin 
1732efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1733efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1734efe9872eSLisandro Dalcin }
1735efe9872eSLisandro Dalcin 
1736efe9872eSLisandro Dalcin /*@
1737efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1738efe9872eSLisandro Dalcin 
1739efe9872eSLisandro Dalcin   Collective on TS and Vec
1740efe9872eSLisandro Dalcin 
1741efe9872eSLisandro Dalcin   Input Parameters:
1742efe9872eSLisandro Dalcin + ts - the TS context
1743efe9872eSLisandro Dalcin . t - current timestep
1744efe9872eSLisandro Dalcin . U - state vector
1745efe9872eSLisandro Dalcin . V - time derivative of state vector
1746efe9872eSLisandro Dalcin . A - second time derivative of state vector
1747efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1748efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1749efe9872eSLisandro Dalcin 
1750efe9872eSLisandro Dalcin   Output Parameters:
1751efe9872eSLisandro Dalcin + J - Jacobian matrix
1752efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1753efe9872eSLisandro Dalcin 
1754efe9872eSLisandro Dalcin   Notes:
1755efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1756efe9872eSLisandro Dalcin 
1757efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1758efe9872eSLisandro Dalcin 
1759efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1760efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1761efe9872eSLisandro Dalcin 
1762efe9872eSLisandro Dalcin   Level: developer
1763efe9872eSLisandro Dalcin 
1764efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix
1765efe9872eSLisandro Dalcin 
1766efe9872eSLisandro Dalcin .seealso:  TSSetI2Jacobian()
1767efe9872eSLisandro Dalcin @*/
1768efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1769efe9872eSLisandro Dalcin {
1770efe9872eSLisandro Dalcin   DM             dm;
1771efe9872eSLisandro Dalcin   TSI2Jacobian   I2Jacobian;
1772efe9872eSLisandro Dalcin   void           *ctx;
1773efe9872eSLisandro Dalcin   TSRHSJacobian  rhsjacobian;
1774efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1775efe9872eSLisandro Dalcin 
1776efe9872eSLisandro Dalcin   PetscFunctionBegin;
1777efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1778efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1779efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1780efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1781efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J,MAT_CLASSID,8);
1782efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P,MAT_CLASSID,9);
1783efe9872eSLisandro Dalcin 
1784efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1785efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr);
1786efe9872eSLisandro Dalcin   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
1787efe9872eSLisandro Dalcin 
1788efe9872eSLisandro Dalcin   if (!I2Jacobian) {
1789efe9872eSLisandro Dalcin     ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr);
1790efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1791efe9872eSLisandro Dalcin   }
1792efe9872eSLisandro Dalcin 
1793efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1794efe9872eSLisandro Dalcin 
1795efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit Jacobian");
1796efe9872eSLisandro Dalcin   ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr);
1797efe9872eSLisandro Dalcin   PetscStackPop;
1798efe9872eSLisandro Dalcin 
1799efe9872eSLisandro Dalcin   if (rhsjacobian) {
1800efe9872eSLisandro Dalcin     Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1801efe9872eSLisandro Dalcin     ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr);
1802efe9872eSLisandro Dalcin     ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr);
1803efe9872eSLisandro Dalcin     ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr);
1804efe9872eSLisandro Dalcin     if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);}
1805efe9872eSLisandro Dalcin   }
1806efe9872eSLisandro Dalcin 
1807efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1808efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1809efe9872eSLisandro Dalcin }
1810efe9872eSLisandro Dalcin 
1811efe9872eSLisandro Dalcin /*@
1812efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1813efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1814efe9872eSLisandro Dalcin 
1815efe9872eSLisandro Dalcin    Logically Collective on TS and Vec
1816efe9872eSLisandro Dalcin 
1817efe9872eSLisandro Dalcin    Input Parameters:
1818efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1819efe9872eSLisandro Dalcin .  u - the solution vector
1820efe9872eSLisandro Dalcin -  v - the time derivative vector
1821efe9872eSLisandro Dalcin 
1822efe9872eSLisandro Dalcin    Level: beginner
1823efe9872eSLisandro Dalcin 
1824efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions
1825efe9872eSLisandro Dalcin @*/
1826efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1827efe9872eSLisandro Dalcin {
1828efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1829efe9872eSLisandro Dalcin 
1830efe9872eSLisandro Dalcin   PetscFunctionBegin;
1831efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1832efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1833efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1834efe9872eSLisandro Dalcin   ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
1835efe9872eSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr);
1836efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
1837efe9872eSLisandro Dalcin   ts->vec_dot = v;
1838efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1839efe9872eSLisandro Dalcin }
1840efe9872eSLisandro Dalcin 
1841efe9872eSLisandro Dalcin /*@
1842efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1843efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1844efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1845efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1846efe9872eSLisandro Dalcin 
1847efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1848efe9872eSLisandro Dalcin 
1849efe9872eSLisandro Dalcin    Input Parameter:
1850efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1851efe9872eSLisandro Dalcin 
1852efe9872eSLisandro Dalcin    Output Parameter:
1853efe9872eSLisandro Dalcin +  u - the vector containing the solution
1854efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1855efe9872eSLisandro Dalcin 
1856efe9872eSLisandro Dalcin    Level: intermediate
1857efe9872eSLisandro Dalcin 
1858efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1859efe9872eSLisandro Dalcin 
1860efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution
1861efe9872eSLisandro Dalcin @*/
1862efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1863efe9872eSLisandro Dalcin {
1864efe9872eSLisandro Dalcin   PetscFunctionBegin;
1865efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1866efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1867efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1868efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1869efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1870efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1871efe9872eSLisandro Dalcin }
1872efe9872eSLisandro Dalcin 
187355849f57SBarry Smith /*@C
187455849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
187555849f57SBarry Smith 
187655849f57SBarry Smith   Collective on PetscViewer
187755849f57SBarry Smith 
187855849f57SBarry Smith   Input Parameters:
187955849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
188055849f57SBarry Smith            some related function before a call to TSLoad().
188155849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
188255849f57SBarry Smith 
188355849f57SBarry Smith    Level: intermediate
188455849f57SBarry Smith 
188555849f57SBarry Smith   Notes:
188655849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
188755849f57SBarry Smith 
188855849f57SBarry Smith   Notes for advanced users:
188955849f57SBarry Smith   Most users should not need to know the details of the binary storage
189055849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
189155849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
189255849f57SBarry Smith   format is
189355849f57SBarry Smith .vb
189455849f57SBarry Smith      has not yet been determined
189555849f57SBarry Smith .ve
189655849f57SBarry Smith 
189755849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
189855849f57SBarry Smith @*/
1899f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
190055849f57SBarry Smith {
190155849f57SBarry Smith   PetscErrorCode ierr;
190255849f57SBarry Smith   PetscBool      isbinary;
190355849f57SBarry Smith   PetscInt       classid;
190455849f57SBarry Smith   char           type[256];
19052d53ad75SBarry Smith   DMTS           sdm;
1906ad6bc421SBarry Smith   DM             dm;
190755849f57SBarry Smith 
190855849f57SBarry Smith   PetscFunctionBegin;
1909f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
191055849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
191155849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
191255849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
191355849f57SBarry Smith 
1914060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1915ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1916060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1917f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1918f2c2a1b9SBarry Smith   if (ts->ops->load) {
1919f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1920f2c2a1b9SBarry Smith   }
1921ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1922ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1923ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1924f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1925f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
19262d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19272d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
192855849f57SBarry Smith   PetscFunctionReturn(0);
192955849f57SBarry Smith }
193055849f57SBarry Smith 
19319804daf3SBarry Smith #include <petscdraw.h>
1932e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1933e04113cfSBarry Smith #include <petscviewersaws.h>
1934f05ece33SBarry Smith #endif
19357e2c5f70SBarry Smith /*@C
1936d763cef2SBarry Smith     TSView - Prints the TS data structure.
1937d763cef2SBarry Smith 
19384c49b128SBarry Smith     Collective on TS
1939d763cef2SBarry Smith 
1940d763cef2SBarry Smith     Input Parameters:
1941d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1942d763cef2SBarry Smith -   viewer - visualization context
1943d763cef2SBarry Smith 
1944d763cef2SBarry Smith     Options Database Key:
1945d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1946d763cef2SBarry Smith 
1947d763cef2SBarry Smith     Notes:
1948d763cef2SBarry Smith     The available visualization contexts include
1949b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1950b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1951d763cef2SBarry Smith          output where only the first processor opens
1952d763cef2SBarry Smith          the file.  All other processors send their
1953d763cef2SBarry Smith          data to the first processor to print.
1954d763cef2SBarry Smith 
1955d763cef2SBarry Smith     The user can open an alternative visualization context with
1956b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1957d763cef2SBarry Smith 
1958d763cef2SBarry Smith     Level: beginner
1959d763cef2SBarry Smith 
1960d763cef2SBarry Smith .keywords: TS, timestep, view
1961d763cef2SBarry Smith 
1962b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1963d763cef2SBarry Smith @*/
19647087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1965d763cef2SBarry Smith {
1966dfbe8321SBarry Smith   PetscErrorCode ierr;
196719fd82e9SBarry Smith   TSType         type;
19682b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
19692d53ad75SBarry Smith   DMTS           sdm;
1970e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1971536b137fSBarry Smith   PetscBool      issaws;
1972f05ece33SBarry Smith #endif
1973d763cef2SBarry Smith 
1974d763cef2SBarry Smith   PetscFunctionBegin;
19750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
19763050cee2SBarry Smith   if (!viewer) {
1977ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
19783050cee2SBarry Smith   }
19790700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1980c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1981fd16b177SBarry Smith 
1982251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1983251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
198455849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
19852b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1986e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1987536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1988f05ece33SBarry Smith #endif
198932077d6dSBarry Smith   if (iascii) {
1990dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
1991efd4aadfSBarry Smith     if (ts->ops->view) {
1992efd4aadfSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1993efd4aadfSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1994efd4aadfSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1995efd4aadfSBarry Smith     }
1996ef85077eSLisandro Dalcin     if (ts->max_steps < PETSC_MAX_INT) {
199777431f27SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
1998ef85077eSLisandro Dalcin     }
1999ef85077eSLisandro Dalcin     if (ts->max_time < PETSC_MAX_REAL) {
20007c8652ddSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
2001ef85077eSLisandro Dalcin     }
2002efd4aadfSBarry Smith     if (ts->usessnes) {
2003efd4aadfSBarry Smith       PetscBool lin;
2004d763cef2SBarry Smith       if (ts->problem_type == TS_NONLINEAR) {
20055ef26d82SJed Brown         ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
2006d763cef2SBarry Smith       }
20075ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
2008efd4aadfSBarry Smith       ierr = PetscObjectTypeCompare((PetscObject)ts->snes,SNESKSPONLY,&lin);CHKERRQ(ierr);
2009efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr);
2010efd4aadfSBarry Smith     }
2011193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
2012a0af407cSBarry Smith     if (ts->vrtol) {
2013a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of relative error tolerances, ");CHKERRQ(ierr);
2014a0af407cSBarry Smith     } else {
2015a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr);
2016a0af407cSBarry Smith     }
2017a0af407cSBarry Smith     if (ts->vatol) {
2018a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of absolute error tolerances\n");CHKERRQ(ierr);
2019a0af407cSBarry Smith     } else {
2020a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr);
2021a0af407cSBarry Smith     }
2022efd4aadfSBarry Smith     ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);
2023efd4aadfSBarry Smith     if (ts->snes && ts->usessnes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
20242d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
20252d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
20260f5bd95cSBarry Smith   } else if (isstring) {
2027a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
2028b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
202955849f57SBarry Smith   } else if (isbinary) {
203055849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
203155849f57SBarry Smith     MPI_Comm    comm;
203255849f57SBarry Smith     PetscMPIInt rank;
203355849f57SBarry Smith     char        type[256];
203455849f57SBarry Smith 
203555849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
203655849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
203755849f57SBarry Smith     if (!rank) {
203855849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
203955849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
204055849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
204155849f57SBarry Smith     }
204255849f57SBarry Smith     if (ts->ops->view) {
204355849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
204455849f57SBarry Smith     }
2045efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2046f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
2047f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
20482d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
20492d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
20502b0a91c0SBarry Smith   } else if (isdraw) {
20512b0a91c0SBarry Smith     PetscDraw draw;
20522b0a91c0SBarry Smith     char      str[36];
205389fd9fafSBarry Smith     PetscReal x,y,bottom,h;
20542b0a91c0SBarry Smith 
20552b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
20562b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
20572b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
20582b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
205951fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
206089fd9fafSBarry Smith     bottom = y - h;
20612b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
20622b0a91c0SBarry Smith     if (ts->ops->view) {
20632b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
20642b0a91c0SBarry Smith     }
2065efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2066efd4aadfSBarry Smith     if (ts->snes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
20672b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2068e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2069536b137fSBarry Smith   } else if (issaws) {
2070d45a07a7SBarry Smith     PetscMPIInt rank;
20712657e9d9SBarry Smith     const char  *name;
20722657e9d9SBarry Smith 
20732657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
2074d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
2075d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
2076d45a07a7SBarry Smith       char       dir[1024];
2077d45a07a7SBarry Smith 
2078e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
2079a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
20802657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
20812657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
20822657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
2083d763cef2SBarry Smith     }
20840acecf5bSBarry Smith     if (ts->ops->view) {
20850acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
20860acecf5bSBarry Smith     }
2087f05ece33SBarry Smith #endif
2088f05ece33SBarry Smith   }
2089f05ece33SBarry Smith 
2090b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2091251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
2092b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2093d763cef2SBarry Smith   PetscFunctionReturn(0);
2094d763cef2SBarry Smith }
2095d763cef2SBarry Smith 
2096b07ff414SBarry Smith /*@
2097d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2098d763cef2SBarry Smith    the timesteppers.
2099d763cef2SBarry Smith 
21003f9fe445SBarry Smith    Logically Collective on TS
2101d763cef2SBarry Smith 
2102d763cef2SBarry Smith    Input Parameters:
2103d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2104d763cef2SBarry Smith -  usrP - optional user context
2105d763cef2SBarry Smith 
2106daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2107daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2108daf670e6SBarry Smith 
2109d763cef2SBarry Smith    Level: intermediate
2110d763cef2SBarry Smith 
2111d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
2112d763cef2SBarry Smith 
2113d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2114d763cef2SBarry Smith @*/
21157087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2116d763cef2SBarry Smith {
2117d763cef2SBarry Smith   PetscFunctionBegin;
21180700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2119d763cef2SBarry Smith   ts->user = usrP;
2120d763cef2SBarry Smith   PetscFunctionReturn(0);
2121d763cef2SBarry Smith }
2122d763cef2SBarry Smith 
2123b07ff414SBarry Smith /*@
2124d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2125d763cef2SBarry Smith     timestepper.
2126d763cef2SBarry Smith 
2127d763cef2SBarry Smith     Not Collective
2128d763cef2SBarry Smith 
2129d763cef2SBarry Smith     Input Parameter:
2130d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2131d763cef2SBarry Smith 
2132d763cef2SBarry Smith     Output Parameter:
2133d763cef2SBarry Smith .   usrP - user context
2134d763cef2SBarry Smith 
2135daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2136daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2137daf670e6SBarry Smith 
2138d763cef2SBarry Smith     Level: intermediate
2139d763cef2SBarry Smith 
2140d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
2141d763cef2SBarry Smith 
2142d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2143d763cef2SBarry Smith @*/
2144e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2145d763cef2SBarry Smith {
2146d763cef2SBarry Smith   PetscFunctionBegin;
21470700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2148e71120c6SJed Brown   *(void**)usrP = ts->user;
2149d763cef2SBarry Smith   PetscFunctionReturn(0);
2150d763cef2SBarry Smith }
2151d763cef2SBarry Smith 
2152d763cef2SBarry Smith /*@
215380275a0aSLisandro Dalcin    TSGetStepNumber - Gets the number of steps completed.
2154d763cef2SBarry Smith 
2155d763cef2SBarry Smith    Not Collective
2156d763cef2SBarry Smith 
2157d763cef2SBarry Smith    Input Parameter:
2158d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2159d763cef2SBarry Smith 
2160d763cef2SBarry Smith    Output Parameter:
216180275a0aSLisandro Dalcin .  steps - number of steps completed so far
2162d763cef2SBarry Smith 
2163d763cef2SBarry Smith    Level: intermediate
2164d763cef2SBarry Smith 
2165d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
21669be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2167d763cef2SBarry Smith @*/
216880275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps)
2169d763cef2SBarry Smith {
2170d763cef2SBarry Smith   PetscFunctionBegin;
21710700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
217280275a0aSLisandro Dalcin   PetscValidIntPointer(steps,2);
217380275a0aSLisandro Dalcin   *steps = ts->steps;
217480275a0aSLisandro Dalcin   PetscFunctionReturn(0);
217580275a0aSLisandro Dalcin }
217680275a0aSLisandro Dalcin 
217780275a0aSLisandro Dalcin /*@
217880275a0aSLisandro Dalcin    TSSetStepNumber - Sets the number of steps completed.
217980275a0aSLisandro Dalcin 
218080275a0aSLisandro Dalcin    Logically Collective on TS
218180275a0aSLisandro Dalcin 
218280275a0aSLisandro Dalcin    Input Parameters:
218380275a0aSLisandro Dalcin +  ts - the TS context
218480275a0aSLisandro Dalcin -  steps - number of steps completed so far
218580275a0aSLisandro Dalcin 
218680275a0aSLisandro Dalcin    Notes:
218780275a0aSLisandro Dalcin    For most uses of the TS solvers the user need not explicitly call
218880275a0aSLisandro Dalcin    TSSetStepNumber(), as the step counter is appropriately updated in
218980275a0aSLisandro Dalcin    TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to
219080275a0aSLisandro Dalcin    reinitialize timestepping by setting the step counter to zero (and time
219180275a0aSLisandro Dalcin    to the initial time) to solve a similar problem with different initial
219280275a0aSLisandro Dalcin    conditions or parameters. Other possible use case is to continue
219380275a0aSLisandro Dalcin    timestepping from a previously interrupted run in such a way that TS
219480275a0aSLisandro Dalcin    monitors will be called with a initial nonzero step counter.
219580275a0aSLisandro Dalcin 
219680275a0aSLisandro Dalcin    Level: advanced
219780275a0aSLisandro Dalcin 
219880275a0aSLisandro Dalcin .keywords: TS, timestep, set, iteration, number
219980275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution()
220080275a0aSLisandro Dalcin @*/
220180275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps)
220280275a0aSLisandro Dalcin {
220380275a0aSLisandro Dalcin   PetscFunctionBegin;
220480275a0aSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
220580275a0aSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,steps,2);
220680275a0aSLisandro Dalcin   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative");
220780275a0aSLisandro Dalcin   ts->steps = steps;
2208d763cef2SBarry Smith   PetscFunctionReturn(0);
2209d763cef2SBarry Smith }
2210d763cef2SBarry Smith 
2211d763cef2SBarry Smith /*@
2212d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2213d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2214d763cef2SBarry Smith 
22153f9fe445SBarry Smith    Logically Collective on TS
2216d763cef2SBarry Smith 
2217d763cef2SBarry Smith    Input Parameters:
2218d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2219d763cef2SBarry Smith -  time_step - the size of the timestep
2220d763cef2SBarry Smith 
2221d763cef2SBarry Smith    Level: intermediate
2222d763cef2SBarry Smith 
2223aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime()
2224d763cef2SBarry Smith 
2225d763cef2SBarry Smith .keywords: TS, set, timestep
2226d763cef2SBarry Smith @*/
22277087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2228d763cef2SBarry Smith {
2229d763cef2SBarry Smith   PetscFunctionBegin;
22300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2231c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2232d763cef2SBarry Smith   ts->time_step = time_step;
2233d763cef2SBarry Smith   PetscFunctionReturn(0);
2234d763cef2SBarry Smith }
2235d763cef2SBarry Smith 
2236a43b19c4SJed Brown /*@
223749354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
223849354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
223949354f04SShri Abhyankar      or just return at the final time TS computed.
2240a43b19c4SJed Brown 
2241a43b19c4SJed Brown   Logically Collective on TS
2242a43b19c4SJed Brown 
2243a43b19c4SJed Brown    Input Parameter:
2244a43b19c4SJed Brown +   ts - the time-step context
224549354f04SShri Abhyankar -   eftopt - exact final time option
2246a43b19c4SJed Brown 
2247feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2248feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2249feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2250feed9e9dSBarry Smith 
2251feed9e9dSBarry Smith    Options Database:
2252feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2253feed9e9dSBarry Smith 
2254ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2255ee346746SBarry Smith     then the final time you selected.
2256ee346746SBarry Smith 
2257a43b19c4SJed Brown    Level: beginner
2258a43b19c4SJed Brown 
2259f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime()
2260a43b19c4SJed Brown @*/
226149354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2262a43b19c4SJed Brown {
2263a43b19c4SJed Brown   PetscFunctionBegin;
2264a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
226549354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
226649354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2267a43b19c4SJed Brown   PetscFunctionReturn(0);
2268a43b19c4SJed Brown }
2269a43b19c4SJed Brown 
2270d763cef2SBarry Smith /*@
2271f6953c82SLisandro Dalcin    TSGetExactFinalTime - Gets the exact final time option.
2272f6953c82SLisandro Dalcin 
2273f6953c82SLisandro Dalcin    Not Collective
2274f6953c82SLisandro Dalcin 
2275f6953c82SLisandro Dalcin    Input Parameter:
2276f6953c82SLisandro Dalcin .  ts - the TS context
2277f6953c82SLisandro Dalcin 
2278f6953c82SLisandro Dalcin    Output Parameter:
2279f6953c82SLisandro Dalcin .  eftopt - exact final time option
2280f6953c82SLisandro Dalcin 
2281f6953c82SLisandro Dalcin    Level: beginner
2282f6953c82SLisandro Dalcin 
2283f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime()
2284f6953c82SLisandro Dalcin @*/
2285f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt)
2286f6953c82SLisandro Dalcin {
2287f6953c82SLisandro Dalcin   PetscFunctionBegin;
2288f6953c82SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2289f6953c82SLisandro Dalcin   PetscValidPointer(eftopt,2);
2290f6953c82SLisandro Dalcin   *eftopt = ts->exact_final_time;
2291f6953c82SLisandro Dalcin   PetscFunctionReturn(0);
2292f6953c82SLisandro Dalcin }
2293f6953c82SLisandro Dalcin 
2294f6953c82SLisandro Dalcin /*@
2295d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2296d763cef2SBarry Smith 
2297d763cef2SBarry Smith    Not Collective
2298d763cef2SBarry Smith 
2299d763cef2SBarry Smith    Input Parameter:
2300d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2301d763cef2SBarry Smith 
2302d763cef2SBarry Smith    Output Parameter:
2303d763cef2SBarry Smith .  dt - the current timestep size
2304d763cef2SBarry Smith 
2305d763cef2SBarry Smith    Level: intermediate
2306d763cef2SBarry Smith 
2307aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime()
2308d763cef2SBarry Smith 
2309d763cef2SBarry Smith .keywords: TS, get, timestep
2310d763cef2SBarry Smith @*/
23117087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2312d763cef2SBarry Smith {
2313d763cef2SBarry Smith   PetscFunctionBegin;
23140700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2315f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2316d763cef2SBarry Smith   *dt = ts->time_step;
2317d763cef2SBarry Smith   PetscFunctionReturn(0);
2318d763cef2SBarry Smith }
2319d763cef2SBarry Smith 
2320d8e5e3e6SSatish Balay /*@
2321d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2322d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2323d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2324d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2325d763cef2SBarry Smith 
2326d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2327d763cef2SBarry Smith 
2328d763cef2SBarry Smith    Input Parameter:
2329d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2330d763cef2SBarry Smith 
2331d763cef2SBarry Smith    Output Parameter:
2332d763cef2SBarry Smith .  v - the vector containing the solution
2333d763cef2SBarry Smith 
233463e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
233563e21af5SBarry Smith    final time. It returns the solution at the next timestep.
233663e21af5SBarry Smith 
2337d763cef2SBarry Smith    Level: intermediate
2338d763cef2SBarry Smith 
23390ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction()
2340d763cef2SBarry Smith 
2341d763cef2SBarry Smith .keywords: TS, timestep, get, solution
2342d763cef2SBarry Smith @*/
23437087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2344d763cef2SBarry Smith {
2345d763cef2SBarry Smith   PetscFunctionBegin;
23460700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
23474482741eSBarry Smith   PetscValidPointer(v,2);
23488737fe31SLisandro Dalcin   *v = ts->vec_sol;
2349d763cef2SBarry Smith   PetscFunctionReturn(0);
2350d763cef2SBarry Smith }
2351d763cef2SBarry Smith 
235203fe5f5eSDebojyoti Ghosh /*@
2353b2bf4f3aSDebojyoti Ghosh    TSGetSolutionComponents - Returns any solution components at the present
235403fe5f5eSDebojyoti Ghosh    timestep, if available for the time integration method being used.
2355b2bf4f3aSDebojyoti Ghosh    Solution components are quantities that share the same size and
235603fe5f5eSDebojyoti Ghosh    structure as the solution vector.
235703fe5f5eSDebojyoti Ghosh 
235803fe5f5eSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
235903fe5f5eSDebojyoti Ghosh 
236003fe5f5eSDebojyoti Ghosh    Parameters :
236103fe5f5eSDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
2362b2bf4f3aSDebojyoti Ghosh .  n - If v is PETSC_NULL, then the number of solution components is
2363b2bf4f3aSDebojyoti Ghosh        returned through n, else the n-th solution component is
236403fe5f5eSDebojyoti Ghosh        returned in v.
2365b2bf4f3aSDebojyoti Ghosh .  v - the vector containing the n-th solution component
236603fe5f5eSDebojyoti Ghosh        (may be PETSC_NULL to use this function to find out
2367b2bf4f3aSDebojyoti Ghosh         the number of solutions components).
236803fe5f5eSDebojyoti Ghosh 
23694cdd57e5SDebojyoti Ghosh    Level: advanced
237003fe5f5eSDebojyoti Ghosh 
237103fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution()
237203fe5f5eSDebojyoti Ghosh 
237303fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution
237403fe5f5eSDebojyoti Ghosh @*/
2375b2bf4f3aSDebojyoti Ghosh PetscErrorCode  TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v)
237603fe5f5eSDebojyoti Ghosh {
237703fe5f5eSDebojyoti Ghosh   PetscErrorCode ierr;
237803fe5f5eSDebojyoti Ghosh 
237903fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
238003fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2381b2bf4f3aSDebojyoti Ghosh   if (!ts->ops->getsolutioncomponents) *n = 0;
238203fe5f5eSDebojyoti Ghosh   else {
2383b2bf4f3aSDebojyoti Ghosh     ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr);
238403fe5f5eSDebojyoti Ghosh   }
238503fe5f5eSDebojyoti Ghosh   PetscFunctionReturn(0);
238603fe5f5eSDebojyoti Ghosh }
238703fe5f5eSDebojyoti Ghosh 
23884cdd57e5SDebojyoti Ghosh /*@
23894cdd57e5SDebojyoti Ghosh    TSGetAuxSolution - Returns an auxiliary solution at the present
23904cdd57e5SDebojyoti Ghosh    timestep, if available for the time integration method being used.
23914cdd57e5SDebojyoti Ghosh 
23924cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
23934cdd57e5SDebojyoti Ghosh 
23944cdd57e5SDebojyoti Ghosh    Parameters :
23954cdd57e5SDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
23964cdd57e5SDebojyoti Ghosh .  v - the vector containing the auxiliary solution
23974cdd57e5SDebojyoti Ghosh 
23984cdd57e5SDebojyoti Ghosh    Level: intermediate
23994cdd57e5SDebojyoti Ghosh 
24004cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution()
24014cdd57e5SDebojyoti Ghosh 
24024cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, solution
24034cdd57e5SDebojyoti Ghosh @*/
24044cdd57e5SDebojyoti Ghosh PetscErrorCode  TSGetAuxSolution(TS ts,Vec *v)
24054cdd57e5SDebojyoti Ghosh {
24064cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
24074cdd57e5SDebojyoti Ghosh 
24084cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
24094cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2410f6356ec7SDebojyoti Ghosh   if (ts->ops->getauxsolution) {
24114cdd57e5SDebojyoti Ghosh     ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr);
2412f6356ec7SDebojyoti Ghosh   } else {
2413f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v); CHKERRQ(ierr);
2414f6356ec7SDebojyoti Ghosh   }
24154cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
24164cdd57e5SDebojyoti Ghosh }
24174cdd57e5SDebojyoti Ghosh 
24184cdd57e5SDebojyoti Ghosh /*@
24194cdd57e5SDebojyoti Ghosh    TSGetTimeError - Returns the estimated error vector, if the chosen
24204cdd57e5SDebojyoti Ghosh    TSType has an error estimation functionality.
24214cdd57e5SDebojyoti Ghosh 
24224cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
24234cdd57e5SDebojyoti Ghosh 
24249657682dSDebojyoti Ghosh    Note: MUST call after TSSetUp()
24259657682dSDebojyoti Ghosh 
24264cdd57e5SDebojyoti Ghosh    Parameters :
24274cdd57e5SDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
2428657c1e31SEmil Constantinescu .  n - current estimate (n=0) or previous one (n=-1)
24294cdd57e5SDebojyoti Ghosh .  v - the vector containing the error (same size as the solution).
24304cdd57e5SDebojyoti Ghosh 
24314cdd57e5SDebojyoti Ghosh    Level: intermediate
24324cdd57e5SDebojyoti Ghosh 
243357df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError()
24344cdd57e5SDebojyoti Ghosh 
24354cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, error
24364cdd57e5SDebojyoti Ghosh @*/
24370a01e1b2SEmil Constantinescu PetscErrorCode  TSGetTimeError(TS ts,PetscInt n,Vec *v)
24384cdd57e5SDebojyoti Ghosh {
24394cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
24404cdd57e5SDebojyoti Ghosh 
24414cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
24424cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2443f6356ec7SDebojyoti Ghosh   if (ts->ops->gettimeerror) {
24440a01e1b2SEmil Constantinescu     ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr);
2445f6356ec7SDebojyoti Ghosh   } else {
2446f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v);CHKERRQ(ierr);
2447f6356ec7SDebojyoti Ghosh   }
24484cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
24494cdd57e5SDebojyoti Ghosh }
24504cdd57e5SDebojyoti Ghosh 
245157df6a1bSDebojyoti Ghosh /*@
245257df6a1bSDebojyoti Ghosh    TSSetTimeError - Sets the estimated error vector, if the chosen
245357df6a1bSDebojyoti Ghosh    TSType has an error estimation functionality. This can be used
245457df6a1bSDebojyoti Ghosh    to restart such a time integrator with a given error vector.
245557df6a1bSDebojyoti Ghosh 
245657df6a1bSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
245757df6a1bSDebojyoti Ghosh 
245857df6a1bSDebojyoti Ghosh    Parameters :
245957df6a1bSDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
246057df6a1bSDebojyoti Ghosh .  v - the vector containing the error (same size as the solution).
246157df6a1bSDebojyoti Ghosh 
246257df6a1bSDebojyoti Ghosh    Level: intermediate
246357df6a1bSDebojyoti Ghosh 
246457df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError)
246557df6a1bSDebojyoti Ghosh 
246657df6a1bSDebojyoti Ghosh .keywords: TS, timestep, get, error
246757df6a1bSDebojyoti Ghosh @*/
246857df6a1bSDebojyoti Ghosh PetscErrorCode  TSSetTimeError(TS ts,Vec v)
246957df6a1bSDebojyoti Ghosh {
247057df6a1bSDebojyoti Ghosh   PetscErrorCode ierr;
247157df6a1bSDebojyoti Ghosh 
247257df6a1bSDebojyoti Ghosh   PetscFunctionBegin;
247357df6a1bSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24749657682dSDebojyoti Ghosh   if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first");
247557df6a1bSDebojyoti Ghosh   if (ts->ops->settimeerror) {
247657df6a1bSDebojyoti Ghosh     ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr);
247757df6a1bSDebojyoti Ghosh   }
247857df6a1bSDebojyoti Ghosh   PetscFunctionReturn(0);
247957df6a1bSDebojyoti Ghosh }
248057df6a1bSDebojyoti Ghosh 
2481c235aa8dSHong Zhang /*@
2482dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
2483c235aa8dSHong Zhang 
2484c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
2485c235aa8dSHong Zhang 
2486c235aa8dSHong Zhang    Input Parameter:
2487c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
2488c235aa8dSHong Zhang 
2489c235aa8dSHong Zhang    Output Parameter:
2490abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
2491abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
2492c235aa8dSHong Zhang 
2493c235aa8dSHong Zhang    Level: intermediate
2494c235aa8dSHong Zhang 
2495c235aa8dSHong Zhang .seealso: TSGetTimeStep()
2496c235aa8dSHong Zhang 
2497c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
2498c235aa8dSHong Zhang @*/
2499dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
2500c235aa8dSHong Zhang {
2501c235aa8dSHong Zhang   PetscFunctionBegin;
2502c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2503abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
2504abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
2505abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
2506c235aa8dSHong Zhang   PetscFunctionReturn(0);
2507c235aa8dSHong Zhang }
2508c235aa8dSHong Zhang 
2509bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
2510d8e5e3e6SSatish Balay /*@
2511bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2512d763cef2SBarry Smith 
2513bdad233fSMatthew Knepley   Not collective
2514d763cef2SBarry Smith 
2515bdad233fSMatthew Knepley   Input Parameters:
2516bdad233fSMatthew Knepley + ts   - The TS
2517bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2518d763cef2SBarry Smith .vb
25190910c330SBarry Smith          U_t - A U = 0      (linear)
25200910c330SBarry Smith          U_t - A(t) U = 0   (linear)
25210910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2522d763cef2SBarry Smith .ve
2523d763cef2SBarry Smith 
2524d763cef2SBarry Smith    Level: beginner
2525d763cef2SBarry Smith 
2526bdad233fSMatthew Knepley .keywords: TS, problem type
2527bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2528d763cef2SBarry Smith @*/
25297087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2530a7cc72afSBarry Smith {
25319e2a6581SJed Brown   PetscErrorCode ierr;
25329e2a6581SJed Brown 
2533d763cef2SBarry Smith   PetscFunctionBegin;
25340700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2535bdad233fSMatthew Knepley   ts->problem_type = type;
25369e2a6581SJed Brown   if (type == TS_LINEAR) {
25379e2a6581SJed Brown     SNES snes;
25389e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
25399e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
25409e2a6581SJed Brown   }
2541d763cef2SBarry Smith   PetscFunctionReturn(0);
2542d763cef2SBarry Smith }
2543d763cef2SBarry Smith 
2544bdad233fSMatthew Knepley /*@C
2545bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2546bdad233fSMatthew Knepley 
2547bdad233fSMatthew Knepley   Not collective
2548bdad233fSMatthew Knepley 
2549bdad233fSMatthew Knepley   Input Parameter:
2550bdad233fSMatthew Knepley . ts   - The TS
2551bdad233fSMatthew Knepley 
2552bdad233fSMatthew Knepley   Output Parameter:
2553bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2554bdad233fSMatthew Knepley .vb
2555089b2837SJed Brown          M U_t = A U
2556089b2837SJed Brown          M(t) U_t = A(t) U
2557b5abc632SBarry Smith          F(t,U,U_t)
2558bdad233fSMatthew Knepley .ve
2559bdad233fSMatthew Knepley 
2560bdad233fSMatthew Knepley    Level: beginner
2561bdad233fSMatthew Knepley 
2562bdad233fSMatthew Knepley .keywords: TS, problem type
2563bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2564bdad233fSMatthew Knepley @*/
25657087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2566a7cc72afSBarry Smith {
2567bdad233fSMatthew Knepley   PetscFunctionBegin;
25680700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
25694482741eSBarry Smith   PetscValidIntPointer(type,2);
2570bdad233fSMatthew Knepley   *type = ts->problem_type;
2571bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2572bdad233fSMatthew Knepley }
2573d763cef2SBarry Smith 
2574d763cef2SBarry Smith /*@
2575d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
2576d763cef2SBarry Smith    of a timestepper.
2577d763cef2SBarry Smith 
2578d763cef2SBarry Smith    Collective on TS
2579d763cef2SBarry Smith 
2580d763cef2SBarry Smith    Input Parameter:
2581d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2582d763cef2SBarry Smith 
2583d763cef2SBarry Smith    Notes:
2584d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2585d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2586141bd67dSStefano Zampini    the call to TSStep() or TSSolve().  However, if one wishes to control this
2587d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2588141bd67dSStefano Zampini    and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve().
2589d763cef2SBarry Smith 
2590d763cef2SBarry Smith    Level: advanced
2591d763cef2SBarry Smith 
2592d763cef2SBarry Smith .keywords: TS, timestep, setup
2593d763cef2SBarry Smith 
2594141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve()
2595d763cef2SBarry Smith @*/
25967087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2597d763cef2SBarry Smith {
2598dfbe8321SBarry Smith   PetscErrorCode ierr;
25996c6b9e74SPeter Brune   DM             dm;
26006c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2601d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2602cd11d68dSLisandro Dalcin   TSIFunction    ifun;
26036c6b9e74SPeter Brune   TSIJacobian    ijac;
2604efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
26056c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
26062ffb9264SLisandro Dalcin   PetscBool      isnone;
2607d763cef2SBarry Smith 
2608d763cef2SBarry Smith   PetscFunctionBegin;
26090700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2610277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2611277b19d0SLisandro Dalcin 
26127adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2613cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
2614cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
2615d763cef2SBarry Smith   }
2616277b19d0SLisandro Dalcin 
2617277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
2618277b19d0SLisandro Dalcin 
2619e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
2620e1244c69SJed Brown     Mat Amat,Pmat;
2621e1244c69SJed Brown     SNES snes;
2622e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2623e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2624e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2625e1244c69SJed Brown      * have displaced the RHS matrix */
2626e1244c69SJed Brown     if (Amat == ts->Arhs) {
2627abc0d4abSBarry 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 */
2628abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2629e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2630e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2631e1244c69SJed Brown     }
2632e1244c69SJed Brown     if (Pmat == ts->Brhs) {
2633abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2634e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2635e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2636e1244c69SJed Brown     }
2637e1244c69SJed Brown   }
26382ffb9264SLisandro Dalcin 
26392ffb9264SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
26402ffb9264SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
26412ffb9264SLisandro Dalcin 
2642277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2643000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2644277b19d0SLisandro Dalcin   }
2645277b19d0SLisandro Dalcin 
26462ffb9264SLisandro Dalcin   /* Attempt to check/preset a default value for the exact final time option */
26472ffb9264SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr);
26482ffb9264SLisandro Dalcin   if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED)
26492ffb9264SLisandro Dalcin     ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP;
26502ffb9264SLisandro Dalcin 
2651a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
26526c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
26536c6b9e74SPeter Brune    */
26546c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
26550298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
26566c6b9e74SPeter Brune   if (!func) {
26576c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
26586c6b9e74SPeter Brune   }
2659a6772fa2SLisandro 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.
26606c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
26616c6b9e74SPeter Brune    */
26620298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
26630298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
2664efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr);
26650298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
2666efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
26676c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
26686c6b9e74SPeter Brune   }
2669c0517034SDebojyoti Ghosh 
2670c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2671c0517034SDebojyoti Ghosh   if (ts->ops->startingmethod) {
2672c0517034SDebojyoti Ghosh     ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr);
2673c0517034SDebojyoti Ghosh   }
2674c0517034SDebojyoti Ghosh 
2675277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2676277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2677277b19d0SLisandro Dalcin }
2678277b19d0SLisandro Dalcin 
2679f6a906c0SBarry Smith /*@
2680f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
2681f6a906c0SBarry Smith    of an adjoint solver
2682f6a906c0SBarry Smith 
2683f6a906c0SBarry Smith    Collective on TS
2684f6a906c0SBarry Smith 
2685f6a906c0SBarry Smith    Input Parameter:
2686f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
2687f6a906c0SBarry Smith 
2688f6a906c0SBarry Smith    Level: advanced
2689f6a906c0SBarry Smith 
2690f6a906c0SBarry Smith .keywords: TS, timestep, setup
2691f6a906c0SBarry Smith 
2692947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
2693f6a906c0SBarry Smith @*/
2694f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
2695f6a906c0SBarry Smith {
2696f6a906c0SBarry Smith   PetscErrorCode ierr;
2697f6a906c0SBarry Smith 
2698f6a906c0SBarry Smith   PetscFunctionBegin;
2699f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2700f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
270123706b9aSHong Zhang   if (!ts->vecs_sensi) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
2702c5767687SHong Zhang   if (ts->vecs_sensip && !ts->Jacp) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"Must call TSAdjointSetRHSJacobian() first");
2703d8151eeaSBarry Smith 
2704947abb85SHong Zhang   if (ts->vec_costintegral) { /* if there is integral in the cost function */
2705d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2706d8151eeaSBarry Smith     if (ts->vecs_sensip){
2707d8151eeaSBarry Smith       ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2708d8151eeaSBarry Smith     }
2709947abb85SHong Zhang   }
2710d8151eeaSBarry Smith 
271142f2b339SBarry Smith   if (ts->ops->adjointsetup) {
271242f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
2713f6a906c0SBarry Smith   }
2714f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
2715f6a906c0SBarry Smith   PetscFunctionReturn(0);
2716f6a906c0SBarry Smith }
2717f6a906c0SBarry Smith 
2718277b19d0SLisandro Dalcin /*@
2719277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2720277b19d0SLisandro Dalcin 
2721277b19d0SLisandro Dalcin    Collective on TS
2722277b19d0SLisandro Dalcin 
2723277b19d0SLisandro Dalcin    Input Parameter:
2724277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2725277b19d0SLisandro Dalcin 
2726277b19d0SLisandro Dalcin    Level: beginner
2727277b19d0SLisandro Dalcin 
2728277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2729277b19d0SLisandro Dalcin 
2730277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2731277b19d0SLisandro Dalcin @*/
2732277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2733277b19d0SLisandro Dalcin {
2734277b19d0SLisandro Dalcin   PetscErrorCode ierr;
2735277b19d0SLisandro Dalcin 
2736277b19d0SLisandro Dalcin   PetscFunctionBegin;
2737277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2738b18ea86cSHong Zhang 
2739277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2740277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2741277b19d0SLisandro Dalcin   }
2742277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2743e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2744bbd56ea5SKarl Rupp 
27454e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
27464e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2747214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
27486bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2749efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
2750e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2751e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
275238637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2753bbd56ea5SKarl Rupp 
2754d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2755d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2756715f1b00SHong Zhang 
2757ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
27582c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
275936eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2760715f1b00SHong Zhang 
2761022c081aSHong Zhang   ierr = PetscFree(ts->vecs_fwdsensipacked);CHKERRQ(ierr);
2762022c081aSHong Zhang 
2763277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2764d763cef2SBarry Smith   PetscFunctionReturn(0);
2765d763cef2SBarry Smith }
2766d763cef2SBarry Smith 
2767d8e5e3e6SSatish Balay /*@
2768d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2769d763cef2SBarry Smith    with TSCreate().
2770d763cef2SBarry Smith 
2771d763cef2SBarry Smith    Collective on TS
2772d763cef2SBarry Smith 
2773d763cef2SBarry Smith    Input Parameter:
2774d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2775d763cef2SBarry Smith 
2776d763cef2SBarry Smith    Level: beginner
2777d763cef2SBarry Smith 
2778d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2779d763cef2SBarry Smith 
2780d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2781d763cef2SBarry Smith @*/
27826bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2783d763cef2SBarry Smith {
27846849ba73SBarry Smith   PetscErrorCode ierr;
2785d763cef2SBarry Smith 
2786d763cef2SBarry Smith   PetscFunctionBegin;
27876bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
27886bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
27896bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2790d763cef2SBarry Smith 
27916bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2792277b19d0SLisandro Dalcin 
2793e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2794e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
27956bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
27966d4c513bSLisandro Dalcin 
2797bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2798bc952696SBarry Smith 
279984df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
28006427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
28016427ac75SLisandro Dalcin 
28026bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
28036bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
28046bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
28050dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
28066d4c513bSLisandro Dalcin 
2807a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2808d763cef2SBarry Smith   PetscFunctionReturn(0);
2809d763cef2SBarry Smith }
2810d763cef2SBarry Smith 
2811d8e5e3e6SSatish Balay /*@
2812d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2813d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2814d763cef2SBarry Smith 
2815d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2816d763cef2SBarry Smith 
2817d763cef2SBarry Smith    Input Parameter:
2818d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2819d763cef2SBarry Smith 
2820d763cef2SBarry Smith    Output Parameter:
2821d763cef2SBarry Smith .  snes - the nonlinear solver context
2822d763cef2SBarry Smith 
2823d763cef2SBarry Smith    Notes:
2824d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2825d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
282694b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2827d763cef2SBarry Smith 
2828d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
28290298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2830d763cef2SBarry Smith 
2831d763cef2SBarry Smith    Level: beginner
2832d763cef2SBarry Smith 
2833d763cef2SBarry Smith .keywords: timestep, get, SNES
2834d763cef2SBarry Smith @*/
28357087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2836d763cef2SBarry Smith {
2837d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2838d372ba47SLisandro Dalcin 
2839d763cef2SBarry Smith   PetscFunctionBegin;
28400700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28414482741eSBarry Smith   PetscValidPointer(snes,2);
2842d372ba47SLisandro Dalcin   if (!ts->snes) {
2843ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
28440298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
28453bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2846d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2847496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
28489e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
28499e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
28509e2a6581SJed Brown     }
2851d372ba47SLisandro Dalcin   }
2852d763cef2SBarry Smith   *snes = ts->snes;
2853d763cef2SBarry Smith   PetscFunctionReturn(0);
2854d763cef2SBarry Smith }
2855d763cef2SBarry Smith 
2856deb2cd25SJed Brown /*@
2857deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2858deb2cd25SJed Brown 
2859deb2cd25SJed Brown    Collective
2860deb2cd25SJed Brown 
2861deb2cd25SJed Brown    Input Parameter:
2862deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2863deb2cd25SJed Brown -  snes - the nonlinear solver context
2864deb2cd25SJed Brown 
2865deb2cd25SJed Brown    Notes:
2866deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2867deb2cd25SJed Brown 
2868deb2cd25SJed Brown    Level: developer
2869deb2cd25SJed Brown 
2870deb2cd25SJed Brown .keywords: timestep, set, SNES
2871deb2cd25SJed Brown @*/
2872deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2873deb2cd25SJed Brown {
2874deb2cd25SJed Brown   PetscErrorCode ierr;
2875d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2876deb2cd25SJed Brown 
2877deb2cd25SJed Brown   PetscFunctionBegin;
2878deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2879deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2880deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2881deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2882bbd56ea5SKarl Rupp 
2883deb2cd25SJed Brown   ts->snes = snes;
2884bbd56ea5SKarl Rupp 
28850298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
28860298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2887740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
28880298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2889740132f1SEmil Constantinescu   }
2890deb2cd25SJed Brown   PetscFunctionReturn(0);
2891deb2cd25SJed Brown }
2892deb2cd25SJed Brown 
2893d8e5e3e6SSatish Balay /*@
289494b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2895d763cef2SBarry Smith    a TS (timestepper) context.
2896d763cef2SBarry Smith 
289794b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2898d763cef2SBarry Smith 
2899d763cef2SBarry Smith    Input Parameter:
2900d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2901d763cef2SBarry Smith 
2902d763cef2SBarry Smith    Output Parameter:
290394b7f48cSBarry Smith .  ksp - the nonlinear solver context
2904d763cef2SBarry Smith 
2905d763cef2SBarry Smith    Notes:
290694b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2907d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2908d763cef2SBarry Smith    KSP and PC contexts as well.
2909d763cef2SBarry Smith 
291094b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
29110298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2912d763cef2SBarry Smith 
2913d763cef2SBarry Smith    Level: beginner
2914d763cef2SBarry Smith 
291594b7f48cSBarry Smith .keywords: timestep, get, KSP
2916d763cef2SBarry Smith @*/
29177087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2918d763cef2SBarry Smith {
2919d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2920089b2837SJed Brown   SNES           snes;
2921d372ba47SLisandro Dalcin 
2922d763cef2SBarry Smith   PetscFunctionBegin;
29230700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29244482741eSBarry Smith   PetscValidPointer(ksp,2);
292517186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2926e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2927089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2928089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2929d763cef2SBarry Smith   PetscFunctionReturn(0);
2930d763cef2SBarry Smith }
2931d763cef2SBarry Smith 
2932d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2933d763cef2SBarry Smith 
2934adb62b0dSMatthew Knepley /*@
2935618ce8baSLisandro Dalcin    TSSetMaxSteps - Sets the maximum number of steps to use.
2936618ce8baSLisandro Dalcin 
2937618ce8baSLisandro Dalcin    Logically Collective on TS
2938618ce8baSLisandro Dalcin 
2939618ce8baSLisandro Dalcin    Input Parameters:
2940618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2941618ce8baSLisandro Dalcin -  maxsteps - maximum number of steps to use
2942618ce8baSLisandro Dalcin 
2943618ce8baSLisandro Dalcin    Options Database Keys:
2944618ce8baSLisandro Dalcin .  -ts_max_steps <maxsteps> - Sets maxsteps
2945618ce8baSLisandro Dalcin 
2946618ce8baSLisandro Dalcin    Notes:
2947618ce8baSLisandro Dalcin    The default maximum number of steps is 5000
2948618ce8baSLisandro Dalcin 
2949618ce8baSLisandro Dalcin    Level: intermediate
2950618ce8baSLisandro Dalcin 
2951618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, steps
2952618ce8baSLisandro Dalcin 
2953618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime()
2954618ce8baSLisandro Dalcin @*/
2955618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps)
2956618ce8baSLisandro Dalcin {
2957618ce8baSLisandro Dalcin   PetscFunctionBegin;
2958618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2959618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2960618ce8baSLisandro Dalcin   if (maxsteps < 0 ) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative");
2961618ce8baSLisandro Dalcin   ts->max_steps = maxsteps;
2962618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2963618ce8baSLisandro Dalcin }
2964618ce8baSLisandro Dalcin 
2965618ce8baSLisandro Dalcin /*@
2966618ce8baSLisandro Dalcin    TSGetMaxSteps - Gets the maximum number of steps to use.
2967618ce8baSLisandro Dalcin 
2968618ce8baSLisandro Dalcin    Not Collective
2969618ce8baSLisandro Dalcin 
2970618ce8baSLisandro Dalcin    Input Parameters:
2971618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2972618ce8baSLisandro Dalcin 
2973618ce8baSLisandro Dalcin    Output Parameter:
2974618ce8baSLisandro Dalcin .  maxsteps - maximum number of steps to use
2975618ce8baSLisandro Dalcin 
2976618ce8baSLisandro Dalcin    Level: advanced
2977618ce8baSLisandro Dalcin 
2978618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, steps
2979618ce8baSLisandro Dalcin 
2980618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime()
2981618ce8baSLisandro Dalcin @*/
2982618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps)
2983618ce8baSLisandro Dalcin {
2984618ce8baSLisandro Dalcin   PetscFunctionBegin;
2985618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2986618ce8baSLisandro Dalcin   PetscValidIntPointer(maxsteps,2);
2987618ce8baSLisandro Dalcin   *maxsteps = ts->max_steps;
2988618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2989618ce8baSLisandro Dalcin }
2990618ce8baSLisandro Dalcin 
2991618ce8baSLisandro Dalcin /*@
2992618ce8baSLisandro Dalcin    TSSetMaxTime - Sets the maximum (or final) time for timestepping.
2993618ce8baSLisandro Dalcin 
2994618ce8baSLisandro Dalcin    Logically Collective on TS
2995618ce8baSLisandro Dalcin 
2996618ce8baSLisandro Dalcin    Input Parameters:
2997618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2998618ce8baSLisandro Dalcin -  maxtime - final time to step to
2999618ce8baSLisandro Dalcin 
3000618ce8baSLisandro Dalcin    Options Database Keys:
3001ef85077eSLisandro Dalcin .  -ts_max_time <maxtime> - Sets maxtime
3002618ce8baSLisandro Dalcin 
3003618ce8baSLisandro Dalcin    Notes:
3004618ce8baSLisandro Dalcin    The default maximum time is 5.0
3005618ce8baSLisandro Dalcin 
3006618ce8baSLisandro Dalcin    Level: intermediate
3007618ce8baSLisandro Dalcin 
3008618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, time
3009618ce8baSLisandro Dalcin 
3010618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime()
3011618ce8baSLisandro Dalcin @*/
3012618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime)
3013618ce8baSLisandro Dalcin {
3014618ce8baSLisandro Dalcin   PetscFunctionBegin;
3015618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3016618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveReal(ts,maxtime,2);
3017618ce8baSLisandro Dalcin   ts->max_time = maxtime;
3018618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3019618ce8baSLisandro Dalcin }
3020618ce8baSLisandro Dalcin 
3021618ce8baSLisandro Dalcin /*@
3022618ce8baSLisandro Dalcin    TSGetMaxTime - Gets the maximum (or final) time for timestepping.
3023618ce8baSLisandro Dalcin 
3024618ce8baSLisandro Dalcin    Not Collective
3025618ce8baSLisandro Dalcin 
3026618ce8baSLisandro Dalcin    Input Parameters:
3027618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
3028618ce8baSLisandro Dalcin 
3029618ce8baSLisandro Dalcin    Output Parameter:
3030618ce8baSLisandro Dalcin .  maxtime - final time to step to
3031618ce8baSLisandro Dalcin 
3032618ce8baSLisandro Dalcin    Level: advanced
3033618ce8baSLisandro Dalcin 
3034618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, time
3035618ce8baSLisandro Dalcin 
3036618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps()
3037618ce8baSLisandro Dalcin @*/
3038618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime)
3039618ce8baSLisandro Dalcin {
3040618ce8baSLisandro Dalcin   PetscFunctionBegin;
3041618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3042618ce8baSLisandro Dalcin   PetscValidRealPointer(maxtime,2);
3043618ce8baSLisandro Dalcin   *maxtime = ts->max_time;
3044618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3045618ce8baSLisandro Dalcin }
3046618ce8baSLisandro Dalcin 
3047618ce8baSLisandro Dalcin /*@
3048aaa6c58dSLisandro Dalcin    TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep().
3049edc382c3SSatish Balay 
3050edc382c3SSatish Balay    Level: deprecated
3051edc382c3SSatish Balay 
3052aaa6c58dSLisandro Dalcin @*/
3053aaa6c58dSLisandro Dalcin PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
3054aaa6c58dSLisandro Dalcin {
3055aaa6c58dSLisandro Dalcin   PetscErrorCode ierr;
3056aaa6c58dSLisandro Dalcin   PetscFunctionBegin;
3057aaa6c58dSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3058aaa6c58dSLisandro Dalcin   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
3059aaa6c58dSLisandro Dalcin   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
3060aaa6c58dSLisandro Dalcin   PetscFunctionReturn(0);
3061aaa6c58dSLisandro Dalcin }
3062aaa6c58dSLisandro Dalcin 
3063aaa6c58dSLisandro Dalcin /*@
306419eac22cSLisandro Dalcin    TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime().
3065edc382c3SSatish Balay 
3066edc382c3SSatish Balay    Level: deprecated
3067edc382c3SSatish Balay 
3068adb62b0dSMatthew Knepley @*/
30697087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
3070adb62b0dSMatthew Knepley {
3071adb62b0dSMatthew Knepley   PetscFunctionBegin;
30720700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3073abc0a331SBarry Smith   if (maxsteps) {
30744482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
3075adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
3076adb62b0dSMatthew Knepley   }
3077abc0a331SBarry Smith   if (maxtime) {
30784482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
3079adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
3080adb62b0dSMatthew Knepley   }
3081adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
3082adb62b0dSMatthew Knepley }
3083adb62b0dSMatthew Knepley 
3084d763cef2SBarry Smith /*@
308519eac22cSLisandro Dalcin    TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime().
3086edc382c3SSatish Balay 
3087edc382c3SSatish Balay    Level: deprecated
3088edc382c3SSatish Balay 
3089d763cef2SBarry Smith @*/
30907087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
3091d763cef2SBarry Smith {
3092d763cef2SBarry Smith   PetscFunctionBegin;
30930700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3094c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
3095c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
309639b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
309739b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
3098d763cef2SBarry Smith   PetscFunctionReturn(0);
3099d763cef2SBarry Smith }
3100d763cef2SBarry Smith 
3101d763cef2SBarry Smith /*@
31025c5f5948SLisandro Dalcin    TSGetTimeStepNumber - Deprecated, use TSGetStepNumber().
3103edc382c3SSatish Balay 
3104edc382c3SSatish Balay    Level: deprecated
3105edc382c3SSatish Balay 
31065c5f5948SLisandro Dalcin @*/
3107e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31085c5f5948SLisandro Dalcin 
310919eac22cSLisandro Dalcin /*@
31104f4e0956SLisandro Dalcin    TSGetTotalSteps - Deprecated, use TSGetStepNumber().
3111edc382c3SSatish Balay 
3112edc382c3SSatish Balay    Level: deprecated
3113edc382c3SSatish Balay 
31144f4e0956SLisandro Dalcin @*/
31154f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31164f4e0956SLisandro Dalcin 
31174f4e0956SLisandro Dalcin /*@
3118d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
3119d763cef2SBarry Smith    for use by the TS routines.
3120d763cef2SBarry Smith 
31213f9fe445SBarry Smith    Logically Collective on TS and Vec
3122d763cef2SBarry Smith 
3123d763cef2SBarry Smith    Input Parameters:
3124d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
31250910c330SBarry Smith -  u - the solution vector
3126d763cef2SBarry Smith 
3127d763cef2SBarry Smith    Level: beginner
3128d763cef2SBarry Smith 
3129715f1b00SHong Zhang .keywords: TS, timestep, set, solution, initial values
31300ed3bfb6SBarry Smith 
31310ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate()
3132d763cef2SBarry Smith @*/
31330910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
3134d763cef2SBarry Smith {
31358737fe31SLisandro Dalcin   PetscErrorCode ierr;
3136496e6a7aSJed Brown   DM             dm;
31378737fe31SLisandro Dalcin 
3138d763cef2SBarry Smith   PetscFunctionBegin;
31390700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31400910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
31410910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
31426bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
31430910c330SBarry Smith   ts->vec_sol = u;
3144bbd56ea5SKarl Rupp 
3145496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
31460910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
3147d763cef2SBarry Smith   PetscFunctionReturn(0);
3148d763cef2SBarry Smith }
3149d763cef2SBarry Smith 
315073b18844SBarry Smith /*@
315173b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
315273b18844SBarry Smith 
315373b18844SBarry Smith    Logically Collective on TS
315473b18844SBarry Smith 
315573b18844SBarry Smith    Input Parameters:
315673b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
315773b18844SBarry Smith .  steps - number of steps to use
315873b18844SBarry Smith 
315973b18844SBarry Smith    Level: intermediate
316073b18844SBarry Smith 
316173b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
316273b18844SBarry Smith           so as to integrate back to less than the original timestep
316373b18844SBarry Smith 
316473b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
316573b18844SBarry Smith 
316673b18844SBarry Smith .seealso: TSSetExactFinalTime()
316773b18844SBarry Smith @*/
316873b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
316973b18844SBarry Smith {
317073b18844SBarry Smith   PetscFunctionBegin;
317173b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
317273b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
317373b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
31742808aa04SLisandro Dalcin   if (steps > ts->steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps");
317573b18844SBarry Smith   ts->adjoint_max_steps = steps;
317673b18844SBarry Smith   PetscFunctionReturn(0);
317773b18844SBarry Smith }
317873b18844SBarry Smith 
3179c235aa8dSHong Zhang /*@
3180715f1b00SHong 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
31810cf82b59SBarry Smith       for use by the TSAdjoint routines.
3182c235aa8dSHong Zhang 
3183c235aa8dSHong Zhang    Logically Collective on TS and Vec
3184c235aa8dSHong Zhang 
3185c235aa8dSHong Zhang    Input Parameters:
3186c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
3187abc2977eSBarry 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
3188abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
3189c235aa8dSHong Zhang 
3190c235aa8dSHong Zhang    Level: beginner
3191c235aa8dSHong Zhang 
3192abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
31930cf82b59SBarry Smith 
31941585b412SBarry Smith    After TSAdjointSolve() is called the lamba and the mu contain the computed sensitivities
31951585b412SBarry Smith 
3196715f1b00SHong Zhang .keywords: TS, timestep, set, sensitivity, initial values
3197c235aa8dSHong Zhang @*/
3198dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
3199c235aa8dSHong Zhang {
3200c235aa8dSHong Zhang   PetscFunctionBegin;
3201c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3202abc2977eSBarry Smith   PetscValidPointer(lambda,2);
3203abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
3204abc2977eSBarry Smith   ts->vecs_sensip = mu;
3205dfb21088SHong 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");
3206abc2977eSBarry Smith   ts->numcost  = numcost;
3207ad8e2604SHong Zhang   PetscFunctionReturn(0);
3208ad8e2604SHong Zhang }
3209ad8e2604SHong Zhang 
3210ad8e2604SHong Zhang /*@C
32110cf82b59SBarry 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.
3212ad8e2604SHong Zhang 
3213ad8e2604SHong Zhang   Logically Collective on TS
3214ad8e2604SHong Zhang 
3215ad8e2604SHong Zhang   Input Parameters:
3216ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
3217ad8e2604SHong Zhang - func - The function
3218ad8e2604SHong Zhang 
3219ad8e2604SHong Zhang   Calling sequence of func:
32200cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
322105755b9cSHong Zhang +   t - current timestep
32220cf82b59SBarry Smith .   y - input vector (current ODE solution)
322305755b9cSHong Zhang .   A - output matrix
322405755b9cSHong Zhang -   ctx - [optional] user-defined function context
3225ad8e2604SHong Zhang 
3226ad8e2604SHong Zhang   Level: intermediate
3227ad8e2604SHong Zhang 
32280cf82b59SBarry 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
32290cf82b59SBarry Smith 
3230ad8e2604SHong Zhang .keywords: TS, sensitivity
3231ad8e2604SHong Zhang .seealso:
3232ad8e2604SHong Zhang @*/
32335bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
3234ad8e2604SHong Zhang {
3235ad8e2604SHong Zhang   PetscErrorCode ierr;
3236ad8e2604SHong Zhang 
3237ad8e2604SHong Zhang   PetscFunctionBegin;
3238ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
323923706b9aSHong Zhang   PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
3240ad8e2604SHong Zhang 
3241ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
3242ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
3243ad8e2604SHong Zhang   if(Amat) {
3244ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
3245ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
3246ad8e2604SHong Zhang     ts->Jacp = Amat;
3247ad8e2604SHong Zhang   }
3248ad8e2604SHong Zhang   PetscFunctionReturn(0);
3249ad8e2604SHong Zhang }
3250ad8e2604SHong Zhang 
32510cf82b59SBarry Smith /*@C
32525bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
3253ad8e2604SHong Zhang 
3254ad8e2604SHong Zhang   Collective on TS
3255ad8e2604SHong Zhang 
3256ad8e2604SHong Zhang   Input Parameters:
3257ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
3258ad8e2604SHong Zhang 
3259ad8e2604SHong Zhang   Level: developer
3260ad8e2604SHong Zhang 
3261ad8e2604SHong Zhang .keywords: TS, sensitivity
32625bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
3263ad8e2604SHong Zhang @*/
32645bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
3265ad8e2604SHong Zhang {
3266ad8e2604SHong Zhang   PetscErrorCode ierr;
3267ad8e2604SHong Zhang 
3268ad8e2604SHong Zhang   PetscFunctionBegin;
3269ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3270ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
3271ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
3272ad8e2604SHong Zhang 
3273ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
3274ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
3275ad8e2604SHong Zhang   PetscStackPop;
3276c235aa8dSHong Zhang   PetscFunctionReturn(0);
3277c235aa8dSHong Zhang }
3278c235aa8dSHong Zhang 
32796fd0887fSHong Zhang /*@C
3280dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
32816fd0887fSHong Zhang 
32826fd0887fSHong Zhang     Logically Collective on TS
32836fd0887fSHong Zhang 
32846fd0887fSHong Zhang     Input Parameters:
32856fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
3286abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
32873d1d12c6SHong Zhang .   costintegral - vector that stores the integral values
32880cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
3289b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
3290b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
3291feaa1ddbSSatish Balay .   fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run
3292b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
32936fd0887fSHong Zhang 
32940cf82b59SBarry Smith     Calling sequence of rf:
32953d1d12c6SHong Zhang $   PetscErrorCode rf(TS ts,PetscReal t,Vec y,Vec f,void *ctx);
32966fd0887fSHong Zhang 
3297b612ec54SBarry Smith     Calling sequence of drdyf:
32980cf82b59SBarry Smith $   PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
3299b612ec54SBarry Smith 
3300b612ec54SBarry Smith     Calling sequence of drdpf:
33010cf82b59SBarry Smith $   PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
3302b612ec54SBarry Smith 
3303b612ec54SBarry Smith     Level: intermediate
33046fd0887fSHong Zhang 
3305715f1b00SHong Zhang     Notes: For optimization there is usually a single cost function (numcost = 1). For sensitivities there may be multiple cost functions
33060cf82b59SBarry Smith 
33076fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
33086fd0887fSHong Zhang 
3309dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
33106fd0887fSHong Zhang @*/
33113d1d12c6SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost,Vec costintegral,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
3312d8151eeaSBarry Smith                                                           PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
3313b1cb36f3SHong Zhang                                                           PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),
3314b1cb36f3SHong Zhang                                                           PetscBool fwd,void *ctx)
33156fd0887fSHong Zhang {
33166fd0887fSHong Zhang   PetscErrorCode ierr;
33176fd0887fSHong Zhang 
33186fd0887fSHong Zhang   PetscFunctionBegin;
33196fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33203d1d12c6SHong Zhang   if (costintegral) PetscValidHeaderSpecific(costintegral,VEC_CLASSID,3);
3321715f1b00SHong 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()");
3322c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
33236fd0887fSHong Zhang 
33243d1d12c6SHong Zhang   if (costintegral) {
33253d1d12c6SHong Zhang     ierr = PetscObjectReference((PetscObject)costintegral);CHKERRQ(ierr);
33263d1d12c6SHong Zhang     ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
33273d1d12c6SHong Zhang     ts->vec_costintegral = costintegral;
3328afe7b317SHong Zhang   } else {
3329afe7b317SHong Zhang     if (!ts->vec_costintegral) { /* Create a seq vec if user does not provide one */
3330afe7b317SHong Zhang       ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
3331afe7b317SHong Zhang     } else {
3332afe7b317SHong Zhang       ierr = VecSet(ts->vec_costintegral,0.0);CHKERRQ(ierr);
3333afe7b317SHong Zhang     }
3334afe7b317SHong Zhang   }
3335afe7b317SHong Zhang   if (!ts->vec_costintegrand) {
33362c39e106SBarry Smith     ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
3337afe7b317SHong Zhang   } else {
3338afe7b317SHong Zhang     ierr = VecSet(ts->vec_costintegrand,0.0);CHKERRQ(ierr);
3339afe7b317SHong Zhang   }
3340afe7b317SHong Zhang   ts->costintegralfwd  = fwd; /* Evaluate the cost integral in forward run if fwd is true */
33410cf82b59SBarry Smith   ts->costintegrand    = rf;
334205755b9cSHong Zhang   ts->costintegrandctx = ctx;
3343b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
3344b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
33456fd0887fSHong Zhang   PetscFunctionReturn(0);
33466fd0887fSHong Zhang }
33476fd0887fSHong Zhang 
334836eaed60SHong Zhang /*@
3349dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
335036eaed60SHong Zhang    It is valid to call the routine after a backward run.
335136eaed60SHong Zhang 
335236eaed60SHong Zhang    Not Collective
335336eaed60SHong Zhang 
335436eaed60SHong Zhang    Input Parameter:
335536eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
335636eaed60SHong Zhang 
335736eaed60SHong Zhang    Output Parameter:
33582c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
335936eaed60SHong Zhang 
336036eaed60SHong Zhang    Level: intermediate
336136eaed60SHong Zhang 
3362dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
336336eaed60SHong Zhang 
336436eaed60SHong Zhang .keywords: TS, sensitivity analysis
336536eaed60SHong Zhang @*/
3366dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
336736eaed60SHong Zhang {
336836eaed60SHong Zhang   PetscFunctionBegin;
336936eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
337036eaed60SHong Zhang   PetscValidPointer(v,2);
33712c39e106SBarry Smith   *v = ts->vec_costintegral;
337236eaed60SHong Zhang   PetscFunctionReturn(0);
337336eaed60SHong Zhang }
337436eaed60SHong Zhang 
33756fd0887fSHong Zhang /*@
3376022c081aSHong Zhang    TSComputeCostIntegrand - Evaluates the integral function in the cost functions.
33776fd0887fSHong Zhang 
33786fd0887fSHong Zhang    Input Parameters:
33796fd0887fSHong Zhang +  ts - the TS context
33806fd0887fSHong Zhang .  t - current time
33810cf82b59SBarry Smith -  y - state vector, i.e. current solution
33826fd0887fSHong Zhang 
33836fd0887fSHong Zhang    Output Parameter:
3384abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
33856fd0887fSHong Zhang 
33866fd0887fSHong Zhang    Note:
33876fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
33886fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
33896fd0887fSHong Zhang 
33906fd0887fSHong Zhang    Level: developer
33916fd0887fSHong Zhang 
33926fd0887fSHong Zhang .keywords: TS, compute
33936fd0887fSHong Zhang 
3394dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
33956fd0887fSHong Zhang @*/
3396022c081aSHong Zhang PetscErrorCode TSComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
33976fd0887fSHong Zhang {
33986fd0887fSHong Zhang   PetscErrorCode ierr;
33996fd0887fSHong Zhang 
34006fd0887fSHong Zhang   PetscFunctionBegin;
34016fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34020cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
34036fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
34046fd0887fSHong Zhang 
34050cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
3406e4680132SHong Zhang   if (ts->costintegrand) {
3407e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
34080cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
34096fd0887fSHong Zhang     PetscStackPop;
34106fd0887fSHong Zhang   } else {
34116fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
34126fd0887fSHong Zhang   }
34136fd0887fSHong Zhang 
34140cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
34156fd0887fSHong Zhang   PetscFunctionReturn(0);
34166fd0887fSHong Zhang }
34176fd0887fSHong Zhang 
341805755b9cSHong Zhang /*@
3419d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
342005755b9cSHong Zhang 
342105755b9cSHong Zhang   Collective on TS
342205755b9cSHong Zhang 
342305755b9cSHong Zhang   Input Parameters:
342405755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
342505755b9cSHong Zhang 
342605755b9cSHong Zhang   Notes:
3427d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
342805755b9cSHong Zhang   so most users would not generally call this routine themselves.
342905755b9cSHong Zhang 
343005755b9cSHong Zhang   Level: developer
343105755b9cSHong Zhang 
343205755b9cSHong Zhang .keywords: TS, sensitivity
3433d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
343405755b9cSHong Zhang @*/
34350cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
343605755b9cSHong Zhang {
343705755b9cSHong Zhang   PetscErrorCode ierr;
343805755b9cSHong Zhang 
343905755b9cSHong Zhang   PetscFunctionBegin;
344005755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34410cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
344205755b9cSHong Zhang 
344305755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
34440cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
344505755b9cSHong Zhang   PetscStackPop;
344605755b9cSHong Zhang   PetscFunctionReturn(0);
344705755b9cSHong Zhang }
344805755b9cSHong Zhang 
344905755b9cSHong Zhang /*@
3450d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
345105755b9cSHong Zhang 
345205755b9cSHong Zhang   Collective on TS
345305755b9cSHong Zhang 
345405755b9cSHong Zhang   Input Parameters:
345505755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
345605755b9cSHong Zhang 
345705755b9cSHong Zhang   Notes:
345805755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
345905755b9cSHong Zhang   so most users would not generally call this routine themselves.
346005755b9cSHong Zhang 
346105755b9cSHong Zhang   Level: developer
346205755b9cSHong Zhang 
346305755b9cSHong Zhang .keywords: TS, sensitivity
3464d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
346505755b9cSHong Zhang @*/
34660cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
346705755b9cSHong Zhang {
346805755b9cSHong Zhang   PetscErrorCode ierr;
346905755b9cSHong Zhang 
347005755b9cSHong Zhang   PetscFunctionBegin;
347105755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34720cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
347305755b9cSHong Zhang 
347405755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
34750cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
347605755b9cSHong Zhang   PetscStackPop;
347705755b9cSHong Zhang   PetscFunctionReturn(0);
347805755b9cSHong Zhang }
347905755b9cSHong Zhang 
3480ac226902SBarry Smith /*@C
3481000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
34823f2090d5SJed Brown   called once at the beginning of each time step.
3483000e7ae3SMatthew Knepley 
34843f9fe445SBarry Smith   Logically Collective on TS
3485000e7ae3SMatthew Knepley 
3486000e7ae3SMatthew Knepley   Input Parameters:
3487000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3488000e7ae3SMatthew Knepley - func - The function
3489000e7ae3SMatthew Knepley 
3490000e7ae3SMatthew Knepley   Calling sequence of func:
3491000e7ae3SMatthew Knepley . func (TS ts);
3492000e7ae3SMatthew Knepley 
3493000e7ae3SMatthew Knepley   Level: intermediate
3494000e7ae3SMatthew Knepley 
3495000e7ae3SMatthew Knepley .keywords: TS, timestep
3496dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep()
3497000e7ae3SMatthew Knepley @*/
34987087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3499000e7ae3SMatthew Knepley {
3500000e7ae3SMatthew Knepley   PetscFunctionBegin;
35010700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3502ae60f76fSBarry Smith   ts->prestep = func;
3503000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3504000e7ae3SMatthew Knepley }
3505000e7ae3SMatthew Knepley 
350609ee8438SJed Brown /*@
35073f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
35083f2090d5SJed Brown 
35093f2090d5SJed Brown   Collective on TS
35103f2090d5SJed Brown 
35113f2090d5SJed Brown   Input Parameters:
35123f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
35133f2090d5SJed Brown 
35143f2090d5SJed Brown   Notes:
35153f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
35163f2090d5SJed Brown   so most users would not generally call this routine themselves.
35173f2090d5SJed Brown 
35183f2090d5SJed Brown   Level: developer
35193f2090d5SJed Brown 
35203f2090d5SJed Brown .keywords: TS, timestep
35219be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
35223f2090d5SJed Brown @*/
35237087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
35243f2090d5SJed Brown {
35253f2090d5SJed Brown   PetscErrorCode ierr;
35263f2090d5SJed Brown 
35273f2090d5SJed Brown   PetscFunctionBegin;
35280700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3529ae60f76fSBarry Smith   if (ts->prestep) {
35305efd42a4SStefano Zampini     Vec              U;
35315efd42a4SStefano Zampini     PetscObjectState sprev,spost;
35325efd42a4SStefano Zampini 
35335efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
35345efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3535ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
35365efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3537dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3538312ce896SJed Brown   }
35393f2090d5SJed Brown   PetscFunctionReturn(0);
35403f2090d5SJed Brown }
35413f2090d5SJed Brown 
3542b8123daeSJed Brown /*@C
3543b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3544b8123daeSJed Brown   called once at the beginning of each stage.
3545b8123daeSJed Brown 
3546b8123daeSJed Brown   Logically Collective on TS
3547b8123daeSJed Brown 
3548b8123daeSJed Brown   Input Parameters:
3549b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3550b8123daeSJed Brown - func - The function
3551b8123daeSJed Brown 
3552b8123daeSJed Brown   Calling sequence of func:
3553b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
3554b8123daeSJed Brown 
3555b8123daeSJed Brown   Level: intermediate
3556b8123daeSJed Brown 
3557b8123daeSJed Brown   Note:
3558b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
355980275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
3560b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3561b8123daeSJed Brown 
3562b8123daeSJed Brown .keywords: TS, timestep
35639be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3564b8123daeSJed Brown @*/
3565b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3566b8123daeSJed Brown {
3567b8123daeSJed Brown   PetscFunctionBegin;
3568b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3569ae60f76fSBarry Smith   ts->prestage = func;
3570b8123daeSJed Brown   PetscFunctionReturn(0);
3571b8123daeSJed Brown }
3572b8123daeSJed Brown 
35739be3e283SDebojyoti Ghosh /*@C
35749be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
35759be3e283SDebojyoti Ghosh   called once at the end of each stage.
35769be3e283SDebojyoti Ghosh 
35779be3e283SDebojyoti Ghosh   Logically Collective on TS
35789be3e283SDebojyoti Ghosh 
35799be3e283SDebojyoti Ghosh   Input Parameters:
35809be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
35819be3e283SDebojyoti Ghosh - func - The function
35829be3e283SDebojyoti Ghosh 
35839be3e283SDebojyoti Ghosh   Calling sequence of func:
35849be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
35859be3e283SDebojyoti Ghosh 
35869be3e283SDebojyoti Ghosh   Level: intermediate
35879be3e283SDebojyoti Ghosh 
35889be3e283SDebojyoti Ghosh   Note:
35899be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
359080275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
35919be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
35929be3e283SDebojyoti Ghosh 
35939be3e283SDebojyoti Ghosh .keywords: TS, timestep
35949be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
35959be3e283SDebojyoti Ghosh @*/
35969be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
35979be3e283SDebojyoti Ghosh {
35989be3e283SDebojyoti Ghosh   PetscFunctionBegin;
35999be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
36009be3e283SDebojyoti Ghosh   ts->poststage = func;
36019be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
36029be3e283SDebojyoti Ghosh }
36039be3e283SDebojyoti Ghosh 
3604c688d042SShri Abhyankar /*@C
3605c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3606c688d042SShri Abhyankar   called once at the end of each step evaluation.
3607c688d042SShri Abhyankar 
3608c688d042SShri Abhyankar   Logically Collective on TS
3609c688d042SShri Abhyankar 
3610c688d042SShri Abhyankar   Input Parameters:
3611c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3612c688d042SShri Abhyankar - func - The function
3613c688d042SShri Abhyankar 
3614c688d042SShri Abhyankar   Calling sequence of func:
3615c688d042SShri Abhyankar . PetscErrorCode func(TS ts);
3616c688d042SShri Abhyankar 
3617c688d042SShri Abhyankar   Level: intermediate
3618c688d042SShri Abhyankar 
3619c688d042SShri Abhyankar   Note:
36201785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
36211785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3622e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3623e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3624e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3625c688d042SShri Abhyankar 
3626c688d042SShri Abhyankar .keywords: TS, timestep
3627c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3628c688d042SShri Abhyankar @*/
3629c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3630c688d042SShri Abhyankar {
3631c688d042SShri Abhyankar   PetscFunctionBegin;
3632c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3633c688d042SShri Abhyankar   ts->postevaluate = func;
3634c688d042SShri Abhyankar   PetscFunctionReturn(0);
3635c688d042SShri Abhyankar }
3636c688d042SShri Abhyankar 
3637b8123daeSJed Brown /*@
3638b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3639b8123daeSJed Brown 
3640b8123daeSJed Brown   Collective on TS
3641b8123daeSJed Brown 
3642b8123daeSJed Brown   Input Parameters:
3643b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
36449be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3645b8123daeSJed Brown 
3646b8123daeSJed Brown   Notes:
3647b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3648b8123daeSJed Brown   most users would not generally call this routine themselves.
3649b8123daeSJed Brown 
3650b8123daeSJed Brown   Level: developer
3651b8123daeSJed Brown 
3652b8123daeSJed Brown .keywords: TS, timestep
36539be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3654b8123daeSJed Brown @*/
3655b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3656b8123daeSJed Brown {
3657b8123daeSJed Brown   PetscErrorCode ierr;
3658b8123daeSJed Brown 
3659b8123daeSJed Brown   PetscFunctionBegin;
3660b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3661ae60f76fSBarry Smith   if (ts->prestage) {
3662ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3663b8123daeSJed Brown   }
3664b8123daeSJed Brown   PetscFunctionReturn(0);
3665b8123daeSJed Brown }
3666b8123daeSJed Brown 
36679be3e283SDebojyoti Ghosh /*@
36689be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
36699be3e283SDebojyoti Ghosh 
36709be3e283SDebojyoti Ghosh   Collective on TS
36719be3e283SDebojyoti Ghosh 
36729be3e283SDebojyoti Ghosh   Input Parameters:
36739be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
36749be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
36759be3e283SDebojyoti Ghosh   stageindex  - Stage number
36769be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
36779be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
36789be3e283SDebojyoti Ghosh 
36799be3e283SDebojyoti Ghosh   Notes:
36809be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
36819be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
36829be3e283SDebojyoti Ghosh 
36839be3e283SDebojyoti Ghosh   Level: developer
36849be3e283SDebojyoti Ghosh 
36859be3e283SDebojyoti Ghosh .keywords: TS, timestep
36869be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
36879be3e283SDebojyoti Ghosh @*/
36889be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
36899be3e283SDebojyoti Ghosh {
36909be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
36919be3e283SDebojyoti Ghosh 
36929be3e283SDebojyoti Ghosh   PetscFunctionBegin;
36939be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
36944beae5d8SLisandro Dalcin   if (ts->poststage) {
36959be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
36969be3e283SDebojyoti Ghosh   }
36979be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
36989be3e283SDebojyoti Ghosh }
36999be3e283SDebojyoti Ghosh 
3700c688d042SShri Abhyankar /*@
3701c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3702c688d042SShri Abhyankar 
3703c688d042SShri Abhyankar   Collective on TS
3704c688d042SShri Abhyankar 
3705c688d042SShri Abhyankar   Input Parameters:
3706c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3707c688d042SShri Abhyankar 
3708c688d042SShri Abhyankar   Notes:
3709c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3710c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3711c688d042SShri Abhyankar 
3712c688d042SShri Abhyankar   Level: developer
3713c688d042SShri Abhyankar 
3714c688d042SShri Abhyankar .keywords: TS, timestep
3715c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3716c688d042SShri Abhyankar @*/
3717c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3718c688d042SShri Abhyankar {
3719c688d042SShri Abhyankar   PetscErrorCode ierr;
3720c688d042SShri Abhyankar 
3721c688d042SShri Abhyankar   PetscFunctionBegin;
3722c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3723c688d042SShri Abhyankar   if (ts->postevaluate) {
3724dcb233daSLisandro Dalcin     Vec              U;
3725dcb233daSLisandro Dalcin     PetscObjectState sprev,spost;
3726dcb233daSLisandro Dalcin 
3727dcb233daSLisandro Dalcin     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
3728dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3729c688d042SShri Abhyankar     PetscStackCallStandard((*ts->postevaluate),(ts));
3730dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3731dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3732c688d042SShri Abhyankar   }
3733c688d042SShri Abhyankar   PetscFunctionReturn(0);
3734c688d042SShri Abhyankar }
3735c688d042SShri Abhyankar 
3736ac226902SBarry Smith /*@C
3737000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
37383f2090d5SJed Brown   called once at the end of each time step.
3739000e7ae3SMatthew Knepley 
37403f9fe445SBarry Smith   Logically Collective on TS
3741000e7ae3SMatthew Knepley 
3742000e7ae3SMatthew Knepley   Input Parameters:
3743000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3744000e7ae3SMatthew Knepley - func - The function
3745000e7ae3SMatthew Knepley 
3746000e7ae3SMatthew Knepley   Calling sequence of func:
3747b8123daeSJed Brown $ func (TS ts);
3748000e7ae3SMatthew Knepley 
37491785ff2aSShri Abhyankar   Notes:
37501785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
37511785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
37521785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
37531785ff2aSShri Abhyankar 
3754000e7ae3SMatthew Knepley   Level: intermediate
3755000e7ae3SMatthew Knepley 
3756000e7ae3SMatthew Knepley .keywords: TS, timestep
3757dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep()
3758000e7ae3SMatthew Knepley @*/
37597087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3760000e7ae3SMatthew Knepley {
3761000e7ae3SMatthew Knepley   PetscFunctionBegin;
37620700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3763ae60f76fSBarry Smith   ts->poststep = func;
3764000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3765000e7ae3SMatthew Knepley }
3766000e7ae3SMatthew Knepley 
376709ee8438SJed Brown /*@
37683f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
37693f2090d5SJed Brown 
37703f2090d5SJed Brown   Collective on TS
37713f2090d5SJed Brown 
37723f2090d5SJed Brown   Input Parameters:
37733f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
37743f2090d5SJed Brown 
37753f2090d5SJed Brown   Notes:
37763f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
37773f2090d5SJed Brown   so most users would not generally call this routine themselves.
37783f2090d5SJed Brown 
37793f2090d5SJed Brown   Level: developer
37803f2090d5SJed Brown 
37813f2090d5SJed Brown .keywords: TS, timestep
37823f2090d5SJed Brown @*/
37837087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
37843f2090d5SJed Brown {
37853f2090d5SJed Brown   PetscErrorCode ierr;
37863f2090d5SJed Brown 
37873f2090d5SJed Brown   PetscFunctionBegin;
37880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3789ae60f76fSBarry Smith   if (ts->poststep) {
37905efd42a4SStefano Zampini     Vec              U;
37915efd42a4SStefano Zampini     PetscObjectState sprev,spost;
37925efd42a4SStefano Zampini 
37935efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
37945efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3795ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
37965efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3797dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
379872ac3e02SJed Brown   }
37993f2090d5SJed Brown   PetscFunctionReturn(0);
38003f2090d5SJed Brown }
38013f2090d5SJed Brown 
3802d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3803d763cef2SBarry Smith 
3804d763cef2SBarry Smith /*@C
3805a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3806d763cef2SBarry Smith    timestep to display the iteration's  progress.
3807d763cef2SBarry Smith 
38083f9fe445SBarry Smith    Logically Collective on TS
3809d763cef2SBarry Smith 
3810d763cef2SBarry Smith    Input Parameters:
3811d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3812e213d8f1SJed Brown .  monitor - monitoring routine
3813329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
38140298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3815b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
38160298fd71SBarry Smith           (may be NULL)
3817d763cef2SBarry Smith 
3818e213d8f1SJed Brown    Calling sequence of monitor:
3819dcb233daSLisandro Dalcin $    PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3820d763cef2SBarry Smith 
3821d763cef2SBarry Smith +    ts - the TS context
382263e21af5SBarry 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)
38231f06c33eSBarry Smith .    time - current time
38240910c330SBarry Smith .    u - current iterate
3825d763cef2SBarry Smith -    mctx - [optional] monitoring context
3826d763cef2SBarry Smith 
3827d763cef2SBarry Smith    Notes:
3828d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3829d763cef2SBarry Smith    already has been loaded.
3830d763cef2SBarry Smith 
3831025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
3832025f1a04SBarry Smith 
3833d763cef2SBarry Smith    Level: intermediate
3834d763cef2SBarry Smith 
3835d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3836d763cef2SBarry Smith 
3837a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3838d763cef2SBarry Smith @*/
3839c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3840d763cef2SBarry Smith {
384178064530SBarry Smith   PetscErrorCode ierr;
384278064530SBarry Smith   PetscInt       i;
384378064530SBarry Smith   PetscBool      identical;
384478064530SBarry Smith 
3845d763cef2SBarry Smith   PetscFunctionBegin;
38460700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
384778064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
384878064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
384978064530SBarry Smith     if (identical) PetscFunctionReturn(0);
385078064530SBarry Smith   }
385117186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3852d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
38538704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3854d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3855d763cef2SBarry Smith   PetscFunctionReturn(0);
3856d763cef2SBarry Smith }
3857d763cef2SBarry Smith 
3858d763cef2SBarry Smith /*@C
3859a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3860d763cef2SBarry Smith 
38613f9fe445SBarry Smith    Logically Collective on TS
3862d763cef2SBarry Smith 
3863d763cef2SBarry Smith    Input Parameters:
3864d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3865d763cef2SBarry Smith 
3866d763cef2SBarry Smith    Notes:
3867d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3868d763cef2SBarry Smith 
3869d763cef2SBarry Smith    Level: intermediate
3870d763cef2SBarry Smith 
3871d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3872d763cef2SBarry Smith 
3873a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3874d763cef2SBarry Smith @*/
38757087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3876d763cef2SBarry Smith {
3877d952e501SBarry Smith   PetscErrorCode ierr;
3878d952e501SBarry Smith   PetscInt       i;
3879d952e501SBarry Smith 
3880d763cef2SBarry Smith   PetscFunctionBegin;
38810700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3882d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
38838704b422SBarry Smith     if (ts->monitordestroy[i]) {
38848704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3885d952e501SBarry Smith     }
3886d952e501SBarry Smith   }
3887d763cef2SBarry Smith   ts->numbermonitors = 0;
3888d763cef2SBarry Smith   PetscFunctionReturn(0);
3889d763cef2SBarry Smith }
3890d763cef2SBarry Smith 
3891721cd6eeSBarry Smith /*@C
3892721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
38935516499fSSatish Balay 
38945516499fSSatish Balay    Level: intermediate
389541251cbbSSatish Balay 
38965516499fSSatish Balay .keywords: TS, set, monitor
38975516499fSSatish Balay 
389863e21af5SBarry Smith .seealso:  TSMonitorSet()
389941251cbbSSatish Balay @*/
3900721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3901d763cef2SBarry Smith {
3902dfbe8321SBarry Smith   PetscErrorCode ierr;
3903721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
390441aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3905d132466eSBarry Smith 
3906d763cef2SBarry Smith   PetscFunctionBegin;
39074d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
390841aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
390941aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3910721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
391141aca3d6SBarry Smith   if (iascii) {
3912649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
391363e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
391463e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
391563e21af5SBarry Smith     } else {
39168392e04aSShri 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);
391763e21af5SBarry Smith     }
3918649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
391941aca3d6SBarry Smith   } else if (ibinary) {
392041aca3d6SBarry Smith     PetscMPIInt rank;
392141aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
392241aca3d6SBarry Smith     if (!rank) {
3923450a797fSBarry Smith       PetscBool skipHeader;
3924450a797fSBarry Smith       PetscInt  classid = REAL_FILE_CLASSID;
3925450a797fSBarry Smith 
3926450a797fSBarry Smith       ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr);
3927450a797fSBarry Smith       if (!skipHeader) {
3928450a797fSBarry Smith          ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
3929450a797fSBarry Smith        }
393041aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
393141aca3d6SBarry Smith     } else {
393241aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
393341aca3d6SBarry Smith     }
393441aca3d6SBarry Smith   }
3935721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3936d763cef2SBarry Smith   PetscFunctionReturn(0);
3937d763cef2SBarry Smith }
3938d763cef2SBarry Smith 
39399110b2e7SHong Zhang /*@C
39409110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
39419110b2e7SHong Zhang    timestep to display the iteration's  progress.
39429110b2e7SHong Zhang 
39439110b2e7SHong Zhang    Logically Collective on TS
39449110b2e7SHong Zhang 
39459110b2e7SHong Zhang    Input Parameters:
39469110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
39479110b2e7SHong Zhang .  adjointmonitor - monitoring routine
39489110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
39499110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
39509110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
39519110b2e7SHong Zhang           (may be NULL)
39529110b2e7SHong Zhang 
39539110b2e7SHong Zhang    Calling sequence of monitor:
39549110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
39559110b2e7SHong Zhang 
39569110b2e7SHong Zhang +    ts - the TS context
39579110b2e7SHong 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
39589110b2e7SHong Zhang                                been interpolated to)
39599110b2e7SHong Zhang .    time - current time
39609110b2e7SHong Zhang .    u - current iterate
39619110b2e7SHong Zhang .    numcost - number of cost functionos
39629110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
39639110b2e7SHong Zhang .    mu - sensitivities to parameters
39649110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
39659110b2e7SHong Zhang 
39669110b2e7SHong Zhang    Notes:
39679110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
39689110b2e7SHong Zhang    already has been loaded.
39699110b2e7SHong Zhang 
39709110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
39719110b2e7SHong Zhang 
39729110b2e7SHong Zhang    Level: intermediate
39739110b2e7SHong Zhang 
39749110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
39759110b2e7SHong Zhang 
39769110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
39779110b2e7SHong Zhang @*/
39789110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
39799110b2e7SHong Zhang {
398078064530SBarry Smith   PetscErrorCode ierr;
398178064530SBarry Smith   PetscInt       i;
398278064530SBarry Smith   PetscBool      identical;
398378064530SBarry Smith 
39849110b2e7SHong Zhang   PetscFunctionBegin;
39859110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
398678064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
398778064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr);
398878064530SBarry Smith     if (identical) PetscFunctionReturn(0);
398978064530SBarry Smith   }
39909110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
39919110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
39929110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
39939110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
39949110b2e7SHong Zhang   PetscFunctionReturn(0);
39959110b2e7SHong Zhang }
39969110b2e7SHong Zhang 
39979110b2e7SHong Zhang /*@C
39989110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
39999110b2e7SHong Zhang 
40009110b2e7SHong Zhang    Logically Collective on TS
40019110b2e7SHong Zhang 
40029110b2e7SHong Zhang    Input Parameters:
40039110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
40049110b2e7SHong Zhang 
40059110b2e7SHong Zhang    Notes:
40069110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
40079110b2e7SHong Zhang 
40089110b2e7SHong Zhang    Level: intermediate
40099110b2e7SHong Zhang 
40109110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
40119110b2e7SHong Zhang 
40129110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
40139110b2e7SHong Zhang @*/
40149110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
40159110b2e7SHong Zhang {
40169110b2e7SHong Zhang   PetscErrorCode ierr;
40179110b2e7SHong Zhang   PetscInt       i;
40189110b2e7SHong Zhang 
40199110b2e7SHong Zhang   PetscFunctionBegin;
40209110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
40219110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
40229110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
40239110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
40249110b2e7SHong Zhang     }
40259110b2e7SHong Zhang   }
40269110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
40279110b2e7SHong Zhang   PetscFunctionReturn(0);
40289110b2e7SHong Zhang }
40299110b2e7SHong Zhang 
4030721cd6eeSBarry Smith /*@C
4031721cd6eeSBarry Smith    TSAdjointMonitorDefault - the default monitor of adjoint computations
4032110eb670SHong Zhang 
4033110eb670SHong Zhang    Level: intermediate
4034110eb670SHong Zhang 
4035110eb670SHong Zhang .keywords: TS, set, monitor
4036110eb670SHong Zhang 
4037110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
4038110eb670SHong Zhang @*/
4039721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
4040110eb670SHong Zhang {
4041110eb670SHong Zhang   PetscErrorCode ierr;
4042721cd6eeSBarry Smith   PetscViewer    viewer = vf->viewer;
4043110eb670SHong Zhang 
4044110eb670SHong Zhang   PetscFunctionBegin;
4045110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
4046721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
4047110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
4048110eb670SHong 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);
4049110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
4050721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
4051110eb670SHong Zhang   PetscFunctionReturn(0);
4052110eb670SHong Zhang }
4053110eb670SHong Zhang 
4054cd652676SJed Brown /*@
4055cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
4056cd652676SJed Brown 
4057cd652676SJed Brown    Collective on TS
4058cd652676SJed Brown 
4059cd652676SJed Brown    Input Argument:
4060cd652676SJed Brown +  ts - time stepping context
4061cd652676SJed Brown -  t - time to interpolate to
4062cd652676SJed Brown 
4063cd652676SJed Brown    Output Argument:
40640910c330SBarry Smith .  U - state at given time
4065cd652676SJed Brown 
4066cd652676SJed Brown    Level: intermediate
4067cd652676SJed Brown 
4068cd652676SJed Brown    Developer Notes:
4069cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
4070cd652676SJed Brown 
4071cd652676SJed Brown .keywords: TS, set
4072cd652676SJed Brown 
4073874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
4074cd652676SJed Brown @*/
40750910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
4076cd652676SJed Brown {
4077cd652676SJed Brown   PetscErrorCode ierr;
4078cd652676SJed Brown 
4079cd652676SJed Brown   PetscFunctionBegin;
4080cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4081b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4082be5899b3SLisandro 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);
4083ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
40840910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
4085cd652676SJed Brown   PetscFunctionReturn(0);
4086cd652676SJed Brown }
4087cd652676SJed Brown 
4088d763cef2SBarry Smith /*@
40896d9e5789SSean Farley    TSStep - Steps one time step
4090d763cef2SBarry Smith 
4091d763cef2SBarry Smith    Collective on TS
4092d763cef2SBarry Smith 
4093d763cef2SBarry Smith    Input Parameter:
4094d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4095d763cef2SBarry Smith 
409627829d71SBarry Smith    Level: developer
4097d763cef2SBarry Smith 
4098b8123daeSJed Brown    Notes:
409927829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
410027829d71SBarry Smith 
4101b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
4102b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
4103b8123daeSJed Brown 
410419eac22cSLisandro Dalcin    This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the
410519eac22cSLisandro Dalcin    time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
410625cb2221SBarry Smith 
4107d763cef2SBarry Smith .keywords: TS, timestep, solve
4108d763cef2SBarry Smith 
41099be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
4110d763cef2SBarry Smith @*/
4111193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
4112d763cef2SBarry Smith {
4113dfbe8321SBarry Smith   PetscErrorCode   ierr;
4114fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
4115be5899b3SLisandro Dalcin   PetscReal        ptime;
4116d763cef2SBarry Smith 
4117d763cef2SBarry Smith   PetscFunctionBegin;
41180700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4119fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
4120fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
4121fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
4122fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
4123fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
4124fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
4125302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
4126fffbeea8SBarry Smith 
4127d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
412868bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4129d405a339SMatthew Knepley 
4130ef85077eSLisandro 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>");
4131a6772fa2SLisandro 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()");
4132be5899b3SLisandro 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");
4133a6772fa2SLisandro Dalcin 
4134be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
4135be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
41362808aa04SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
4137e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
4138d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
4139193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
4140d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
4141be5899b3SLisandro Dalcin   ts->ptime_prev = ptime;
41422808aa04SLisandro Dalcin   ts->steps++;
4143be5899b3SLisandro Dalcin   ts->steprollback = PETSC_FALSE;
414428d5b5d6SLisandro Dalcin   ts->steprestart  = PETSC_FALSE;
4145362cd11cSLisandro Dalcin 
4146362cd11cSLisandro Dalcin   if (ts->reason < 0) {
4147cef5090cSJed Brown     if (ts->errorifstepfailed) {
414808c7845fSBarry 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]);
414908c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
4150d2daff3dSHong Zhang     }
415108c7845fSBarry Smith   } else if (!ts->reason) {
415208c7845fSBarry Smith     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
415308c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
415408c7845fSBarry Smith   }
415508c7845fSBarry Smith   PetscFunctionReturn(0);
415608c7845fSBarry Smith }
415708c7845fSBarry Smith 
415808c7845fSBarry Smith /*@
4159b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
416008c7845fSBarry Smith 
416108c7845fSBarry Smith    Collective on TS
416208c7845fSBarry Smith 
416308c7845fSBarry Smith    Input Parameter:
416408c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
416508c7845fSBarry Smith 
41666a4d4014SLisandro Dalcin    Level: intermediate
41676a4d4014SLisandro Dalcin 
4168b957a604SHong Zhang .keywords: TS, adjoint, step
41696a4d4014SLisandro Dalcin 
4170b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
41716a4d4014SLisandro Dalcin @*/
417208c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
41736a4d4014SLisandro Dalcin {
417408c7845fSBarry Smith   DM               dm;
41756a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
41766a4d4014SLisandro Dalcin 
41776a4d4014SLisandro Dalcin   PetscFunctionBegin;
41784a2ae208SSatish Balay   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
417908c7845fSBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
418008c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
4181d763cef2SBarry Smith 
4182685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr);
4183d763cef2SBarry Smith 
4184be5899b3SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
4185be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime;
418642f2b339SBarry 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);
4187be5899b3SLisandro Dalcin   ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
418842f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
41898d0ad7a8SHong Zhang   ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
41902808aa04SLisandro Dalcin   ts->adjoint_steps++; ts->steps--;
4191362cd11cSLisandro Dalcin 
4192362cd11cSLisandro Dalcin   if (ts->reason < 0) {
4193cef5090cSJed Brown     if (ts->errorifstepfailed) {
41946c4ed002SBarry 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]);
41956c4ed002SBarry 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]);
41966c4ed002SBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
4197cef5090cSJed Brown     }
4198362cd11cSLisandro Dalcin   } else if (!ts->reason) {
41992808aa04SLisandro Dalcin     if (ts->adjoint_steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
4200362cd11cSLisandro Dalcin   }
4201d763cef2SBarry Smith   PetscFunctionReturn(0);
4202d763cef2SBarry Smith }
4203d763cef2SBarry Smith 
42047cbde773SLisandro Dalcin /*@
42057cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
42067cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
42077cbde773SLisandro Dalcin 
42087cbde773SLisandro Dalcin    Collective on TS
42097cbde773SLisandro Dalcin 
42107cbde773SLisandro Dalcin    Input Arguments:
42117cbde773SLisandro Dalcin +  ts - time stepping context
42127cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
42137cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
42147cbde773SLisandro Dalcin 
42157cbde773SLisandro Dalcin    Output Arguments:
42167cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
42177cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
42187cbde773SLisandro Dalcin 
42197cbde773SLisandro Dalcin    Level: advanced
42207cbde773SLisandro Dalcin 
42217cbde773SLisandro Dalcin    Notes:
42227cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
42237cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
42247cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
42257cbde773SLisandro Dalcin 
42267cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
42277cbde773SLisandro Dalcin @*/
42287cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
42297cbde773SLisandro Dalcin {
42307cbde773SLisandro Dalcin   PetscErrorCode ierr;
42317cbde773SLisandro Dalcin 
42327cbde773SLisandro Dalcin   PetscFunctionBegin;
42337cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
42347cbde773SLisandro Dalcin   PetscValidType(ts,1);
42357cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
42367cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
42377cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
42387cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
42397cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
42407cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
42417cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
42427cbde773SLisandro Dalcin   PetscFunctionReturn(0);
42437cbde773SLisandro Dalcin }
42447cbde773SLisandro Dalcin 
424505175c85SJed Brown /*@
424605175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
424705175c85SJed Brown 
42481c3436cfSJed Brown    Collective on TS
424905175c85SJed Brown 
425005175c85SJed Brown    Input Arguments:
42511c3436cfSJed Brown +  ts - time stepping context
42521c3436cfSJed Brown .  order - desired order of accuracy
42530298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
425405175c85SJed Brown 
425505175c85SJed Brown    Output Arguments:
42560910c330SBarry Smith .  U - state at the end of the current step
425705175c85SJed Brown 
425805175c85SJed Brown    Level: advanced
425905175c85SJed Brown 
4260108c343cSJed Brown    Notes:
4261108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
4262108c343cSJed 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.
4263108c343cSJed Brown 
42641c3436cfSJed Brown .seealso: TSStep(), TSAdapt
426505175c85SJed Brown @*/
42660910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
426705175c85SJed Brown {
426805175c85SJed Brown   PetscErrorCode ierr;
426905175c85SJed Brown 
427005175c85SJed Brown   PetscFunctionBegin;
427105175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
427205175c85SJed Brown   PetscValidType(ts,1);
42730910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4274ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
42750910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
427605175c85SJed Brown   PetscFunctionReturn(0);
427705175c85SJed Brown }
427805175c85SJed Brown 
4279b1cb36f3SHong Zhang /*@
4280b1cb36f3SHong Zhang    TSForwardCostIntegral - Evaluate the cost integral in the forward run.
4281b1cb36f3SHong Zhang 
4282b1cb36f3SHong Zhang    Collective on TS
4283b1cb36f3SHong Zhang 
4284b1cb36f3SHong Zhang    Input Arguments:
4285b1cb36f3SHong Zhang .  ts - time stepping context
4286b1cb36f3SHong Zhang 
4287b1cb36f3SHong Zhang    Level: advanced
4288b1cb36f3SHong Zhang 
4289b1cb36f3SHong Zhang    Notes:
4290b1cb36f3SHong Zhang    This function cannot be called until TSStep() has been completed.
4291b1cb36f3SHong Zhang 
4292b1cb36f3SHong Zhang .seealso: TSSolve(), TSAdjointCostIntegral()
4293b1cb36f3SHong Zhang @*/
4294b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts)
4295b1cb36f3SHong Zhang {
4296b1cb36f3SHong Zhang   PetscErrorCode ierr;
4297b1cb36f3SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4298b1cb36f3SHong 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);
4299b1cb36f3SHong Zhang   ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr);
4300b1cb36f3SHong Zhang   PetscFunctionReturn(0);
4301b1cb36f3SHong Zhang }
4302d67e68b7SBarry Smith 
4303d763cef2SBarry Smith /*@
4304d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
4305d763cef2SBarry Smith 
4306d763cef2SBarry Smith    Collective on TS
4307d763cef2SBarry Smith 
4308d763cef2SBarry Smith    Input Parameter:
4309d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
431063e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
431163e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
43125a3a76d0SJed Brown 
4313d763cef2SBarry Smith    Level: beginner
4314d763cef2SBarry Smith 
43155a3a76d0SJed Brown    Notes:
43165a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
43175a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
43185a3a76d0SJed Brown    stepped over the final time.
43195a3a76d0SJed Brown 
4320d763cef2SBarry Smith .keywords: TS, timestep, solve
4321d763cef2SBarry Smith 
432263e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
4323d763cef2SBarry Smith @*/
4324cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
4325d763cef2SBarry Smith {
4326b06615a5SLisandro Dalcin   Vec               solution;
4327d763cef2SBarry Smith   PetscErrorCode    ierr;
4328d763cef2SBarry Smith 
4329d763cef2SBarry Smith   PetscFunctionBegin;
4330d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4331f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
4332feed9e9dSBarry Smith 
4333ee41a567SStefano 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 */
43340910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
4335b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
4336b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
4337b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
43385a3a76d0SJed Brown     }
43390910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
4340715f1b00SHong Zhang     if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
4341bbd56ea5SKarl Rupp   } else if (u) {
43420910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
43435a3a76d0SJed Brown   }
4344b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
434568bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4346a6772fa2SLisandro Dalcin 
4347ef85077eSLisandro 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>");
4348a6772fa2SLisandro 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()");
4349a6772fa2SLisandro 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");
4350a6772fa2SLisandro Dalcin 
4351715f1b00SHong Zhang   if (ts->forward_solve) {
4352715f1b00SHong Zhang     ierr = TSForwardSetUp(ts);CHKERRQ(ierr);
4353715f1b00SHong Zhang   }
4354715f1b00SHong Zhang 
4355e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
4356715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
4357e7069c78SShri      TSTrajectory to incorrectly save the output files
4358e7069c78SShri   */
4359715f1b00SHong Zhang   /* reset time step and iteration counters */
43602808aa04SLisandro Dalcin   if (!ts->steps) {
43615ef26d82SJed Brown     ts->ksp_its           = 0;
43625ef26d82SJed Brown     ts->snes_its          = 0;
4363c610991cSLisandro Dalcin     ts->num_snes_failures = 0;
4364c610991cSLisandro Dalcin     ts->reject            = 0;
43652808aa04SLisandro Dalcin     ts->steprestart       = PETSC_TRUE;
43662808aa04SLisandro Dalcin     ts->steprollback      = PETSC_FALSE;
43672808aa04SLisandro Dalcin   }
436810bc0e4dSStefano 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;
4369193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
4370193ac0bcSJed Brown 
4371ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
4372f05ece33SBarry Smith 
4373193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
4374193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
4375a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4376cc708dedSBarry Smith     ts->solvetime = ts->ptime;
4377a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
4378be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
4379db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
4380db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
4381e7069c78SShri 
43822808aa04SLisandro Dalcin     if (!ts->steps) {
43832808aa04SLisandro Dalcin       ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
43846427ac75SLisandro Dalcin       ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
43852808aa04SLisandro Dalcin     }
43866427ac75SLisandro Dalcin 
4387e1a7a14fSJed Brown     while (!ts->reason) {
43882808aa04SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
43899687d888SLisandro Dalcin       if (!ts->steprollback) {
43909687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
43919687d888SLisandro Dalcin       }
4392193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
4393e783b05fSHong 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. */
4394b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
4395b1cb36f3SHong Zhang       }
439658818c2dSLisandro Dalcin       if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */
4397715f1b00SHong Zhang         ierr = TSForwardStep(ts);CHKERRQ(ierr);
4398715f1b00SHong Zhang       }
439910b82f12SShri Abhyankar       ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
4400e783b05fSHong 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. */
440158818c2dSLisandro Dalcin       if (ts->steprollback) {
440258818c2dSLisandro Dalcin         ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
440358818c2dSLisandro Dalcin       }
4404e783b05fSHong Zhang       if (!ts->steprollback) {
44052808aa04SLisandro Dalcin         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
44061eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
4407aeb4809dSShri Abhyankar       }
4408193ac0bcSJed Brown     }
44092808aa04SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
44106427ac75SLisandro Dalcin 
441149354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
44120910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
4413cc708dedSBarry Smith       ts->solvetime = ts->max_time;
4414b06615a5SLisandro Dalcin       solution = u;
441563e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
44160574a7fbSJed Brown     } else {
4417ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4418cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4419b06615a5SLisandro Dalcin       solution = ts->vec_sol;
44200574a7fbSJed Brown     }
4421193ac0bcSJed Brown   }
4422d2daff3dSHong Zhang 
4423ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
442463e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
442556f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
4426ef222394SBarry Smith   if (ts->adjoint_solve) {
4427ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
44282b0a91c0SBarry Smith   }
4429d763cef2SBarry Smith   PetscFunctionReturn(0);
4430d763cef2SBarry Smith }
4431d763cef2SBarry Smith 
4432b1cb36f3SHong Zhang /*@
4433b1cb36f3SHong Zhang  TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run.
4434b1cb36f3SHong Zhang 
4435b1cb36f3SHong Zhang  Collective on TS
4436b1cb36f3SHong Zhang 
4437b1cb36f3SHong Zhang  Input Arguments:
4438b1cb36f3SHong Zhang  .  ts - time stepping context
4439b1cb36f3SHong Zhang 
4440b1cb36f3SHong Zhang  Level: advanced
4441b1cb36f3SHong Zhang 
4442b1cb36f3SHong Zhang  Notes:
4443b1cb36f3SHong Zhang  This function cannot be called until TSAdjointStep() has been completed.
4444b1cb36f3SHong Zhang 
4445b1cb36f3SHong Zhang  .seealso: TSAdjointSolve(), TSAdjointStep
4446b1cb36f3SHong Zhang  @*/
4447b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts)
4448b1cb36f3SHong Zhang {
4449b1cb36f3SHong Zhang     PetscErrorCode ierr;
4450b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4451b1cb36f3SHong 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);
4452b1cb36f3SHong Zhang     ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr);
4453b1cb36f3SHong Zhang     PetscFunctionReturn(0);
4454b1cb36f3SHong Zhang }
4455b1cb36f3SHong Zhang 
4456c88f2d44SBarry Smith /*@
4457c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
4458c88f2d44SBarry Smith 
4459c88f2d44SBarry Smith    Collective on TS
4460c88f2d44SBarry Smith 
4461c88f2d44SBarry Smith    Input Parameter:
44622c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
4463c88f2d44SBarry Smith 
4464e87fd094SBarry Smith    Options Database:
4465715f1b00SHong Zhang . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial values
4466e87fd094SBarry Smith 
4467c88f2d44SBarry Smith    Level: intermediate
4468c88f2d44SBarry Smith 
4469c88f2d44SBarry Smith    Notes:
4470c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
4471c88f2d44SBarry Smith 
447273b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
447373b18844SBarry Smith 
4474c88f2d44SBarry Smith .keywords: TS, timestep, solve
4475c88f2d44SBarry Smith 
4476b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
4477c88f2d44SBarry Smith @*/
44782c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
4479c88f2d44SBarry Smith {
4480c88f2d44SBarry Smith   PetscErrorCode    ierr;
4481c88f2d44SBarry Smith 
4482c88f2d44SBarry Smith   PetscFunctionBegin;
4483c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4484c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
448568bece0bSHong Zhang 
4486c88f2d44SBarry Smith   /* reset time step and iteration counters */
44872808aa04SLisandro Dalcin   ts->adjoint_steps     = 0;
4488c88f2d44SBarry Smith   ts->ksp_its           = 0;
4489c88f2d44SBarry Smith   ts->snes_its          = 0;
4490c88f2d44SBarry Smith   ts->num_snes_failures = 0;
4491c88f2d44SBarry Smith   ts->reject            = 0;
4492c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
4493c88f2d44SBarry Smith 
44942808aa04SLisandro Dalcin   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->steps;
44952808aa04SLisandro Dalcin   if (ts->adjoint_steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
4496c88f2d44SBarry Smith 
4497c88f2d44SBarry Smith   while (!ts->reason) {
44982808aa04SLisandro Dalcin     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->steps,&ts->ptime);CHKERRQ(ierr);
44992808aa04SLisandro Dalcin     ierr = TSAdjointMonitor(ts,ts->steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
45006427ac75SLisandro Dalcin     ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr);
4501616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
4502b1cb36f3SHong Zhang     if (ts->vec_costintegral && !ts->costintegralfwd) {
4503b1cb36f3SHong Zhang       ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr);
4504b1cb36f3SHong Zhang     }
4505c88f2d44SBarry Smith   }
45062808aa04SLisandro Dalcin   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->steps,&ts->ptime);CHKERRQ(ierr);
45072808aa04SLisandro Dalcin   ierr = TSAdjointMonitor(ts,ts->steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
4508c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
4509e210cd0eSHong Zhang   ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr);
4510685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
451111e1d5c3SBarry Smith   ts->adjoint_max_steps = 0;
4512c88f2d44SBarry Smith   PetscFunctionReturn(0);
4513c88f2d44SBarry Smith }
4514c88f2d44SBarry Smith 
45157db568b7SBarry Smith /*@C
4516228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4517228d79bcSJed Brown 
4518228d79bcSJed Brown    Collective on TS
4519228d79bcSJed Brown 
4520228d79bcSJed Brown    Input Parameters:
4521228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
4522228d79bcSJed Brown .  step - step number that has just completed
4523228d79bcSJed Brown .  ptime - model time of the state
45240910c330SBarry Smith -  u - state at the current model time
4525228d79bcSJed Brown 
4526228d79bcSJed Brown    Notes:
45277db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
45287db568b7SBarry Smith    Users would almost never call this routine directly.
4529228d79bcSJed Brown 
453063e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
453163e21af5SBarry Smith 
45327db568b7SBarry Smith    Level: developer
4533228d79bcSJed Brown 
4534228d79bcSJed Brown .keywords: TS, timestep
4535228d79bcSJed Brown @*/
45360910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4537d763cef2SBarry Smith {
4538d6152f81SLisandro Dalcin   DM             dm;
4539a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
4540d6152f81SLisandro Dalcin   PetscErrorCode ierr;
4541d763cef2SBarry Smith 
4542d763cef2SBarry Smith   PetscFunctionBegin;
4543b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4544b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4545d6152f81SLisandro Dalcin 
4546d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
4547d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
4548d6152f81SLisandro Dalcin 
45495edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
4550d763cef2SBarry Smith   for (i=0; i<n; i++) {
45510910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
4552d763cef2SBarry Smith   }
45535edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
4554d763cef2SBarry Smith   PetscFunctionReturn(0);
4555d763cef2SBarry Smith }
4556d763cef2SBarry Smith 
45577db568b7SBarry Smith /*@C
45589110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
45599110b2e7SHong Zhang 
45609110b2e7SHong Zhang    Collective on TS
45619110b2e7SHong Zhang 
45629110b2e7SHong Zhang    Input Parameters:
45639110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
45649110b2e7SHong Zhang .  step - step number that has just completed
45659110b2e7SHong Zhang .  ptime - model time of the state
45669110b2e7SHong Zhang .  u - state at the current model time
45679110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
45689110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
45699110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
45709110b2e7SHong Zhang 
45719110b2e7SHong Zhang    Notes:
45727db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
45737db568b7SBarry Smith    Users would almost never call this routine directly.
45749110b2e7SHong Zhang 
45757db568b7SBarry Smith    Level: developer
45769110b2e7SHong Zhang 
45779110b2e7SHong Zhang .keywords: TS, timestep
45789110b2e7SHong Zhang @*/
45799110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
45809110b2e7SHong Zhang {
45819110b2e7SHong Zhang   PetscErrorCode ierr;
45829110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
45839110b2e7SHong Zhang 
45849110b2e7SHong Zhang   PetscFunctionBegin;
45859110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45869110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
45879110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
45889110b2e7SHong Zhang   for (i=0; i<n; i++) {
45899110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
45909110b2e7SHong Zhang   }
45919110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
45929110b2e7SHong Zhang   PetscFunctionReturn(0);
45939110b2e7SHong Zhang }
45949110b2e7SHong Zhang 
4595d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
4596d763cef2SBarry Smith /*@C
45977db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4598a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
4599d763cef2SBarry Smith 
4600d763cef2SBarry Smith    Collective on TS
4601d763cef2SBarry Smith 
4602d763cef2SBarry Smith    Input Parameters:
4603d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
4604d763cef2SBarry Smith .  label - the title to put in the title bar
46057c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
4606a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
4607a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4608d763cef2SBarry Smith 
4609d763cef2SBarry Smith    Output Parameter:
46100b039ecaSBarry Smith .  ctx - the context
4611d763cef2SBarry Smith 
4612d763cef2SBarry Smith    Options Database Key:
46134f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
46148b668821SLisandro Dalcin +  -ts_monitor_lg_timestep_log - automatically sets line graph monitor
46157db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
46167db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
46177db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
46187db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4619b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4620d763cef2SBarry Smith 
4621d763cef2SBarry Smith    Notes:
4622a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
4623d763cef2SBarry Smith 
46247db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
46257db568b7SBarry Smith 
46267db568b7SBarry 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
46277db568b7SBarry 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
46287db568b7SBarry Smith    as the first argument.
46297db568b7SBarry Smith 
46307db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
46317db568b7SBarry Smith 
4632d763cef2SBarry Smith    Level: intermediate
4633d763cef2SBarry Smith 
46347db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
4635d763cef2SBarry Smith 
46367db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
46377db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
46387db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
46397db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
46407db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
46417c922b88SBarry Smith 
4642d763cef2SBarry Smith @*/
4643a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4644d763cef2SBarry Smith {
46457f52daa2SLisandro Dalcin   PetscDraw      draw;
4646dfbe8321SBarry Smith   PetscErrorCode ierr;
4647d763cef2SBarry Smith 
4648d763cef2SBarry Smith   PetscFunctionBegin;
4649b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
46507f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
46517f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
46527f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
4653287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
46547f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
4655a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
4656d763cef2SBarry Smith   PetscFunctionReturn(0);
4657d763cef2SBarry Smith }
4658d763cef2SBarry Smith 
4659b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4660d763cef2SBarry Smith {
46610b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4662c32365f1SBarry Smith   PetscReal      x   = ptime,y;
4663dfbe8321SBarry Smith   PetscErrorCode ierr;
4664d763cef2SBarry Smith 
4665d763cef2SBarry Smith   PetscFunctionBegin;
466663e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
4667b06615a5SLisandro Dalcin   if (!step) {
4668a9f9c1f6SBarry Smith     PetscDrawAxis axis;
46698b668821SLisandro Dalcin     const char *ylabel = ctx->semilogy ? "Log Time Step" : "Time Step";
4670a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
46718b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time",ylabel);CHKERRQ(ierr);
4672a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4673a9f9c1f6SBarry Smith   }
4674c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
46758b668821SLisandro Dalcin   if (ctx->semilogy) y = PetscLog10Real(y);
46760b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
4677b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
46780b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
46796934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
46803923b477SBarry Smith   }
4681d763cef2SBarry Smith   PetscFunctionReturn(0);
4682d763cef2SBarry Smith }
4683d763cef2SBarry Smith 
4684d763cef2SBarry Smith /*@C
4685a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4686a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
4687d763cef2SBarry Smith 
46880b039ecaSBarry Smith    Collective on TSMonitorLGCtx
4689d763cef2SBarry Smith 
4690d763cef2SBarry Smith    Input Parameter:
46910b039ecaSBarry Smith .  ctx - the monitor context
4692d763cef2SBarry Smith 
4693d763cef2SBarry Smith    Level: intermediate
4694d763cef2SBarry Smith 
4695d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
4696d763cef2SBarry Smith 
46974f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
4698d763cef2SBarry Smith @*/
4699a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4700d763cef2SBarry Smith {
4701dfbe8321SBarry Smith   PetscErrorCode ierr;
4702d763cef2SBarry Smith 
4703d763cef2SBarry Smith   PetscFunctionBegin;
47047684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
47057684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
47067684fa3eSBarry Smith   }
47070b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
470831152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
4709387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
4710387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
4711387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
47120b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
4713d763cef2SBarry Smith   PetscFunctionReturn(0);
4714d763cef2SBarry Smith }
4715d763cef2SBarry Smith 
4716d763cef2SBarry Smith /*@
4717b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4718d763cef2SBarry Smith 
4719d763cef2SBarry Smith    Not Collective
4720d763cef2SBarry Smith 
4721d763cef2SBarry Smith    Input Parameter:
4722d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4723d763cef2SBarry Smith 
4724d763cef2SBarry Smith    Output Parameter:
472519eac22cSLisandro Dalcin .  t  - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime().
4726d763cef2SBarry Smith 
4727d763cef2SBarry Smith    Level: beginner
4728d763cef2SBarry Smith 
4729b8123daeSJed Brown    Note:
4730b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
47319be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4732b8123daeSJed Brown 
4733aaa6c58dSLisandro Dalcin .seealso:  TSGetSolveTime(), TSSetTime(), TSGetTimeStep()
4734d763cef2SBarry Smith 
4735d763cef2SBarry Smith .keywords: TS, get, time
4736d763cef2SBarry Smith @*/
47377087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4738d763cef2SBarry Smith {
4739d763cef2SBarry Smith   PetscFunctionBegin;
47400700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4741f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4742d763cef2SBarry Smith   *t = ts->ptime;
4743d763cef2SBarry Smith   PetscFunctionReturn(0);
4744d763cef2SBarry Smith }
4745d763cef2SBarry Smith 
4746e5e524a1SHong Zhang /*@
4747e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4748e5e524a1SHong Zhang 
4749e5e524a1SHong Zhang    Not Collective
4750e5e524a1SHong Zhang 
4751e5e524a1SHong Zhang    Input Parameter:
4752e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4753e5e524a1SHong Zhang 
4754e5e524a1SHong Zhang    Output Parameter:
4755e5e524a1SHong Zhang .  t  - the previous time
4756e5e524a1SHong Zhang 
4757e5e524a1SHong Zhang    Level: beginner
4758e5e524a1SHong Zhang 
4759aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep()
4760e5e524a1SHong Zhang 
4761e5e524a1SHong Zhang .keywords: TS, get, time
4762e5e524a1SHong Zhang @*/
4763e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4764e5e524a1SHong Zhang {
4765e5e524a1SHong Zhang   PetscFunctionBegin;
4766e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4767e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4768e5e524a1SHong Zhang   *t = ts->ptime_prev;
4769e5e524a1SHong Zhang   PetscFunctionReturn(0);
4770e5e524a1SHong Zhang }
4771e5e524a1SHong Zhang 
47726a4d4014SLisandro Dalcin /*@
47736a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
47746a4d4014SLisandro Dalcin 
47753f9fe445SBarry Smith    Logically Collective on TS
47766a4d4014SLisandro Dalcin 
47776a4d4014SLisandro Dalcin    Input Parameters:
47786a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
47796a4d4014SLisandro Dalcin -  time - the time
47806a4d4014SLisandro Dalcin 
47816a4d4014SLisandro Dalcin    Level: intermediate
47826a4d4014SLisandro Dalcin 
478319eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps()
47846a4d4014SLisandro Dalcin 
47856a4d4014SLisandro Dalcin .keywords: TS, set, time
47866a4d4014SLisandro Dalcin @*/
47877087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
47886a4d4014SLisandro Dalcin {
47896a4d4014SLisandro Dalcin   PetscFunctionBegin;
47900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4791c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
47926a4d4014SLisandro Dalcin   ts->ptime = t;
47936a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
47946a4d4014SLisandro Dalcin }
47956a4d4014SLisandro Dalcin 
4796d763cef2SBarry Smith /*@C
4797d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4798d763cef2SBarry Smith    TS options in the database.
4799d763cef2SBarry Smith 
48003f9fe445SBarry Smith    Logically Collective on TS
4801d763cef2SBarry Smith 
4802d763cef2SBarry Smith    Input Parameter:
4803d763cef2SBarry Smith +  ts     - The TS context
4804d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4805d763cef2SBarry Smith 
4806d763cef2SBarry Smith    Notes:
4807d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4808d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4809d763cef2SBarry Smith    hyphen.
4810d763cef2SBarry Smith 
4811d763cef2SBarry Smith    Level: advanced
4812d763cef2SBarry Smith 
4813d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
4814d763cef2SBarry Smith 
4815d763cef2SBarry Smith .seealso: TSSetFromOptions()
4816d763cef2SBarry Smith 
4817d763cef2SBarry Smith @*/
48187087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4819d763cef2SBarry Smith {
4820dfbe8321SBarry Smith   PetscErrorCode ierr;
4821089b2837SJed Brown   SNES           snes;
4822d763cef2SBarry Smith 
4823d763cef2SBarry Smith   PetscFunctionBegin;
48240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4825d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4826089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4827089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4828d763cef2SBarry Smith   PetscFunctionReturn(0);
4829d763cef2SBarry Smith }
4830d763cef2SBarry Smith 
4831d763cef2SBarry Smith /*@C
4832d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4833d763cef2SBarry Smith    TS options in the database.
4834d763cef2SBarry Smith 
48353f9fe445SBarry Smith    Logically Collective on TS
4836d763cef2SBarry Smith 
4837d763cef2SBarry Smith    Input Parameter:
4838d763cef2SBarry Smith +  ts     - The TS context
4839d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4840d763cef2SBarry Smith 
4841d763cef2SBarry Smith    Notes:
4842d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4843d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4844d763cef2SBarry Smith    hyphen.
4845d763cef2SBarry Smith 
4846d763cef2SBarry Smith    Level: advanced
4847d763cef2SBarry Smith 
4848d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
4849d763cef2SBarry Smith 
4850d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4851d763cef2SBarry Smith 
4852d763cef2SBarry Smith @*/
48537087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4854d763cef2SBarry Smith {
4855dfbe8321SBarry Smith   PetscErrorCode ierr;
4856089b2837SJed Brown   SNES           snes;
4857d763cef2SBarry Smith 
4858d763cef2SBarry Smith   PetscFunctionBegin;
48590700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4860d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4861089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4862089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4863d763cef2SBarry Smith   PetscFunctionReturn(0);
4864d763cef2SBarry Smith }
4865d763cef2SBarry Smith 
4866d763cef2SBarry Smith /*@C
4867d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4868d763cef2SBarry Smith    TS options in the database.
4869d763cef2SBarry Smith 
4870d763cef2SBarry Smith    Not Collective
4871d763cef2SBarry Smith 
4872d763cef2SBarry Smith    Input Parameter:
4873d763cef2SBarry Smith .  ts - The TS context
4874d763cef2SBarry Smith 
4875d763cef2SBarry Smith    Output Parameter:
4876d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4877d763cef2SBarry Smith 
4878d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
4879d763cef2SBarry Smith    sufficient length to hold the prefix.
4880d763cef2SBarry Smith 
4881d763cef2SBarry Smith    Level: intermediate
4882d763cef2SBarry Smith 
4883d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
4884d763cef2SBarry Smith 
4885d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4886d763cef2SBarry Smith @*/
48877087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4888d763cef2SBarry Smith {
4889dfbe8321SBarry Smith   PetscErrorCode ierr;
4890d763cef2SBarry Smith 
4891d763cef2SBarry Smith   PetscFunctionBegin;
48920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48934482741eSBarry Smith   PetscValidPointer(prefix,2);
4894d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4895d763cef2SBarry Smith   PetscFunctionReturn(0);
4896d763cef2SBarry Smith }
4897d763cef2SBarry Smith 
4898d763cef2SBarry Smith /*@C
4899d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4900d763cef2SBarry Smith 
4901d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4902d763cef2SBarry Smith 
4903d763cef2SBarry Smith    Input Parameter:
4904d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4905d763cef2SBarry Smith 
4906d763cef2SBarry Smith    Output Parameters:
4907e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4908e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4909e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4910e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4911d763cef2SBarry Smith 
49120298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
4913d763cef2SBarry Smith 
4914d763cef2SBarry Smith    Level: intermediate
4915d763cef2SBarry Smith 
491680275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
4917d763cef2SBarry Smith 
4918d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
4919d763cef2SBarry Smith @*/
4920e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4921d763cef2SBarry Smith {
4922089b2837SJed Brown   PetscErrorCode ierr;
492324989b8cSPeter Brune   DM             dm;
4924089b2837SJed Brown 
4925d763cef2SBarry Smith   PetscFunctionBegin;
492623a57915SBarry Smith   if (Amat || Pmat) {
492723a57915SBarry Smith     SNES snes;
4928089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
492923a57915SBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4930e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
493123a57915SBarry Smith   }
493224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
493324989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4934d763cef2SBarry Smith   PetscFunctionReturn(0);
4935d763cef2SBarry Smith }
4936d763cef2SBarry Smith 
49372eca1d9cSJed Brown /*@C
49382eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
49392eca1d9cSJed Brown 
49402eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
49412eca1d9cSJed Brown 
49422eca1d9cSJed Brown    Input Parameter:
49432eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
49442eca1d9cSJed Brown 
49452eca1d9cSJed Brown    Output Parameters:
4946e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4947e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
49482eca1d9cSJed Brown .  f   - The function to compute the matrices
49492eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
49502eca1d9cSJed Brown 
49510298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
49522eca1d9cSJed Brown 
49532eca1d9cSJed Brown    Level: advanced
49542eca1d9cSJed Brown 
495580275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
49562eca1d9cSJed Brown 
49572eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
49582eca1d9cSJed Brown @*/
4959e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
49602eca1d9cSJed Brown {
4961089b2837SJed Brown   PetscErrorCode ierr;
496224989b8cSPeter Brune   DM             dm;
49630910c330SBarry Smith 
49642eca1d9cSJed Brown   PetscFunctionBegin;
4965c0aab802Sstefano_zampini   if (Amat || Pmat) {
4966c0aab802Sstefano_zampini     SNES snes;
4967089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4968f7d39f7aSBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4969e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
4970c0aab802Sstefano_zampini   }
497124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
497224989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
49732eca1d9cSJed Brown   PetscFunctionReturn(0);
49742eca1d9cSJed Brown }
49752eca1d9cSJed Brown 
49761713a123SBarry Smith /*@C
497783a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
49781713a123SBarry Smith    VecView() for the solution at each timestep
49791713a123SBarry Smith 
49801713a123SBarry Smith    Collective on TS
49811713a123SBarry Smith 
49821713a123SBarry Smith    Input Parameters:
49831713a123SBarry Smith +  ts - the TS context
49841713a123SBarry Smith .  step - current time-step
4985142b95e3SSatish Balay .  ptime - current time
49860298fd71SBarry Smith -  dummy - either a viewer or NULL
49871713a123SBarry Smith 
498899fdda47SBarry Smith    Options Database:
498999fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
499099fdda47SBarry Smith 
4991387f4636SBarry 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
499299fdda47SBarry Smith        will look bad
499399fdda47SBarry Smith 
49941713a123SBarry Smith    Level: intermediate
49951713a123SBarry Smith 
49961713a123SBarry Smith .keywords: TS,  vector, monitor, view
49971713a123SBarry Smith 
4998a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
49991713a123SBarry Smith @*/
50000910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
50011713a123SBarry Smith {
5002dfbe8321SBarry Smith   PetscErrorCode   ierr;
500383a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
5004473a3ab2SBarry Smith   PetscDraw        draw;
50051713a123SBarry Smith 
50061713a123SBarry Smith   PetscFunctionBegin;
50076083293cSBarry Smith   if (!step && ictx->showinitial) {
50086083293cSBarry Smith     if (!ictx->initialsolution) {
50090910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
50101713a123SBarry Smith     }
50110910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
50126083293cSBarry Smith   }
5013b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
50140dcf80beSBarry Smith 
50156083293cSBarry Smith   if (ictx->showinitial) {
50166083293cSBarry Smith     PetscReal pause;
50176083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
50186083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
50196083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
50206083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
50216083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
50226083293cSBarry Smith   }
50230910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
5024473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
502551fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
5026473a3ab2SBarry Smith     char      time[32];
5027473a3ab2SBarry Smith 
5028473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
502985b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
5030473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
5031473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
503251fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
5033473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
5034473a3ab2SBarry Smith   }
5035473a3ab2SBarry Smith 
50366083293cSBarry Smith   if (ictx->showinitial) {
50376083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
50386083293cSBarry Smith   }
50391713a123SBarry Smith   PetscFunctionReturn(0);
50401713a123SBarry Smith }
50411713a123SBarry Smith 
50429110b2e7SHong Zhang /*@C
50439110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
50449110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
50459110b2e7SHong Zhang 
50469110b2e7SHong Zhang    Collective on TS
50479110b2e7SHong Zhang 
50489110b2e7SHong Zhang    Input Parameters:
50499110b2e7SHong Zhang +  ts - the TS context
50509110b2e7SHong Zhang .  step - current time-step
50519110b2e7SHong Zhang .  ptime - current time
50529110b2e7SHong Zhang .  u - current state
50539110b2e7SHong Zhang .  numcost - number of cost functions
50549110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
50559110b2e7SHong Zhang .  mu - sensitivities to parameters
50569110b2e7SHong Zhang -  dummy - either a viewer or NULL
50579110b2e7SHong Zhang 
50589110b2e7SHong Zhang    Level: intermediate
50599110b2e7SHong Zhang 
50609110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
50619110b2e7SHong Zhang 
50629110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
50639110b2e7SHong Zhang @*/
50649110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
50659110b2e7SHong Zhang {
50669110b2e7SHong Zhang   PetscErrorCode   ierr;
50679110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
50689110b2e7SHong Zhang   PetscDraw        draw;
5069a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
5070a0046e2cSSatish Balay   char             time[32];
50719110b2e7SHong Zhang 
50729110b2e7SHong Zhang   PetscFunctionBegin;
50739110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
50749110b2e7SHong Zhang 
50759110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
50769110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
50779110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
50789110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
50799110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
50809110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
50819110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
50829110b2e7SHong Zhang   PetscFunctionReturn(0);
50839110b2e7SHong Zhang }
50849110b2e7SHong Zhang 
50852d5ee99bSBarry Smith /*@C
50862d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
50872d5ee99bSBarry Smith 
50882d5ee99bSBarry Smith    Collective on TS
50892d5ee99bSBarry Smith 
50902d5ee99bSBarry Smith    Input Parameters:
50912d5ee99bSBarry Smith +  ts - the TS context
50922d5ee99bSBarry Smith .  step - current time-step
50932d5ee99bSBarry Smith .  ptime - current time
50942d5ee99bSBarry Smith -  dummy - either a viewer or NULL
50952d5ee99bSBarry Smith 
50962d5ee99bSBarry Smith    Level: intermediate
50972d5ee99bSBarry Smith 
50982d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
50992d5ee99bSBarry Smith 
51002d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
51012d5ee99bSBarry Smith @*/
51022d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
51032d5ee99bSBarry Smith {
51042d5ee99bSBarry Smith   PetscErrorCode    ierr;
51052d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
51062d5ee99bSBarry Smith   PetscDraw         draw;
51076934998bSLisandro Dalcin   PetscDrawAxis     axis;
51082d5ee99bSBarry Smith   PetscInt          n;
51092d5ee99bSBarry Smith   PetscMPIInt       size;
51106934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
51112d5ee99bSBarry Smith   char              time[32];
51122d5ee99bSBarry Smith   const PetscScalar *U;
51132d5ee99bSBarry Smith 
51142d5ee99bSBarry Smith   PetscFunctionBegin;
51156934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
51166934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
51172d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
51186934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
51192d5ee99bSBarry Smith 
51202d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
51216934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
51226934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
51236934998bSLisandro Dalcin   if (!step) {
51246934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
51256934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
51266934998bSLisandro Dalcin   }
51272d5ee99bSBarry Smith 
51282d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
51296934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
51306934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
5131a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
51326934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
51332d5ee99bSBarry Smith 
51346934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
51356934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
51362d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
51374b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
513885b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
51392d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
514051fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
51412d5ee99bSBarry Smith   }
51426934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
51432d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
514456d62c8fSLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
51456934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
51462d5ee99bSBarry Smith   PetscFunctionReturn(0);
51472d5ee99bSBarry Smith }
51482d5ee99bSBarry Smith 
51496083293cSBarry Smith /*@C
515083a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
51516083293cSBarry Smith 
51526083293cSBarry Smith    Collective on TS
51536083293cSBarry Smith 
51546083293cSBarry Smith    Input Parameters:
51556083293cSBarry Smith .    ctx - the monitor context
51566083293cSBarry Smith 
51576083293cSBarry Smith    Level: intermediate
51586083293cSBarry Smith 
51596083293cSBarry Smith .keywords: TS,  vector, monitor, view
51606083293cSBarry Smith 
516183a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
51626083293cSBarry Smith @*/
516383a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
51646083293cSBarry Smith {
51656083293cSBarry Smith   PetscErrorCode ierr;
51666083293cSBarry Smith 
51676083293cSBarry Smith   PetscFunctionBegin;
516883a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
516983a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
517083a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
51716083293cSBarry Smith   PetscFunctionReturn(0);
51726083293cSBarry Smith }
51736083293cSBarry Smith 
51746083293cSBarry Smith /*@C
517583a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
51766083293cSBarry Smith 
51776083293cSBarry Smith    Collective on TS
51786083293cSBarry Smith 
51796083293cSBarry Smith    Input Parameter:
51806083293cSBarry Smith .    ts - time-step context
51816083293cSBarry Smith 
51826083293cSBarry Smith    Output Patameter:
51836083293cSBarry Smith .    ctx - the monitor context
51846083293cSBarry Smith 
518599fdda47SBarry Smith    Options Database:
518699fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
518799fdda47SBarry Smith 
51886083293cSBarry Smith    Level: intermediate
51896083293cSBarry Smith 
51906083293cSBarry Smith .keywords: TS,  vector, monitor, view
51916083293cSBarry Smith 
519283a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
51936083293cSBarry Smith @*/
519483a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
51956083293cSBarry Smith {
51966083293cSBarry Smith   PetscErrorCode   ierr;
51976083293cSBarry Smith 
51986083293cSBarry Smith   PetscFunctionBegin;
5199b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
520083a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
5201e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
5202bbd56ea5SKarl Rupp 
520383a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
5204473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
5205c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
5206473a3ab2SBarry Smith 
5207473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
5208c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
52096083293cSBarry Smith   PetscFunctionReturn(0);
52106083293cSBarry Smith }
52116083293cSBarry Smith 
52123a471f94SBarry Smith /*@C
52130ed3bfb6SBarry Smith    TSMonitorDrawSolutionFunction - Monitors progress of the TS solvers by calling
52140ed3bfb6SBarry Smith    VecView() for the solution provided by TSSetSolutionFunction() at each timestep
52150ed3bfb6SBarry Smith 
52160ed3bfb6SBarry Smith    Collective on TS
52170ed3bfb6SBarry Smith 
52180ed3bfb6SBarry Smith    Input Parameters:
52190ed3bfb6SBarry Smith +  ts - the TS context
52200ed3bfb6SBarry Smith .  step - current time-step
52210ed3bfb6SBarry Smith .  ptime - current time
52220ed3bfb6SBarry Smith -  dummy - either a viewer or NULL
52230ed3bfb6SBarry Smith 
52240ed3bfb6SBarry Smith    Options Database:
52250ed3bfb6SBarry Smith .  -ts_monitor_draw_solution_function - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
52260ed3bfb6SBarry Smith 
52270ed3bfb6SBarry Smith    Level: intermediate
52280ed3bfb6SBarry Smith 
52290ed3bfb6SBarry Smith .keywords: TS,  vector, monitor, view
52300ed3bfb6SBarry Smith 
52310ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
52320ed3bfb6SBarry Smith @*/
52330ed3bfb6SBarry Smith PetscErrorCode  TSMonitorDrawSolutionFunction(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
52340ed3bfb6SBarry Smith {
52350ed3bfb6SBarry Smith   PetscErrorCode   ierr;
52360ed3bfb6SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
52370ed3bfb6SBarry Smith   PetscViewer      viewer = ctx->viewer;
52380ed3bfb6SBarry Smith   Vec              work;
52390ed3bfb6SBarry Smith 
52400ed3bfb6SBarry Smith   PetscFunctionBegin;
52410ed3bfb6SBarry Smith   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
52420ed3bfb6SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
52430ed3bfb6SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
52440ed3bfb6SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
52450ed3bfb6SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
52460ed3bfb6SBarry Smith   PetscFunctionReturn(0);
52470ed3bfb6SBarry Smith }
52480ed3bfb6SBarry Smith 
52490ed3bfb6SBarry Smith /*@C
525083a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
52513a471f94SBarry Smith    VecView() for the error at each timestep
52523a471f94SBarry Smith 
52533a471f94SBarry Smith    Collective on TS
52543a471f94SBarry Smith 
52553a471f94SBarry Smith    Input Parameters:
52563a471f94SBarry Smith +  ts - the TS context
52573a471f94SBarry Smith .  step - current time-step
52583a471f94SBarry Smith .  ptime - current time
52590298fd71SBarry Smith -  dummy - either a viewer or NULL
52603a471f94SBarry Smith 
52610ed3bfb6SBarry Smith    Options Database:
52620ed3bfb6SBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
52630ed3bfb6SBarry Smith 
52643a471f94SBarry Smith    Level: intermediate
52653a471f94SBarry Smith 
52663a471f94SBarry Smith .keywords: TS,  vector, monitor, view
52673a471f94SBarry Smith 
52680ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
52693a471f94SBarry Smith @*/
52700910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
52713a471f94SBarry Smith {
52723a471f94SBarry Smith   PetscErrorCode   ierr;
527383a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
527483a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
52753a471f94SBarry Smith   Vec              work;
52763a471f94SBarry Smith 
52773a471f94SBarry Smith   PetscFunctionBegin;
5278b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
52790910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
52803a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
52810910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
52823a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
52833a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
52843a471f94SBarry Smith   PetscFunctionReturn(0);
52853a471f94SBarry Smith }
52863a471f94SBarry Smith 
5287af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
52886c699258SBarry Smith /*@
52892a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
52906c699258SBarry Smith 
52913f9fe445SBarry Smith    Logically Collective on TS and DM
52926c699258SBarry Smith 
52936c699258SBarry Smith    Input Parameters:
52942a808120SBarry Smith +  ts - the ODE integrator object
52952a808120SBarry Smith -  dm - the dm, cannot be NULL
52966c699258SBarry Smith 
52976c699258SBarry Smith    Level: intermediate
52986c699258SBarry Smith 
52996c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
53006c699258SBarry Smith @*/
53017087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
53026c699258SBarry Smith {
53036c699258SBarry Smith   PetscErrorCode ierr;
5304089b2837SJed Brown   SNES           snes;
5305942e3340SBarry Smith   DMTS           tsdm;
53066c699258SBarry Smith 
53076c699258SBarry Smith   PetscFunctionBegin;
53080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53092a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
531070663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
5311942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
53122a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
5313942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
5314942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
531524989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
531624989b8cSPeter Brune         tsdm->originaldm = dm;
531724989b8cSPeter Brune       }
531824989b8cSPeter Brune     }
53196bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
532024989b8cSPeter Brune   }
53216c699258SBarry Smith   ts->dm = dm;
5322bbd56ea5SKarl Rupp 
5323089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5324089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
53256c699258SBarry Smith   PetscFunctionReturn(0);
53266c699258SBarry Smith }
53276c699258SBarry Smith 
53286c699258SBarry Smith /*@
53296c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
53306c699258SBarry Smith 
53313f9fe445SBarry Smith    Not Collective
53326c699258SBarry Smith 
53336c699258SBarry Smith    Input Parameter:
53346c699258SBarry Smith . ts - the preconditioner context
53356c699258SBarry Smith 
53366c699258SBarry Smith    Output Parameter:
53376c699258SBarry Smith .  dm - the dm
53386c699258SBarry Smith 
53396c699258SBarry Smith    Level: intermediate
53406c699258SBarry Smith 
53416c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
53426c699258SBarry Smith @*/
53437087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
53446c699258SBarry Smith {
5345496e6a7aSJed Brown   PetscErrorCode ierr;
5346496e6a7aSJed Brown 
53476c699258SBarry Smith   PetscFunctionBegin;
53480700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5349496e6a7aSJed Brown   if (!ts->dm) {
5350ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
5351496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
5352496e6a7aSJed Brown   }
53536c699258SBarry Smith   *dm = ts->dm;
53546c699258SBarry Smith   PetscFunctionReturn(0);
53556c699258SBarry Smith }
53561713a123SBarry Smith 
53570f5c6efeSJed Brown /*@
53580f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
53590f5c6efeSJed Brown 
53603f9fe445SBarry Smith    Logically Collective on SNES
53610f5c6efeSJed Brown 
53620f5c6efeSJed Brown    Input Parameter:
5363d42a1c89SJed Brown + snes - nonlinear solver
53640910c330SBarry Smith . U - the current state at which to evaluate the residual
5365d42a1c89SJed Brown - ctx - user context, must be a TS
53660f5c6efeSJed Brown 
53670f5c6efeSJed Brown    Output Parameter:
53680f5c6efeSJed Brown . F - the nonlinear residual
53690f5c6efeSJed Brown 
53700f5c6efeSJed Brown    Notes:
53710f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
53720f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
53730f5c6efeSJed Brown 
53740f5c6efeSJed Brown    Level: advanced
53750f5c6efeSJed Brown 
53760f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
53770f5c6efeSJed Brown @*/
53780910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
53790f5c6efeSJed Brown {
53800f5c6efeSJed Brown   TS             ts = (TS)ctx;
53810f5c6efeSJed Brown   PetscErrorCode ierr;
53820f5c6efeSJed Brown 
53830f5c6efeSJed Brown   PetscFunctionBegin;
53840f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
53850910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
53860f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
53870f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
53880910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
53890f5c6efeSJed Brown   PetscFunctionReturn(0);
53900f5c6efeSJed Brown }
53910f5c6efeSJed Brown 
53920f5c6efeSJed Brown /*@
53930f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
53940f5c6efeSJed Brown 
53950f5c6efeSJed Brown    Collective on SNES
53960f5c6efeSJed Brown 
53970f5c6efeSJed Brown    Input Parameter:
53980f5c6efeSJed Brown + snes - nonlinear solver
53990910c330SBarry Smith . U - the current state at which to evaluate the residual
54000f5c6efeSJed Brown - ctx - user context, must be a TS
54010f5c6efeSJed Brown 
54020f5c6efeSJed Brown    Output Parameter:
54030f5c6efeSJed Brown + A - the Jacobian
54040f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
54050f5c6efeSJed Brown - flag - indicates any structure change in the matrix
54060f5c6efeSJed Brown 
54070f5c6efeSJed Brown    Notes:
54080f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
54090f5c6efeSJed Brown 
54100f5c6efeSJed Brown    Level: developer
54110f5c6efeSJed Brown 
54120f5c6efeSJed Brown .seealso: SNESSetJacobian()
54130f5c6efeSJed Brown @*/
5414d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
54150f5c6efeSJed Brown {
54160f5c6efeSJed Brown   TS             ts = (TS)ctx;
54170f5c6efeSJed Brown   PetscErrorCode ierr;
54180f5c6efeSJed Brown 
54190f5c6efeSJed Brown   PetscFunctionBegin;
54200f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
54210910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
54220f5c6efeSJed Brown   PetscValidPointer(A,3);
542394ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
54240f5c6efeSJed Brown   PetscValidPointer(B,4);
542594ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
54260f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
5427d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
54280f5c6efeSJed Brown   PetscFunctionReturn(0);
54290f5c6efeSJed Brown }
5430325fc9f4SBarry Smith 
54310e4ef248SJed Brown /*@C
54329ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
54330e4ef248SJed Brown 
54340e4ef248SJed Brown    Collective on TS
54350e4ef248SJed Brown 
54360e4ef248SJed Brown    Input Arguments:
54370e4ef248SJed Brown +  ts - time stepping context
54380e4ef248SJed Brown .  t - time at which to evaluate
54390910c330SBarry Smith .  U - state at which to evaluate
54400e4ef248SJed Brown -  ctx - context
54410e4ef248SJed Brown 
54420e4ef248SJed Brown    Output Arguments:
54430e4ef248SJed Brown .  F - right hand side
54440e4ef248SJed Brown 
54450e4ef248SJed Brown    Level: intermediate
54460e4ef248SJed Brown 
54470e4ef248SJed Brown    Notes:
54480e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
54490e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
54500e4ef248SJed Brown 
54510e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
54520e4ef248SJed Brown @*/
54530910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
54540e4ef248SJed Brown {
54550e4ef248SJed Brown   PetscErrorCode ierr;
54560e4ef248SJed Brown   Mat            Arhs,Brhs;
54570e4ef248SJed Brown 
54580e4ef248SJed Brown   PetscFunctionBegin;
54590e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
5460d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
54610910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
54620e4ef248SJed Brown   PetscFunctionReturn(0);
54630e4ef248SJed Brown }
54640e4ef248SJed Brown 
54650e4ef248SJed Brown /*@C
54660e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
54670e4ef248SJed Brown 
54680e4ef248SJed Brown    Collective on TS
54690e4ef248SJed Brown 
54700e4ef248SJed Brown    Input Arguments:
54710e4ef248SJed Brown +  ts - time stepping context
54720e4ef248SJed Brown .  t - time at which to evaluate
54730910c330SBarry Smith .  U - state at which to evaluate
54740e4ef248SJed Brown -  ctx - context
54750e4ef248SJed Brown 
54760e4ef248SJed Brown    Output Arguments:
54770e4ef248SJed Brown +  A - pointer to operator
54780e4ef248SJed Brown .  B - pointer to preconditioning matrix
54790e4ef248SJed Brown -  flg - matrix structure flag
54800e4ef248SJed Brown 
54810e4ef248SJed Brown    Level: intermediate
54820e4ef248SJed Brown 
54830e4ef248SJed Brown    Notes:
54840e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
54850e4ef248SJed Brown 
54860e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
54870e4ef248SJed Brown @*/
5488d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
54890e4ef248SJed Brown {
54900e4ef248SJed Brown   PetscFunctionBegin;
54910e4ef248SJed Brown   PetscFunctionReturn(0);
54920e4ef248SJed Brown }
54930e4ef248SJed Brown 
54940026cea9SSean Farley /*@C
54950026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
54960026cea9SSean Farley 
54970026cea9SSean Farley    Collective on TS
54980026cea9SSean Farley 
54990026cea9SSean Farley    Input Arguments:
55000026cea9SSean Farley +  ts - time stepping context
55010026cea9SSean Farley .  t - time at which to evaluate
55020910c330SBarry Smith .  U - state at which to evaluate
55030910c330SBarry Smith .  Udot - time derivative of state vector
55040026cea9SSean Farley -  ctx - context
55050026cea9SSean Farley 
55060026cea9SSean Farley    Output Arguments:
55070026cea9SSean Farley .  F - left hand side
55080026cea9SSean Farley 
55090026cea9SSean Farley    Level: intermediate
55100026cea9SSean Farley 
55110026cea9SSean Farley    Notes:
55120910c330SBarry 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
55130026cea9SSean Farley    user is required to write their own TSComputeIFunction.
55140026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
55150026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
55160026cea9SSean Farley 
55179ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
55189ae8fd06SBarry Smith 
55199ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
55200026cea9SSean Farley @*/
55210910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
55220026cea9SSean Farley {
55230026cea9SSean Farley   PetscErrorCode ierr;
55240026cea9SSean Farley   Mat            A,B;
55250026cea9SSean Farley 
55260026cea9SSean Farley   PetscFunctionBegin;
55270298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
5528d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
55290910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
55300026cea9SSean Farley   PetscFunctionReturn(0);
55310026cea9SSean Farley }
55320026cea9SSean Farley 
55330026cea9SSean Farley /*@C
5534b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
55350026cea9SSean Farley 
55360026cea9SSean Farley    Collective on TS
55370026cea9SSean Farley 
55380026cea9SSean Farley    Input Arguments:
55390026cea9SSean Farley +  ts - time stepping context
55400026cea9SSean Farley .  t - time at which to evaluate
55410910c330SBarry Smith .  U - state at which to evaluate
55420910c330SBarry Smith .  Udot - time derivative of state vector
55430026cea9SSean Farley .  shift - shift to apply
55440026cea9SSean Farley -  ctx - context
55450026cea9SSean Farley 
55460026cea9SSean Farley    Output Arguments:
55470026cea9SSean Farley +  A - pointer to operator
55480026cea9SSean Farley .  B - pointer to preconditioning matrix
55490026cea9SSean Farley -  flg - matrix structure flag
55500026cea9SSean Farley 
5551b41af12eSJed Brown    Level: advanced
55520026cea9SSean Farley 
55530026cea9SSean Farley    Notes:
55540026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
55550026cea9SSean Farley 
5556b41af12eSJed Brown    It is only appropriate for problems of the form
5557b41af12eSJed Brown 
5558b41af12eSJed Brown $     M Udot = F(U,t)
5559b41af12eSJed Brown 
5560b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
5561b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5562b41af12eSJed Brown   an implicit operator of the form
5563b41af12eSJed Brown 
5564b41af12eSJed Brown $    shift*M + J
5565b41af12eSJed Brown 
5566b41af12eSJed 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
5567b41af12eSJed Brown   a copy of M or reassemble it when requested.
5568b41af12eSJed Brown 
55690026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
55700026cea9SSean Farley @*/
5571d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
55720026cea9SSean Farley {
5573b41af12eSJed Brown   PetscErrorCode ierr;
5574b41af12eSJed Brown 
55750026cea9SSean Farley   PetscFunctionBegin;
557694ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
5577b41af12eSJed Brown   ts->ijacobian.shift = shift;
55780026cea9SSean Farley   PetscFunctionReturn(0);
55790026cea9SSean Farley }
5580b41af12eSJed Brown 
5581e817cc15SEmil Constantinescu /*@
5582e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
5583e817cc15SEmil Constantinescu 
5584e817cc15SEmil Constantinescu    Not Collective
5585e817cc15SEmil Constantinescu 
5586e817cc15SEmil Constantinescu    Input Parameter:
5587e817cc15SEmil Constantinescu .  ts - the TS context
5588e817cc15SEmil Constantinescu 
5589e817cc15SEmil Constantinescu    Output Parameter:
55904e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
5591e817cc15SEmil Constantinescu 
5592e817cc15SEmil Constantinescu    Level: beginner
5593e817cc15SEmil Constantinescu 
5594e817cc15SEmil Constantinescu .keywords: TS, equation type
5595e817cc15SEmil Constantinescu 
5596e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
5597e817cc15SEmil Constantinescu @*/
5598e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
5599e817cc15SEmil Constantinescu {
5600e817cc15SEmil Constantinescu   PetscFunctionBegin;
5601e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5602e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
5603e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
5604e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5605e817cc15SEmil Constantinescu }
5606e817cc15SEmil Constantinescu 
5607e817cc15SEmil Constantinescu /*@
5608e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
5609e817cc15SEmil Constantinescu 
5610e817cc15SEmil Constantinescu    Not Collective
5611e817cc15SEmil Constantinescu 
5612e817cc15SEmil Constantinescu    Input Parameter:
5613e817cc15SEmil Constantinescu +  ts - the TS context
56141297b224SEmil Constantinescu -  equation_type - see TSEquationType
5615e817cc15SEmil Constantinescu 
5616e817cc15SEmil Constantinescu    Level: advanced
5617e817cc15SEmil Constantinescu 
5618e817cc15SEmil Constantinescu .keywords: TS, equation type
5619e817cc15SEmil Constantinescu 
5620e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
5621e817cc15SEmil Constantinescu @*/
5622e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
5623e817cc15SEmil Constantinescu {
5624e817cc15SEmil Constantinescu   PetscFunctionBegin;
5625e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5626e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
5627e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5628e817cc15SEmil Constantinescu }
56290026cea9SSean Farley 
56304af1b03aSJed Brown /*@
56314af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
56324af1b03aSJed Brown 
56334af1b03aSJed Brown    Not Collective
56344af1b03aSJed Brown 
56354af1b03aSJed Brown    Input Parameter:
56364af1b03aSJed Brown .  ts - the TS context
56374af1b03aSJed Brown 
56384af1b03aSJed Brown    Output Parameter:
56394af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
56404af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
56414af1b03aSJed Brown 
5642487e0bb9SJed Brown    Level: beginner
56434af1b03aSJed Brown 
5644cd652676SJed Brown    Notes:
5645cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
56464af1b03aSJed Brown 
56474af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
56484af1b03aSJed Brown 
56494af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
56504af1b03aSJed Brown @*/
56514af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
56524af1b03aSJed Brown {
56534af1b03aSJed Brown   PetscFunctionBegin;
56544af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
56554af1b03aSJed Brown   PetscValidPointer(reason,2);
56564af1b03aSJed Brown   *reason = ts->reason;
56574af1b03aSJed Brown   PetscFunctionReturn(0);
56584af1b03aSJed Brown }
56594af1b03aSJed Brown 
5660d6ad946cSShri Abhyankar /*@
5661d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5662d6ad946cSShri Abhyankar 
5663d6ad946cSShri Abhyankar    Not Collective
5664d6ad946cSShri Abhyankar 
5665d6ad946cSShri Abhyankar    Input Parameter:
5666d6ad946cSShri Abhyankar +  ts - the TS context
5667d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5668d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
5669d6ad946cSShri Abhyankar 
5670f5abba47SShri Abhyankar    Level: advanced
5671d6ad946cSShri Abhyankar 
5672d6ad946cSShri Abhyankar    Notes:
5673d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
5674d6ad946cSShri Abhyankar 
5675d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
5676d6ad946cSShri Abhyankar 
5677d6ad946cSShri Abhyankar .seealso: TSConvergedReason
5678d6ad946cSShri Abhyankar @*/
5679d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
5680d6ad946cSShri Abhyankar {
5681d6ad946cSShri Abhyankar   PetscFunctionBegin;
5682d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5683d6ad946cSShri Abhyankar   ts->reason = reason;
5684d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
5685d6ad946cSShri Abhyankar }
5686d6ad946cSShri Abhyankar 
5687cc708dedSBarry Smith /*@
5688cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
5689cc708dedSBarry Smith 
5690cc708dedSBarry Smith    Not Collective
5691cc708dedSBarry Smith 
5692cc708dedSBarry Smith    Input Parameter:
5693cc708dedSBarry Smith .  ts - the TS context
5694cc708dedSBarry Smith 
5695cc708dedSBarry Smith    Output Parameter:
569619eac22cSLisandro Dalcin .  ftime - the final time. This time corresponds to the final time set with TSSetMaxTime()
5697cc708dedSBarry Smith 
5698487e0bb9SJed Brown    Level: beginner
5699cc708dedSBarry Smith 
5700cc708dedSBarry Smith    Notes:
5701cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
5702cc708dedSBarry Smith 
5703cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
5704cc708dedSBarry Smith 
5705cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
5706cc708dedSBarry Smith @*/
5707cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
5708cc708dedSBarry Smith {
5709cc708dedSBarry Smith   PetscFunctionBegin;
5710cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5711cc708dedSBarry Smith   PetscValidPointer(ftime,2);
5712cc708dedSBarry Smith   *ftime = ts->solvetime;
5713cc708dedSBarry Smith   PetscFunctionReturn(0);
5714cc708dedSBarry Smith }
5715cc708dedSBarry Smith 
57162c18e0fdSBarry Smith /*@
57175ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
57189f67acb7SJed Brown    used by the time integrator.
57199f67acb7SJed Brown 
57209f67acb7SJed Brown    Not Collective
57219f67acb7SJed Brown 
57229f67acb7SJed Brown    Input Parameter:
57239f67acb7SJed Brown .  ts - TS context
57249f67acb7SJed Brown 
57259f67acb7SJed Brown    Output Parameter:
57269f67acb7SJed Brown .  nits - number of nonlinear iterations
57279f67acb7SJed Brown 
57289f67acb7SJed Brown    Notes:
57299f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
57309f67acb7SJed Brown 
57319f67acb7SJed Brown    Level: intermediate
57329f67acb7SJed Brown 
57339f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
57349f67acb7SJed Brown 
57355ef26d82SJed Brown .seealso:  TSGetKSPIterations()
57369f67acb7SJed Brown @*/
57375ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
57389f67acb7SJed Brown {
57399f67acb7SJed Brown   PetscFunctionBegin;
57409f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
57419f67acb7SJed Brown   PetscValidIntPointer(nits,2);
57425ef26d82SJed Brown   *nits = ts->snes_its;
57439f67acb7SJed Brown   PetscFunctionReturn(0);
57449f67acb7SJed Brown }
57459f67acb7SJed Brown 
57469f67acb7SJed Brown /*@
57475ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
57489f67acb7SJed Brown    used by the time integrator.
57499f67acb7SJed Brown 
57509f67acb7SJed Brown    Not Collective
57519f67acb7SJed Brown 
57529f67acb7SJed Brown    Input Parameter:
57539f67acb7SJed Brown .  ts - TS context
57549f67acb7SJed Brown 
57559f67acb7SJed Brown    Output Parameter:
57569f67acb7SJed Brown .  lits - number of linear iterations
57579f67acb7SJed Brown 
57589f67acb7SJed Brown    Notes:
57599f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
57609f67acb7SJed Brown 
57619f67acb7SJed Brown    Level: intermediate
57629f67acb7SJed Brown 
57639f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
57649f67acb7SJed Brown 
57655ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
57669f67acb7SJed Brown @*/
57675ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
57689f67acb7SJed Brown {
57699f67acb7SJed Brown   PetscFunctionBegin;
57709f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
57719f67acb7SJed Brown   PetscValidIntPointer(lits,2);
57725ef26d82SJed Brown   *lits = ts->ksp_its;
57739f67acb7SJed Brown   PetscFunctionReturn(0);
57749f67acb7SJed Brown }
57759f67acb7SJed Brown 
5776cef5090cSJed Brown /*@
5777cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5778cef5090cSJed Brown 
5779cef5090cSJed Brown    Not Collective
5780cef5090cSJed Brown 
5781cef5090cSJed Brown    Input Parameter:
5782cef5090cSJed Brown .  ts - TS context
5783cef5090cSJed Brown 
5784cef5090cSJed Brown    Output Parameter:
5785cef5090cSJed Brown .  rejects - number of steps rejected
5786cef5090cSJed Brown 
5787cef5090cSJed Brown    Notes:
5788cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5789cef5090cSJed Brown 
5790cef5090cSJed Brown    Level: intermediate
5791cef5090cSJed Brown 
5792cef5090cSJed Brown .keywords: TS, get, number
5793cef5090cSJed Brown 
57945ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5795cef5090cSJed Brown @*/
5796cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5797cef5090cSJed Brown {
5798cef5090cSJed Brown   PetscFunctionBegin;
5799cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5800cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5801cef5090cSJed Brown   *rejects = ts->reject;
5802cef5090cSJed Brown   PetscFunctionReturn(0);
5803cef5090cSJed Brown }
5804cef5090cSJed Brown 
5805cef5090cSJed Brown /*@
5806cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5807cef5090cSJed Brown 
5808cef5090cSJed Brown    Not Collective
5809cef5090cSJed Brown 
5810cef5090cSJed Brown    Input Parameter:
5811cef5090cSJed Brown .  ts - TS context
5812cef5090cSJed Brown 
5813cef5090cSJed Brown    Output Parameter:
5814cef5090cSJed Brown .  fails - number of failed nonlinear solves
5815cef5090cSJed Brown 
5816cef5090cSJed Brown    Notes:
5817cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5818cef5090cSJed Brown 
5819cef5090cSJed Brown    Level: intermediate
5820cef5090cSJed Brown 
5821cef5090cSJed Brown .keywords: TS, get, number
5822cef5090cSJed Brown 
58235ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5824cef5090cSJed Brown @*/
5825cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5826cef5090cSJed Brown {
5827cef5090cSJed Brown   PetscFunctionBegin;
5828cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5829cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5830cef5090cSJed Brown   *fails = ts->num_snes_failures;
5831cef5090cSJed Brown   PetscFunctionReturn(0);
5832cef5090cSJed Brown }
5833cef5090cSJed Brown 
5834cef5090cSJed Brown /*@
5835cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5836cef5090cSJed Brown 
5837cef5090cSJed Brown    Not Collective
5838cef5090cSJed Brown 
5839cef5090cSJed Brown    Input Parameter:
5840cef5090cSJed Brown +  ts - TS context
5841cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5842cef5090cSJed Brown 
5843cef5090cSJed Brown    Notes:
5844cef5090cSJed Brown    The counter is reset to zero for each step
5845cef5090cSJed Brown 
5846cef5090cSJed Brown    Options Database Key:
5847cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5848cef5090cSJed Brown 
5849cef5090cSJed Brown    Level: intermediate
5850cef5090cSJed Brown 
5851cef5090cSJed Brown .keywords: TS, set, maximum, number
5852cef5090cSJed Brown 
58535ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5854cef5090cSJed Brown @*/
5855cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5856cef5090cSJed Brown {
5857cef5090cSJed Brown   PetscFunctionBegin;
5858cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5859cef5090cSJed Brown   ts->max_reject = rejects;
5860cef5090cSJed Brown   PetscFunctionReturn(0);
5861cef5090cSJed Brown }
5862cef5090cSJed Brown 
5863cef5090cSJed Brown /*@
5864cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5865cef5090cSJed Brown 
5866cef5090cSJed Brown    Not Collective
5867cef5090cSJed Brown 
5868cef5090cSJed Brown    Input Parameter:
5869cef5090cSJed Brown +  ts - TS context
5870cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5871cef5090cSJed Brown 
5872cef5090cSJed Brown    Notes:
5873cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5874cef5090cSJed Brown 
5875cef5090cSJed Brown    Options Database Key:
5876cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5877cef5090cSJed Brown 
5878cef5090cSJed Brown    Level: intermediate
5879cef5090cSJed Brown 
5880cef5090cSJed Brown .keywords: TS, set, maximum, number
5881cef5090cSJed Brown 
58825ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5883cef5090cSJed Brown @*/
5884cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5885cef5090cSJed Brown {
5886cef5090cSJed Brown   PetscFunctionBegin;
5887cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5888cef5090cSJed Brown   ts->max_snes_failures = fails;
5889cef5090cSJed Brown   PetscFunctionReturn(0);
5890cef5090cSJed Brown }
5891cef5090cSJed Brown 
5892cef5090cSJed Brown /*@
5893cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5894cef5090cSJed Brown 
5895cef5090cSJed Brown    Not Collective
5896cef5090cSJed Brown 
5897cef5090cSJed Brown    Input Parameter:
5898cef5090cSJed Brown +  ts - TS context
5899cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5900cef5090cSJed Brown 
5901cef5090cSJed Brown    Options Database Key:
5902cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5903cef5090cSJed Brown 
5904cef5090cSJed Brown    Level: intermediate
5905cef5090cSJed Brown 
5906cef5090cSJed Brown .keywords: TS, set, error
5907cef5090cSJed Brown 
59085ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5909cef5090cSJed Brown @*/
5910cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5911cef5090cSJed Brown {
5912cef5090cSJed Brown   PetscFunctionBegin;
5913cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5914cef5090cSJed Brown   ts->errorifstepfailed = err;
5915cef5090cSJed Brown   PetscFunctionReturn(0);
5916cef5090cSJed Brown }
5917cef5090cSJed Brown 
5918fb1732b5SBarry Smith /*@C
5919fde5950dSBarry 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
5920fb1732b5SBarry Smith 
5921fb1732b5SBarry Smith    Collective on TS
5922fb1732b5SBarry Smith 
5923fb1732b5SBarry Smith    Input Parameters:
5924fb1732b5SBarry Smith +  ts - the TS context
5925fb1732b5SBarry Smith .  step - current time-step
5926fb1732b5SBarry Smith .  ptime - current time
59270910c330SBarry Smith .  u - current state
5928721cd6eeSBarry Smith -  vf - viewer and its format
5929fb1732b5SBarry Smith 
5930fb1732b5SBarry Smith    Level: intermediate
5931fb1732b5SBarry Smith 
5932fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
5933fb1732b5SBarry Smith 
5934fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5935fb1732b5SBarry Smith @*/
5936721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5937fb1732b5SBarry Smith {
5938fb1732b5SBarry Smith   PetscErrorCode ierr;
5939fb1732b5SBarry Smith 
5940fb1732b5SBarry Smith   PetscFunctionBegin;
5941721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5942721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5943721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5944ed81e22dSJed Brown   PetscFunctionReturn(0);
5945ed81e22dSJed Brown }
5946ed81e22dSJed Brown 
5947ed81e22dSJed Brown /*@C
5948ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5949ed81e22dSJed Brown 
5950ed81e22dSJed Brown    Collective on TS
5951ed81e22dSJed Brown 
5952ed81e22dSJed Brown    Input Parameters:
5953ed81e22dSJed Brown +  ts - the TS context
5954ed81e22dSJed Brown .  step - current time-step
5955ed81e22dSJed Brown .  ptime - current time
59560910c330SBarry Smith .  u - current state
5957ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5958ed81e22dSJed Brown 
5959ed81e22dSJed Brown    Level: intermediate
5960ed81e22dSJed Brown 
5961ed81e22dSJed Brown    Notes:
5962ed81e22dSJed 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.
5963ed81e22dSJed Brown    These are named according to the file name template.
5964ed81e22dSJed Brown 
5965ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5966ed81e22dSJed Brown 
5967ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5968ed81e22dSJed Brown 
5969ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5970ed81e22dSJed Brown @*/
59710910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5972ed81e22dSJed Brown {
5973ed81e22dSJed Brown   PetscErrorCode ierr;
5974ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5975ed81e22dSJed Brown   PetscViewer    viewer;
5976ed81e22dSJed Brown 
5977ed81e22dSJed Brown   PetscFunctionBegin;
597863e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
59798caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5980ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
59810910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5982ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5983ed81e22dSJed Brown   PetscFunctionReturn(0);
5984ed81e22dSJed Brown }
5985ed81e22dSJed Brown 
5986ed81e22dSJed Brown /*@C
5987ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5988ed81e22dSJed Brown 
5989ed81e22dSJed Brown    Collective on TS
5990ed81e22dSJed Brown 
5991ed81e22dSJed Brown    Input Parameters:
5992ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5993ed81e22dSJed Brown 
5994ed81e22dSJed Brown    Level: intermediate
5995ed81e22dSJed Brown 
5996ed81e22dSJed Brown    Note:
5997ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5998ed81e22dSJed Brown 
5999ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
6000ed81e22dSJed Brown 
6001ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
6002ed81e22dSJed Brown @*/
6003ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
6004ed81e22dSJed Brown {
6005ed81e22dSJed Brown   PetscErrorCode ierr;
6006ed81e22dSJed Brown 
6007ed81e22dSJed Brown   PetscFunctionBegin;
6008ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
6009fb1732b5SBarry Smith   PetscFunctionReturn(0);
6010fb1732b5SBarry Smith }
6011fb1732b5SBarry Smith 
601284df9cb4SJed Brown /*@
6013552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
601484df9cb4SJed Brown 
6015ed81e22dSJed Brown    Collective on TS if controller has not been created yet
601684df9cb4SJed Brown 
601784df9cb4SJed Brown    Input Arguments:
6018ed81e22dSJed Brown .  ts - time stepping context
601984df9cb4SJed Brown 
602084df9cb4SJed Brown    Output Arguments:
6021ed81e22dSJed Brown .  adapt - adaptive controller
602284df9cb4SJed Brown 
602384df9cb4SJed Brown    Level: intermediate
602484df9cb4SJed Brown 
6025ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
602684df9cb4SJed Brown @*/
6027552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
602884df9cb4SJed Brown {
602984df9cb4SJed Brown   PetscErrorCode ierr;
603084df9cb4SJed Brown 
603184df9cb4SJed Brown   PetscFunctionBegin;
603284df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6033bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
603484df9cb4SJed Brown   if (!ts->adapt) {
6035ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
60363bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
60371c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
603884df9cb4SJed Brown   }
6039bec58848SLisandro Dalcin   *adapt = ts->adapt;
604084df9cb4SJed Brown   PetscFunctionReturn(0);
604184df9cb4SJed Brown }
6042d6ebe24aSShri Abhyankar 
60431c3436cfSJed Brown /*@
60441c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
60451c3436cfSJed Brown 
60461c3436cfSJed Brown    Logically Collective
60471c3436cfSJed Brown 
60481c3436cfSJed Brown    Input Arguments:
60491c3436cfSJed Brown +  ts - time integration context
60501c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
60510298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
60521c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
60530298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
60541c3436cfSJed Brown 
6055a3cdaa26SBarry Smith    Options Database keys:
6056a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
6057a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
6058a3cdaa26SBarry Smith 
60593ff766beSShri Abhyankar    Notes:
60603ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
60613ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
60623ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
60633ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
60643ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
60653ff766beSShri Abhyankar    differential variables.
60663ff766beSShri Abhyankar 
60671c3436cfSJed Brown    Level: beginner
60681c3436cfSJed Brown 
6069c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
60701c3436cfSJed Brown @*/
60711c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
60721c3436cfSJed Brown {
60731c3436cfSJed Brown   PetscErrorCode ierr;
60741c3436cfSJed Brown 
60751c3436cfSJed Brown   PetscFunctionBegin;
6076c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
60771c3436cfSJed Brown   if (vatol) {
60781c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
60791c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
60801c3436cfSJed Brown     ts->vatol = vatol;
60811c3436cfSJed Brown   }
6082c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
60831c3436cfSJed Brown   if (vrtol) {
60841c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
60851c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
60861c3436cfSJed Brown     ts->vrtol = vrtol;
60871c3436cfSJed Brown   }
60881c3436cfSJed Brown   PetscFunctionReturn(0);
60891c3436cfSJed Brown }
60901c3436cfSJed Brown 
6091c5033834SJed Brown /*@
6092c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
6093c5033834SJed Brown 
6094c5033834SJed Brown    Logically Collective
6095c5033834SJed Brown 
6096c5033834SJed Brown    Input Arguments:
6097c5033834SJed Brown .  ts - time integration context
6098c5033834SJed Brown 
6099c5033834SJed Brown    Output Arguments:
61000298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
61010298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
61020298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
61030298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
6104c5033834SJed Brown 
6105c5033834SJed Brown    Level: beginner
6106c5033834SJed Brown 
6107c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
6108c5033834SJed Brown @*/
6109c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
6110c5033834SJed Brown {
6111c5033834SJed Brown   PetscFunctionBegin;
6112c5033834SJed Brown   if (atol)  *atol  = ts->atol;
6113c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
6114c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
6115c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
6116c5033834SJed Brown   PetscFunctionReturn(0);
6117c5033834SJed Brown }
6118c5033834SJed Brown 
61199c6b16b5SShri Abhyankar /*@
6120a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
61219c6b16b5SShri Abhyankar 
61229c6b16b5SShri Abhyankar    Collective on TS
61239c6b16b5SShri Abhyankar 
61249c6b16b5SShri Abhyankar    Input Arguments:
61259c6b16b5SShri Abhyankar +  ts - time stepping context
6126a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6127a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
61289c6b16b5SShri Abhyankar 
61299c6b16b5SShri Abhyankar    Output Arguments:
61307453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
61317453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
61327453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
61339c6b16b5SShri Abhyankar 
61349c6b16b5SShri Abhyankar    Level: developer
61359c6b16b5SShri Abhyankar 
6136deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
61379c6b16b5SShri Abhyankar @*/
61387453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
61399c6b16b5SShri Abhyankar {
61409c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
61419c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
61427453f775SEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
61437453f775SEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
61449c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
61457453f775SEmil Constantinescu   PetscReal         sum,suma,sumr,gsum,gsuma,gsumr,diff;
61467453f775SEmil Constantinescu   PetscReal         tol,tola,tolr;
61477453f775SEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
61489c6b16b5SShri Abhyankar 
61499c6b16b5SShri Abhyankar   PetscFunctionBegin;
61509c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6151a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
6152a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
6153a4868fbcSLisandro Dalcin   PetscValidType(U,2);
6154a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
6155a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
6156a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
61578a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
61588a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
6159a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
61609c6b16b5SShri Abhyankar 
61619c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
61629c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
61639c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
61649c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
61659c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
61667453f775SEmil Constantinescu   sum  = 0.; n_loc  = 0;
61677453f775SEmil Constantinescu   suma = 0.; na_loc = 0;
61687453f775SEmil Constantinescu   sumr = 0.; nr_loc = 0;
61699c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
61709c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
61719c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61729c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61739c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
61747453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
61757453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
61767453f775SEmil Constantinescu       if(tola>0.){
61777453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
61787453f775SEmil Constantinescu         na_loc++;
61797453f775SEmil Constantinescu       }
61807453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61817453f775SEmil Constantinescu       if(tolr>0.){
61827453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
61837453f775SEmil Constantinescu         nr_loc++;
61847453f775SEmil Constantinescu       }
61857453f775SEmil Constantinescu       tol=tola+tolr;
61867453f775SEmil Constantinescu       if(tol>0.){
61877453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
61887453f775SEmil Constantinescu         n_loc++;
61897453f775SEmil Constantinescu       }
61909c6b16b5SShri Abhyankar     }
61919c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61929c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61939c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
61949c6b16b5SShri Abhyankar     const PetscScalar *atol;
61959c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61969c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
61977453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
61987453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
61997453f775SEmil Constantinescu       if(tola>0.){
62007453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
62017453f775SEmil Constantinescu         na_loc++;
62027453f775SEmil Constantinescu       }
62037453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62047453f775SEmil Constantinescu       if(tolr>0.){
62057453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
62067453f775SEmil Constantinescu         nr_loc++;
62077453f775SEmil Constantinescu       }
62087453f775SEmil Constantinescu       tol=tola+tolr;
62097453f775SEmil Constantinescu       if(tol>0.){
62107453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
62117453f775SEmil Constantinescu         n_loc++;
62127453f775SEmil Constantinescu       }
62139c6b16b5SShri Abhyankar     }
62149c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
62159c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
62169c6b16b5SShri Abhyankar     const PetscScalar *rtol;
62179c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62189c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
62197453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
62207453f775SEmil Constantinescu       tola = ts->atol;
62217453f775SEmil Constantinescu       if(tola>0.){
62227453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
62237453f775SEmil Constantinescu         na_loc++;
62247453f775SEmil Constantinescu       }
62257453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62267453f775SEmil Constantinescu       if(tolr>0.){
62277453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
62287453f775SEmil Constantinescu         nr_loc++;
62297453f775SEmil Constantinescu       }
62307453f775SEmil Constantinescu       tol=tola+tolr;
62317453f775SEmil Constantinescu       if(tol>0.){
62327453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
62337453f775SEmil Constantinescu         n_loc++;
62347453f775SEmil Constantinescu       }
62359c6b16b5SShri Abhyankar     }
62369c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62379c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
62389c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
62397453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
62407453f775SEmil Constantinescu      tola = ts->atol;
62417453f775SEmil Constantinescu       if(tola>0.){
62427453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
62437453f775SEmil Constantinescu         na_loc++;
62447453f775SEmil Constantinescu       }
62457453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62467453f775SEmil Constantinescu       if(tolr>0.){
62477453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
62487453f775SEmil Constantinescu         nr_loc++;
62497453f775SEmil Constantinescu       }
62507453f775SEmil Constantinescu       tol=tola+tolr;
62517453f775SEmil Constantinescu       if(tol>0.){
62527453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
62537453f775SEmil Constantinescu         n_loc++;
62547453f775SEmil Constantinescu       }
62559c6b16b5SShri Abhyankar     }
62569c6b16b5SShri Abhyankar   }
62579c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
62589c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
62599c6b16b5SShri Abhyankar 
62607453f775SEmil Constantinescu   err_loc[0] = sum;
62617453f775SEmil Constantinescu   err_loc[1] = suma;
62627453f775SEmil Constantinescu   err_loc[2] = sumr;
62637453f775SEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
62647453f775SEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
62657453f775SEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
62667453f775SEmil Constantinescu 
6267a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
62687453f775SEmil Constantinescu 
62697453f775SEmil Constantinescu   gsum   = err_glb[0];
62707453f775SEmil Constantinescu   gsuma  = err_glb[1];
62717453f775SEmil Constantinescu   gsumr  = err_glb[2];
62727453f775SEmil Constantinescu   n_glb  = err_glb[3];
62737453f775SEmil Constantinescu   na_glb = err_glb[4];
62747453f775SEmil Constantinescu   nr_glb = err_glb[5];
62757453f775SEmil Constantinescu 
6276b1316ef9SEmil Constantinescu   *norm  = 0.;
6277b1316ef9SEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
6278b1316ef9SEmil Constantinescu   *norma = 0.;
6279b1316ef9SEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
6280b1316ef9SEmil Constantinescu   *normr = 0.;
6281b1316ef9SEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
62829c6b16b5SShri Abhyankar 
62839c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
62847453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
62857453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
62869c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
62879c6b16b5SShri Abhyankar }
62889c6b16b5SShri Abhyankar 
62899c6b16b5SShri Abhyankar /*@
6290a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
62919c6b16b5SShri Abhyankar 
62929c6b16b5SShri Abhyankar    Collective on TS
62939c6b16b5SShri Abhyankar 
62949c6b16b5SShri Abhyankar    Input Arguments:
62959c6b16b5SShri Abhyankar +  ts - time stepping context
6296a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6297a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
62989c6b16b5SShri Abhyankar 
62999c6b16b5SShri Abhyankar    Output Arguments:
63007453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
63017453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
63027453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
63039c6b16b5SShri Abhyankar 
63049c6b16b5SShri Abhyankar    Level: developer
63059c6b16b5SShri Abhyankar 
6306deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
63079c6b16b5SShri Abhyankar @*/
63087453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
63099c6b16b5SShri Abhyankar {
63109c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
63117453f775SEmil Constantinescu   PetscInt          i,n,N,rstart;
63129c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
63137453f775SEmil Constantinescu   PetscReal         max,gmax,maxa,gmaxa,maxr,gmaxr;
63147453f775SEmil Constantinescu   PetscReal         tol,tola,tolr,diff;
63157453f775SEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
63169c6b16b5SShri Abhyankar 
63179c6b16b5SShri Abhyankar   PetscFunctionBegin;
63189c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6319a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
6320a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
6321a4868fbcSLisandro Dalcin   PetscValidType(U,2);
6322a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
6323a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
6324a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
63258a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
63268a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
6327a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
63289c6b16b5SShri Abhyankar 
63299c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
63309c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
63319c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
63329c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
63339c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
63347453f775SEmil Constantinescu 
63357453f775SEmil Constantinescu   max=0.;
63367453f775SEmil Constantinescu   maxa=0.;
63377453f775SEmil Constantinescu   maxr=0.;
63387453f775SEmil Constantinescu 
63397453f775SEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
63409c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
63419c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63429c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63437453f775SEmil Constantinescu 
63447453f775SEmil Constantinescu     for (i=0; i<n; i++) {
63457453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
63467453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
63477453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63487453f775SEmil Constantinescu       tol  = tola+tolr;
63497453f775SEmil Constantinescu       if(tola>0.){
63507453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
63517453f775SEmil Constantinescu       }
63527453f775SEmil Constantinescu       if(tolr>0.){
63537453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
63547453f775SEmil Constantinescu       }
63557453f775SEmil Constantinescu       if(tol>0.){
63567453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
63577453f775SEmil Constantinescu       }
63589c6b16b5SShri Abhyankar     }
63599c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63609c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63619c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
63629c6b16b5SShri Abhyankar     const PetscScalar *atol;
63639c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63647453f775SEmil Constantinescu     for (i=0; i<n; i++) {
63657453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
63667453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
63677453f775SEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63687453f775SEmil Constantinescu       tol  = tola+tolr;
63697453f775SEmil Constantinescu       if(tola>0.){
63707453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
63717453f775SEmil Constantinescu       }
63727453f775SEmil Constantinescu       if(tolr>0.){
63737453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
63747453f775SEmil Constantinescu       }
63757453f775SEmil Constantinescu       if(tol>0.){
63767453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
63777453f775SEmil Constantinescu       }
63789c6b16b5SShri Abhyankar     }
63799c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63809c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
63819c6b16b5SShri Abhyankar     const PetscScalar *rtol;
63829c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63837453f775SEmil Constantinescu 
63847453f775SEmil Constantinescu     for (i=0; i<n; i++) {
63857453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
63867453f775SEmil Constantinescu       tola = ts->atol;
63877453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63887453f775SEmil Constantinescu       tol  = tola+tolr;
63897453f775SEmil Constantinescu       if(tola>0.){
63907453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
63917453f775SEmil Constantinescu       }
63927453f775SEmil Constantinescu       if(tolr>0.){
63937453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
63947453f775SEmil Constantinescu       }
63957453f775SEmil Constantinescu       if(tol>0.){
63967453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
63977453f775SEmil Constantinescu       }
63989c6b16b5SShri Abhyankar     }
63999c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
64009c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
64017453f775SEmil Constantinescu 
64027453f775SEmil Constantinescu     for (i=0; i<n; i++) {
64037453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
64047453f775SEmil Constantinescu       tola = ts->atol;
64057453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
64067453f775SEmil Constantinescu       tol  = tola+tolr;
64077453f775SEmil Constantinescu       if(tola>0.){
64087453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
64097453f775SEmil Constantinescu       }
64107453f775SEmil Constantinescu       if(tolr>0.){
64117453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
64127453f775SEmil Constantinescu       }
64137453f775SEmil Constantinescu       if(tol>0.){
64147453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
64157453f775SEmil Constantinescu       }
64169c6b16b5SShri Abhyankar     }
64179c6b16b5SShri Abhyankar   }
64189c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
64199c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
64207453f775SEmil Constantinescu   err_loc[0] = max;
64217453f775SEmil Constantinescu   err_loc[1] = maxa;
64227453f775SEmil Constantinescu   err_loc[2] = maxr;
6423a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
64247453f775SEmil Constantinescu   gmax   = err_glb[0];
64257453f775SEmil Constantinescu   gmaxa  = err_glb[1];
64267453f775SEmil Constantinescu   gmaxr  = err_glb[2];
64279c6b16b5SShri Abhyankar 
64289c6b16b5SShri Abhyankar   *norm = gmax;
64297453f775SEmil Constantinescu   *norma = gmaxa;
64307453f775SEmil Constantinescu   *normr = gmaxr;
64319c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
64327453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
64337453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
64349c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
64359c6b16b5SShri Abhyankar }
64369c6b16b5SShri Abhyankar 
64371c3436cfSJed Brown /*@
64388a175baeSEmil Constantinescu    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
64391c3436cfSJed Brown 
64401c3436cfSJed Brown    Collective on TS
64411c3436cfSJed Brown 
64421c3436cfSJed Brown    Input Arguments:
64431c3436cfSJed Brown +  ts - time stepping context
6444a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6445a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
6446a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
64477619abb3SShri 
64481c3436cfSJed Brown    Output Arguments:
64498a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
64508a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
64518a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
6452a4868fbcSLisandro Dalcin 
6453a4868fbcSLisandro Dalcin    Options Database Keys:
6454a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
6455a4868fbcSLisandro Dalcin 
64561c3436cfSJed Brown    Level: developer
64571c3436cfSJed Brown 
64588a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm
64591c3436cfSJed Brown @*/
64607453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
64611c3436cfSJed Brown {
64628beabaa1SBarry Smith   PetscErrorCode ierr;
64631c3436cfSJed Brown 
64641c3436cfSJed Brown   PetscFunctionBegin;
6465a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
64667453f775SEmil Constantinescu     ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6467a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
64687453f775SEmil Constantinescu     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6469a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
64701c3436cfSJed Brown   PetscFunctionReturn(0);
64711c3436cfSJed Brown }
64721c3436cfSJed Brown 
64738a175baeSEmil Constantinescu 
64748a175baeSEmil Constantinescu /*@
64758a175baeSEmil Constantinescu    TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances
64768a175baeSEmil Constantinescu 
64778a175baeSEmil Constantinescu    Collective on TS
64788a175baeSEmil Constantinescu 
64798a175baeSEmil Constantinescu    Input Arguments:
64808a175baeSEmil Constantinescu +  ts - time stepping context
64818a175baeSEmil Constantinescu .  E - error vector
64828a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
64838a175baeSEmil Constantinescu -  Y - state vector, previous time step
64848a175baeSEmil Constantinescu 
64858a175baeSEmil Constantinescu    Output Arguments:
64868a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
64878a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
64888a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
64898a175baeSEmil Constantinescu 
64908a175baeSEmil Constantinescu    Level: developer
64918a175baeSEmil Constantinescu 
64928a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity()
64938a175baeSEmil Constantinescu @*/
64948a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
64958a175baeSEmil Constantinescu {
64968a175baeSEmil Constantinescu   PetscErrorCode    ierr;
64978a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
64988a175baeSEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
64998a175baeSEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
65008a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
65018a175baeSEmil Constantinescu   PetscReal         err,sum,suma,sumr,gsum,gsuma,gsumr;
65028a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
65038a175baeSEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
65048a175baeSEmil Constantinescu 
65058a175baeSEmil Constantinescu   PetscFunctionBegin;
65068a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
65078a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
65088a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
65098a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
65108a175baeSEmil Constantinescu   PetscValidType(E,2);
65118a175baeSEmil Constantinescu   PetscValidType(U,3);
65128a175baeSEmil Constantinescu   PetscValidType(Y,4);
65138a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
65148a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
65158a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
65168a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
65178a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
65188a175baeSEmil Constantinescu 
65198a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
65208a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
65218a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
65228a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
65238a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
65248a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
65258a175baeSEmil Constantinescu   sum  = 0.; n_loc  = 0;
65268a175baeSEmil Constantinescu   suma = 0.; na_loc = 0;
65278a175baeSEmil Constantinescu   sumr = 0.; nr_loc = 0;
65288a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {
65298a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
65308a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65318a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65328a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65338a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65348a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
65358a175baeSEmil Constantinescu       if(tola>0.){
65368a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
65378a175baeSEmil Constantinescu         na_loc++;
65388a175baeSEmil Constantinescu       }
65398a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65408a175baeSEmil Constantinescu       if(tolr>0.){
65418a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
65428a175baeSEmil Constantinescu         nr_loc++;
65438a175baeSEmil Constantinescu       }
65448a175baeSEmil Constantinescu       tol=tola+tolr;
65458a175baeSEmil Constantinescu       if(tol>0.){
65468a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
65478a175baeSEmil Constantinescu         n_loc++;
65488a175baeSEmil Constantinescu       }
65498a175baeSEmil Constantinescu     }
65508a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65518a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65528a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
65538a175baeSEmil Constantinescu     const PetscScalar *atol;
65548a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65558a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65568a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65578a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
65588a175baeSEmil Constantinescu       if(tola>0.){
65598a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
65608a175baeSEmil Constantinescu         na_loc++;
65618a175baeSEmil Constantinescu       }
65628a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65638a175baeSEmil Constantinescu       if(tolr>0.){
65648a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
65658a175baeSEmil Constantinescu         nr_loc++;
65668a175baeSEmil Constantinescu       }
65678a175baeSEmil Constantinescu       tol=tola+tolr;
65688a175baeSEmil Constantinescu       if(tol>0.){
65698a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
65708a175baeSEmil Constantinescu         n_loc++;
65718a175baeSEmil Constantinescu       }
65728a175baeSEmil Constantinescu     }
65738a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65748a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
65758a175baeSEmil Constantinescu     const PetscScalar *rtol;
65768a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65778a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65788a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65798a175baeSEmil Constantinescu       tola = ts->atol;
65808a175baeSEmil Constantinescu       if(tola>0.){
65818a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
65828a175baeSEmil Constantinescu         na_loc++;
65838a175baeSEmil Constantinescu       }
65848a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65858a175baeSEmil Constantinescu       if(tolr>0.){
65868a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
65878a175baeSEmil Constantinescu         nr_loc++;
65888a175baeSEmil Constantinescu       }
65898a175baeSEmil Constantinescu       tol=tola+tolr;
65908a175baeSEmil Constantinescu       if(tol>0.){
65918a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
65928a175baeSEmil Constantinescu         n_loc++;
65938a175baeSEmil Constantinescu       }
65948a175baeSEmil Constantinescu     }
65958a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65968a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
65978a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65988a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65998a175baeSEmil Constantinescu      tola = ts->atol;
66008a175baeSEmil Constantinescu       if(tola>0.){
66018a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
66028a175baeSEmil Constantinescu         na_loc++;
66038a175baeSEmil Constantinescu       }
66048a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
66058a175baeSEmil Constantinescu       if(tolr>0.){
66068a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
66078a175baeSEmil Constantinescu         nr_loc++;
66088a175baeSEmil Constantinescu       }
66098a175baeSEmil Constantinescu       tol=tola+tolr;
66108a175baeSEmil Constantinescu       if(tol>0.){
66118a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
66128a175baeSEmil Constantinescu         n_loc++;
66138a175baeSEmil Constantinescu       }
66148a175baeSEmil Constantinescu     }
66158a175baeSEmil Constantinescu   }
66168a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
66178a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
66188a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
66198a175baeSEmil Constantinescu 
66208a175baeSEmil Constantinescu   err_loc[0] = sum;
66218a175baeSEmil Constantinescu   err_loc[1] = suma;
66228a175baeSEmil Constantinescu   err_loc[2] = sumr;
66238a175baeSEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
66248a175baeSEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
66258a175baeSEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
66268a175baeSEmil Constantinescu 
6627a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
66288a175baeSEmil Constantinescu 
66298a175baeSEmil Constantinescu   gsum   = err_glb[0];
66308a175baeSEmil Constantinescu   gsuma  = err_glb[1];
66318a175baeSEmil Constantinescu   gsumr  = err_glb[2];
66328a175baeSEmil Constantinescu   n_glb  = err_glb[3];
66338a175baeSEmil Constantinescu   na_glb = err_glb[4];
66348a175baeSEmil Constantinescu   nr_glb = err_glb[5];
66358a175baeSEmil Constantinescu 
66368a175baeSEmil Constantinescu   *norm  = 0.;
66378a175baeSEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
66388a175baeSEmil Constantinescu   *norma = 0.;
66398a175baeSEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
66408a175baeSEmil Constantinescu   *normr = 0.;
66418a175baeSEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
66428a175baeSEmil Constantinescu 
66438a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
66448a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
66458a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
66468a175baeSEmil Constantinescu   PetscFunctionReturn(0);
66478a175baeSEmil Constantinescu }
66488a175baeSEmil Constantinescu 
66498a175baeSEmil Constantinescu /*@
66508a175baeSEmil Constantinescu    TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances
66518a175baeSEmil Constantinescu    Collective on TS
66528a175baeSEmil Constantinescu 
66538a175baeSEmil Constantinescu    Input Arguments:
66548a175baeSEmil Constantinescu +  ts - time stepping context
66558a175baeSEmil Constantinescu .  E - error vector
66568a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
66578a175baeSEmil Constantinescu -  Y - state vector, previous time step
66588a175baeSEmil Constantinescu 
66598a175baeSEmil Constantinescu    Output Arguments:
66608a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
66618a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
66628a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
66638a175baeSEmil Constantinescu 
66648a175baeSEmil Constantinescu    Level: developer
66658a175baeSEmil Constantinescu 
66668a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2()
66678a175baeSEmil Constantinescu @*/
66688a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
66698a175baeSEmil Constantinescu {
66708a175baeSEmil Constantinescu   PetscErrorCode    ierr;
66718a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
66728a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
66738a175baeSEmil Constantinescu   PetscReal         err,max,gmax,maxa,gmaxa,maxr,gmaxr;
66748a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
66758a175baeSEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
66768a175baeSEmil Constantinescu 
66778a175baeSEmil Constantinescu   PetscFunctionBegin;
66788a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
66798a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
66808a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
66818a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
66828a175baeSEmil Constantinescu   PetscValidType(E,2);
66838a175baeSEmil Constantinescu   PetscValidType(U,3);
66848a175baeSEmil Constantinescu   PetscValidType(Y,4);
66858a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
66868a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
66878a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
66888a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
66898a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
66908a175baeSEmil Constantinescu 
66918a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
66928a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
66938a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
66948a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
66958a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
66968a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
66978a175baeSEmil Constantinescu 
66988a175baeSEmil Constantinescu   max=0.;
66998a175baeSEmil Constantinescu   maxa=0.;
67008a175baeSEmil Constantinescu   maxr=0.;
67018a175baeSEmil Constantinescu 
67028a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
67038a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
67048a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67058a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67068a175baeSEmil Constantinescu 
67078a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67088a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67098a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
67108a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67118a175baeSEmil Constantinescu       tol  = tola+tolr;
67128a175baeSEmil Constantinescu       if(tola>0.){
67138a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67148a175baeSEmil Constantinescu       }
67158a175baeSEmil Constantinescu       if(tolr>0.){
67168a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67178a175baeSEmil Constantinescu       }
67188a175baeSEmil Constantinescu       if(tol>0.){
67198a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67208a175baeSEmil Constantinescu       }
67218a175baeSEmil Constantinescu     }
67228a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67238a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67248a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
67258a175baeSEmil Constantinescu     const PetscScalar *atol;
67268a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67278a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67288a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67298a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
67308a175baeSEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67318a175baeSEmil Constantinescu       tol  = tola+tolr;
67328a175baeSEmil Constantinescu       if(tola>0.){
67338a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67348a175baeSEmil Constantinescu       }
67358a175baeSEmil Constantinescu       if(tolr>0.){
67368a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67378a175baeSEmil Constantinescu       }
67388a175baeSEmil Constantinescu       if(tol>0.){
67398a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67408a175baeSEmil Constantinescu       }
67418a175baeSEmil Constantinescu     }
67428a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67438a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
67448a175baeSEmil Constantinescu     const PetscScalar *rtol;
67458a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67468a175baeSEmil Constantinescu 
67478a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67488a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67498a175baeSEmil Constantinescu       tola = ts->atol;
67508a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67518a175baeSEmil Constantinescu       tol  = tola+tolr;
67528a175baeSEmil Constantinescu       if(tola>0.){
67538a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67548a175baeSEmil Constantinescu       }
67558a175baeSEmil Constantinescu       if(tolr>0.){
67568a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67578a175baeSEmil Constantinescu       }
67588a175baeSEmil Constantinescu       if(tol>0.){
67598a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67608a175baeSEmil Constantinescu       }
67618a175baeSEmil Constantinescu     }
67628a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67638a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
67648a175baeSEmil Constantinescu 
67658a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67668a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67678a175baeSEmil Constantinescu       tola = ts->atol;
67688a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67698a175baeSEmil Constantinescu       tol  = tola+tolr;
67708a175baeSEmil Constantinescu       if(tola>0.){
67718a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67728a175baeSEmil Constantinescu       }
67738a175baeSEmil Constantinescu       if(tolr>0.){
67748a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67758a175baeSEmil Constantinescu       }
67768a175baeSEmil Constantinescu       if(tol>0.){
67778a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67788a175baeSEmil Constantinescu       }
67798a175baeSEmil Constantinescu     }
67808a175baeSEmil Constantinescu   }
67818a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
67828a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
67838a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
67848a175baeSEmil Constantinescu   err_loc[0] = max;
67858a175baeSEmil Constantinescu   err_loc[1] = maxa;
67868a175baeSEmil Constantinescu   err_loc[2] = maxr;
6787a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
67888a175baeSEmil Constantinescu   gmax   = err_glb[0];
67898a175baeSEmil Constantinescu   gmaxa  = err_glb[1];
67908a175baeSEmil Constantinescu   gmaxr  = err_glb[2];
67918a175baeSEmil Constantinescu 
67928a175baeSEmil Constantinescu   *norm = gmax;
67938a175baeSEmil Constantinescu   *norma = gmaxa;
67948a175baeSEmil Constantinescu   *normr = gmaxr;
67958a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
67968a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
67978a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
67988a175baeSEmil Constantinescu   PetscFunctionReturn(0);
67998a175baeSEmil Constantinescu }
68008a175baeSEmil Constantinescu 
68018a175baeSEmil Constantinescu /*@
68028a175baeSEmil Constantinescu    TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
68038a175baeSEmil Constantinescu 
68048a175baeSEmil Constantinescu    Collective on TS
68058a175baeSEmil Constantinescu 
68068a175baeSEmil Constantinescu    Input Arguments:
68078a175baeSEmil Constantinescu +  ts - time stepping context
68088a175baeSEmil Constantinescu .  E - error vector
68098a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
68108a175baeSEmil Constantinescu .  Y - state vector, previous time step
68118a175baeSEmil Constantinescu -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
68128a175baeSEmil Constantinescu 
68138a175baeSEmil Constantinescu    Output Arguments:
68148a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
68158a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
68168a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
68178a175baeSEmil Constantinescu 
68188a175baeSEmil Constantinescu    Options Database Keys:
68198a175baeSEmil Constantinescu .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
68208a175baeSEmil Constantinescu 
68218a175baeSEmil Constantinescu    Level: developer
68228a175baeSEmil Constantinescu 
68238a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
68248a175baeSEmil Constantinescu @*/
68258a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
68268a175baeSEmil Constantinescu {
68278a175baeSEmil Constantinescu   PetscErrorCode ierr;
68288a175baeSEmil Constantinescu 
68298a175baeSEmil Constantinescu   PetscFunctionBegin;
68308a175baeSEmil Constantinescu   if (wnormtype == NORM_2) {
68318a175baeSEmil Constantinescu     ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
68328a175baeSEmil Constantinescu   } else if(wnormtype == NORM_INFINITY) {
68338a175baeSEmil Constantinescu     ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
68348a175baeSEmil Constantinescu   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
68358a175baeSEmil Constantinescu   PetscFunctionReturn(0);
68368a175baeSEmil Constantinescu }
68378a175baeSEmil Constantinescu 
68388a175baeSEmil Constantinescu 
68398d59e960SJed Brown /*@
68408d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
68418d59e960SJed Brown 
68428d59e960SJed Brown    Logically Collective on TS
68438d59e960SJed Brown 
68448d59e960SJed Brown    Input Arguments:
68458d59e960SJed Brown +  ts - time stepping context
68468d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
68478d59e960SJed Brown 
68488d59e960SJed Brown    Note:
68498d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
68508d59e960SJed Brown 
68518d59e960SJed Brown    Level: intermediate
68528d59e960SJed Brown 
68538d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
68548d59e960SJed Brown @*/
68558d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
68568d59e960SJed Brown {
68578d59e960SJed Brown   PetscFunctionBegin;
68588d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
68598d59e960SJed Brown   ts->cfltime_local = cfltime;
68608d59e960SJed Brown   ts->cfltime       = -1.;
68618d59e960SJed Brown   PetscFunctionReturn(0);
68628d59e960SJed Brown }
68638d59e960SJed Brown 
68648d59e960SJed Brown /*@
68658d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
68668d59e960SJed Brown 
68678d59e960SJed Brown    Collective on TS
68688d59e960SJed Brown 
68698d59e960SJed Brown    Input Arguments:
68708d59e960SJed Brown .  ts - time stepping context
68718d59e960SJed Brown 
68728d59e960SJed Brown    Output Arguments:
68738d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
68748d59e960SJed Brown 
68758d59e960SJed Brown    Level: advanced
68768d59e960SJed Brown 
68778d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
68788d59e960SJed Brown @*/
68798d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
68808d59e960SJed Brown {
68818d59e960SJed Brown   PetscErrorCode ierr;
68828d59e960SJed Brown 
68838d59e960SJed Brown   PetscFunctionBegin;
68848d59e960SJed Brown   if (ts->cfltime < 0) {
6885b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
68868d59e960SJed Brown   }
68878d59e960SJed Brown   *cfltime = ts->cfltime;
68888d59e960SJed Brown   PetscFunctionReturn(0);
68898d59e960SJed Brown }
68908d59e960SJed Brown 
6891d6ebe24aSShri Abhyankar /*@
6892d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6893d6ebe24aSShri Abhyankar 
6894d6ebe24aSShri Abhyankar    Input Parameters:
6895d6ebe24aSShri Abhyankar .  ts   - the TS context.
6896d6ebe24aSShri Abhyankar .  xl   - lower bound.
6897d6ebe24aSShri Abhyankar .  xu   - upper bound.
6898d6ebe24aSShri Abhyankar 
6899d6ebe24aSShri Abhyankar    Notes:
6900d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6901e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6902d6ebe24aSShri Abhyankar 
69032bd2b0e6SSatish Balay    Level: advanced
69042bd2b0e6SSatish Balay 
6905d6ebe24aSShri Abhyankar @*/
6906d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6907d6ebe24aSShri Abhyankar {
6908d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6909d6ebe24aSShri Abhyankar   SNES           snes;
6910d6ebe24aSShri Abhyankar 
6911d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6912d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6913d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6914d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6915d6ebe24aSShri Abhyankar }
6916d6ebe24aSShri Abhyankar 
6917325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
6918c6db04a5SJed Brown #include <mex.h>
6919325fc9f4SBarry Smith 
6920325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
6921325fc9f4SBarry Smith 
6922325fc9f4SBarry Smith /*
6923325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
6924325fc9f4SBarry Smith                          TSSetFunctionMatlab().
6925325fc9f4SBarry Smith 
6926325fc9f4SBarry Smith    Collective on TS
6927325fc9f4SBarry Smith 
6928325fc9f4SBarry Smith    Input Parameters:
6929325fc9f4SBarry Smith +  snes - the TS context
69300910c330SBarry Smith -  u - input vector
6931325fc9f4SBarry Smith 
6932325fc9f4SBarry Smith    Output Parameter:
6933325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
6934325fc9f4SBarry Smith 
6935325fc9f4SBarry Smith    Notes:
6936325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
6937325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
6938325fc9f4SBarry Smith    themselves.
6939325fc9f4SBarry Smith 
6940325fc9f4SBarry Smith    Level: developer
6941325fc9f4SBarry Smith 
6942325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6943325fc9f4SBarry Smith 
6944325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6945325fc9f4SBarry Smith */
69460910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
6947325fc9f4SBarry Smith {
6948325fc9f4SBarry Smith   PetscErrorCode  ierr;
6949325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6950325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
6951325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
6952325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
6953325fc9f4SBarry Smith 
6954325fc9f4SBarry Smith   PetscFunctionBegin;
6955325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
69560910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
69570910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
6958325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
69590910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
6960325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
6961325fc9f4SBarry Smith 
6962325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
69630910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
69640910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
69650910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
6966bbd56ea5SKarl Rupp 
6967325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6968325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
6969325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6970325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6971325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
6972325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
6973325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
6974325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
6975325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6976325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6977325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6978325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6979325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6980325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6981325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6982325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6983325fc9f4SBarry Smith   PetscFunctionReturn(0);
6984325fc9f4SBarry Smith }
6985325fc9f4SBarry Smith 
6986325fc9f4SBarry Smith /*
6987325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
6988325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
6989e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
6990325fc9f4SBarry Smith 
6991325fc9f4SBarry Smith    Logically Collective on TS
6992325fc9f4SBarry Smith 
6993325fc9f4SBarry Smith    Input Parameters:
6994325fc9f4SBarry Smith +  ts - the TS context
6995325fc9f4SBarry Smith -  func - function evaluation routine
6996325fc9f4SBarry Smith 
6997325fc9f4SBarry Smith    Calling sequence of func:
69980910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
6999325fc9f4SBarry Smith 
7000325fc9f4SBarry Smith    Level: beginner
7001325fc9f4SBarry Smith 
7002325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
7003325fc9f4SBarry Smith 
7004325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
7005325fc9f4SBarry Smith */
7006cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
7007325fc9f4SBarry Smith {
7008325fc9f4SBarry Smith   PetscErrorCode  ierr;
7009325fc9f4SBarry Smith   TSMatlabContext *sctx;
7010325fc9f4SBarry Smith 
7011325fc9f4SBarry Smith   PetscFunctionBegin;
7012325fc9f4SBarry Smith   /* currently sctx is memory bleed */
701395dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
7014325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
7015325fc9f4SBarry Smith   /*
7016325fc9f4SBarry Smith      This should work, but it doesn't
7017325fc9f4SBarry Smith   sctx->ctx = ctx;
7018325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
7019325fc9f4SBarry Smith   */
7020325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
7021bbd56ea5SKarl Rupp 
70220298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
7023325fc9f4SBarry Smith   PetscFunctionReturn(0);
7024325fc9f4SBarry Smith }
7025325fc9f4SBarry Smith 
7026325fc9f4SBarry Smith /*
7027325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
7028325fc9f4SBarry Smith                          TSSetJacobianMatlab().
7029325fc9f4SBarry Smith 
7030325fc9f4SBarry Smith    Collective on TS
7031325fc9f4SBarry Smith 
7032325fc9f4SBarry Smith    Input Parameters:
7033cdcf91faSSean Farley +  ts - the TS context
70340910c330SBarry Smith .  u - input vector
7035325fc9f4SBarry Smith .  A, B - the matrices
7036325fc9f4SBarry Smith -  ctx - user context
7037325fc9f4SBarry Smith 
7038325fc9f4SBarry Smith    Level: developer
7039325fc9f4SBarry Smith 
7040325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
7041325fc9f4SBarry Smith 
7042325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
7043325fc9f4SBarry Smith @*/
7044f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
7045325fc9f4SBarry Smith {
7046325fc9f4SBarry Smith   PetscErrorCode  ierr;
7047325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
7048325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
7049325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
7050325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
7051325fc9f4SBarry Smith 
7052325fc9f4SBarry Smith   PetscFunctionBegin;
7053cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
70540910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
7055325fc9f4SBarry Smith 
70560910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
7057325fc9f4SBarry Smith 
7058cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
70590910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
70600910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
70610910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
70620910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
7063bbd56ea5SKarl Rupp 
7064325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
7065325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
7066325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
7067325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
7068325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
7069325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
7070325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
7071325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
7072325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
7073325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
7074325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
7075325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
7076325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
7077325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
7078325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
7079325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
7080325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
7081325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
7082325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
7083325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
7084325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
7085325fc9f4SBarry Smith   PetscFunctionReturn(0);
7086325fc9f4SBarry Smith }
7087325fc9f4SBarry Smith 
7088325fc9f4SBarry Smith /*
7089325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
7090e3c5b3baSBarry 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
7091325fc9f4SBarry Smith 
7092325fc9f4SBarry Smith    Logically Collective on TS
7093325fc9f4SBarry Smith 
7094325fc9f4SBarry Smith    Input Parameters:
7095cdcf91faSSean Farley +  ts - the TS context
7096325fc9f4SBarry Smith .  A,B - Jacobian matrices
7097325fc9f4SBarry Smith .  func - function evaluation routine
7098325fc9f4SBarry Smith -  ctx - user context
7099325fc9f4SBarry Smith 
7100325fc9f4SBarry Smith    Calling sequence of func:
71010910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
7102325fc9f4SBarry Smith 
7103325fc9f4SBarry Smith    Level: developer
7104325fc9f4SBarry Smith 
7105325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
7106325fc9f4SBarry Smith 
7107325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
7108325fc9f4SBarry Smith */
7109cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
7110325fc9f4SBarry Smith {
7111325fc9f4SBarry Smith   PetscErrorCode  ierr;
7112325fc9f4SBarry Smith   TSMatlabContext *sctx;
7113325fc9f4SBarry Smith 
7114325fc9f4SBarry Smith   PetscFunctionBegin;
7115325fc9f4SBarry Smith   /* currently sctx is memory bleed */
711695dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
7117325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
7118325fc9f4SBarry Smith   /*
7119325fc9f4SBarry Smith      This should work, but it doesn't
7120325fc9f4SBarry Smith   sctx->ctx = ctx;
7121325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
7122325fc9f4SBarry Smith   */
7123325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
7124bbd56ea5SKarl Rupp 
7125cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
7126325fc9f4SBarry Smith   PetscFunctionReturn(0);
7127325fc9f4SBarry Smith }
7128325fc9f4SBarry Smith 
7129b5b1a830SBarry Smith /*
7130b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
7131b5b1a830SBarry Smith 
7132b5b1a830SBarry Smith    Collective on TS
7133b5b1a830SBarry Smith 
7134b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
7135b5b1a830SBarry Smith @*/
71360910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
7137b5b1a830SBarry Smith {
7138b5b1a830SBarry Smith   PetscErrorCode  ierr;
7139b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
7140a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
7141b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
7142b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
7143b5b1a830SBarry Smith 
7144b5b1a830SBarry Smith   PetscFunctionBegin;
7145cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
71460910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
7147b5b1a830SBarry Smith 
7148cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
71490910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
7150bbd56ea5SKarl Rupp 
7151b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
7152b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
7153b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
7154b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
7155b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
7156b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
7157b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
7158b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
7159b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
7160b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
7161b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
7162b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
7163b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
7164b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
7165b5b1a830SBarry Smith   PetscFunctionReturn(0);
7166b5b1a830SBarry Smith }
7167b5b1a830SBarry Smith 
7168b5b1a830SBarry Smith /*
7169b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
7170b5b1a830SBarry Smith 
7171b5b1a830SBarry Smith    Level: developer
7172b5b1a830SBarry Smith 
7173b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
7174b5b1a830SBarry Smith 
7175b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
7176b5b1a830SBarry Smith */
7177cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
7178b5b1a830SBarry Smith {
7179b5b1a830SBarry Smith   PetscErrorCode  ierr;
7180b5b1a830SBarry Smith   TSMatlabContext *sctx;
7181b5b1a830SBarry Smith 
7182b5b1a830SBarry Smith   PetscFunctionBegin;
7183b5b1a830SBarry Smith   /* currently sctx is memory bleed */
718495dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
7185b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
7186b5b1a830SBarry Smith   /*
7187b5b1a830SBarry Smith      This should work, but it doesn't
7188b5b1a830SBarry Smith   sctx->ctx = ctx;
7189b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
7190b5b1a830SBarry Smith   */
7191b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
7192bbd56ea5SKarl Rupp 
71930298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
7194b5b1a830SBarry Smith   PetscFunctionReturn(0);
7195b5b1a830SBarry Smith }
7196325fc9f4SBarry Smith #endif
7197b3603a34SBarry Smith 
7198b3603a34SBarry Smith /*@C
71994f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
7200b3603a34SBarry Smith        in a time based line graph
7201b3603a34SBarry Smith 
7202b3603a34SBarry Smith    Collective on TS
7203b3603a34SBarry Smith 
7204b3603a34SBarry Smith    Input Parameters:
7205b3603a34SBarry Smith +  ts - the TS context
7206b3603a34SBarry Smith .  step - current time-step
7207b3603a34SBarry Smith .  ptime - current time
72087db568b7SBarry Smith .  u - current solution
72097db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
7210b3603a34SBarry Smith 
7211b3d3934dSBarry Smith    Options Database:
72129ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
7213b3d3934dSBarry Smith 
7214b3603a34SBarry Smith    Level: intermediate
7215b3603a34SBarry Smith 
72166934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component solutions in a separate window
7217b3603a34SBarry Smith 
7218b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
7219b3603a34SBarry Smith 
72207db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
72217db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
72227db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
72237db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
7224b3603a34SBarry Smith @*/
72257db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7226b3603a34SBarry Smith {
7227b3603a34SBarry Smith   PetscErrorCode    ierr;
72287db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
7229b3603a34SBarry Smith   const PetscScalar *yy;
723080666b62SBarry Smith   Vec               v;
7231b3603a34SBarry Smith 
7232b3603a34SBarry Smith   PetscFunctionBegin;
723363e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
723458ff32f7SBarry Smith   if (!step) {
7235a9f9c1f6SBarry Smith     PetscDrawAxis axis;
72366934998bSLisandro Dalcin     PetscInt      dim;
7237a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7238a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
7239bab0a581SBarry Smith     if (!ctx->names) {
7240bab0a581SBarry Smith       PetscBool flg;
7241bab0a581SBarry Smith       /* user provides names of variables to plot but no names has been set so assume names are integer values */
7242bab0a581SBarry Smith       ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr);
7243bab0a581SBarry Smith       if (flg) {
7244bab0a581SBarry Smith         PetscInt i,n;
7245bab0a581SBarry Smith         char     **names;
7246bab0a581SBarry Smith         ierr = VecGetSize(u,&n);CHKERRQ(ierr);
7247bab0a581SBarry Smith         ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr);
7248bab0a581SBarry Smith         for (i=0; i<n; i++) {
7249bab0a581SBarry Smith           ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr);
7250bab0a581SBarry Smith           ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr);
7251bab0a581SBarry Smith         }
7252bab0a581SBarry Smith         names[n] = NULL;
7253bab0a581SBarry Smith         ctx->names = names;
7254bab0a581SBarry Smith       }
7255bab0a581SBarry Smith     }
7256387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
7257387f4636SBarry Smith       char      **displaynames;
7258387f4636SBarry Smith       PetscBool flg;
7259387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
726095dccacaSBarry Smith       ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr);
7261387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
7262c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
7263387f4636SBarry Smith       if (flg) {
7264a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
7265387f4636SBarry Smith       }
7266387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
7267387f4636SBarry Smith     }
7268387f4636SBarry Smith     if (ctx->displaynames) {
7269387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
7270387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
7271387f4636SBarry Smith     } else if (ctx->names) {
72720910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
72730b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7274387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
7275b0bc92c6SBarry Smith     } else {
7276b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
7277b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7278387f4636SBarry Smith     }
72790b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
728058ff32f7SBarry Smith   }
72816934998bSLisandro Dalcin 
72826934998bSLisandro Dalcin   if (!ctx->transform) v = u;
72836934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
728480666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
72856934998bSLisandro Dalcin   if (ctx->displaynames) {
72866934998bSLisandro Dalcin     PetscInt i;
72876934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
72886934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
72896934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
72906934998bSLisandro Dalcin   } else {
7291e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
7292e3efe391SJed Brown     PetscInt  i,n;
72936934998bSLisandro Dalcin     PetscReal *yreal;
729480666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
7295785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
7296e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
72970b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
7298e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
7299e3efe391SJed Brown #else
73000b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
7301e3efe391SJed Brown #endif
730280666b62SBarry Smith   }
73036934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
73046934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
73056934998bSLisandro Dalcin 
7306b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
73070b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
73086934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
73093923b477SBarry Smith   }
7310b3603a34SBarry Smith   PetscFunctionReturn(0);
7311b3603a34SBarry Smith }
7312b3603a34SBarry Smith 
7313b037adc7SBarry Smith /*@C
731431152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
7315b037adc7SBarry Smith 
7316b037adc7SBarry Smith    Collective on TS
7317b037adc7SBarry Smith 
7318b037adc7SBarry Smith    Input Parameters:
7319b037adc7SBarry Smith +  ts - the TS context
7320b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
7321b037adc7SBarry Smith 
7322b037adc7SBarry Smith    Level: intermediate
7323b037adc7SBarry Smith 
73247db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
73257db568b7SBarry Smith 
7326b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
7327b037adc7SBarry Smith 
7328a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
7329b037adc7SBarry Smith @*/
733031152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
7331b037adc7SBarry Smith {
7332b037adc7SBarry Smith   PetscErrorCode    ierr;
7333b037adc7SBarry Smith   PetscInt          i;
7334b037adc7SBarry Smith 
7335b037adc7SBarry Smith   PetscFunctionBegin;
7336b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7337b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
73385537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
7339b3d3934dSBarry Smith       break;
7340b3d3934dSBarry Smith     }
7341b3d3934dSBarry Smith   }
7342b3d3934dSBarry Smith   PetscFunctionReturn(0);
7343b3d3934dSBarry Smith }
7344b3d3934dSBarry Smith 
7345e673d494SBarry Smith /*@C
7346e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
7347e673d494SBarry Smith 
7348e673d494SBarry Smith    Collective on TS
7349e673d494SBarry Smith 
7350e673d494SBarry Smith    Input Parameters:
7351e673d494SBarry Smith +  ts - the TS context
7352e673d494SBarry Smith -  names - the names of the components, final string must be NULL
7353e673d494SBarry Smith 
7354e673d494SBarry Smith    Level: intermediate
7355e673d494SBarry Smith 
7356e673d494SBarry Smith .keywords: TS,  vector, monitor, view
7357e673d494SBarry Smith 
7358a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
7359e673d494SBarry Smith @*/
7360e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
7361e673d494SBarry Smith {
7362e673d494SBarry Smith   PetscErrorCode    ierr;
7363e673d494SBarry Smith 
7364e673d494SBarry Smith   PetscFunctionBegin;
7365e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
7366e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
7367e673d494SBarry Smith   PetscFunctionReturn(0);
7368e673d494SBarry Smith }
7369e673d494SBarry Smith 
7370b3d3934dSBarry Smith /*@C
7371b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
7372b3d3934dSBarry Smith 
7373b3d3934dSBarry Smith    Collective on TS
7374b3d3934dSBarry Smith 
7375b3d3934dSBarry Smith    Input Parameter:
7376b3d3934dSBarry Smith .  ts - the TS context
7377b3d3934dSBarry Smith 
7378b3d3934dSBarry Smith    Output Parameter:
7379b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
7380b3d3934dSBarry Smith 
7381b3d3934dSBarry Smith    Level: intermediate
7382b3d3934dSBarry Smith 
73837db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
73847db568b7SBarry Smith 
7385b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7386b3d3934dSBarry Smith 
7387b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7388b3d3934dSBarry Smith @*/
7389b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
7390b3d3934dSBarry Smith {
7391b3d3934dSBarry Smith   PetscInt       i;
7392b3d3934dSBarry Smith 
7393b3d3934dSBarry Smith   PetscFunctionBegin;
7394b3d3934dSBarry Smith   *names = NULL;
7395b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7396b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
73975537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
7398b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
7399b3d3934dSBarry Smith       break;
7400387f4636SBarry Smith     }
7401387f4636SBarry Smith   }
7402387f4636SBarry Smith   PetscFunctionReturn(0);
7403387f4636SBarry Smith }
7404387f4636SBarry Smith 
7405a66092f1SBarry Smith /*@C
7406a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
7407a66092f1SBarry Smith 
7408a66092f1SBarry Smith    Collective on TS
7409a66092f1SBarry Smith 
7410a66092f1SBarry Smith    Input Parameters:
7411a66092f1SBarry Smith +  ctx - the TSMonitorLG context
7412a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
7413a66092f1SBarry Smith 
7414a66092f1SBarry Smith    Level: intermediate
7415a66092f1SBarry Smith 
7416a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
7417a66092f1SBarry Smith 
7418a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
7419a66092f1SBarry Smith @*/
7420a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
7421a66092f1SBarry Smith {
7422a66092f1SBarry Smith   PetscInt          j = 0,k;
7423a66092f1SBarry Smith   PetscErrorCode    ierr;
7424a66092f1SBarry Smith 
7425a66092f1SBarry Smith   PetscFunctionBegin;
7426a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
7427a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
7428a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
7429a66092f1SBarry Smith   while (displaynames[j]) j++;
7430a66092f1SBarry Smith   ctx->ndisplayvariables = j;
7431a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
7432a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
7433a66092f1SBarry Smith   j = 0;
7434a66092f1SBarry Smith   while (displaynames[j]) {
7435a66092f1SBarry Smith     k = 0;
7436a66092f1SBarry Smith     while (ctx->names[k]) {
7437a66092f1SBarry Smith       PetscBool flg;
7438a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
7439a66092f1SBarry Smith       if (flg) {
7440a66092f1SBarry Smith         ctx->displayvariables[j] = k;
7441a66092f1SBarry Smith         break;
7442a66092f1SBarry Smith       }
7443a66092f1SBarry Smith       k++;
7444a66092f1SBarry Smith     }
7445a66092f1SBarry Smith     j++;
7446a66092f1SBarry Smith   }
7447a66092f1SBarry Smith   PetscFunctionReturn(0);
7448a66092f1SBarry Smith }
7449a66092f1SBarry Smith 
7450387f4636SBarry Smith /*@C
7451387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
7452387f4636SBarry Smith 
7453387f4636SBarry Smith    Collective on TS
7454387f4636SBarry Smith 
7455387f4636SBarry Smith    Input Parameters:
7456387f4636SBarry Smith +  ts - the TS context
7457387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
7458387f4636SBarry Smith 
74597db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
74607db568b7SBarry Smith 
7461387f4636SBarry Smith    Level: intermediate
7462387f4636SBarry Smith 
7463387f4636SBarry Smith .keywords: TS,  vector, monitor, view
7464387f4636SBarry Smith 
7465387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
7466387f4636SBarry Smith @*/
7467387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
7468387f4636SBarry Smith {
7469a66092f1SBarry Smith   PetscInt          i;
7470387f4636SBarry Smith   PetscErrorCode    ierr;
7471387f4636SBarry Smith 
7472387f4636SBarry Smith   PetscFunctionBegin;
7473387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7474387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
74755537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
7476b3d3934dSBarry Smith       break;
7477b037adc7SBarry Smith     }
7478b037adc7SBarry Smith   }
7479b037adc7SBarry Smith   PetscFunctionReturn(0);
7480b037adc7SBarry Smith }
7481b037adc7SBarry Smith 
748280666b62SBarry Smith /*@C
748380666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
748480666b62SBarry Smith 
748580666b62SBarry Smith    Collective on TS
748680666b62SBarry Smith 
748780666b62SBarry Smith    Input Parameters:
748880666b62SBarry Smith +  ts - the TS context
748980666b62SBarry Smith .  transform - the transform function
74907684fa3eSBarry Smith .  destroy - function to destroy the optional context
749180666b62SBarry Smith -  ctx - optional context used by transform function
749280666b62SBarry Smith 
74937db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
74947db568b7SBarry Smith 
749580666b62SBarry Smith    Level: intermediate
749680666b62SBarry Smith 
749780666b62SBarry Smith .keywords: TS,  vector, monitor, view
749880666b62SBarry Smith 
7499a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
750080666b62SBarry Smith @*/
75017684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
750280666b62SBarry Smith {
750380666b62SBarry Smith   PetscInt          i;
7504a66092f1SBarry Smith   PetscErrorCode    ierr;
750580666b62SBarry Smith 
750680666b62SBarry Smith   PetscFunctionBegin;
750780666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
750880666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
75095537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
751080666b62SBarry Smith     }
751180666b62SBarry Smith   }
751280666b62SBarry Smith   PetscFunctionReturn(0);
751380666b62SBarry Smith }
751480666b62SBarry Smith 
7515e673d494SBarry Smith /*@C
7516e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
7517e673d494SBarry Smith 
7518e673d494SBarry Smith    Collective on TSLGCtx
7519e673d494SBarry Smith 
7520e673d494SBarry Smith    Input Parameters:
7521e673d494SBarry Smith +  ts - the TS context
7522e673d494SBarry Smith .  transform - the transform function
75237684fa3eSBarry Smith .  destroy - function to destroy the optional context
7524e673d494SBarry Smith -  ctx - optional context used by transform function
7525e673d494SBarry Smith 
7526e673d494SBarry Smith    Level: intermediate
7527e673d494SBarry Smith 
7528e673d494SBarry Smith .keywords: TS,  vector, monitor, view
7529e673d494SBarry Smith 
7530a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
7531e673d494SBarry Smith @*/
75327684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
7533e673d494SBarry Smith {
7534e673d494SBarry Smith   PetscFunctionBegin;
7535e673d494SBarry Smith   ctx->transform    = transform;
75367684fa3eSBarry Smith   ctx->transformdestroy = destroy;
7537e673d494SBarry Smith   ctx->transformctx = tctx;
7538e673d494SBarry Smith   PetscFunctionReturn(0);
7539e673d494SBarry Smith }
7540e673d494SBarry Smith 
7541ef20d060SBarry Smith /*@C
75428b668821SLisandro Dalcin    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the error
7543ef20d060SBarry Smith        in a time based line graph
7544ef20d060SBarry Smith 
7545ef20d060SBarry Smith    Collective on TS
7546ef20d060SBarry Smith 
7547ef20d060SBarry Smith    Input Parameters:
7548ef20d060SBarry Smith +  ts - the TS context
7549ef20d060SBarry Smith .  step - current time-step
7550ef20d060SBarry Smith .  ptime - current time
75517db568b7SBarry Smith .  u - current solution
75527db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
7553ef20d060SBarry Smith 
7554ef20d060SBarry Smith    Level: intermediate
7555ef20d060SBarry Smith 
75566934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component errors in a separate window
7557abd5a294SJed Brown 
7558abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
7559abd5a294SJed Brown 
7560abd5a294SJed Brown    Options Database Keys:
75614f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
7562ef20d060SBarry Smith 
7563ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
7564ef20d060SBarry Smith 
7565abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
7566ef20d060SBarry Smith @*/
75670910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
7568ef20d060SBarry Smith {
7569ef20d060SBarry Smith   PetscErrorCode    ierr;
75700b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
7571ef20d060SBarry Smith   const PetscScalar *yy;
7572ef20d060SBarry Smith   Vec               y;
7573ef20d060SBarry Smith 
7574ef20d060SBarry Smith   PetscFunctionBegin;
7575a9f9c1f6SBarry Smith   if (!step) {
7576a9f9c1f6SBarry Smith     PetscDrawAxis axis;
75776934998bSLisandro Dalcin     PetscInt      dim;
7578a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
75798b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Error");CHKERRQ(ierr);
75800910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
7581a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7582a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7583a9f9c1f6SBarry Smith   }
75840910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
7585ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
75860910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
7587ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
7588e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
7589e3efe391SJed Brown   {
7590e3efe391SJed Brown     PetscReal *yreal;
7591e3efe391SJed Brown     PetscInt  i,n;
7592e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
7593785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
7594e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
75950b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
7596e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
7597e3efe391SJed Brown   }
7598e3efe391SJed Brown #else
75990b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
7600e3efe391SJed Brown #endif
7601ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
7602ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
7603b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
76040b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
76056934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
76063923b477SBarry Smith   }
7607ef20d060SBarry Smith   PetscFunctionReturn(0);
7608ef20d060SBarry Smith }
7609ef20d060SBarry Smith 
76107cf37e64SBarry Smith /*@C
76117cf37e64SBarry Smith    TSMonitorError - Monitors progress of the TS solvers by printing the 2 norm of the error at each timestep
76127cf37e64SBarry Smith 
76137cf37e64SBarry Smith    Collective on TS
76147cf37e64SBarry Smith 
76157cf37e64SBarry Smith    Input Parameters:
76167cf37e64SBarry Smith +  ts - the TS context
76177cf37e64SBarry Smith .  step - current time-step
76187cf37e64SBarry Smith .  ptime - current time
76197cf37e64SBarry Smith .  u - current solution
76207cf37e64SBarry Smith -  dctx - unused context
76217cf37e64SBarry Smith 
76227cf37e64SBarry Smith    Level: intermediate
76237cf37e64SBarry Smith 
76247cf37e64SBarry Smith    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
76257cf37e64SBarry Smith 
76267cf37e64SBarry Smith    Options Database Keys:
76277cf37e64SBarry Smith .  -ts_monitor_error - create a graphical monitor of error history
76287cf37e64SBarry Smith 
76297cf37e64SBarry Smith .keywords: TS,  vector, monitor, view
76307cf37e64SBarry Smith 
76317cf37e64SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
76327cf37e64SBarry Smith @*/
7633*edbaebb3SBarry Smith PetscErrorCode  TSMonitorError(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
76347cf37e64SBarry Smith {
76357cf37e64SBarry Smith   PetscErrorCode    ierr;
76367cf37e64SBarry Smith   Vec               y;
76377cf37e64SBarry Smith   PetscReal         nrm;
7638*edbaebb3SBarry Smith   PetscBool         flg;
76397cf37e64SBarry Smith 
76407cf37e64SBarry Smith   PetscFunctionBegin;
76417cf37e64SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
76427cf37e64SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
76437cf37e64SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
7644*edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERASCII,&flg);CHKERRQ(ierr);
7645*edbaebb3SBarry Smith   if (flg) {
76467cf37e64SBarry Smith     ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
7647*edbaebb3SBarry Smith     ierr = PetscViewerASCIIPrintf(vf->viewer,"2-norm of error %g\n",(double)nrm);CHKERRQ(ierr);
7648*edbaebb3SBarry Smith   }
7649*edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERDRAW,&flg);CHKERRQ(ierr);
7650*edbaebb3SBarry Smith   if (flg) {
7651*edbaebb3SBarry Smith     ierr = VecView(y,vf->viewer);CHKERRQ(ierr);
7652*edbaebb3SBarry Smith   }
7653*edbaebb3SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
76547cf37e64SBarry Smith   PetscFunctionReturn(0);
76557cf37e64SBarry Smith }
76567cf37e64SBarry Smith 
7657201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7658201da799SBarry Smith {
7659201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7660201da799SBarry Smith   PetscReal      x   = ptime,y;
7661201da799SBarry Smith   PetscErrorCode ierr;
7662201da799SBarry Smith   PetscInt       its;
7663201da799SBarry Smith 
7664201da799SBarry Smith   PetscFunctionBegin;
766563e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7666201da799SBarry Smith   if (!n) {
7667201da799SBarry Smith     PetscDrawAxis axis;
7668201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7669201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
7670201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7671201da799SBarry Smith     ctx->snes_its = 0;
7672201da799SBarry Smith   }
7673201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
7674201da799SBarry Smith   y    = its - ctx->snes_its;
7675201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
76763fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7677201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
76786934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7679201da799SBarry Smith   }
7680201da799SBarry Smith   ctx->snes_its = its;
7681201da799SBarry Smith   PetscFunctionReturn(0);
7682201da799SBarry Smith }
7683201da799SBarry Smith 
7684201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7685201da799SBarry Smith {
7686201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7687201da799SBarry Smith   PetscReal      x   = ptime,y;
7688201da799SBarry Smith   PetscErrorCode ierr;
7689201da799SBarry Smith   PetscInt       its;
7690201da799SBarry Smith 
7691201da799SBarry Smith   PetscFunctionBegin;
769263e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7693201da799SBarry Smith   if (!n) {
7694201da799SBarry Smith     PetscDrawAxis axis;
7695201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7696201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
7697201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7698201da799SBarry Smith     ctx->ksp_its = 0;
7699201da799SBarry Smith   }
7700201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
7701201da799SBarry Smith   y    = its - ctx->ksp_its;
7702201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
770399fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7704201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
77056934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7706201da799SBarry Smith   }
7707201da799SBarry Smith   ctx->ksp_its = its;
7708201da799SBarry Smith   PetscFunctionReturn(0);
7709201da799SBarry Smith }
7710f9c1d6abSBarry Smith 
7711f9c1d6abSBarry Smith /*@
7712f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
7713f9c1d6abSBarry Smith 
7714f9c1d6abSBarry Smith    Collective on TS and Vec
7715f9c1d6abSBarry Smith 
7716f9c1d6abSBarry Smith    Input Parameters:
7717f9c1d6abSBarry Smith +  ts - the TS context
7718f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
7719f9c1d6abSBarry Smith 
7720f9c1d6abSBarry Smith    Output Parameters:
7721f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
7722f9c1d6abSBarry Smith 
7723f9c1d6abSBarry Smith    Level: developer
7724f9c1d6abSBarry Smith 
7725f9c1d6abSBarry Smith .keywords: TS, compute
7726f9c1d6abSBarry Smith 
7727f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
7728f9c1d6abSBarry Smith @*/
7729f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
7730f9c1d6abSBarry Smith {
7731f9c1d6abSBarry Smith   PetscErrorCode ierr;
7732f9c1d6abSBarry Smith 
7733f9c1d6abSBarry Smith   PetscFunctionBegin;
7734f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7735ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
7736f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
7737f9c1d6abSBarry Smith   PetscFunctionReturn(0);
7738f9c1d6abSBarry Smith }
773924655328SShri 
7740b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
7741b3d3934dSBarry Smith /*@C
7742b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
7743b3d3934dSBarry Smith 
7744b3d3934dSBarry Smith    Collective on TS
7745b3d3934dSBarry Smith 
7746b3d3934dSBarry Smith    Input Parameters:
7747b3d3934dSBarry Smith .  ts  - the ODE solver object
7748b3d3934dSBarry Smith 
7749b3d3934dSBarry Smith    Output Parameter:
7750b3d3934dSBarry Smith .  ctx - the context
7751b3d3934dSBarry Smith 
7752b3d3934dSBarry Smith    Level: intermediate
7753b3d3934dSBarry Smith 
7754b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
7755b3d3934dSBarry Smith 
7756b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
7757b3d3934dSBarry Smith 
7758b3d3934dSBarry Smith @*/
7759b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
7760b3d3934dSBarry Smith {
7761b3d3934dSBarry Smith   PetscErrorCode ierr;
7762b3d3934dSBarry Smith 
7763b3d3934dSBarry Smith   PetscFunctionBegin;
7764a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
7765b3d3934dSBarry Smith   PetscFunctionReturn(0);
7766b3d3934dSBarry Smith }
7767b3d3934dSBarry Smith 
7768b3d3934dSBarry Smith /*@C
7769b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
7770b3d3934dSBarry Smith 
7771b3d3934dSBarry Smith    Collective on TS
7772b3d3934dSBarry Smith 
7773b3d3934dSBarry Smith    Input Parameters:
7774b3d3934dSBarry Smith +  ts - the TS context
7775b3d3934dSBarry Smith .  step - current time-step
7776b3d3934dSBarry Smith .  ptime - current time
77777db568b7SBarry Smith .  u  - current solution
77787db568b7SBarry Smith -  dctx - the envelope context
7779b3d3934dSBarry Smith 
7780b3d3934dSBarry Smith    Options Database:
7781b3d3934dSBarry Smith .  -ts_monitor_envelope
7782b3d3934dSBarry Smith 
7783b3d3934dSBarry Smith    Level: intermediate
7784b3d3934dSBarry Smith 
7785b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
7786b3d3934dSBarry Smith 
7787b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7788b3d3934dSBarry Smith 
77897db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
7790b3d3934dSBarry Smith @*/
77917db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7792b3d3934dSBarry Smith {
7793b3d3934dSBarry Smith   PetscErrorCode       ierr;
77947db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
7795b3d3934dSBarry Smith 
7796b3d3934dSBarry Smith   PetscFunctionBegin;
7797b3d3934dSBarry Smith   if (!ctx->max) {
7798b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
7799b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
7800b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
7801b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
7802b3d3934dSBarry Smith   } else {
7803b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
7804b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
7805b3d3934dSBarry Smith   }
7806b3d3934dSBarry Smith   PetscFunctionReturn(0);
7807b3d3934dSBarry Smith }
7808b3d3934dSBarry Smith 
7809b3d3934dSBarry Smith /*@C
7810b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
7811b3d3934dSBarry Smith 
7812b3d3934dSBarry Smith    Collective on TS
7813b3d3934dSBarry Smith 
7814b3d3934dSBarry Smith    Input Parameter:
7815b3d3934dSBarry Smith .  ts - the TS context
7816b3d3934dSBarry Smith 
7817b3d3934dSBarry Smith    Output Parameter:
7818b3d3934dSBarry Smith +  max - the maximum values
7819b3d3934dSBarry Smith -  min - the minimum values
7820b3d3934dSBarry Smith 
78217db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
78227db568b7SBarry Smith 
7823b3d3934dSBarry Smith    Level: intermediate
7824b3d3934dSBarry Smith 
7825b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7826b3d3934dSBarry Smith 
7827b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7828b3d3934dSBarry Smith @*/
7829b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
7830b3d3934dSBarry Smith {
7831b3d3934dSBarry Smith   PetscInt i;
7832b3d3934dSBarry Smith 
7833b3d3934dSBarry Smith   PetscFunctionBegin;
7834b3d3934dSBarry Smith   if (max) *max = NULL;
7835b3d3934dSBarry Smith   if (min) *min = NULL;
7836b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7837b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
78385537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7839b3d3934dSBarry Smith       if (max) *max = ctx->max;
7840b3d3934dSBarry Smith       if (min) *min = ctx->min;
7841b3d3934dSBarry Smith       break;
7842b3d3934dSBarry Smith     }
7843b3d3934dSBarry Smith   }
7844b3d3934dSBarry Smith   PetscFunctionReturn(0);
7845b3d3934dSBarry Smith }
7846b3d3934dSBarry Smith 
7847b3d3934dSBarry Smith /*@C
7848b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7849b3d3934dSBarry Smith 
7850b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7851b3d3934dSBarry Smith 
7852b3d3934dSBarry Smith    Input Parameter:
7853b3d3934dSBarry Smith .  ctx - the monitor context
7854b3d3934dSBarry Smith 
7855b3d3934dSBarry Smith    Level: intermediate
7856b3d3934dSBarry Smith 
7857b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
7858b3d3934dSBarry Smith 
78597db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7860b3d3934dSBarry Smith @*/
7861b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7862b3d3934dSBarry Smith {
7863b3d3934dSBarry Smith   PetscErrorCode ierr;
7864b3d3934dSBarry Smith 
7865b3d3934dSBarry Smith   PetscFunctionBegin;
7866b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7867b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7868b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7869b3d3934dSBarry Smith   PetscFunctionReturn(0);
7870b3d3934dSBarry Smith }
7871f2dee214SBarry Smith 
787224655328SShri /*@
7873dcb233daSLisandro Dalcin    TSRestartStep - Flags the solver to restart the next step
7874dcb233daSLisandro Dalcin 
7875dcb233daSLisandro Dalcin    Collective on TS
7876dcb233daSLisandro Dalcin 
7877dcb233daSLisandro Dalcin    Input Parameter:
7878dcb233daSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
7879dcb233daSLisandro Dalcin 
7880dcb233daSLisandro Dalcin    Level: advanced
7881dcb233daSLisandro Dalcin 
7882dcb233daSLisandro Dalcin    Notes:
7883dcb233daSLisandro Dalcin    Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of
7884dcb233daSLisandro Dalcin    discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution
7885dcb233daSLisandro Dalcin    vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For
7886dcb233daSLisandro Dalcin    the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce
7887dcb233daSLisandro Dalcin    discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with
7888dcb233daSLisandro Dalcin    discontinuous source terms).
7889dcb233daSLisandro Dalcin 
7890dcb233daSLisandro Dalcin .keywords: TS, timestep, restart
7891dcb233daSLisandro Dalcin 
7892dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep()
7893dcb233daSLisandro Dalcin @*/
7894dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts)
7895dcb233daSLisandro Dalcin {
7896dcb233daSLisandro Dalcin   PetscFunctionBegin;
7897dcb233daSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7898dcb233daSLisandro Dalcin   ts->steprestart = PETSC_TRUE;
7899dcb233daSLisandro Dalcin   PetscFunctionReturn(0);
7900dcb233daSLisandro Dalcin }
7901dcb233daSLisandro Dalcin 
7902dcb233daSLisandro Dalcin /*@
790324655328SShri    TSRollBack - Rolls back one time step
790424655328SShri 
790524655328SShri    Collective on TS
790624655328SShri 
790724655328SShri    Input Parameter:
790824655328SShri .  ts - the TS context obtained from TSCreate()
790924655328SShri 
791024655328SShri    Level: advanced
791124655328SShri 
791224655328SShri .keywords: TS, timestep, rollback
791324655328SShri 
791424655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
791524655328SShri @*/
791624655328SShri PetscErrorCode  TSRollBack(TS ts)
791724655328SShri {
791824655328SShri   PetscErrorCode ierr;
791924655328SShri 
792024655328SShri   PetscFunctionBegin;
792124655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7922b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
792324655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
792424655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
792524655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
792624655328SShri   ts->ptime = ts->ptime_prev;
7927be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
79282808aa04SLisandro Dalcin   ts->steps--;
7929b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
793024655328SShri   PetscFunctionReturn(0);
793124655328SShri }
7932aeb4809dSShri Abhyankar 
7933ff22ae23SHong Zhang /*@
7934ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7935ff22ae23SHong Zhang 
7936ff22ae23SHong Zhang    Input Parameter:
7937ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7938ff22ae23SHong Zhang 
7939ff22ae23SHong Zhang    Level: advanced
7940ff22ae23SHong Zhang 
7941ff22ae23SHong Zhang .keywords: TS, getstages
7942ff22ae23SHong Zhang 
7943ff22ae23SHong Zhang .seealso: TSCreate()
7944ff22ae23SHong Zhang @*/
7945ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7946ff22ae23SHong Zhang {
7947ff22ae23SHong Zhang   PetscErrorCode ierr;
7948ff22ae23SHong Zhang 
7949ff22ae23SHong Zhang   PetscFunctionBegin;
7950ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7951ff22ae23SHong Zhang   PetscValidPointer(ns,2);
7952ff22ae23SHong Zhang 
7953ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
7954ff22ae23SHong Zhang   else {
7955ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7956ff22ae23SHong Zhang   }
7957ff22ae23SHong Zhang   PetscFunctionReturn(0);
7958ff22ae23SHong Zhang }
7959ff22ae23SHong Zhang 
7960847ff0e1SMatthew G. Knepley /*@C
7961847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7962847ff0e1SMatthew G. Knepley 
7963847ff0e1SMatthew G. Knepley   Collective on SNES
7964847ff0e1SMatthew G. Knepley 
7965847ff0e1SMatthew G. Knepley   Input Parameters:
7966847ff0e1SMatthew G. Knepley + ts - the TS context
7967847ff0e1SMatthew G. Knepley . t - current timestep
7968847ff0e1SMatthew G. Knepley . U - state vector
7969847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7970847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7971847ff0e1SMatthew G. Knepley - ctx - an optional user context
7972847ff0e1SMatthew G. Knepley 
7973847ff0e1SMatthew G. Knepley   Output Parameters:
7974847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7975847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7976847ff0e1SMatthew G. Knepley 
7977847ff0e1SMatthew G. Knepley   Level: intermediate
7978847ff0e1SMatthew G. Knepley 
7979847ff0e1SMatthew G. Knepley   Notes:
7980847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7981847ff0e1SMatthew G. Knepley 
7982847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7983847ff0e1SMatthew G. Knepley 
7984847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7985847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7986847ff0e1SMatthew G. Knepley 
7987847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7988847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7989847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7990847ff0e1SMatthew G. Knepley 
7991847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
7992847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7993847ff0e1SMatthew G. Knepley @*/
7994847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7995847ff0e1SMatthew G. Knepley {
7996847ff0e1SMatthew G. Knepley   SNES           snes;
7997847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7998847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7999847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
8000847ff0e1SMatthew G. Knepley 
8001847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
8002c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
8003847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
8004847ff0e1SMatthew G. Knepley   if (!color) {
8005847ff0e1SMatthew G. Knepley     DM         dm;
8006847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
8007847ff0e1SMatthew G. Knepley 
8008847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
8009847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
8010847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
8011847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
8012847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
8013847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
8014847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
8015847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
8016847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
8017847ff0e1SMatthew G. Knepley     } else {
8018847ff0e1SMatthew G. Knepley       MatColoring mc;
8019847ff0e1SMatthew G. Knepley 
8020847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
8021847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
8022847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
8023847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
8024847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
8025847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
8026847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
8027847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
8028847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
8029847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
8030847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
8031847ff0e1SMatthew G. Knepley     }
8032847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
8033847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
8034847ff0e1SMatthew G. Knepley   }
8035847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
8036847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
8037847ff0e1SMatthew G. Knepley   if (J != B) {
8038847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
8039847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
8040847ff0e1SMatthew G. Knepley   }
8041847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
8042847ff0e1SMatthew G. Knepley }
804393b34091SDebojyoti Ghosh 
8044cb9d8021SPierre Barbier de Reuille /*@
8045cb9d8021SPierre Barbier de Reuille     TSSetFunctionDomainError - Set the function testing if the current state vector is valid
8046cb9d8021SPierre Barbier de Reuille 
8047cb9d8021SPierre Barbier de Reuille     Input Parameters:
8048cb9d8021SPierre Barbier de Reuille     ts - the TS context
8049cb9d8021SPierre Barbier de Reuille     func - function called within TSFunctionDomainError
8050cb9d8021SPierre Barbier de Reuille 
8051cb9d8021SPierre Barbier de Reuille     Level: intermediate
8052cb9d8021SPierre Barbier de Reuille 
8053cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain
8054cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
8055cb9d8021SPierre Barbier de Reuille @*/
8056cb9d8021SPierre Barbier de Reuille 
8057d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
8058cb9d8021SPierre Barbier de Reuille {
8059cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
8060cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
8061cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
8062cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
8063cb9d8021SPierre Barbier de Reuille }
8064cb9d8021SPierre Barbier de Reuille 
8065cb9d8021SPierre Barbier de Reuille /*@
8066cb9d8021SPierre Barbier de Reuille     TSFunctionDomainError - Check if the current state is valid
8067cb9d8021SPierre Barbier de Reuille 
8068cb9d8021SPierre Barbier de Reuille     Input Parameters:
8069cb9d8021SPierre Barbier de Reuille     ts - the TS context
8070cb9d8021SPierre Barbier de Reuille     stagetime - time of the simulation
8071d183316bSPierre Barbier de Reuille     Y - state vector to check.
8072cb9d8021SPierre Barbier de Reuille 
8073cb9d8021SPierre Barbier de Reuille     Output Parameter:
8074cb9d8021SPierre Barbier de Reuille     accept - Set to PETSC_FALSE if the current state vector is valid.
8075cb9d8021SPierre Barbier de Reuille 
8076cb9d8021SPierre Barbier de Reuille     Note:
8077cb9d8021SPierre Barbier de Reuille     This function should be used to ensure the state is in a valid part of the space.
8078cb9d8021SPierre Barbier de Reuille     For example, one can ensure here all values are positive.
807996a0c994SBarry Smith 
808096a0c994SBarry Smith     Level: advanced
8081cb9d8021SPierre Barbier de Reuille @*/
8082d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
8083cb9d8021SPierre Barbier de Reuille {
8084cb9d8021SPierre Barbier de Reuille   PetscErrorCode ierr;
8085cb9d8021SPierre Barbier de Reuille 
8086cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
8087cb9d8021SPierre Barbier de Reuille 
8088cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8089cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
8090cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
8091d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
8092cb9d8021SPierre Barbier de Reuille   }
8093cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
8094cb9d8021SPierre Barbier de Reuille }
80951ceb14c0SBarry Smith 
809693b34091SDebojyoti Ghosh /*@C
8097e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
809893b34091SDebojyoti Ghosh 
809993b34091SDebojyoti Ghosh   Collective on MPI_Comm
810093b34091SDebojyoti Ghosh 
810193b34091SDebojyoti Ghosh   Input Parameter:
810293b34091SDebojyoti Ghosh . tsin    - The input TS
810393b34091SDebojyoti Ghosh 
810493b34091SDebojyoti Ghosh   Output Parameter:
8105e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
810693b34091SDebojyoti Ghosh 
81075eca1a21SEmil Constantinescu   Notes:
81085eca1a21SEmil 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.
81095eca1a21SEmil Constantinescu 
8110baa10174SEmil 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);
81115eca1a21SEmil Constantinescu 
81125eca1a21SEmil Constantinescu   Level: developer
811393b34091SDebojyoti Ghosh 
8114e5168f73SEmil Constantinescu .keywords: TS, clone
8115e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
811693b34091SDebojyoti Ghosh @*/
8117baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
811893b34091SDebojyoti Ghosh {
811993b34091SDebojyoti Ghosh   TS             t;
812093b34091SDebojyoti Ghosh   PetscErrorCode ierr;
8121dc846ba4SSatish Balay   SNES           snes_start;
8122dc846ba4SSatish Balay   DM             dm;
8123dc846ba4SSatish Balay   TSType         type;
812493b34091SDebojyoti Ghosh 
812593b34091SDebojyoti Ghosh   PetscFunctionBegin;
812693b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
812793b34091SDebojyoti Ghosh   *tsout = NULL;
812893b34091SDebojyoti Ghosh 
81297a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
813093b34091SDebojyoti Ghosh 
813193b34091SDebojyoti Ghosh   /* General TS description */
813293b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
813393b34091SDebojyoti Ghosh   t->setupcalled       = 0;
813493b34091SDebojyoti Ghosh   t->ksp_its           = 0;
813593b34091SDebojyoti Ghosh   t->snes_its          = 0;
813693b34091SDebojyoti Ghosh   t->nwork             = 0;
813793b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
813893b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
813993b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
814093b34091SDebojyoti Ghosh 
814134561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
814234561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
8143d15a3a53SEmil Constantinescu 
814493b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
814593b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
814693b34091SDebojyoti Ghosh 
814793b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
814851699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
814993b34091SDebojyoti Ghosh 
8150e7069c78SShri   t->trajectory = tsin->trajectory;
8151e7069c78SShri   ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr);
8152e7069c78SShri 
8153e7069c78SShri   t->event = tsin->event;
81546b10a48eSSatish Balay   if (t->event) t->event->refct++;
8155e7069c78SShri 
815693b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
815793b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
8158e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
815993b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
816093b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
816193b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
816293b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
816393b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
816493b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
816593b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
816693b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
816793b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
816893b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
816993b34091SDebojyoti Ghosh 
817093b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
817193b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
817293b34091SDebojyoti Ghosh 
817393b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
817493b34091SDebojyoti Ghosh 
817593b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
817693b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
817793b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
817893b34091SDebojyoti Ghosh 
817993b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
818093b34091SDebojyoti Ghosh 
81810d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
81820d4fed19SBarry Smith     PetscInt i;
81830d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
81840d4fed19SBarry Smith     for (i=0; i<10; i++) {
81850d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
81860d4fed19SBarry Smith     }
81870d4fed19SBarry Smith   }
818893b34091SDebojyoti Ghosh   *tsout = t;
818993b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
819093b34091SDebojyoti Ghosh }
8191