xref: /petsc/src/ts/interface/ts.c (revision 7cf37e642d3319e9563be9d1808aae351b5314ed)
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
171*7cf37e64SBarry 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   }
2786934998bSLisandro Dalcin 
279*7cf37e64SBarry Smith   ierr = PetscOptionsName("-ts_monitor_error","Monitor error","TSMonitorError",&opt);CHKERRQ(ierr);
280*7cf37e64SBarry Smith   if (opt) {
281*7cf37e64SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorError,NULL,NULL);CHKERRQ(ierr);
282*7cf37e64SBarry Smith   }
283*7cf37e64SBarry Smith 
2846934998bSLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2856934998bSLisandro Dalcin   if (opt) {
2866934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
2876934998bSLisandro Dalcin     PetscInt       howoften = 1;
2886934998bSLisandro Dalcin 
2896934998bSLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2906ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2916934998bSLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2926934998bSLisandro Dalcin   }
2938b668821SLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2948b668821SLisandro Dalcin   if (opt) {
2958b668821SLisandro Dalcin     TSMonitorLGCtx ctx;
2968b668821SLisandro Dalcin     PetscInt       howoften = 1;
2978b668821SLisandro Dalcin 
2988b668821SLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2998b668821SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
3008b668821SLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
3018b668821SLisandro Dalcin     ctx->semilogy = PETSC_TRUE;
3028b668821SLisandro Dalcin   }
3038b668821SLisandro Dalcin 
304201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
305201da799SBarry Smith   if (opt) {
306201da799SBarry Smith     TSMonitorLGCtx ctx;
307201da799SBarry Smith     PetscInt       howoften = 1;
308201da799SBarry Smith 
3090298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
3106ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
311201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
312201da799SBarry Smith   }
313201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
314201da799SBarry Smith   if (opt) {
315201da799SBarry Smith     TSMonitorLGCtx ctx;
316201da799SBarry Smith     PetscInt       howoften = 1;
317201da799SBarry Smith 
3180298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
3196ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
320201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
321201da799SBarry Smith   }
3228189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
3238189c53fSBarry Smith   if (opt) {
3248189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
3258189c53fSBarry Smith     PetscInt          howoften = 1;
3268189c53fSBarry Smith 
3270298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
3286934998bSLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3298189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
3308189c53fSBarry Smith   }
331ef20d060SBarry Smith   opt  = PETSC_FALSE;
3320dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
333a7cc72afSBarry Smith   if (opt) {
33483a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
33583a4ac43SBarry Smith     PetscInt         howoften = 1;
336a80ad3e0SBarry Smith 
3370298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
3380ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
33983a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
340bdad233fSMatthew Knepley   }
341fb1732b5SBarry Smith   opt  = PETSC_FALSE;
3429110b2e7SHong Zhang   ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr);
3439110b2e7SHong Zhang   if (opt) {
3449110b2e7SHong Zhang     TSMonitorDrawCtx ctx;
3459110b2e7SHong Zhang     PetscInt         howoften = 1;
3469110b2e7SHong Zhang 
3479110b2e7SHong Zhang     ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr);
3486934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3499110b2e7SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3509110b2e7SHong Zhang   }
3519110b2e7SHong Zhang   opt  = PETSC_FALSE;
3522d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
3532d5ee99bSBarry Smith   if (opt) {
3542d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
3552d5ee99bSBarry Smith     PetscReal        bounds[4];
3562d5ee99bSBarry Smith     PetscInt         n = 4;
3572d5ee99bSBarry Smith     PetscDraw        draw;
3586934998bSLisandro Dalcin     PetscDrawAxis    axis;
3592d5ee99bSBarry Smith 
3602d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
3612d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
3626934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr);
3632d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
3646934998bSLisandro Dalcin     ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr);
3656934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
3666934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
3672d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3682d5ee99bSBarry Smith   }
3692d5ee99bSBarry Smith   opt  = PETSC_FALSE;
3700dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
3713a471f94SBarry Smith   if (opt) {
37283a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
37383a4ac43SBarry Smith     PetscInt         howoften = 1;
3743a471f94SBarry Smith 
3750298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
3760ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
37783a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3783a471f94SBarry Smith   }
3790ed3bfb6SBarry Smith   opt  = PETSC_FALSE;
3800ed3bfb6SBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt);CHKERRQ(ierr);
3810ed3bfb6SBarry Smith   if (opt) {
3820ed3bfb6SBarry Smith     TSMonitorDrawCtx ctx;
3830ed3bfb6SBarry Smith     PetscInt         howoften = 1;
3840ed3bfb6SBarry Smith 
3850ed3bfb6SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL);CHKERRQ(ierr);
3860ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3870ed3bfb6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3880ed3bfb6SBarry Smith   }
389fde5950dSBarry Smith 
390ed81e22dSJed Brown   opt  = PETSC_FALSE;
39191b97e58SBarry 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);
392ed81e22dSJed Brown   if (flg) {
393ed81e22dSJed Brown     const char *ptr,*ptr2;
394ed81e22dSJed Brown     char       *filetemplate;
395ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
396ed81e22dSJed Brown     /* Do some cursory validation of the input. */
397ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
398ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
399ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
400ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
401ce94432eSBarry 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");
402ed81e22dSJed Brown       if (ptr2) break;
403ed81e22dSJed Brown     }
404ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
405ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
406ed81e22dSJed Brown   }
407bdad233fSMatthew Knepley 
408d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
409d1212d36SBarry Smith   if (flg) {
410d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
411d1212d36SBarry Smith     int                  ray = 0;
412d1212d36SBarry Smith     DMDADirection        ddir;
413d1212d36SBarry Smith     DM                   da;
414d1212d36SBarry Smith     PetscMPIInt          rank;
415d1212d36SBarry Smith 
416ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
417d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
418d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
419ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
420d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
421d1212d36SBarry Smith 
422d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
423b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
424d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
425d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
426ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
427d1212d36SBarry Smith     if (!rank) {
428d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
429d1212d36SBarry Smith     }
43051b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
431d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
432d1212d36SBarry Smith   }
43351b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
43451b4a12fSMatthew G. Knepley   if (flg) {
43551b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
43651b4a12fSMatthew G. Knepley     int                 ray = 0;
43751b4a12fSMatthew G. Knepley     DMDADirection       ddir;
43851b4a12fSMatthew G. Knepley     DM                  da;
43951b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
440d1212d36SBarry Smith 
44151b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
44251b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
44351b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
44451b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
44551b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
4461c3436cfSJed Brown 
44751b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
448b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
44951b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
45051b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
45151b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
45251b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
45351b4a12fSMatthew G. Knepley   }
454a7a1495cSBarry Smith 
455b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
456b3d3934dSBarry Smith   if (opt) {
457b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
458b3d3934dSBarry Smith 
459b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
460b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
461b3d3934dSBarry Smith   }
462b3d3934dSBarry Smith 
463847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
464847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
465847ff0e1SMatthew G. Knepley   if (flg) {
466847ff0e1SMatthew G. Knepley     DM   dm;
467847ff0e1SMatthew G. Knepley     DMTS tdm;
468847ff0e1SMatthew G. Knepley 
469847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
470847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
471847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
472847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
473847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
474847ff0e1SMatthew G. Knepley   }
475847ff0e1SMatthew G. Knepley 
476d763cef2SBarry Smith   /* Handle specific TS options */
477d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
4786991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
479d763cef2SBarry Smith   }
480fbc52257SHong Zhang 
481a7bdc993SLisandro Dalcin   /* Handle TSAdapt options */
482a7bdc993SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
483a7bdc993SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
484a7bdc993SLisandro Dalcin   ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr);
485a7bdc993SLisandro Dalcin 
48668bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
4874f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
48868bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
48968bece0bSHong Zhang   if (tflg) {
49068bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
49168bece0bSHong Zhang   }
4924f122a70SLisandro Dalcin   tflg = ts->adjoint_solve ? PETSC_TRUE : PETSC_FALSE;
49368bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
49468bece0bSHong Zhang   if (flg) {
49568bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
49668bece0bSHong Zhang     ts->adjoint_solve = tflg;
49768bece0bSHong Zhang   }
498d763cef2SBarry Smith 
499d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
5000633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
501fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
502d763cef2SBarry Smith 
5034f122a70SLisandro Dalcin   if (ts->trajectory) {
5044f122a70SLisandro Dalcin     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
505d763cef2SBarry Smith   }
50668bece0bSHong Zhang 
5074f122a70SLisandro Dalcin   ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr);
5084f122a70SLisandro Dalcin   if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);}
5094f122a70SLisandro Dalcin   ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
510d763cef2SBarry Smith   PetscFunctionReturn(0);
511d763cef2SBarry Smith }
512d763cef2SBarry Smith 
513d2daff3dSHong Zhang /*@
51478fbdcc8SBarry Smith    TSGetTrajectory - Gets the trajectory from a TS if it exists
51578fbdcc8SBarry Smith 
51678fbdcc8SBarry Smith    Collective on TS
51778fbdcc8SBarry Smith 
51878fbdcc8SBarry Smith    Input Parameters:
51978fbdcc8SBarry Smith .  ts - the TS context obtained from TSCreate()
52078fbdcc8SBarry Smith 
52178fbdcc8SBarry Smith    Output Parameters;
52278fbdcc8SBarry Smith .  tr - the TSTrajectory object, if it exists
52378fbdcc8SBarry Smith 
52478fbdcc8SBarry Smith    Note: This routine should be called after all TS options have been set
52578fbdcc8SBarry Smith 
52678fbdcc8SBarry Smith    Level: advanced
52778fbdcc8SBarry Smith 
52878fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate()
52978fbdcc8SBarry Smith 
53078fbdcc8SBarry Smith .keywords: TS, set, checkpoint,
53178fbdcc8SBarry Smith @*/
53278fbdcc8SBarry Smith PetscErrorCode  TSGetTrajectory(TS ts,TSTrajectory *tr)
53378fbdcc8SBarry Smith {
53478fbdcc8SBarry Smith   PetscFunctionBegin;
53578fbdcc8SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53678fbdcc8SBarry Smith   *tr = ts->trajectory;
53778fbdcc8SBarry Smith   PetscFunctionReturn(0);
53878fbdcc8SBarry Smith }
53978fbdcc8SBarry Smith 
54078fbdcc8SBarry Smith /*@
541bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
542d2daff3dSHong Zhang 
543d2daff3dSHong Zhang    Collective on TS
544d2daff3dSHong Zhang 
545d2daff3dSHong Zhang    Input Parameters:
546bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
547bc952696SBarry Smith 
54878fbdcc8SBarry Smith    Options Database:
54978fbdcc8SBarry Smith +  -ts_save_trajectory - saves the trajectory to a file
55078fbdcc8SBarry Smith -  -ts_trajectory_type type
55178fbdcc8SBarry Smith 
55268bece0bSHong Zhang Note: This routine should be called after all TS options have been set
553d2daff3dSHong Zhang 
55478fbdcc8SBarry Smith     The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/bin/PetscBinaryIOTrajectory.py and
55578fbdcc8SBarry Smith    MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m
55678fbdcc8SBarry Smith 
557d2daff3dSHong Zhang    Level: intermediate
558d2daff3dSHong Zhang 
55978fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectoryType, TSSetTrajectoryType()
560d2daff3dSHong Zhang 
561bc952696SBarry Smith .keywords: TS, set, checkpoint,
562d2daff3dSHong Zhang @*/
563bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
564d2daff3dSHong Zhang {
565bc952696SBarry Smith   PetscErrorCode ierr;
566bc952696SBarry Smith 
567d2daff3dSHong Zhang   PetscFunctionBegin;
568d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
569bc952696SBarry Smith   if (!ts->trajectory) {
570bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
571bc952696SBarry Smith   }
572d2daff3dSHong Zhang   PetscFunctionReturn(0);
573d2daff3dSHong Zhang }
574d2daff3dSHong Zhang 
575a7a1495cSBarry Smith /*@
576a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
577a7a1495cSBarry Smith       set with TSSetRHSJacobian().
578a7a1495cSBarry Smith 
579a7a1495cSBarry Smith    Collective on TS and Vec
580a7a1495cSBarry Smith 
581a7a1495cSBarry Smith    Input Parameters:
582316643e7SJed Brown +  ts - the TS context
583a7a1495cSBarry Smith .  t - current timestep
5840910c330SBarry Smith -  U - input vector
585a7a1495cSBarry Smith 
586a7a1495cSBarry Smith    Output Parameters:
587a7a1495cSBarry Smith +  A - Jacobian matrix
588a7a1495cSBarry Smith .  B - optional preconditioning matrix
589a7a1495cSBarry Smith -  flag - flag indicating matrix structure
590a7a1495cSBarry Smith 
591a7a1495cSBarry Smith    Notes:
592a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
593a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
594a7a1495cSBarry Smith 
59594b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
596a7a1495cSBarry Smith    flag parameter.
597a7a1495cSBarry Smith 
598a7a1495cSBarry Smith    Level: developer
599a7a1495cSBarry Smith 
600a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
601a7a1495cSBarry Smith 
60294b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
603a7a1495cSBarry Smith @*/
604d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
605a7a1495cSBarry Smith {
606dfbe8321SBarry Smith   PetscErrorCode   ierr;
607270bf2e7SJed Brown   PetscObjectState Ustate;
6086c1e1eecSBarry Smith   PetscObjectId    Uid;
60924989b8cSPeter Brune   DM               dm;
610942e3340SBarry Smith   DMTS             tsdm;
61124989b8cSPeter Brune   TSRHSJacobian    rhsjacobianfunc;
61224989b8cSPeter Brune   void             *ctx;
61324989b8cSPeter Brune   TSIJacobian      ijacobianfunc;
614b2df71adSDebojyoti Ghosh   TSRHSFunction    rhsfunction;
615a7a1495cSBarry Smith 
616a7a1495cSBarry Smith   PetscFunctionBegin;
6170700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6180910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6190910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
62024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
621942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
62224989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
6230298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
624b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
62559e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
6266c1e1eecSBarry Smith   ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr);
6276c1e1eecSBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
6280e4ef248SJed Brown     PetscFunctionReturn(0);
629f8ede8e7SJed Brown   }
630d90be118SSean Farley 
631ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
632d90be118SSean Farley 
633e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
63494ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
63594ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
636303f9b21SStefano Zampini     if (B && A != B) {
63794ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
63894ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
639e1244c69SJed Brown     }
640e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
641e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
642e1244c69SJed Brown   }
643e1244c69SJed Brown 
64424989b8cSPeter Brune   if (rhsjacobianfunc) {
6456cd88445SBarry Smith     PetscBool missing;
64694ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
647a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
648d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
649a7a1495cSBarry Smith     PetscStackPop;
65094ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
6516cd88445SBarry Smith     if (A) {
6526cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
6536cd88445SBarry 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");
6546cd88445SBarry Smith     }
6556cd88445SBarry Smith     if (B && B != A) {
6566cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
6576cd88445SBarry 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");
6586cd88445SBarry Smith     }
659ef66eb69SBarry Smith   } else {
66094ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
66194ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
662ef66eb69SBarry Smith   }
6630e4ef248SJed Brown   ts->rhsjacobian.time       = t;
6647f79407eSBarry Smith   ierr                       = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr);
66559e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
666a7a1495cSBarry Smith   PetscFunctionReturn(0);
667a7a1495cSBarry Smith }
668a7a1495cSBarry Smith 
669316643e7SJed Brown /*@
670d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
671d763cef2SBarry Smith 
672316643e7SJed Brown    Collective on TS and Vec
673316643e7SJed Brown 
674316643e7SJed Brown    Input Parameters:
675316643e7SJed Brown +  ts - the TS context
676316643e7SJed Brown .  t - current time
6770910c330SBarry Smith -  U - state vector
678316643e7SJed Brown 
679316643e7SJed Brown    Output Parameter:
680316643e7SJed Brown .  y - right hand side
681316643e7SJed Brown 
682316643e7SJed Brown    Note:
683316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
684316643e7SJed Brown    is used internally within the nonlinear solvers.
685316643e7SJed Brown 
686316643e7SJed Brown    Level: developer
687316643e7SJed Brown 
688316643e7SJed Brown .keywords: TS, compute
689316643e7SJed Brown 
690316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
691316643e7SJed Brown @*/
6920910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
693d763cef2SBarry Smith {
694dfbe8321SBarry Smith   PetscErrorCode ierr;
69524989b8cSPeter Brune   TSRHSFunction  rhsfunction;
69624989b8cSPeter Brune   TSIFunction    ifunction;
69724989b8cSPeter Brune   void           *ctx;
69824989b8cSPeter Brune   DM             dm;
69924989b8cSPeter Brune 
700d763cef2SBarry Smith   PetscFunctionBegin;
7010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7020910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7030700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
70424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
70524989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
7060298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
707d763cef2SBarry Smith 
708ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
709d763cef2SBarry Smith 
7100910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
71124989b8cSPeter Brune   if (rhsfunction) {
712d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
7130910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
714d763cef2SBarry Smith     PetscStackPop;
715214bc6a2SJed Brown   } else {
716214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
717b2cd27e8SJed Brown   }
71844a41b28SSean Farley 
7190910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
720d763cef2SBarry Smith   PetscFunctionReturn(0);
721d763cef2SBarry Smith }
722d763cef2SBarry Smith 
723ef20d060SBarry Smith /*@
724ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
725ef20d060SBarry Smith 
726ef20d060SBarry Smith    Collective on TS and Vec
727ef20d060SBarry Smith 
728ef20d060SBarry Smith    Input Parameters:
729ef20d060SBarry Smith +  ts - the TS context
730ef20d060SBarry Smith -  t - current time
731ef20d060SBarry Smith 
732ef20d060SBarry Smith    Output Parameter:
7330910c330SBarry Smith .  U - the solution
734ef20d060SBarry Smith 
735ef20d060SBarry Smith    Note:
736ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
737ef20d060SBarry Smith    is used internally within the nonlinear solvers.
738ef20d060SBarry Smith 
739ef20d060SBarry Smith    Level: developer
740ef20d060SBarry Smith 
741ef20d060SBarry Smith .keywords: TS, compute
742ef20d060SBarry Smith 
743abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
744ef20d060SBarry Smith @*/
7450910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
746ef20d060SBarry Smith {
747ef20d060SBarry Smith   PetscErrorCode     ierr;
748ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
749ef20d060SBarry Smith   void               *ctx;
750ef20d060SBarry Smith   DM                 dm;
751ef20d060SBarry Smith 
752ef20d060SBarry Smith   PetscFunctionBegin;
753ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7540910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
755ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
756ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
757ef20d060SBarry Smith 
758ef20d060SBarry Smith   if (solutionfunction) {
7599b7cd975SBarry Smith     PetscStackPush("TS user solution function");
7600910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
761ef20d060SBarry Smith     PetscStackPop;
762ef20d060SBarry Smith   }
763ef20d060SBarry Smith   PetscFunctionReturn(0);
764ef20d060SBarry Smith }
7659b7cd975SBarry Smith /*@
7669b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
7679b7cd975SBarry Smith 
7689b7cd975SBarry Smith    Collective on TS and Vec
7699b7cd975SBarry Smith 
7709b7cd975SBarry Smith    Input Parameters:
7719b7cd975SBarry Smith +  ts - the TS context
7729b7cd975SBarry Smith -  t - current time
7739b7cd975SBarry Smith 
7749b7cd975SBarry Smith    Output Parameter:
7759b7cd975SBarry Smith .  U - the function value
7769b7cd975SBarry Smith 
7779b7cd975SBarry Smith    Note:
7789b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
7799b7cd975SBarry Smith    is used internally within the nonlinear solvers.
7809b7cd975SBarry Smith 
7819b7cd975SBarry Smith    Level: developer
7829b7cd975SBarry Smith 
7839b7cd975SBarry Smith .keywords: TS, compute
7849b7cd975SBarry Smith 
7859b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7869b7cd975SBarry Smith @*/
7879b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7889b7cd975SBarry Smith {
7899b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7909b7cd975SBarry Smith   void               *ctx;
7919b7cd975SBarry Smith   DM                 dm;
7929b7cd975SBarry Smith 
7939b7cd975SBarry Smith   PetscFunctionBegin;
7949b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7959b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7969b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7979b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7989b7cd975SBarry Smith 
7999b7cd975SBarry Smith   if (forcing) {
8009b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
8019b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
8029b7cd975SBarry Smith     PetscStackPop;
8039b7cd975SBarry Smith   }
8049b7cd975SBarry Smith   PetscFunctionReturn(0);
8059b7cd975SBarry Smith }
806ef20d060SBarry Smith 
807214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
808214bc6a2SJed Brown {
8092dd45cf8SJed Brown   Vec            F;
810214bc6a2SJed Brown   PetscErrorCode ierr;
811214bc6a2SJed Brown 
812214bc6a2SJed Brown   PetscFunctionBegin;
8130298fd71SBarry Smith   *Frhs = NULL;
8140298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
815214bc6a2SJed Brown   if (!ts->Frhs) {
8162dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
817214bc6a2SJed Brown   }
818214bc6a2SJed Brown   *Frhs = ts->Frhs;
819214bc6a2SJed Brown   PetscFunctionReturn(0);
820214bc6a2SJed Brown }
821214bc6a2SJed Brown 
822214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
823214bc6a2SJed Brown {
824214bc6a2SJed Brown   Mat            A,B;
8252dd45cf8SJed Brown   PetscErrorCode ierr;
82641a1d4d2SBarry Smith   TSIJacobian    ijacobian;
827214bc6a2SJed Brown 
828214bc6a2SJed Brown   PetscFunctionBegin;
829c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
830c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
83141a1d4d2SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr);
832214bc6a2SJed Brown   if (Arhs) {
833214bc6a2SJed Brown     if (!ts->Arhs) {
83441a1d4d2SBarry Smith       if (ijacobian) {
835214bc6a2SJed Brown         ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
83641a1d4d2SBarry Smith       } else {
83741a1d4d2SBarry Smith         ts->Arhs = A;
83841a1d4d2SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
83941a1d4d2SBarry Smith       }
8403565c898SBarry Smith     } else {
8413565c898SBarry Smith       PetscBool flg;
8423565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
8433565c898SBarry Smith       /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */
8443565c898SBarry Smith       if (flg && !ijacobian && ts->Arhs == ts->Brhs){
8453565c898SBarry Smith         ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr);
8463565c898SBarry Smith         ts->Arhs = A;
8473565c898SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
8483565c898SBarry Smith       }
849214bc6a2SJed Brown     }
850214bc6a2SJed Brown     *Arhs = ts->Arhs;
851214bc6a2SJed Brown   }
852214bc6a2SJed Brown   if (Brhs) {
853214bc6a2SJed Brown     if (!ts->Brhs) {
854bdb70873SJed Brown       if (A != B) {
85541a1d4d2SBarry Smith         if (ijacobian) {
856214bc6a2SJed Brown           ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
857bdb70873SJed Brown         } else {
85841a1d4d2SBarry Smith           ts->Brhs = B;
85941a1d4d2SBarry Smith           ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
86041a1d4d2SBarry Smith         }
86141a1d4d2SBarry Smith       } else {
862bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
86351699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
864bdb70873SJed Brown       }
865214bc6a2SJed Brown     }
866214bc6a2SJed Brown     *Brhs = ts->Brhs;
867214bc6a2SJed Brown   }
868214bc6a2SJed Brown   PetscFunctionReturn(0);
869214bc6a2SJed Brown }
870214bc6a2SJed Brown 
871316643e7SJed Brown /*@
8720910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
873316643e7SJed Brown 
874316643e7SJed Brown    Collective on TS and Vec
875316643e7SJed Brown 
876316643e7SJed Brown    Input Parameters:
877316643e7SJed Brown +  ts - the TS context
878316643e7SJed Brown .  t - current time
8790910c330SBarry Smith .  U - state vector
8800910c330SBarry Smith .  Udot - time derivative of state vector
881214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
882316643e7SJed Brown 
883316643e7SJed Brown    Output Parameter:
884316643e7SJed Brown .  Y - right hand side
885316643e7SJed Brown 
886316643e7SJed Brown    Note:
887316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
888316643e7SJed Brown    is used internally within the nonlinear solvers.
889316643e7SJed Brown 
890316643e7SJed Brown    If the user did did not write their equations in implicit form, this
891316643e7SJed Brown    function recasts them in implicit form.
892316643e7SJed Brown 
893316643e7SJed Brown    Level: developer
894316643e7SJed Brown 
895316643e7SJed Brown .keywords: TS, compute
896316643e7SJed Brown 
897316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
898316643e7SJed Brown @*/
8990910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
900316643e7SJed Brown {
901316643e7SJed Brown   PetscErrorCode ierr;
90224989b8cSPeter Brune   TSIFunction    ifunction;
90324989b8cSPeter Brune   TSRHSFunction  rhsfunction;
90424989b8cSPeter Brune   void           *ctx;
90524989b8cSPeter Brune   DM             dm;
906316643e7SJed Brown 
907316643e7SJed Brown   PetscFunctionBegin;
9080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9090910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9100910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
9110700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
912316643e7SJed Brown 
91324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
91424989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
9150298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
91624989b8cSPeter Brune 
917ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
918d90be118SSean Farley 
9190910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
92024989b8cSPeter Brune   if (ifunction) {
921316643e7SJed Brown     PetscStackPush("TS user implicit function");
9220910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
923316643e7SJed Brown     PetscStackPop;
924214bc6a2SJed Brown   }
925214bc6a2SJed Brown   if (imex) {
92624989b8cSPeter Brune     if (!ifunction) {
9270910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
9282dd45cf8SJed Brown     }
92924989b8cSPeter Brune   } else if (rhsfunction) {
93024989b8cSPeter Brune     if (ifunction) {
931214bc6a2SJed Brown       Vec Frhs;
932214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
9330910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
934214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
9352dd45cf8SJed Brown     } else {
9360910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
9370910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
938316643e7SJed Brown     }
9394a6899ffSJed Brown   }
9400910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
941316643e7SJed Brown   PetscFunctionReturn(0);
942316643e7SJed Brown }
943316643e7SJed Brown 
944316643e7SJed Brown /*@
945316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
946316643e7SJed Brown 
947316643e7SJed Brown    Collective on TS and Vec
948316643e7SJed Brown 
949316643e7SJed Brown    Input
950316643e7SJed Brown       Input Parameters:
951316643e7SJed Brown +  ts - the TS context
952316643e7SJed Brown .  t - current timestep
9530910c330SBarry Smith .  U - state vector
9540910c330SBarry Smith .  Udot - time derivative of state vector
955214bc6a2SJed Brown .  shift - shift to apply, see note below
956214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
957316643e7SJed Brown 
958316643e7SJed Brown    Output Parameters:
959316643e7SJed Brown +  A - Jacobian matrix
9603565c898SBarry Smith -  B - matrix from which the preconditioner is constructed; often the same as A
961316643e7SJed Brown 
962316643e7SJed Brown    Notes:
9630910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
964316643e7SJed Brown 
9650910c330SBarry Smith    dF/dU + shift*dF/dUdot
966316643e7SJed Brown 
967316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
968316643e7SJed Brown    is used internally within the nonlinear solvers.
969316643e7SJed Brown 
970316643e7SJed Brown    Level: developer
971316643e7SJed Brown 
972316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
973316643e7SJed Brown 
974316643e7SJed Brown .seealso:  TSSetIJacobian()
97563495f91SJed Brown @*/
976d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
977316643e7SJed Brown {
978316643e7SJed Brown   PetscErrorCode ierr;
97924989b8cSPeter Brune   TSIJacobian    ijacobian;
98024989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
98124989b8cSPeter Brune   DM             dm;
98224989b8cSPeter Brune   void           *ctx;
983316643e7SJed Brown 
984316643e7SJed Brown   PetscFunctionBegin;
9850700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9860910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9870910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
988316643e7SJed Brown   PetscValidPointer(A,6);
98994ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
990316643e7SJed Brown   PetscValidPointer(B,7);
99194ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
99224989b8cSPeter Brune 
99324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
99424989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
9950298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
99624989b8cSPeter Brune 
997ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
998316643e7SJed Brown 
99994ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
100024989b8cSPeter Brune   if (ijacobian) {
10016cd88445SBarry Smith     PetscBool missing;
1002316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
1003d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
1004316643e7SJed Brown     PetscStackPop;
10056cd88445SBarry Smith     ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
10066cd88445SBarry 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");
10073565c898SBarry Smith     if (B != A) {
10086cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
10096cd88445SBarry 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");
10106cd88445SBarry Smith     }
10114a6899ffSJed Brown   }
1012214bc6a2SJed Brown   if (imex) {
1013b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
10144c26be97Sstefano_zampini       PetscBool assembled;
101594ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
10164c26be97Sstefano_zampini       ierr = MatAssembled(A,&assembled);CHKERRQ(ierr);
10174c26be97Sstefano_zampini       if (!assembled) {
10184c26be97Sstefano_zampini         ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10194c26be97Sstefano_zampini         ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10204c26be97Sstefano_zampini       }
102194ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
102294ab13aaSBarry Smith       if (A != B) {
102394ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
10244c26be97Sstefano_zampini         ierr = MatAssembled(B,&assembled);CHKERRQ(ierr);
10254c26be97Sstefano_zampini         if (!assembled) {
10264c26be97Sstefano_zampini           ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10274c26be97Sstefano_zampini           ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
10284c26be97Sstefano_zampini         }
102994ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
1030214bc6a2SJed Brown       }
1031214bc6a2SJed Brown     }
1032214bc6a2SJed Brown   } else {
1033e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
1034e1244c69SJed Brown     if (rhsjacobian) {
1035214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
1036d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
1037e1244c69SJed Brown     }
103894ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
10393565c898SBarry Smith       PetscBool flg;
1040e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
1041e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
10423565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
10433565c898SBarry Smith       /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */
10443565c898SBarry Smith       if (!flg) {
104594ab13aaSBarry Smith         ierr = MatScale(A,-1);CHKERRQ(ierr);
104694ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
10473565c898SBarry Smith       }
104894ab13aaSBarry Smith       if (A != B) {
104994ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
105094ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
1051316643e7SJed Brown       }
1052e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
1053e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1054e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
105594ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
105694ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
105794ab13aaSBarry Smith         if (A != B) {
105894ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
105994ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
1060214bc6a2SJed Brown         }
1061316643e7SJed Brown       }
106294ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
106394ab13aaSBarry Smith       if (A != B) {
106494ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
1065316643e7SJed Brown       }
1066316643e7SJed Brown     }
1067316643e7SJed Brown   }
106894ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
1069316643e7SJed Brown   PetscFunctionReturn(0);
1070316643e7SJed Brown }
1071316643e7SJed Brown 
1072d763cef2SBarry Smith /*@C
1073d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
1074b5abc632SBarry Smith     where U_t = G(t,u).
1075d763cef2SBarry Smith 
10763f9fe445SBarry Smith     Logically Collective on TS
1077d763cef2SBarry Smith 
1078d763cef2SBarry Smith     Input Parameters:
1079d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
10800298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
1081d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
1082d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
10830298fd71SBarry Smith           function evaluation routine (may be NULL)
1084d763cef2SBarry Smith 
1085d763cef2SBarry Smith     Calling sequence of func:
108687828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
1087d763cef2SBarry Smith 
1088d763cef2SBarry Smith +   t - current timestep
1089d763cef2SBarry Smith .   u - input vector
1090d763cef2SBarry Smith .   F - function vector
1091d763cef2SBarry Smith -   ctx - [optional] user-defined function context
1092d763cef2SBarry Smith 
1093d763cef2SBarry Smith     Level: beginner
1094d763cef2SBarry Smith 
10952bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
10962bbac0d3SBarry Smith 
1097d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1098d763cef2SBarry Smith 
1099ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
1100d763cef2SBarry Smith @*/
1101089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
1102d763cef2SBarry Smith {
1103089b2837SJed Brown   PetscErrorCode ierr;
1104089b2837SJed Brown   SNES           snes;
11050298fd71SBarry Smith   Vec            ralloc = NULL;
110624989b8cSPeter Brune   DM             dm;
1107d763cef2SBarry Smith 
1108089b2837SJed Brown   PetscFunctionBegin;
11090700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1110ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
111124989b8cSPeter Brune 
111224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
111324989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1114089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1115e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1116e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1117e856ceecSJed Brown     r = ralloc;
1118e856ceecSJed Brown   }
1119089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1120e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1121d763cef2SBarry Smith   PetscFunctionReturn(0);
1122d763cef2SBarry Smith }
1123d763cef2SBarry Smith 
1124ef20d060SBarry Smith /*@C
1125abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1126ef20d060SBarry Smith 
1127ef20d060SBarry Smith     Logically Collective on TS
1128ef20d060SBarry Smith 
1129ef20d060SBarry Smith     Input Parameters:
1130ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1131ef20d060SBarry Smith .   f - routine for evaluating the solution
1132ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
11330298fd71SBarry Smith           function evaluation routine (may be NULL)
1134ef20d060SBarry Smith 
1135ef20d060SBarry Smith     Calling sequence of func:
1136ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
1137ef20d060SBarry Smith 
1138ef20d060SBarry Smith +   t - current timestep
1139ef20d060SBarry Smith .   u - output vector
1140ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1141ef20d060SBarry Smith 
11420ed3bfb6SBarry Smith     Options Database:
11430ed3bfb6SBarry Smith +  -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction()
11440ed3bfb6SBarry Smith -  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
11450ed3bfb6SBarry Smith 
1146abd5a294SJed Brown     Notes:
1147abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1148abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1149abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1150abd5a294SJed Brown 
11514f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1152abd5a294SJed Brown 
1153ef20d060SBarry Smith     Level: beginner
1154ef20d060SBarry Smith 
1155ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1156ef20d060SBarry Smith 
11570ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError()
1158ef20d060SBarry Smith @*/
1159ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1160ef20d060SBarry Smith {
1161ef20d060SBarry Smith   PetscErrorCode ierr;
1162ef20d060SBarry Smith   DM             dm;
1163ef20d060SBarry Smith 
1164ef20d060SBarry Smith   PetscFunctionBegin;
1165ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1166ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1167ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1168ef20d060SBarry Smith   PetscFunctionReturn(0);
1169ef20d060SBarry Smith }
1170ef20d060SBarry Smith 
11719b7cd975SBarry Smith /*@C
11729b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
11739b7cd975SBarry Smith 
11749b7cd975SBarry Smith     Logically Collective on TS
11759b7cd975SBarry Smith 
11769b7cd975SBarry Smith     Input Parameters:
11779b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
1178e162b725SBarry Smith .   func - routine for evaluating the forcing function
11799b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
11800298fd71SBarry Smith           function evaluation routine (may be NULL)
11819b7cd975SBarry Smith 
11829b7cd975SBarry Smith     Calling sequence of func:
1183e162b725SBarry Smith $     func (TS ts,PetscReal t,Vec f,void *ctx);
11849b7cd975SBarry Smith 
11859b7cd975SBarry Smith +   t - current timestep
1186e162b725SBarry Smith .   f - output vector
11879b7cd975SBarry Smith -   ctx - [optional] user-defined function context
11889b7cd975SBarry Smith 
11899b7cd975SBarry Smith     Notes:
11909b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
1191e162b725SBarry 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
1192e162b725SBarry Smith     definition of the problem you are solving and hence possibly introducing bugs.
1193e162b725SBarry Smith 
1194e162b725SBarry Smith     This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0
1195e162b725SBarry Smith 
1196e162b725SBarry 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
1197e162b725SBarry Smith     parameters can be passed in the ctx variable.
11989b7cd975SBarry Smith 
11999b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
12009b7cd975SBarry Smith 
12019b7cd975SBarry Smith     Level: beginner
12029b7cd975SBarry Smith 
12039b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
12049b7cd975SBarry Smith 
12059b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
12069b7cd975SBarry Smith @*/
1207e162b725SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx)
12089b7cd975SBarry Smith {
12099b7cd975SBarry Smith   PetscErrorCode ierr;
12109b7cd975SBarry Smith   DM             dm;
12119b7cd975SBarry Smith 
12129b7cd975SBarry Smith   PetscFunctionBegin;
12139b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
12149b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1215e162b725SBarry Smith   ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr);
12169b7cd975SBarry Smith   PetscFunctionReturn(0);
12179b7cd975SBarry Smith }
12189b7cd975SBarry Smith 
1219d763cef2SBarry Smith /*@C
1220f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1221b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1222d763cef2SBarry Smith 
12233f9fe445SBarry Smith    Logically Collective on TS
1224d763cef2SBarry Smith 
1225d763cef2SBarry Smith    Input Parameters:
1226d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1227e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1228e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1229d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1230d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
12310298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1232d763cef2SBarry Smith 
1233f7ab8db6SBarry Smith    Calling sequence of f:
1234ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1235d763cef2SBarry Smith 
1236d763cef2SBarry Smith +  t - current timestep
1237d763cef2SBarry Smith .  u - input vector
1238e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1239e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1240d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1241d763cef2SBarry Smith 
12426cd88445SBarry Smith    Notes:
12436cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
12446cd88445SBarry Smith 
12456cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1246ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1247d763cef2SBarry Smith 
1248d763cef2SBarry Smith    Level: beginner
1249d763cef2SBarry Smith 
1250d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1251d763cef2SBarry Smith 
1252ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1253d763cef2SBarry Smith 
1254d763cef2SBarry Smith @*/
1255e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1256d763cef2SBarry Smith {
1257277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1258089b2837SJed Brown   SNES           snes;
125924989b8cSPeter Brune   DM             dm;
126024989b8cSPeter Brune   TSIJacobian    ijacobian;
1261277b19d0SLisandro Dalcin 
1262d763cef2SBarry Smith   PetscFunctionBegin;
12630700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1264e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1265e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1266e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1267e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1268d763cef2SBarry Smith 
126924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
127024989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1271e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1272e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1273e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1274e1244c69SJed Brown   }
12750298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1276089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12775f659677SPeter Brune   if (!ijacobian) {
1278e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
12790e4ef248SJed Brown   }
1280e5d3d808SBarry Smith   if (Amat) {
1281e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
12820e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1283e5d3d808SBarry Smith     ts->Arhs = Amat;
12840e4ef248SJed Brown   }
1285e5d3d808SBarry Smith   if (Pmat) {
1286e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
12870e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1288e5d3d808SBarry Smith     ts->Brhs = Pmat;
12890e4ef248SJed Brown   }
1290d763cef2SBarry Smith   PetscFunctionReturn(0);
1291d763cef2SBarry Smith }
1292d763cef2SBarry Smith 
1293316643e7SJed Brown /*@C
1294b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1295316643e7SJed Brown 
12963f9fe445SBarry Smith    Logically Collective on TS
1297316643e7SJed Brown 
1298316643e7SJed Brown    Input Parameters:
1299316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
13000298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1301316643e7SJed Brown .  f   - the function evaluation routine
13020298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1303316643e7SJed Brown 
1304316643e7SJed Brown    Calling sequence of f:
1305316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1306316643e7SJed Brown 
1307316643e7SJed Brown +  t   - time at step/stage being solved
1308316643e7SJed Brown .  u   - state vector
1309316643e7SJed Brown .  u_t - time derivative of state vector
1310316643e7SJed Brown .  F   - function vector
1311316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1312316643e7SJed Brown 
1313316643e7SJed Brown    Important:
13142bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1315316643e7SJed Brown 
1316316643e7SJed Brown    Level: beginner
1317316643e7SJed Brown 
1318316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1319316643e7SJed Brown 
1320d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1321316643e7SJed Brown @*/
132251699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1323316643e7SJed Brown {
1324089b2837SJed Brown   PetscErrorCode ierr;
1325089b2837SJed Brown   SNES           snes;
132651699248SLisandro Dalcin   Vec            ralloc = NULL;
132724989b8cSPeter Brune   DM             dm;
1328316643e7SJed Brown 
1329316643e7SJed Brown   PetscFunctionBegin;
13300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
133151699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
133224989b8cSPeter Brune 
133324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
133424989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
133524989b8cSPeter Brune 
1336089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
133751699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
133851699248SLisandro Dalcin     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
133951699248SLisandro Dalcin     r  = ralloc;
1340e856ceecSJed Brown   }
134151699248SLisandro Dalcin   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
134251699248SLisandro Dalcin   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1343089b2837SJed Brown   PetscFunctionReturn(0);
1344089b2837SJed Brown }
1345089b2837SJed Brown 
1346089b2837SJed Brown /*@C
1347089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1348089b2837SJed Brown 
1349089b2837SJed Brown    Not Collective
1350089b2837SJed Brown 
1351089b2837SJed Brown    Input Parameter:
1352089b2837SJed Brown .  ts - the TS context
1353089b2837SJed Brown 
1354089b2837SJed Brown    Output Parameter:
13550298fd71SBarry Smith +  r - vector to hold residual (or NULL)
13560298fd71SBarry Smith .  func - the function to compute residual (or NULL)
13570298fd71SBarry Smith -  ctx - the function context (or NULL)
1358089b2837SJed Brown 
1359089b2837SJed Brown    Level: advanced
1360089b2837SJed Brown 
1361089b2837SJed Brown .keywords: TS, nonlinear, get, function
1362089b2837SJed Brown 
1363089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1364089b2837SJed Brown @*/
1365089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1366089b2837SJed Brown {
1367089b2837SJed Brown   PetscErrorCode ierr;
1368089b2837SJed Brown   SNES           snes;
136924989b8cSPeter Brune   DM             dm;
1370089b2837SJed Brown 
1371089b2837SJed Brown   PetscFunctionBegin;
1372089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1373089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13740298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
137524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
137624989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1377089b2837SJed Brown   PetscFunctionReturn(0);
1378089b2837SJed Brown }
1379089b2837SJed Brown 
1380089b2837SJed Brown /*@C
1381089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1382089b2837SJed Brown 
1383089b2837SJed Brown    Not Collective
1384089b2837SJed Brown 
1385089b2837SJed Brown    Input Parameter:
1386089b2837SJed Brown .  ts - the TS context
1387089b2837SJed Brown 
1388089b2837SJed Brown    Output Parameter:
13890298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
13900298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
13910298fd71SBarry Smith -  ctx - the function context (or NULL)
1392089b2837SJed Brown 
1393089b2837SJed Brown    Level: advanced
1394089b2837SJed Brown 
1395089b2837SJed Brown .keywords: TS, nonlinear, get, function
1396089b2837SJed Brown 
13972bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1398089b2837SJed Brown @*/
1399089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1400089b2837SJed Brown {
1401089b2837SJed Brown   PetscErrorCode ierr;
1402089b2837SJed Brown   SNES           snes;
140324989b8cSPeter Brune   DM             dm;
1404089b2837SJed Brown 
1405089b2837SJed Brown   PetscFunctionBegin;
1406089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1407089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
14080298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
140924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
141024989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1411316643e7SJed Brown   PetscFunctionReturn(0);
1412316643e7SJed Brown }
1413316643e7SJed Brown 
1414316643e7SJed Brown /*@C
1415a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1416ae8867d6SBarry Smith         provided with TSSetIFunction().
1417316643e7SJed Brown 
14183f9fe445SBarry Smith    Logically Collective on TS
1419316643e7SJed Brown 
1420316643e7SJed Brown    Input Parameters:
1421316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1422e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1423e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1424316643e7SJed Brown .  f   - the Jacobian evaluation routine
14250298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1426316643e7SJed Brown 
1427316643e7SJed Brown    Calling sequence of f:
1428ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1429316643e7SJed Brown 
1430316643e7SJed Brown +  t    - time at step/stage being solved
14311b4a444bSJed Brown .  U    - state vector
14321b4a444bSJed Brown .  U_t  - time derivative of state vector
1433316643e7SJed Brown .  a    - shift
1434e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1435e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1436316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1437316643e7SJed Brown 
1438316643e7SJed Brown    Notes:
1439e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1440316643e7SJed Brown 
1441895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1442895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1443895c21f2SBarry Smith 
1444a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1445b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1446a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1447a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1448a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1449a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1450a4f0a591SBarry Smith 
14516cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
14526cd88445SBarry Smith 
14536cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1454ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1455ca5f011dSBarry Smith 
1456316643e7SJed Brown    Level: beginner
1457316643e7SJed Brown 
1458316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1459316643e7SJed Brown 
1460ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1461316643e7SJed Brown 
1462316643e7SJed Brown @*/
1463e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1464316643e7SJed Brown {
1465316643e7SJed Brown   PetscErrorCode ierr;
1466089b2837SJed Brown   SNES           snes;
146724989b8cSPeter Brune   DM             dm;
1468316643e7SJed Brown 
1469316643e7SJed Brown   PetscFunctionBegin;
14700700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1471e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1472e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1473e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1474e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
147524989b8cSPeter Brune 
147624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
147724989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
147824989b8cSPeter Brune 
1479089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1480e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1481316643e7SJed Brown   PetscFunctionReturn(0);
1482316643e7SJed Brown }
1483316643e7SJed Brown 
1484e1244c69SJed Brown /*@
1485e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1486e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1487e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1488e1244c69SJed Brown    not been changed by the TS.
1489e1244c69SJed Brown 
1490e1244c69SJed Brown    Logically Collective
1491e1244c69SJed Brown 
1492e1244c69SJed Brown    Input Arguments:
1493e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1494e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1495e1244c69SJed Brown 
1496e1244c69SJed Brown    Level: intermediate
1497e1244c69SJed Brown 
1498e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1499e1244c69SJed Brown @*/
1500e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1501e1244c69SJed Brown {
1502e1244c69SJed Brown   PetscFunctionBegin;
1503e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1504e1244c69SJed Brown   PetscFunctionReturn(0);
1505e1244c69SJed Brown }
1506e1244c69SJed Brown 
1507efe9872eSLisandro Dalcin /*@C
1508efe9872eSLisandro Dalcin    TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1509efe9872eSLisandro Dalcin 
1510efe9872eSLisandro Dalcin    Logically Collective on TS
1511efe9872eSLisandro Dalcin 
1512efe9872eSLisandro Dalcin    Input Parameters:
1513efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1514efe9872eSLisandro Dalcin .  F   - vector to hold the residual (or NULL to have it created internally)
1515efe9872eSLisandro Dalcin .  fun - the function evaluation routine
1516efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1517efe9872eSLisandro Dalcin 
1518efe9872eSLisandro Dalcin    Calling sequence of fun:
1519efe9872eSLisandro Dalcin $  fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx);
1520efe9872eSLisandro Dalcin 
1521efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1522efe9872eSLisandro Dalcin .  U    - state vector
1523efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1524efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1525efe9872eSLisandro Dalcin .  F    - function vector
1526efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine (may be NULL)
1527efe9872eSLisandro Dalcin 
1528efe9872eSLisandro Dalcin    Level: beginner
1529efe9872eSLisandro Dalcin 
1530efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function
1531efe9872eSLisandro Dalcin 
1532efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian()
1533efe9872eSLisandro Dalcin @*/
1534efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx)
1535efe9872eSLisandro Dalcin {
1536efe9872eSLisandro Dalcin   DM             dm;
1537efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1538efe9872eSLisandro Dalcin 
1539efe9872eSLisandro Dalcin   PetscFunctionBegin;
1540efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1541efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2);
1542efe9872eSLisandro Dalcin   ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr);
1543efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1544efe9872eSLisandro Dalcin   ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1545efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1546efe9872eSLisandro Dalcin }
1547efe9872eSLisandro Dalcin 
1548efe9872eSLisandro Dalcin /*@C
1549efe9872eSLisandro Dalcin   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1550efe9872eSLisandro Dalcin 
1551efe9872eSLisandro Dalcin   Not Collective
1552efe9872eSLisandro Dalcin 
1553efe9872eSLisandro Dalcin   Input Parameter:
1554efe9872eSLisandro Dalcin . ts - the TS context
1555efe9872eSLisandro Dalcin 
1556efe9872eSLisandro Dalcin   Output Parameter:
1557efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL)
1558efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL)
1559efe9872eSLisandro Dalcin - ctx - the function context (or NULL)
1560efe9872eSLisandro Dalcin 
1561efe9872eSLisandro Dalcin   Level: advanced
1562efe9872eSLisandro Dalcin 
1563efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function
1564efe9872eSLisandro Dalcin 
1565efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction()
1566efe9872eSLisandro Dalcin @*/
1567efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1568efe9872eSLisandro Dalcin {
1569efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1570efe9872eSLisandro Dalcin   SNES           snes;
1571efe9872eSLisandro Dalcin   DM             dm;
1572efe9872eSLisandro Dalcin 
1573efe9872eSLisandro Dalcin   PetscFunctionBegin;
1574efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1575efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1576efe9872eSLisandro Dalcin   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1577efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1578efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1579efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1580efe9872eSLisandro Dalcin }
1581efe9872eSLisandro Dalcin 
1582efe9872eSLisandro Dalcin /*@C
1583bc77d74cSLisandro Dalcin    TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1584efe9872eSLisandro Dalcin         where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1585efe9872eSLisandro Dalcin 
1586efe9872eSLisandro Dalcin    Logically Collective on TS
1587efe9872eSLisandro Dalcin 
1588efe9872eSLisandro Dalcin    Input Parameters:
1589efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1590efe9872eSLisandro Dalcin .  J   - Jacobian matrix
1591efe9872eSLisandro Dalcin .  P   - preconditioning matrix for J (may be same as J)
1592efe9872eSLisandro Dalcin .  jac - the Jacobian evaluation routine
1593efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1594efe9872eSLisandro Dalcin 
1595efe9872eSLisandro Dalcin    Calling sequence of jac:
1596bc77d74cSLisandro Dalcin $  jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx);
1597efe9872eSLisandro Dalcin 
1598efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1599efe9872eSLisandro Dalcin .  U    - state vector
1600efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1601efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1602efe9872eSLisandro Dalcin .  v    - shift for U_t
1603efe9872eSLisandro Dalcin .  a    - shift for U_tt
1604efe9872eSLisandro 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
1605efe9872eSLisandro Dalcin .  P    - preconditioning matrix for J, may be same as J
1606efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine
1607efe9872eSLisandro Dalcin 
1608efe9872eSLisandro Dalcin    Notes:
1609efe9872eSLisandro Dalcin    The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1610efe9872eSLisandro Dalcin 
1611efe9872eSLisandro Dalcin    The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1612efe9872eSLisandro 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.
1613efe9872eSLisandro Dalcin    The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1614bc77d74cSLisandro Dalcin    parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1615efe9872eSLisandro Dalcin 
1616efe9872eSLisandro Dalcin    Level: beginner
1617efe9872eSLisandro Dalcin 
1618efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian
1619efe9872eSLisandro Dalcin 
1620efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1621efe9872eSLisandro Dalcin @*/
1622efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1623efe9872eSLisandro Dalcin {
1624efe9872eSLisandro Dalcin   DM             dm;
1625efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1626efe9872eSLisandro Dalcin 
1627efe9872eSLisandro Dalcin   PetscFunctionBegin;
1628efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1629efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2);
1630efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3);
1631efe9872eSLisandro Dalcin   ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr);
1632efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1633efe9872eSLisandro Dalcin   ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1634efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1635efe9872eSLisandro Dalcin }
1636efe9872eSLisandro Dalcin 
1637efe9872eSLisandro Dalcin /*@C
1638efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1639efe9872eSLisandro Dalcin 
1640efe9872eSLisandro Dalcin   Not Collective, but parallel objects are returned if TS is parallel
1641efe9872eSLisandro Dalcin 
1642efe9872eSLisandro Dalcin   Input Parameter:
1643efe9872eSLisandro Dalcin . ts  - The TS context obtained from TSCreate()
1644efe9872eSLisandro Dalcin 
1645efe9872eSLisandro Dalcin   Output Parameters:
1646efe9872eSLisandro Dalcin + J  - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1647efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J
1648efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1649efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1650efe9872eSLisandro Dalcin 
1651efe9872eSLisandro Dalcin   Notes: You can pass in NULL for any return argument you do not need.
1652efe9872eSLisandro Dalcin 
1653efe9872eSLisandro Dalcin   Level: advanced
1654efe9872eSLisandro Dalcin 
165580275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
1656efe9872eSLisandro Dalcin 
1657efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian
1658efe9872eSLisandro Dalcin @*/
1659efe9872eSLisandro Dalcin PetscErrorCode  TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1660efe9872eSLisandro Dalcin {
1661efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1662efe9872eSLisandro Dalcin   SNES           snes;
1663efe9872eSLisandro Dalcin   DM             dm;
1664efe9872eSLisandro Dalcin 
1665efe9872eSLisandro Dalcin   PetscFunctionBegin;
1666efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1667efe9872eSLisandro Dalcin   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
1668efe9872eSLisandro Dalcin   ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr);
1669efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1670efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1671efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1672efe9872eSLisandro Dalcin }
1673efe9872eSLisandro Dalcin 
1674efe9872eSLisandro Dalcin /*@
1675efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1676efe9872eSLisandro Dalcin 
1677efe9872eSLisandro Dalcin   Collective on TS and Vec
1678efe9872eSLisandro Dalcin 
1679efe9872eSLisandro Dalcin   Input Parameters:
1680efe9872eSLisandro Dalcin + ts - the TS context
1681efe9872eSLisandro Dalcin . t - current time
1682efe9872eSLisandro Dalcin . U - state vector
1683efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t)
1684efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt)
1685efe9872eSLisandro Dalcin 
1686efe9872eSLisandro Dalcin   Output Parameter:
1687efe9872eSLisandro Dalcin . F - the residual vector
1688efe9872eSLisandro Dalcin 
1689efe9872eSLisandro Dalcin   Note:
1690efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1691efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1692efe9872eSLisandro Dalcin 
1693efe9872eSLisandro Dalcin   Level: developer
1694efe9872eSLisandro Dalcin 
1695efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector
1696efe9872eSLisandro Dalcin 
1697efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1698efe9872eSLisandro Dalcin @*/
1699efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1700efe9872eSLisandro Dalcin {
1701efe9872eSLisandro Dalcin   DM             dm;
1702efe9872eSLisandro Dalcin   TSI2Function   I2Function;
1703efe9872eSLisandro Dalcin   void           *ctx;
1704efe9872eSLisandro Dalcin   TSRHSFunction  rhsfunction;
1705efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1706efe9872eSLisandro Dalcin 
1707efe9872eSLisandro Dalcin   PetscFunctionBegin;
1708efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1709efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1710efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1711efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1712efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F,VEC_CLASSID,6);
1713efe9872eSLisandro Dalcin 
1714efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1715efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr);
1716efe9872eSLisandro Dalcin   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
1717efe9872eSLisandro Dalcin 
1718efe9872eSLisandro Dalcin   if (!I2Function) {
1719efe9872eSLisandro Dalcin     ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr);
1720efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1721efe9872eSLisandro Dalcin   }
1722efe9872eSLisandro Dalcin 
1723efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1724efe9872eSLisandro Dalcin 
1725efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit function");
1726efe9872eSLisandro Dalcin   ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr);
1727efe9872eSLisandro Dalcin   PetscStackPop;
1728efe9872eSLisandro Dalcin 
1729efe9872eSLisandro Dalcin   if (rhsfunction) {
1730efe9872eSLisandro Dalcin     Vec Frhs;
1731efe9872eSLisandro Dalcin     ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
1732efe9872eSLisandro Dalcin     ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
1733efe9872eSLisandro Dalcin     ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr);
1734efe9872eSLisandro Dalcin   }
1735efe9872eSLisandro Dalcin 
1736efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1737efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1738efe9872eSLisandro Dalcin }
1739efe9872eSLisandro Dalcin 
1740efe9872eSLisandro Dalcin /*@
1741efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1742efe9872eSLisandro Dalcin 
1743efe9872eSLisandro Dalcin   Collective on TS and Vec
1744efe9872eSLisandro Dalcin 
1745efe9872eSLisandro Dalcin   Input Parameters:
1746efe9872eSLisandro Dalcin + ts - the TS context
1747efe9872eSLisandro Dalcin . t - current timestep
1748efe9872eSLisandro Dalcin . U - state vector
1749efe9872eSLisandro Dalcin . V - time derivative of state vector
1750efe9872eSLisandro Dalcin . A - second time derivative of state vector
1751efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1752efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1753efe9872eSLisandro Dalcin 
1754efe9872eSLisandro Dalcin   Output Parameters:
1755efe9872eSLisandro Dalcin + J - Jacobian matrix
1756efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1757efe9872eSLisandro Dalcin 
1758efe9872eSLisandro Dalcin   Notes:
1759efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1760efe9872eSLisandro Dalcin 
1761efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1762efe9872eSLisandro Dalcin 
1763efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1764efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1765efe9872eSLisandro Dalcin 
1766efe9872eSLisandro Dalcin   Level: developer
1767efe9872eSLisandro Dalcin 
1768efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix
1769efe9872eSLisandro Dalcin 
1770efe9872eSLisandro Dalcin .seealso:  TSSetI2Jacobian()
1771efe9872eSLisandro Dalcin @*/
1772efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1773efe9872eSLisandro Dalcin {
1774efe9872eSLisandro Dalcin   DM             dm;
1775efe9872eSLisandro Dalcin   TSI2Jacobian   I2Jacobian;
1776efe9872eSLisandro Dalcin   void           *ctx;
1777efe9872eSLisandro Dalcin   TSRHSJacobian  rhsjacobian;
1778efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1779efe9872eSLisandro Dalcin 
1780efe9872eSLisandro Dalcin   PetscFunctionBegin;
1781efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1782efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1783efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1784efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1785efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J,MAT_CLASSID,8);
1786efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P,MAT_CLASSID,9);
1787efe9872eSLisandro Dalcin 
1788efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1789efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr);
1790efe9872eSLisandro Dalcin   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
1791efe9872eSLisandro Dalcin 
1792efe9872eSLisandro Dalcin   if (!I2Jacobian) {
1793efe9872eSLisandro Dalcin     ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr);
1794efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1795efe9872eSLisandro Dalcin   }
1796efe9872eSLisandro Dalcin 
1797efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1798efe9872eSLisandro Dalcin 
1799efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit Jacobian");
1800efe9872eSLisandro Dalcin   ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr);
1801efe9872eSLisandro Dalcin   PetscStackPop;
1802efe9872eSLisandro Dalcin 
1803efe9872eSLisandro Dalcin   if (rhsjacobian) {
1804efe9872eSLisandro Dalcin     Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1805efe9872eSLisandro Dalcin     ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr);
1806efe9872eSLisandro Dalcin     ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr);
1807efe9872eSLisandro Dalcin     ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr);
1808efe9872eSLisandro Dalcin     if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);}
1809efe9872eSLisandro Dalcin   }
1810efe9872eSLisandro Dalcin 
1811efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1812efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1813efe9872eSLisandro Dalcin }
1814efe9872eSLisandro Dalcin 
1815efe9872eSLisandro Dalcin /*@
1816efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1817efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1818efe9872eSLisandro Dalcin 
1819efe9872eSLisandro Dalcin    Logically Collective on TS and Vec
1820efe9872eSLisandro Dalcin 
1821efe9872eSLisandro Dalcin    Input Parameters:
1822efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1823efe9872eSLisandro Dalcin .  u - the solution vector
1824efe9872eSLisandro Dalcin -  v - the time derivative vector
1825efe9872eSLisandro Dalcin 
1826efe9872eSLisandro Dalcin    Level: beginner
1827efe9872eSLisandro Dalcin 
1828efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions
1829efe9872eSLisandro Dalcin @*/
1830efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1831efe9872eSLisandro Dalcin {
1832efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1833efe9872eSLisandro Dalcin 
1834efe9872eSLisandro Dalcin   PetscFunctionBegin;
1835efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1836efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1837efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1838efe9872eSLisandro Dalcin   ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
1839efe9872eSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr);
1840efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
1841efe9872eSLisandro Dalcin   ts->vec_dot = v;
1842efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1843efe9872eSLisandro Dalcin }
1844efe9872eSLisandro Dalcin 
1845efe9872eSLisandro Dalcin /*@
1846efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1847efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1848efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1849efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1850efe9872eSLisandro Dalcin 
1851efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1852efe9872eSLisandro Dalcin 
1853efe9872eSLisandro Dalcin    Input Parameter:
1854efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1855efe9872eSLisandro Dalcin 
1856efe9872eSLisandro Dalcin    Output Parameter:
1857efe9872eSLisandro Dalcin +  u - the vector containing the solution
1858efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1859efe9872eSLisandro Dalcin 
1860efe9872eSLisandro Dalcin    Level: intermediate
1861efe9872eSLisandro Dalcin 
1862efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1863efe9872eSLisandro Dalcin 
1864efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution
1865efe9872eSLisandro Dalcin @*/
1866efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1867efe9872eSLisandro Dalcin {
1868efe9872eSLisandro Dalcin   PetscFunctionBegin;
1869efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1870efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1871efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1872efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1873efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1874efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1875efe9872eSLisandro Dalcin }
1876efe9872eSLisandro Dalcin 
187755849f57SBarry Smith /*@C
187855849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
187955849f57SBarry Smith 
188055849f57SBarry Smith   Collective on PetscViewer
188155849f57SBarry Smith 
188255849f57SBarry Smith   Input Parameters:
188355849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
188455849f57SBarry Smith            some related function before a call to TSLoad().
188555849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
188655849f57SBarry Smith 
188755849f57SBarry Smith    Level: intermediate
188855849f57SBarry Smith 
188955849f57SBarry Smith   Notes:
189055849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
189155849f57SBarry Smith 
189255849f57SBarry Smith   Notes for advanced users:
189355849f57SBarry Smith   Most users should not need to know the details of the binary storage
189455849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
189555849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
189655849f57SBarry Smith   format is
189755849f57SBarry Smith .vb
189855849f57SBarry Smith      has not yet been determined
189955849f57SBarry Smith .ve
190055849f57SBarry Smith 
190155849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
190255849f57SBarry Smith @*/
1903f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
190455849f57SBarry Smith {
190555849f57SBarry Smith   PetscErrorCode ierr;
190655849f57SBarry Smith   PetscBool      isbinary;
190755849f57SBarry Smith   PetscInt       classid;
190855849f57SBarry Smith   char           type[256];
19092d53ad75SBarry Smith   DMTS           sdm;
1910ad6bc421SBarry Smith   DM             dm;
191155849f57SBarry Smith 
191255849f57SBarry Smith   PetscFunctionBegin;
1913f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
191455849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
191555849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
191655849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
191755849f57SBarry Smith 
1918060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1919ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1920060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1921f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1922f2c2a1b9SBarry Smith   if (ts->ops->load) {
1923f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1924f2c2a1b9SBarry Smith   }
1925ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1926ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1927ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1928f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1929f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
19302d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19312d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
193255849f57SBarry Smith   PetscFunctionReturn(0);
193355849f57SBarry Smith }
193455849f57SBarry Smith 
19359804daf3SBarry Smith #include <petscdraw.h>
1936e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1937e04113cfSBarry Smith #include <petscviewersaws.h>
1938f05ece33SBarry Smith #endif
19397e2c5f70SBarry Smith /*@C
1940d763cef2SBarry Smith     TSView - Prints the TS data structure.
1941d763cef2SBarry Smith 
19424c49b128SBarry Smith     Collective on TS
1943d763cef2SBarry Smith 
1944d763cef2SBarry Smith     Input Parameters:
1945d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1946d763cef2SBarry Smith -   viewer - visualization context
1947d763cef2SBarry Smith 
1948d763cef2SBarry Smith     Options Database Key:
1949d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1950d763cef2SBarry Smith 
1951d763cef2SBarry Smith     Notes:
1952d763cef2SBarry Smith     The available visualization contexts include
1953b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1954b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1955d763cef2SBarry Smith          output where only the first processor opens
1956d763cef2SBarry Smith          the file.  All other processors send their
1957d763cef2SBarry Smith          data to the first processor to print.
1958d763cef2SBarry Smith 
1959d763cef2SBarry Smith     The user can open an alternative visualization context with
1960b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1961d763cef2SBarry Smith 
1962d763cef2SBarry Smith     Level: beginner
1963d763cef2SBarry Smith 
1964d763cef2SBarry Smith .keywords: TS, timestep, view
1965d763cef2SBarry Smith 
1966b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1967d763cef2SBarry Smith @*/
19687087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1969d763cef2SBarry Smith {
1970dfbe8321SBarry Smith   PetscErrorCode ierr;
197119fd82e9SBarry Smith   TSType         type;
19722b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
19732d53ad75SBarry Smith   DMTS           sdm;
1974e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1975536b137fSBarry Smith   PetscBool      issaws;
1976f05ece33SBarry Smith #endif
1977d763cef2SBarry Smith 
1978d763cef2SBarry Smith   PetscFunctionBegin;
19790700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
19803050cee2SBarry Smith   if (!viewer) {
1981ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
19823050cee2SBarry Smith   }
19830700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1984c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1985fd16b177SBarry Smith 
1986251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1987251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
198855849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
19892b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1990e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1991536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1992f05ece33SBarry Smith #endif
199332077d6dSBarry Smith   if (iascii) {
1994dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
1995efd4aadfSBarry Smith     if (ts->ops->view) {
1996efd4aadfSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1997efd4aadfSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1998efd4aadfSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1999efd4aadfSBarry Smith     }
2000ef85077eSLisandro Dalcin     if (ts->max_steps < PETSC_MAX_INT) {
200177431f27SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
2002ef85077eSLisandro Dalcin     }
2003ef85077eSLisandro Dalcin     if (ts->max_time < PETSC_MAX_REAL) {
20047c8652ddSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
2005ef85077eSLisandro Dalcin     }
2006efd4aadfSBarry Smith     if (ts->usessnes) {
2007efd4aadfSBarry Smith       PetscBool lin;
2008d763cef2SBarry Smith       if (ts->problem_type == TS_NONLINEAR) {
20095ef26d82SJed Brown         ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
2010d763cef2SBarry Smith       }
20115ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
2012efd4aadfSBarry Smith       ierr = PetscObjectTypeCompare((PetscObject)ts->snes,SNESKSPONLY,&lin);CHKERRQ(ierr);
2013efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr);
2014efd4aadfSBarry Smith     }
2015193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
2016a0af407cSBarry Smith     if (ts->vrtol) {
2017a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of relative error tolerances, ");CHKERRQ(ierr);
2018a0af407cSBarry Smith     } else {
2019a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr);
2020a0af407cSBarry Smith     }
2021a0af407cSBarry Smith     if (ts->vatol) {
2022a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of absolute error tolerances\n");CHKERRQ(ierr);
2023a0af407cSBarry Smith     } else {
2024a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr);
2025a0af407cSBarry Smith     }
2026efd4aadfSBarry Smith     ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);
2027efd4aadfSBarry Smith     if (ts->snes && ts->usessnes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
20282d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
20292d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
20300f5bd95cSBarry Smith   } else if (isstring) {
2031a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
2032b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
203355849f57SBarry Smith   } else if (isbinary) {
203455849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
203555849f57SBarry Smith     MPI_Comm    comm;
203655849f57SBarry Smith     PetscMPIInt rank;
203755849f57SBarry Smith     char        type[256];
203855849f57SBarry Smith 
203955849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
204055849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
204155849f57SBarry Smith     if (!rank) {
204255849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
204355849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
204455849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
204555849f57SBarry Smith     }
204655849f57SBarry Smith     if (ts->ops->view) {
204755849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
204855849f57SBarry Smith     }
2049efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2050f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
2051f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
20522d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
20532d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
20542b0a91c0SBarry Smith   } else if (isdraw) {
20552b0a91c0SBarry Smith     PetscDraw draw;
20562b0a91c0SBarry Smith     char      str[36];
205789fd9fafSBarry Smith     PetscReal x,y,bottom,h;
20582b0a91c0SBarry Smith 
20592b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
20602b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
20612b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
20622b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
206351fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
206489fd9fafSBarry Smith     bottom = y - h;
20652b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
20662b0a91c0SBarry Smith     if (ts->ops->view) {
20672b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
20682b0a91c0SBarry Smith     }
2069efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2070efd4aadfSBarry Smith     if (ts->snes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
20712b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2072e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2073536b137fSBarry Smith   } else if (issaws) {
2074d45a07a7SBarry Smith     PetscMPIInt rank;
20752657e9d9SBarry Smith     const char  *name;
20762657e9d9SBarry Smith 
20772657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
2078d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
2079d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
2080d45a07a7SBarry Smith       char       dir[1024];
2081d45a07a7SBarry Smith 
2082e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
2083a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
20842657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
20852657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
20862657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
2087d763cef2SBarry Smith     }
20880acecf5bSBarry Smith     if (ts->ops->view) {
20890acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
20900acecf5bSBarry Smith     }
2091f05ece33SBarry Smith #endif
2092f05ece33SBarry Smith   }
2093f05ece33SBarry Smith 
2094b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2095251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
2096b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2097d763cef2SBarry Smith   PetscFunctionReturn(0);
2098d763cef2SBarry Smith }
2099d763cef2SBarry Smith 
2100b07ff414SBarry Smith /*@
2101d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2102d763cef2SBarry Smith    the timesteppers.
2103d763cef2SBarry Smith 
21043f9fe445SBarry Smith    Logically Collective on TS
2105d763cef2SBarry Smith 
2106d763cef2SBarry Smith    Input Parameters:
2107d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2108d763cef2SBarry Smith -  usrP - optional user context
2109d763cef2SBarry Smith 
2110daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2111daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2112daf670e6SBarry Smith 
2113d763cef2SBarry Smith    Level: intermediate
2114d763cef2SBarry Smith 
2115d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
2116d763cef2SBarry Smith 
2117d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2118d763cef2SBarry Smith @*/
21197087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2120d763cef2SBarry Smith {
2121d763cef2SBarry Smith   PetscFunctionBegin;
21220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2123d763cef2SBarry Smith   ts->user = usrP;
2124d763cef2SBarry Smith   PetscFunctionReturn(0);
2125d763cef2SBarry Smith }
2126d763cef2SBarry Smith 
2127b07ff414SBarry Smith /*@
2128d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2129d763cef2SBarry Smith     timestepper.
2130d763cef2SBarry Smith 
2131d763cef2SBarry Smith     Not Collective
2132d763cef2SBarry Smith 
2133d763cef2SBarry Smith     Input Parameter:
2134d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2135d763cef2SBarry Smith 
2136d763cef2SBarry Smith     Output Parameter:
2137d763cef2SBarry Smith .   usrP - user context
2138d763cef2SBarry Smith 
2139daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2140daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2141daf670e6SBarry Smith 
2142d763cef2SBarry Smith     Level: intermediate
2143d763cef2SBarry Smith 
2144d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
2145d763cef2SBarry Smith 
2146d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2147d763cef2SBarry Smith @*/
2148e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2149d763cef2SBarry Smith {
2150d763cef2SBarry Smith   PetscFunctionBegin;
21510700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2152e71120c6SJed Brown   *(void**)usrP = ts->user;
2153d763cef2SBarry Smith   PetscFunctionReturn(0);
2154d763cef2SBarry Smith }
2155d763cef2SBarry Smith 
2156d763cef2SBarry Smith /*@
215780275a0aSLisandro Dalcin    TSGetStepNumber - Gets the number of steps completed.
2158d763cef2SBarry Smith 
2159d763cef2SBarry Smith    Not Collective
2160d763cef2SBarry Smith 
2161d763cef2SBarry Smith    Input Parameter:
2162d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2163d763cef2SBarry Smith 
2164d763cef2SBarry Smith    Output Parameter:
216580275a0aSLisandro Dalcin .  steps - number of steps completed so far
2166d763cef2SBarry Smith 
2167d763cef2SBarry Smith    Level: intermediate
2168d763cef2SBarry Smith 
2169d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
21709be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2171d763cef2SBarry Smith @*/
217280275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps)
2173d763cef2SBarry Smith {
2174d763cef2SBarry Smith   PetscFunctionBegin;
21750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
217680275a0aSLisandro Dalcin   PetscValidIntPointer(steps,2);
217780275a0aSLisandro Dalcin   *steps = ts->steps;
217880275a0aSLisandro Dalcin   PetscFunctionReturn(0);
217980275a0aSLisandro Dalcin }
218080275a0aSLisandro Dalcin 
218180275a0aSLisandro Dalcin /*@
218280275a0aSLisandro Dalcin    TSSetStepNumber - Sets the number of steps completed.
218380275a0aSLisandro Dalcin 
218480275a0aSLisandro Dalcin    Logically Collective on TS
218580275a0aSLisandro Dalcin 
218680275a0aSLisandro Dalcin    Input Parameters:
218780275a0aSLisandro Dalcin +  ts - the TS context
218880275a0aSLisandro Dalcin -  steps - number of steps completed so far
218980275a0aSLisandro Dalcin 
219080275a0aSLisandro Dalcin    Notes:
219180275a0aSLisandro Dalcin    For most uses of the TS solvers the user need not explicitly call
219280275a0aSLisandro Dalcin    TSSetStepNumber(), as the step counter is appropriately updated in
219380275a0aSLisandro Dalcin    TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to
219480275a0aSLisandro Dalcin    reinitialize timestepping by setting the step counter to zero (and time
219580275a0aSLisandro Dalcin    to the initial time) to solve a similar problem with different initial
219680275a0aSLisandro Dalcin    conditions or parameters. Other possible use case is to continue
219780275a0aSLisandro Dalcin    timestepping from a previously interrupted run in such a way that TS
219880275a0aSLisandro Dalcin    monitors will be called with a initial nonzero step counter.
219980275a0aSLisandro Dalcin 
220080275a0aSLisandro Dalcin    Level: advanced
220180275a0aSLisandro Dalcin 
220280275a0aSLisandro Dalcin .keywords: TS, timestep, set, iteration, number
220380275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution()
220480275a0aSLisandro Dalcin @*/
220580275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps)
220680275a0aSLisandro Dalcin {
220780275a0aSLisandro Dalcin   PetscFunctionBegin;
220880275a0aSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
220980275a0aSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,steps,2);
221080275a0aSLisandro Dalcin   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative");
221180275a0aSLisandro Dalcin   ts->steps = steps;
2212d763cef2SBarry Smith   PetscFunctionReturn(0);
2213d763cef2SBarry Smith }
2214d763cef2SBarry Smith 
2215d763cef2SBarry Smith /*@
2216d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2217d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2218d763cef2SBarry Smith 
22193f9fe445SBarry Smith    Logically Collective on TS
2220d763cef2SBarry Smith 
2221d763cef2SBarry Smith    Input Parameters:
2222d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2223d763cef2SBarry Smith -  time_step - the size of the timestep
2224d763cef2SBarry Smith 
2225d763cef2SBarry Smith    Level: intermediate
2226d763cef2SBarry Smith 
2227aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime()
2228d763cef2SBarry Smith 
2229d763cef2SBarry Smith .keywords: TS, set, timestep
2230d763cef2SBarry Smith @*/
22317087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2232d763cef2SBarry Smith {
2233d763cef2SBarry Smith   PetscFunctionBegin;
22340700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2235c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2236d763cef2SBarry Smith   ts->time_step = time_step;
2237d763cef2SBarry Smith   PetscFunctionReturn(0);
2238d763cef2SBarry Smith }
2239d763cef2SBarry Smith 
2240a43b19c4SJed Brown /*@
224149354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
224249354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
224349354f04SShri Abhyankar      or just return at the final time TS computed.
2244a43b19c4SJed Brown 
2245a43b19c4SJed Brown   Logically Collective on TS
2246a43b19c4SJed Brown 
2247a43b19c4SJed Brown    Input Parameter:
2248a43b19c4SJed Brown +   ts - the time-step context
224949354f04SShri Abhyankar -   eftopt - exact final time option
2250a43b19c4SJed Brown 
2251feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2252feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2253feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2254feed9e9dSBarry Smith 
2255feed9e9dSBarry Smith    Options Database:
2256feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2257feed9e9dSBarry Smith 
2258ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2259ee346746SBarry Smith     then the final time you selected.
2260ee346746SBarry Smith 
2261a43b19c4SJed Brown    Level: beginner
2262a43b19c4SJed Brown 
2263f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime()
2264a43b19c4SJed Brown @*/
226549354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2266a43b19c4SJed Brown {
2267a43b19c4SJed Brown   PetscFunctionBegin;
2268a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
226949354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
227049354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2271a43b19c4SJed Brown   PetscFunctionReturn(0);
2272a43b19c4SJed Brown }
2273a43b19c4SJed Brown 
2274d763cef2SBarry Smith /*@
2275f6953c82SLisandro Dalcin    TSGetExactFinalTime - Gets the exact final time option.
2276f6953c82SLisandro Dalcin 
2277f6953c82SLisandro Dalcin    Not Collective
2278f6953c82SLisandro Dalcin 
2279f6953c82SLisandro Dalcin    Input Parameter:
2280f6953c82SLisandro Dalcin .  ts - the TS context
2281f6953c82SLisandro Dalcin 
2282f6953c82SLisandro Dalcin    Output Parameter:
2283f6953c82SLisandro Dalcin .  eftopt - exact final time option
2284f6953c82SLisandro Dalcin 
2285f6953c82SLisandro Dalcin    Level: beginner
2286f6953c82SLisandro Dalcin 
2287f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime()
2288f6953c82SLisandro Dalcin @*/
2289f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt)
2290f6953c82SLisandro Dalcin {
2291f6953c82SLisandro Dalcin   PetscFunctionBegin;
2292f6953c82SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2293f6953c82SLisandro Dalcin   PetscValidPointer(eftopt,2);
2294f6953c82SLisandro Dalcin   *eftopt = ts->exact_final_time;
2295f6953c82SLisandro Dalcin   PetscFunctionReturn(0);
2296f6953c82SLisandro Dalcin }
2297f6953c82SLisandro Dalcin 
2298f6953c82SLisandro Dalcin /*@
2299d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2300d763cef2SBarry Smith 
2301d763cef2SBarry Smith    Not Collective
2302d763cef2SBarry Smith 
2303d763cef2SBarry Smith    Input Parameter:
2304d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2305d763cef2SBarry Smith 
2306d763cef2SBarry Smith    Output Parameter:
2307d763cef2SBarry Smith .  dt - the current timestep size
2308d763cef2SBarry Smith 
2309d763cef2SBarry Smith    Level: intermediate
2310d763cef2SBarry Smith 
2311aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime()
2312d763cef2SBarry Smith 
2313d763cef2SBarry Smith .keywords: TS, get, timestep
2314d763cef2SBarry Smith @*/
23157087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2316d763cef2SBarry Smith {
2317d763cef2SBarry Smith   PetscFunctionBegin;
23180700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2319f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2320d763cef2SBarry Smith   *dt = ts->time_step;
2321d763cef2SBarry Smith   PetscFunctionReturn(0);
2322d763cef2SBarry Smith }
2323d763cef2SBarry Smith 
2324d8e5e3e6SSatish Balay /*@
2325d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2326d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2327d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2328d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2329d763cef2SBarry Smith 
2330d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2331d763cef2SBarry Smith 
2332d763cef2SBarry Smith    Input Parameter:
2333d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2334d763cef2SBarry Smith 
2335d763cef2SBarry Smith    Output Parameter:
2336d763cef2SBarry Smith .  v - the vector containing the solution
2337d763cef2SBarry Smith 
233863e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
233963e21af5SBarry Smith    final time. It returns the solution at the next timestep.
234063e21af5SBarry Smith 
2341d763cef2SBarry Smith    Level: intermediate
2342d763cef2SBarry Smith 
23430ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction()
2344d763cef2SBarry Smith 
2345d763cef2SBarry Smith .keywords: TS, timestep, get, solution
2346d763cef2SBarry Smith @*/
23477087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2348d763cef2SBarry Smith {
2349d763cef2SBarry Smith   PetscFunctionBegin;
23500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
23514482741eSBarry Smith   PetscValidPointer(v,2);
23528737fe31SLisandro Dalcin   *v = ts->vec_sol;
2353d763cef2SBarry Smith   PetscFunctionReturn(0);
2354d763cef2SBarry Smith }
2355d763cef2SBarry Smith 
235603fe5f5eSDebojyoti Ghosh /*@
2357b2bf4f3aSDebojyoti Ghosh    TSGetSolutionComponents - Returns any solution components at the present
235803fe5f5eSDebojyoti Ghosh    timestep, if available for the time integration method being used.
2359b2bf4f3aSDebojyoti Ghosh    Solution components are quantities that share the same size and
236003fe5f5eSDebojyoti Ghosh    structure as the solution vector.
236103fe5f5eSDebojyoti Ghosh 
236203fe5f5eSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
236303fe5f5eSDebojyoti Ghosh 
236403fe5f5eSDebojyoti Ghosh    Parameters :
236503fe5f5eSDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
2366b2bf4f3aSDebojyoti Ghosh .  n - If v is PETSC_NULL, then the number of solution components is
2367b2bf4f3aSDebojyoti Ghosh        returned through n, else the n-th solution component is
236803fe5f5eSDebojyoti Ghosh        returned in v.
2369b2bf4f3aSDebojyoti Ghosh .  v - the vector containing the n-th solution component
237003fe5f5eSDebojyoti Ghosh        (may be PETSC_NULL to use this function to find out
2371b2bf4f3aSDebojyoti Ghosh         the number of solutions components).
237203fe5f5eSDebojyoti Ghosh 
23734cdd57e5SDebojyoti Ghosh    Level: advanced
237403fe5f5eSDebojyoti Ghosh 
237503fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution()
237603fe5f5eSDebojyoti Ghosh 
237703fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution
237803fe5f5eSDebojyoti Ghosh @*/
2379b2bf4f3aSDebojyoti Ghosh PetscErrorCode  TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v)
238003fe5f5eSDebojyoti Ghosh {
238103fe5f5eSDebojyoti Ghosh   PetscErrorCode ierr;
238203fe5f5eSDebojyoti Ghosh 
238303fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
238403fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2385b2bf4f3aSDebojyoti Ghosh   if (!ts->ops->getsolutioncomponents) *n = 0;
238603fe5f5eSDebojyoti Ghosh   else {
2387b2bf4f3aSDebojyoti Ghosh     ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr);
238803fe5f5eSDebojyoti Ghosh   }
238903fe5f5eSDebojyoti Ghosh   PetscFunctionReturn(0);
239003fe5f5eSDebojyoti Ghosh }
239103fe5f5eSDebojyoti Ghosh 
23924cdd57e5SDebojyoti Ghosh /*@
23934cdd57e5SDebojyoti Ghosh    TSGetAuxSolution - Returns an auxiliary solution at the present
23944cdd57e5SDebojyoti Ghosh    timestep, if available for the time integration method being used.
23954cdd57e5SDebojyoti Ghosh 
23964cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
23974cdd57e5SDebojyoti Ghosh 
23984cdd57e5SDebojyoti Ghosh    Parameters :
23994cdd57e5SDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
24004cdd57e5SDebojyoti Ghosh .  v - the vector containing the auxiliary solution
24014cdd57e5SDebojyoti Ghosh 
24024cdd57e5SDebojyoti Ghosh    Level: intermediate
24034cdd57e5SDebojyoti Ghosh 
24044cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution()
24054cdd57e5SDebojyoti Ghosh 
24064cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, solution
24074cdd57e5SDebojyoti Ghosh @*/
24084cdd57e5SDebojyoti Ghosh PetscErrorCode  TSGetAuxSolution(TS ts,Vec *v)
24094cdd57e5SDebojyoti Ghosh {
24104cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
24114cdd57e5SDebojyoti Ghosh 
24124cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
24134cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2414f6356ec7SDebojyoti Ghosh   if (ts->ops->getauxsolution) {
24154cdd57e5SDebojyoti Ghosh     ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr);
2416f6356ec7SDebojyoti Ghosh   } else {
2417f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v); CHKERRQ(ierr);
2418f6356ec7SDebojyoti Ghosh   }
24194cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
24204cdd57e5SDebojyoti Ghosh }
24214cdd57e5SDebojyoti Ghosh 
24224cdd57e5SDebojyoti Ghosh /*@
24234cdd57e5SDebojyoti Ghosh    TSGetTimeError - Returns the estimated error vector, if the chosen
24244cdd57e5SDebojyoti Ghosh    TSType has an error estimation functionality.
24254cdd57e5SDebojyoti Ghosh 
24264cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
24274cdd57e5SDebojyoti Ghosh 
24289657682dSDebojyoti Ghosh    Note: MUST call after TSSetUp()
24299657682dSDebojyoti Ghosh 
24304cdd57e5SDebojyoti Ghosh    Parameters :
24314cdd57e5SDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
2432657c1e31SEmil Constantinescu .  n - current estimate (n=0) or previous one (n=-1)
24334cdd57e5SDebojyoti Ghosh .  v - the vector containing the error (same size as the solution).
24344cdd57e5SDebojyoti Ghosh 
24354cdd57e5SDebojyoti Ghosh    Level: intermediate
24364cdd57e5SDebojyoti Ghosh 
243757df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError()
24384cdd57e5SDebojyoti Ghosh 
24394cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, error
24404cdd57e5SDebojyoti Ghosh @*/
24410a01e1b2SEmil Constantinescu PetscErrorCode  TSGetTimeError(TS ts,PetscInt n,Vec *v)
24424cdd57e5SDebojyoti Ghosh {
24434cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
24444cdd57e5SDebojyoti Ghosh 
24454cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
24464cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2447f6356ec7SDebojyoti Ghosh   if (ts->ops->gettimeerror) {
24480a01e1b2SEmil Constantinescu     ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr);
2449f6356ec7SDebojyoti Ghosh   } else {
2450f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v);CHKERRQ(ierr);
2451f6356ec7SDebojyoti Ghosh   }
24524cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
24534cdd57e5SDebojyoti Ghosh }
24544cdd57e5SDebojyoti Ghosh 
245557df6a1bSDebojyoti Ghosh /*@
245657df6a1bSDebojyoti Ghosh    TSSetTimeError - Sets the estimated error vector, if the chosen
245757df6a1bSDebojyoti Ghosh    TSType has an error estimation functionality. This can be used
245857df6a1bSDebojyoti Ghosh    to restart such a time integrator with a given error vector.
245957df6a1bSDebojyoti Ghosh 
246057df6a1bSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
246157df6a1bSDebojyoti Ghosh 
246257df6a1bSDebojyoti Ghosh    Parameters :
246357df6a1bSDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
246457df6a1bSDebojyoti Ghosh .  v - the vector containing the error (same size as the solution).
246557df6a1bSDebojyoti Ghosh 
246657df6a1bSDebojyoti Ghosh    Level: intermediate
246757df6a1bSDebojyoti Ghosh 
246857df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError)
246957df6a1bSDebojyoti Ghosh 
247057df6a1bSDebojyoti Ghosh .keywords: TS, timestep, get, error
247157df6a1bSDebojyoti Ghosh @*/
247257df6a1bSDebojyoti Ghosh PetscErrorCode  TSSetTimeError(TS ts,Vec v)
247357df6a1bSDebojyoti Ghosh {
247457df6a1bSDebojyoti Ghosh   PetscErrorCode ierr;
247557df6a1bSDebojyoti Ghosh 
247657df6a1bSDebojyoti Ghosh   PetscFunctionBegin;
247757df6a1bSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24789657682dSDebojyoti Ghosh   if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first");
247957df6a1bSDebojyoti Ghosh   if (ts->ops->settimeerror) {
248057df6a1bSDebojyoti Ghosh     ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr);
248157df6a1bSDebojyoti Ghosh   }
248257df6a1bSDebojyoti Ghosh   PetscFunctionReturn(0);
248357df6a1bSDebojyoti Ghosh }
248457df6a1bSDebojyoti Ghosh 
2485c235aa8dSHong Zhang /*@
2486dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
2487c235aa8dSHong Zhang 
2488c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
2489c235aa8dSHong Zhang 
2490c235aa8dSHong Zhang    Input Parameter:
2491c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
2492c235aa8dSHong Zhang 
2493c235aa8dSHong Zhang    Output Parameter:
2494abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
2495abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
2496c235aa8dSHong Zhang 
2497c235aa8dSHong Zhang    Level: intermediate
2498c235aa8dSHong Zhang 
2499c235aa8dSHong Zhang .seealso: TSGetTimeStep()
2500c235aa8dSHong Zhang 
2501c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
2502c235aa8dSHong Zhang @*/
2503dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
2504c235aa8dSHong Zhang {
2505c235aa8dSHong Zhang   PetscFunctionBegin;
2506c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2507abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
2508abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
2509abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
2510c235aa8dSHong Zhang   PetscFunctionReturn(0);
2511c235aa8dSHong Zhang }
2512c235aa8dSHong Zhang 
2513bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
2514d8e5e3e6SSatish Balay /*@
2515bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2516d763cef2SBarry Smith 
2517bdad233fSMatthew Knepley   Not collective
2518d763cef2SBarry Smith 
2519bdad233fSMatthew Knepley   Input Parameters:
2520bdad233fSMatthew Knepley + ts   - The TS
2521bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2522d763cef2SBarry Smith .vb
25230910c330SBarry Smith          U_t - A U = 0      (linear)
25240910c330SBarry Smith          U_t - A(t) U = 0   (linear)
25250910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2526d763cef2SBarry Smith .ve
2527d763cef2SBarry Smith 
2528d763cef2SBarry Smith    Level: beginner
2529d763cef2SBarry Smith 
2530bdad233fSMatthew Knepley .keywords: TS, problem type
2531bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2532d763cef2SBarry Smith @*/
25337087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2534a7cc72afSBarry Smith {
25359e2a6581SJed Brown   PetscErrorCode ierr;
25369e2a6581SJed Brown 
2537d763cef2SBarry Smith   PetscFunctionBegin;
25380700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2539bdad233fSMatthew Knepley   ts->problem_type = type;
25409e2a6581SJed Brown   if (type == TS_LINEAR) {
25419e2a6581SJed Brown     SNES snes;
25429e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
25439e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
25449e2a6581SJed Brown   }
2545d763cef2SBarry Smith   PetscFunctionReturn(0);
2546d763cef2SBarry Smith }
2547d763cef2SBarry Smith 
2548bdad233fSMatthew Knepley /*@C
2549bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2550bdad233fSMatthew Knepley 
2551bdad233fSMatthew Knepley   Not collective
2552bdad233fSMatthew Knepley 
2553bdad233fSMatthew Knepley   Input Parameter:
2554bdad233fSMatthew Knepley . ts   - The TS
2555bdad233fSMatthew Knepley 
2556bdad233fSMatthew Knepley   Output Parameter:
2557bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2558bdad233fSMatthew Knepley .vb
2559089b2837SJed Brown          M U_t = A U
2560089b2837SJed Brown          M(t) U_t = A(t) U
2561b5abc632SBarry Smith          F(t,U,U_t)
2562bdad233fSMatthew Knepley .ve
2563bdad233fSMatthew Knepley 
2564bdad233fSMatthew Knepley    Level: beginner
2565bdad233fSMatthew Knepley 
2566bdad233fSMatthew Knepley .keywords: TS, problem type
2567bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2568bdad233fSMatthew Knepley @*/
25697087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2570a7cc72afSBarry Smith {
2571bdad233fSMatthew Knepley   PetscFunctionBegin;
25720700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
25734482741eSBarry Smith   PetscValidIntPointer(type,2);
2574bdad233fSMatthew Knepley   *type = ts->problem_type;
2575bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2576bdad233fSMatthew Knepley }
2577d763cef2SBarry Smith 
2578d763cef2SBarry Smith /*@
2579d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
2580d763cef2SBarry Smith    of a timestepper.
2581d763cef2SBarry Smith 
2582d763cef2SBarry Smith    Collective on TS
2583d763cef2SBarry Smith 
2584d763cef2SBarry Smith    Input Parameter:
2585d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2586d763cef2SBarry Smith 
2587d763cef2SBarry Smith    Notes:
2588d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2589d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2590141bd67dSStefano Zampini    the call to TSStep() or TSSolve().  However, if one wishes to control this
2591d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2592141bd67dSStefano Zampini    and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve().
2593d763cef2SBarry Smith 
2594d763cef2SBarry Smith    Level: advanced
2595d763cef2SBarry Smith 
2596d763cef2SBarry Smith .keywords: TS, timestep, setup
2597d763cef2SBarry Smith 
2598141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve()
2599d763cef2SBarry Smith @*/
26007087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2601d763cef2SBarry Smith {
2602dfbe8321SBarry Smith   PetscErrorCode ierr;
26036c6b9e74SPeter Brune   DM             dm;
26046c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2605d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2606cd11d68dSLisandro Dalcin   TSIFunction    ifun;
26076c6b9e74SPeter Brune   TSIJacobian    ijac;
2608efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
26096c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
26102ffb9264SLisandro Dalcin   PetscBool      isnone;
2611d763cef2SBarry Smith 
2612d763cef2SBarry Smith   PetscFunctionBegin;
26130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2614277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2615277b19d0SLisandro Dalcin 
26167adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2617cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
2618cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
2619d763cef2SBarry Smith   }
2620277b19d0SLisandro Dalcin 
2621277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
2622277b19d0SLisandro Dalcin 
2623e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
2624e1244c69SJed Brown     Mat Amat,Pmat;
2625e1244c69SJed Brown     SNES snes;
2626e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2627e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2628e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2629e1244c69SJed Brown      * have displaced the RHS matrix */
2630e1244c69SJed Brown     if (Amat == ts->Arhs) {
2631abc0d4abSBarry 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 */
2632abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2633e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2634e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2635e1244c69SJed Brown     }
2636e1244c69SJed Brown     if (Pmat == ts->Brhs) {
2637abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2638e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2639e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2640e1244c69SJed Brown     }
2641e1244c69SJed Brown   }
26422ffb9264SLisandro Dalcin 
26432ffb9264SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
26442ffb9264SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
26452ffb9264SLisandro Dalcin 
2646277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2647000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2648277b19d0SLisandro Dalcin   }
2649277b19d0SLisandro Dalcin 
26502ffb9264SLisandro Dalcin   /* Attempt to check/preset a default value for the exact final time option */
26512ffb9264SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr);
26522ffb9264SLisandro Dalcin   if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED)
26532ffb9264SLisandro Dalcin     ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP;
26542ffb9264SLisandro Dalcin 
2655a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
26566c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
26576c6b9e74SPeter Brune    */
26586c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
26590298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
26606c6b9e74SPeter Brune   if (!func) {
26616c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
26626c6b9e74SPeter Brune   }
2663a6772fa2SLisandro 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.
26646c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
26656c6b9e74SPeter Brune    */
26660298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
26670298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
2668efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr);
26690298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
2670efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
26716c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
26726c6b9e74SPeter Brune   }
2673c0517034SDebojyoti Ghosh 
2674c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2675c0517034SDebojyoti Ghosh   if (ts->ops->startingmethod) {
2676c0517034SDebojyoti Ghosh     ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr);
2677c0517034SDebojyoti Ghosh   }
2678c0517034SDebojyoti Ghosh 
2679277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2680277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2681277b19d0SLisandro Dalcin }
2682277b19d0SLisandro Dalcin 
2683f6a906c0SBarry Smith /*@
2684f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
2685f6a906c0SBarry Smith    of an adjoint solver
2686f6a906c0SBarry Smith 
2687f6a906c0SBarry Smith    Collective on TS
2688f6a906c0SBarry Smith 
2689f6a906c0SBarry Smith    Input Parameter:
2690f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
2691f6a906c0SBarry Smith 
2692f6a906c0SBarry Smith    Level: advanced
2693f6a906c0SBarry Smith 
2694f6a906c0SBarry Smith .keywords: TS, timestep, setup
2695f6a906c0SBarry Smith 
2696947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
2697f6a906c0SBarry Smith @*/
2698f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
2699f6a906c0SBarry Smith {
2700f6a906c0SBarry Smith   PetscErrorCode ierr;
2701f6a906c0SBarry Smith 
2702f6a906c0SBarry Smith   PetscFunctionBegin;
2703f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2704f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
270523706b9aSHong Zhang   if (!ts->vecs_sensi) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
2706c5767687SHong Zhang   if (ts->vecs_sensip && !ts->Jacp) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"Must call TSAdjointSetRHSJacobian() first");
2707d8151eeaSBarry Smith 
2708947abb85SHong Zhang   if (ts->vec_costintegral) { /* if there is integral in the cost function */
2709d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2710d8151eeaSBarry Smith     if (ts->vecs_sensip){
2711d8151eeaSBarry Smith       ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2712d8151eeaSBarry Smith     }
2713947abb85SHong Zhang   }
2714d8151eeaSBarry Smith 
271542f2b339SBarry Smith   if (ts->ops->adjointsetup) {
271642f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
2717f6a906c0SBarry Smith   }
2718f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
2719f6a906c0SBarry Smith   PetscFunctionReturn(0);
2720f6a906c0SBarry Smith }
2721f6a906c0SBarry Smith 
2722277b19d0SLisandro Dalcin /*@
2723277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2724277b19d0SLisandro Dalcin 
2725277b19d0SLisandro Dalcin    Collective on TS
2726277b19d0SLisandro Dalcin 
2727277b19d0SLisandro Dalcin    Input Parameter:
2728277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2729277b19d0SLisandro Dalcin 
2730277b19d0SLisandro Dalcin    Level: beginner
2731277b19d0SLisandro Dalcin 
2732277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2733277b19d0SLisandro Dalcin 
2734277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2735277b19d0SLisandro Dalcin @*/
2736277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2737277b19d0SLisandro Dalcin {
2738277b19d0SLisandro Dalcin   PetscErrorCode ierr;
2739277b19d0SLisandro Dalcin 
2740277b19d0SLisandro Dalcin   PetscFunctionBegin;
2741277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2742b18ea86cSHong Zhang 
2743277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2744277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2745277b19d0SLisandro Dalcin   }
2746277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2747e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2748bbd56ea5SKarl Rupp 
27494e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
27504e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2751214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
27526bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2753efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
2754e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2755e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
275638637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2757bbd56ea5SKarl Rupp 
2758d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2759d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2760715f1b00SHong Zhang 
2761ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
27622c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
276336eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2764715f1b00SHong Zhang 
2765022c081aSHong Zhang   ierr = PetscFree(ts->vecs_fwdsensipacked);CHKERRQ(ierr);
2766022c081aSHong Zhang 
2767277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2768d763cef2SBarry Smith   PetscFunctionReturn(0);
2769d763cef2SBarry Smith }
2770d763cef2SBarry Smith 
2771d8e5e3e6SSatish Balay /*@
2772d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2773d763cef2SBarry Smith    with TSCreate().
2774d763cef2SBarry Smith 
2775d763cef2SBarry Smith    Collective on TS
2776d763cef2SBarry Smith 
2777d763cef2SBarry Smith    Input Parameter:
2778d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2779d763cef2SBarry Smith 
2780d763cef2SBarry Smith    Level: beginner
2781d763cef2SBarry Smith 
2782d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2783d763cef2SBarry Smith 
2784d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2785d763cef2SBarry Smith @*/
27866bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2787d763cef2SBarry Smith {
27886849ba73SBarry Smith   PetscErrorCode ierr;
2789d763cef2SBarry Smith 
2790d763cef2SBarry Smith   PetscFunctionBegin;
27916bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
27926bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
27936bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2794d763cef2SBarry Smith 
27956bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2796277b19d0SLisandro Dalcin 
2797e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2798e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
27996bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
28006d4c513bSLisandro Dalcin 
2801bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2802bc952696SBarry Smith 
280384df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
28046427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
28056427ac75SLisandro Dalcin 
28066bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
28076bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
28086bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
28090dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
28106d4c513bSLisandro Dalcin 
2811a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2812d763cef2SBarry Smith   PetscFunctionReturn(0);
2813d763cef2SBarry Smith }
2814d763cef2SBarry Smith 
2815d8e5e3e6SSatish Balay /*@
2816d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2817d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2818d763cef2SBarry Smith 
2819d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2820d763cef2SBarry Smith 
2821d763cef2SBarry Smith    Input Parameter:
2822d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2823d763cef2SBarry Smith 
2824d763cef2SBarry Smith    Output Parameter:
2825d763cef2SBarry Smith .  snes - the nonlinear solver context
2826d763cef2SBarry Smith 
2827d763cef2SBarry Smith    Notes:
2828d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2829d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
283094b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2831d763cef2SBarry Smith 
2832d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
28330298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2834d763cef2SBarry Smith 
2835d763cef2SBarry Smith    Level: beginner
2836d763cef2SBarry Smith 
2837d763cef2SBarry Smith .keywords: timestep, get, SNES
2838d763cef2SBarry Smith @*/
28397087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2840d763cef2SBarry Smith {
2841d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2842d372ba47SLisandro Dalcin 
2843d763cef2SBarry Smith   PetscFunctionBegin;
28440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28454482741eSBarry Smith   PetscValidPointer(snes,2);
2846d372ba47SLisandro Dalcin   if (!ts->snes) {
2847ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
28480298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
28493bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2850d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2851496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
28529e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
28539e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
28549e2a6581SJed Brown     }
2855d372ba47SLisandro Dalcin   }
2856d763cef2SBarry Smith   *snes = ts->snes;
2857d763cef2SBarry Smith   PetscFunctionReturn(0);
2858d763cef2SBarry Smith }
2859d763cef2SBarry Smith 
2860deb2cd25SJed Brown /*@
2861deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2862deb2cd25SJed Brown 
2863deb2cd25SJed Brown    Collective
2864deb2cd25SJed Brown 
2865deb2cd25SJed Brown    Input Parameter:
2866deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2867deb2cd25SJed Brown -  snes - the nonlinear solver context
2868deb2cd25SJed Brown 
2869deb2cd25SJed Brown    Notes:
2870deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2871deb2cd25SJed Brown 
2872deb2cd25SJed Brown    Level: developer
2873deb2cd25SJed Brown 
2874deb2cd25SJed Brown .keywords: timestep, set, SNES
2875deb2cd25SJed Brown @*/
2876deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2877deb2cd25SJed Brown {
2878deb2cd25SJed Brown   PetscErrorCode ierr;
2879d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2880deb2cd25SJed Brown 
2881deb2cd25SJed Brown   PetscFunctionBegin;
2882deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2883deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2884deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2885deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2886bbd56ea5SKarl Rupp 
2887deb2cd25SJed Brown   ts->snes = snes;
2888bbd56ea5SKarl Rupp 
28890298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
28900298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2891740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
28920298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2893740132f1SEmil Constantinescu   }
2894deb2cd25SJed Brown   PetscFunctionReturn(0);
2895deb2cd25SJed Brown }
2896deb2cd25SJed Brown 
2897d8e5e3e6SSatish Balay /*@
289894b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2899d763cef2SBarry Smith    a TS (timestepper) context.
2900d763cef2SBarry Smith 
290194b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2902d763cef2SBarry Smith 
2903d763cef2SBarry Smith    Input Parameter:
2904d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2905d763cef2SBarry Smith 
2906d763cef2SBarry Smith    Output Parameter:
290794b7f48cSBarry Smith .  ksp - the nonlinear solver context
2908d763cef2SBarry Smith 
2909d763cef2SBarry Smith    Notes:
291094b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2911d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2912d763cef2SBarry Smith    KSP and PC contexts as well.
2913d763cef2SBarry Smith 
291494b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
29150298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2916d763cef2SBarry Smith 
2917d763cef2SBarry Smith    Level: beginner
2918d763cef2SBarry Smith 
291994b7f48cSBarry Smith .keywords: timestep, get, KSP
2920d763cef2SBarry Smith @*/
29217087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2922d763cef2SBarry Smith {
2923d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2924089b2837SJed Brown   SNES           snes;
2925d372ba47SLisandro Dalcin 
2926d763cef2SBarry Smith   PetscFunctionBegin;
29270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29284482741eSBarry Smith   PetscValidPointer(ksp,2);
292917186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2930e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2931089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2932089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2933d763cef2SBarry Smith   PetscFunctionReturn(0);
2934d763cef2SBarry Smith }
2935d763cef2SBarry Smith 
2936d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2937d763cef2SBarry Smith 
2938adb62b0dSMatthew Knepley /*@
2939618ce8baSLisandro Dalcin    TSSetMaxSteps - Sets the maximum number of steps to use.
2940618ce8baSLisandro Dalcin 
2941618ce8baSLisandro Dalcin    Logically Collective on TS
2942618ce8baSLisandro Dalcin 
2943618ce8baSLisandro Dalcin    Input Parameters:
2944618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2945618ce8baSLisandro Dalcin -  maxsteps - maximum number of steps to use
2946618ce8baSLisandro Dalcin 
2947618ce8baSLisandro Dalcin    Options Database Keys:
2948618ce8baSLisandro Dalcin .  -ts_max_steps <maxsteps> - Sets maxsteps
2949618ce8baSLisandro Dalcin 
2950618ce8baSLisandro Dalcin    Notes:
2951618ce8baSLisandro Dalcin    The default maximum number of steps is 5000
2952618ce8baSLisandro Dalcin 
2953618ce8baSLisandro Dalcin    Level: intermediate
2954618ce8baSLisandro Dalcin 
2955618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, steps
2956618ce8baSLisandro Dalcin 
2957618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime()
2958618ce8baSLisandro Dalcin @*/
2959618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps)
2960618ce8baSLisandro Dalcin {
2961618ce8baSLisandro Dalcin   PetscFunctionBegin;
2962618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2963618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2964618ce8baSLisandro Dalcin   if (maxsteps < 0 ) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative");
2965618ce8baSLisandro Dalcin   ts->max_steps = maxsteps;
2966618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2967618ce8baSLisandro Dalcin }
2968618ce8baSLisandro Dalcin 
2969618ce8baSLisandro Dalcin /*@
2970618ce8baSLisandro Dalcin    TSGetMaxSteps - Gets the maximum number of steps to use.
2971618ce8baSLisandro Dalcin 
2972618ce8baSLisandro Dalcin    Not Collective
2973618ce8baSLisandro Dalcin 
2974618ce8baSLisandro Dalcin    Input Parameters:
2975618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2976618ce8baSLisandro Dalcin 
2977618ce8baSLisandro Dalcin    Output Parameter:
2978618ce8baSLisandro Dalcin .  maxsteps - maximum number of steps to use
2979618ce8baSLisandro Dalcin 
2980618ce8baSLisandro Dalcin    Level: advanced
2981618ce8baSLisandro Dalcin 
2982618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, steps
2983618ce8baSLisandro Dalcin 
2984618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime()
2985618ce8baSLisandro Dalcin @*/
2986618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps)
2987618ce8baSLisandro Dalcin {
2988618ce8baSLisandro Dalcin   PetscFunctionBegin;
2989618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2990618ce8baSLisandro Dalcin   PetscValidIntPointer(maxsteps,2);
2991618ce8baSLisandro Dalcin   *maxsteps = ts->max_steps;
2992618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2993618ce8baSLisandro Dalcin }
2994618ce8baSLisandro Dalcin 
2995618ce8baSLisandro Dalcin /*@
2996618ce8baSLisandro Dalcin    TSSetMaxTime - Sets the maximum (or final) time for timestepping.
2997618ce8baSLisandro Dalcin 
2998618ce8baSLisandro Dalcin    Logically Collective on TS
2999618ce8baSLisandro Dalcin 
3000618ce8baSLisandro Dalcin    Input Parameters:
3001618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
3002618ce8baSLisandro Dalcin -  maxtime - final time to step to
3003618ce8baSLisandro Dalcin 
3004618ce8baSLisandro Dalcin    Options Database Keys:
3005ef85077eSLisandro Dalcin .  -ts_max_time <maxtime> - Sets maxtime
3006618ce8baSLisandro Dalcin 
3007618ce8baSLisandro Dalcin    Notes:
3008618ce8baSLisandro Dalcin    The default maximum time is 5.0
3009618ce8baSLisandro Dalcin 
3010618ce8baSLisandro Dalcin    Level: intermediate
3011618ce8baSLisandro Dalcin 
3012618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, time
3013618ce8baSLisandro Dalcin 
3014618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime()
3015618ce8baSLisandro Dalcin @*/
3016618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime)
3017618ce8baSLisandro Dalcin {
3018618ce8baSLisandro Dalcin   PetscFunctionBegin;
3019618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3020618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveReal(ts,maxtime,2);
3021618ce8baSLisandro Dalcin   ts->max_time = maxtime;
3022618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3023618ce8baSLisandro Dalcin }
3024618ce8baSLisandro Dalcin 
3025618ce8baSLisandro Dalcin /*@
3026618ce8baSLisandro Dalcin    TSGetMaxTime - Gets the maximum (or final) time for timestepping.
3027618ce8baSLisandro Dalcin 
3028618ce8baSLisandro Dalcin    Not Collective
3029618ce8baSLisandro Dalcin 
3030618ce8baSLisandro Dalcin    Input Parameters:
3031618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
3032618ce8baSLisandro Dalcin 
3033618ce8baSLisandro Dalcin    Output Parameter:
3034618ce8baSLisandro Dalcin .  maxtime - final time to step to
3035618ce8baSLisandro Dalcin 
3036618ce8baSLisandro Dalcin    Level: advanced
3037618ce8baSLisandro Dalcin 
3038618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, time
3039618ce8baSLisandro Dalcin 
3040618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps()
3041618ce8baSLisandro Dalcin @*/
3042618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime)
3043618ce8baSLisandro Dalcin {
3044618ce8baSLisandro Dalcin   PetscFunctionBegin;
3045618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3046618ce8baSLisandro Dalcin   PetscValidRealPointer(maxtime,2);
3047618ce8baSLisandro Dalcin   *maxtime = ts->max_time;
3048618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
3049618ce8baSLisandro Dalcin }
3050618ce8baSLisandro Dalcin 
3051618ce8baSLisandro Dalcin /*@
3052aaa6c58dSLisandro Dalcin    TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep().
3053edc382c3SSatish Balay 
3054edc382c3SSatish Balay    Level: deprecated
3055edc382c3SSatish Balay 
3056aaa6c58dSLisandro Dalcin @*/
3057aaa6c58dSLisandro Dalcin PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
3058aaa6c58dSLisandro Dalcin {
3059aaa6c58dSLisandro Dalcin   PetscErrorCode ierr;
3060aaa6c58dSLisandro Dalcin   PetscFunctionBegin;
3061aaa6c58dSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3062aaa6c58dSLisandro Dalcin   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
3063aaa6c58dSLisandro Dalcin   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
3064aaa6c58dSLisandro Dalcin   PetscFunctionReturn(0);
3065aaa6c58dSLisandro Dalcin }
3066aaa6c58dSLisandro Dalcin 
3067aaa6c58dSLisandro Dalcin /*@
306819eac22cSLisandro Dalcin    TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime().
3069edc382c3SSatish Balay 
3070edc382c3SSatish Balay    Level: deprecated
3071edc382c3SSatish Balay 
3072adb62b0dSMatthew Knepley @*/
30737087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
3074adb62b0dSMatthew Knepley {
3075adb62b0dSMatthew Knepley   PetscFunctionBegin;
30760700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3077abc0a331SBarry Smith   if (maxsteps) {
30784482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
3079adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
3080adb62b0dSMatthew Knepley   }
3081abc0a331SBarry Smith   if (maxtime) {
30824482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
3083adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
3084adb62b0dSMatthew Knepley   }
3085adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
3086adb62b0dSMatthew Knepley }
3087adb62b0dSMatthew Knepley 
3088d763cef2SBarry Smith /*@
308919eac22cSLisandro Dalcin    TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime().
3090edc382c3SSatish Balay 
3091edc382c3SSatish Balay    Level: deprecated
3092edc382c3SSatish Balay 
3093d763cef2SBarry Smith @*/
30947087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
3095d763cef2SBarry Smith {
3096d763cef2SBarry Smith   PetscFunctionBegin;
30970700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3098c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
3099c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
310039b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
310139b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
3102d763cef2SBarry Smith   PetscFunctionReturn(0);
3103d763cef2SBarry Smith }
3104d763cef2SBarry Smith 
3105d763cef2SBarry Smith /*@
31065c5f5948SLisandro Dalcin    TSGetTimeStepNumber - Deprecated, use TSGetStepNumber().
3107edc382c3SSatish Balay 
3108edc382c3SSatish Balay    Level: deprecated
3109edc382c3SSatish Balay 
31105c5f5948SLisandro Dalcin @*/
3111e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31125c5f5948SLisandro Dalcin 
311319eac22cSLisandro Dalcin /*@
31144f4e0956SLisandro Dalcin    TSGetTotalSteps - Deprecated, use TSGetStepNumber().
3115edc382c3SSatish Balay 
3116edc382c3SSatish Balay    Level: deprecated
3117edc382c3SSatish Balay 
31184f4e0956SLisandro Dalcin @*/
31194f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
31204f4e0956SLisandro Dalcin 
31214f4e0956SLisandro Dalcin /*@
3122d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
3123d763cef2SBarry Smith    for use by the TS routines.
3124d763cef2SBarry Smith 
31253f9fe445SBarry Smith    Logically Collective on TS and Vec
3126d763cef2SBarry Smith 
3127d763cef2SBarry Smith    Input Parameters:
3128d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
31290910c330SBarry Smith -  u - the solution vector
3130d763cef2SBarry Smith 
3131d763cef2SBarry Smith    Level: beginner
3132d763cef2SBarry Smith 
3133715f1b00SHong Zhang .keywords: TS, timestep, set, solution, initial values
31340ed3bfb6SBarry Smith 
31350ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate()
3136d763cef2SBarry Smith @*/
31370910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
3138d763cef2SBarry Smith {
31398737fe31SLisandro Dalcin   PetscErrorCode ierr;
3140496e6a7aSJed Brown   DM             dm;
31418737fe31SLisandro Dalcin 
3142d763cef2SBarry Smith   PetscFunctionBegin;
31430700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31440910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
31450910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
31466bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
31470910c330SBarry Smith   ts->vec_sol = u;
3148bbd56ea5SKarl Rupp 
3149496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
31500910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
3151d763cef2SBarry Smith   PetscFunctionReturn(0);
3152d763cef2SBarry Smith }
3153d763cef2SBarry Smith 
315473b18844SBarry Smith /*@
315573b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
315673b18844SBarry Smith 
315773b18844SBarry Smith    Logically Collective on TS
315873b18844SBarry Smith 
315973b18844SBarry Smith    Input Parameters:
316073b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
316173b18844SBarry Smith .  steps - number of steps to use
316273b18844SBarry Smith 
316373b18844SBarry Smith    Level: intermediate
316473b18844SBarry Smith 
316573b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
316673b18844SBarry Smith           so as to integrate back to less than the original timestep
316773b18844SBarry Smith 
316873b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
316973b18844SBarry Smith 
317073b18844SBarry Smith .seealso: TSSetExactFinalTime()
317173b18844SBarry Smith @*/
317273b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
317373b18844SBarry Smith {
317473b18844SBarry Smith   PetscFunctionBegin;
317573b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
317673b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
317773b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
31782808aa04SLisandro Dalcin   if (steps > ts->steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps");
317973b18844SBarry Smith   ts->adjoint_max_steps = steps;
318073b18844SBarry Smith   PetscFunctionReturn(0);
318173b18844SBarry Smith }
318273b18844SBarry Smith 
3183c235aa8dSHong Zhang /*@
3184715f1b00SHong 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
31850cf82b59SBarry Smith       for use by the TSAdjoint routines.
3186c235aa8dSHong Zhang 
3187c235aa8dSHong Zhang    Logically Collective on TS and Vec
3188c235aa8dSHong Zhang 
3189c235aa8dSHong Zhang    Input Parameters:
3190c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
3191abc2977eSBarry 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
3192abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
3193c235aa8dSHong Zhang 
3194c235aa8dSHong Zhang    Level: beginner
3195c235aa8dSHong Zhang 
3196abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
31970cf82b59SBarry Smith 
31981585b412SBarry Smith    After TSAdjointSolve() is called the lamba and the mu contain the computed sensitivities
31991585b412SBarry Smith 
3200715f1b00SHong Zhang .keywords: TS, timestep, set, sensitivity, initial values
3201c235aa8dSHong Zhang @*/
3202dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
3203c235aa8dSHong Zhang {
3204c235aa8dSHong Zhang   PetscFunctionBegin;
3205c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3206abc2977eSBarry Smith   PetscValidPointer(lambda,2);
3207abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
3208abc2977eSBarry Smith   ts->vecs_sensip = mu;
3209dfb21088SHong 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");
3210abc2977eSBarry Smith   ts->numcost  = numcost;
3211ad8e2604SHong Zhang   PetscFunctionReturn(0);
3212ad8e2604SHong Zhang }
3213ad8e2604SHong Zhang 
3214ad8e2604SHong Zhang /*@C
32150cf82b59SBarry 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.
3216ad8e2604SHong Zhang 
3217ad8e2604SHong Zhang   Logically Collective on TS
3218ad8e2604SHong Zhang 
3219ad8e2604SHong Zhang   Input Parameters:
3220ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
3221ad8e2604SHong Zhang - func - The function
3222ad8e2604SHong Zhang 
3223ad8e2604SHong Zhang   Calling sequence of func:
32240cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
322505755b9cSHong Zhang +   t - current timestep
32260cf82b59SBarry Smith .   y - input vector (current ODE solution)
322705755b9cSHong Zhang .   A - output matrix
322805755b9cSHong Zhang -   ctx - [optional] user-defined function context
3229ad8e2604SHong Zhang 
3230ad8e2604SHong Zhang   Level: intermediate
3231ad8e2604SHong Zhang 
32320cf82b59SBarry 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
32330cf82b59SBarry Smith 
3234ad8e2604SHong Zhang .keywords: TS, sensitivity
3235ad8e2604SHong Zhang .seealso:
3236ad8e2604SHong Zhang @*/
32375bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
3238ad8e2604SHong Zhang {
3239ad8e2604SHong Zhang   PetscErrorCode ierr;
3240ad8e2604SHong Zhang 
3241ad8e2604SHong Zhang   PetscFunctionBegin;
3242ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
324323706b9aSHong Zhang   PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
3244ad8e2604SHong Zhang 
3245ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
3246ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
3247ad8e2604SHong Zhang   if(Amat) {
3248ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
3249ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
3250ad8e2604SHong Zhang     ts->Jacp = Amat;
3251ad8e2604SHong Zhang   }
3252ad8e2604SHong Zhang   PetscFunctionReturn(0);
3253ad8e2604SHong Zhang }
3254ad8e2604SHong Zhang 
32550cf82b59SBarry Smith /*@C
32565bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
3257ad8e2604SHong Zhang 
3258ad8e2604SHong Zhang   Collective on TS
3259ad8e2604SHong Zhang 
3260ad8e2604SHong Zhang   Input Parameters:
3261ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
3262ad8e2604SHong Zhang 
3263ad8e2604SHong Zhang   Level: developer
3264ad8e2604SHong Zhang 
3265ad8e2604SHong Zhang .keywords: TS, sensitivity
32665bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
3267ad8e2604SHong Zhang @*/
32685bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
3269ad8e2604SHong Zhang {
3270ad8e2604SHong Zhang   PetscErrorCode ierr;
3271ad8e2604SHong Zhang 
3272ad8e2604SHong Zhang   PetscFunctionBegin;
3273ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3274ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
3275ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
3276ad8e2604SHong Zhang 
3277ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
3278ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
3279ad8e2604SHong Zhang   PetscStackPop;
3280c235aa8dSHong Zhang   PetscFunctionReturn(0);
3281c235aa8dSHong Zhang }
3282c235aa8dSHong Zhang 
32836fd0887fSHong Zhang /*@C
3284dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
32856fd0887fSHong Zhang 
32866fd0887fSHong Zhang     Logically Collective on TS
32876fd0887fSHong Zhang 
32886fd0887fSHong Zhang     Input Parameters:
32896fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
3290abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
32913d1d12c6SHong Zhang .   costintegral - vector that stores the integral values
32920cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
3293b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
3294b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
3295feaa1ddbSSatish Balay .   fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run
3296b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
32976fd0887fSHong Zhang 
32980cf82b59SBarry Smith     Calling sequence of rf:
32993d1d12c6SHong Zhang $   PetscErrorCode rf(TS ts,PetscReal t,Vec y,Vec f,void *ctx);
33006fd0887fSHong Zhang 
3301b612ec54SBarry Smith     Calling sequence of drdyf:
33020cf82b59SBarry Smith $   PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
3303b612ec54SBarry Smith 
3304b612ec54SBarry Smith     Calling sequence of drdpf:
33050cf82b59SBarry Smith $   PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
3306b612ec54SBarry Smith 
3307b612ec54SBarry Smith     Level: intermediate
33086fd0887fSHong Zhang 
3309715f1b00SHong Zhang     Notes: For optimization there is usually a single cost function (numcost = 1). For sensitivities there may be multiple cost functions
33100cf82b59SBarry Smith 
33116fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
33126fd0887fSHong Zhang 
3313dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
33146fd0887fSHong Zhang @*/
33153d1d12c6SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost,Vec costintegral,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
3316d8151eeaSBarry Smith                                                           PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
3317b1cb36f3SHong Zhang                                                           PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),
3318b1cb36f3SHong Zhang                                                           PetscBool fwd,void *ctx)
33196fd0887fSHong Zhang {
33206fd0887fSHong Zhang   PetscErrorCode ierr;
33216fd0887fSHong Zhang 
33226fd0887fSHong Zhang   PetscFunctionBegin;
33236fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33243d1d12c6SHong Zhang   if (costintegral) PetscValidHeaderSpecific(costintegral,VEC_CLASSID,3);
3325715f1b00SHong 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()");
3326c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
33276fd0887fSHong Zhang 
33283d1d12c6SHong Zhang   if (costintegral) {
33293d1d12c6SHong Zhang     ierr = PetscObjectReference((PetscObject)costintegral);CHKERRQ(ierr);
33303d1d12c6SHong Zhang     ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
33313d1d12c6SHong Zhang     ts->vec_costintegral = costintegral;
3332afe7b317SHong Zhang   } else {
3333afe7b317SHong Zhang     if (!ts->vec_costintegral) { /* Create a seq vec if user does not provide one */
3334afe7b317SHong Zhang       ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
3335afe7b317SHong Zhang     } else {
3336afe7b317SHong Zhang       ierr = VecSet(ts->vec_costintegral,0.0);CHKERRQ(ierr);
3337afe7b317SHong Zhang     }
3338afe7b317SHong Zhang   }
3339afe7b317SHong Zhang   if (!ts->vec_costintegrand) {
33402c39e106SBarry Smith     ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
3341afe7b317SHong Zhang   } else {
3342afe7b317SHong Zhang     ierr = VecSet(ts->vec_costintegrand,0.0);CHKERRQ(ierr);
3343afe7b317SHong Zhang   }
3344afe7b317SHong Zhang   ts->costintegralfwd  = fwd; /* Evaluate the cost integral in forward run if fwd is true */
33450cf82b59SBarry Smith   ts->costintegrand    = rf;
334605755b9cSHong Zhang   ts->costintegrandctx = ctx;
3347b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
3348b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
33496fd0887fSHong Zhang   PetscFunctionReturn(0);
33506fd0887fSHong Zhang }
33516fd0887fSHong Zhang 
335236eaed60SHong Zhang /*@
3353dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
335436eaed60SHong Zhang    It is valid to call the routine after a backward run.
335536eaed60SHong Zhang 
335636eaed60SHong Zhang    Not Collective
335736eaed60SHong Zhang 
335836eaed60SHong Zhang    Input Parameter:
335936eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
336036eaed60SHong Zhang 
336136eaed60SHong Zhang    Output Parameter:
33622c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
336336eaed60SHong Zhang 
336436eaed60SHong Zhang    Level: intermediate
336536eaed60SHong Zhang 
3366dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
336736eaed60SHong Zhang 
336836eaed60SHong Zhang .keywords: TS, sensitivity analysis
336936eaed60SHong Zhang @*/
3370dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
337136eaed60SHong Zhang {
337236eaed60SHong Zhang   PetscFunctionBegin;
337336eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
337436eaed60SHong Zhang   PetscValidPointer(v,2);
33752c39e106SBarry Smith   *v = ts->vec_costintegral;
337636eaed60SHong Zhang   PetscFunctionReturn(0);
337736eaed60SHong Zhang }
337836eaed60SHong Zhang 
33796fd0887fSHong Zhang /*@
3380022c081aSHong Zhang    TSComputeCostIntegrand - Evaluates the integral function in the cost functions.
33816fd0887fSHong Zhang 
33826fd0887fSHong Zhang    Input Parameters:
33836fd0887fSHong Zhang +  ts - the TS context
33846fd0887fSHong Zhang .  t - current time
33850cf82b59SBarry Smith -  y - state vector, i.e. current solution
33866fd0887fSHong Zhang 
33876fd0887fSHong Zhang    Output Parameter:
3388abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
33896fd0887fSHong Zhang 
33906fd0887fSHong Zhang    Note:
33916fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
33926fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
33936fd0887fSHong Zhang 
33946fd0887fSHong Zhang    Level: developer
33956fd0887fSHong Zhang 
33966fd0887fSHong Zhang .keywords: TS, compute
33976fd0887fSHong Zhang 
3398dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
33996fd0887fSHong Zhang @*/
3400022c081aSHong Zhang PetscErrorCode TSComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
34016fd0887fSHong Zhang {
34026fd0887fSHong Zhang   PetscErrorCode ierr;
34036fd0887fSHong Zhang 
34046fd0887fSHong Zhang   PetscFunctionBegin;
34056fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34060cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
34076fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
34086fd0887fSHong Zhang 
34090cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
3410e4680132SHong Zhang   if (ts->costintegrand) {
3411e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
34120cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
34136fd0887fSHong Zhang     PetscStackPop;
34146fd0887fSHong Zhang   } else {
34156fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
34166fd0887fSHong Zhang   }
34176fd0887fSHong Zhang 
34180cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
34196fd0887fSHong Zhang   PetscFunctionReturn(0);
34206fd0887fSHong Zhang }
34216fd0887fSHong Zhang 
342205755b9cSHong Zhang /*@
3423d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
342405755b9cSHong Zhang 
342505755b9cSHong Zhang   Collective on TS
342605755b9cSHong Zhang 
342705755b9cSHong Zhang   Input Parameters:
342805755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
342905755b9cSHong Zhang 
343005755b9cSHong Zhang   Notes:
3431d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
343205755b9cSHong Zhang   so most users would not generally call this routine themselves.
343305755b9cSHong Zhang 
343405755b9cSHong Zhang   Level: developer
343505755b9cSHong Zhang 
343605755b9cSHong Zhang .keywords: TS, sensitivity
3437d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
343805755b9cSHong Zhang @*/
34390cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
344005755b9cSHong Zhang {
344105755b9cSHong Zhang   PetscErrorCode ierr;
344205755b9cSHong Zhang 
344305755b9cSHong Zhang   PetscFunctionBegin;
344405755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34450cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
344605755b9cSHong Zhang 
344705755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
34480cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
344905755b9cSHong Zhang   PetscStackPop;
345005755b9cSHong Zhang   PetscFunctionReturn(0);
345105755b9cSHong Zhang }
345205755b9cSHong Zhang 
345305755b9cSHong Zhang /*@
3454d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
345505755b9cSHong Zhang 
345605755b9cSHong Zhang   Collective on TS
345705755b9cSHong Zhang 
345805755b9cSHong Zhang   Input Parameters:
345905755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
346005755b9cSHong Zhang 
346105755b9cSHong Zhang   Notes:
346205755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
346305755b9cSHong Zhang   so most users would not generally call this routine themselves.
346405755b9cSHong Zhang 
346505755b9cSHong Zhang   Level: developer
346605755b9cSHong Zhang 
346705755b9cSHong Zhang .keywords: TS, sensitivity
3468d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
346905755b9cSHong Zhang @*/
34700cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
347105755b9cSHong Zhang {
347205755b9cSHong Zhang   PetscErrorCode ierr;
347305755b9cSHong Zhang 
347405755b9cSHong Zhang   PetscFunctionBegin;
347505755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34760cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
347705755b9cSHong Zhang 
347805755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
34790cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
348005755b9cSHong Zhang   PetscStackPop;
348105755b9cSHong Zhang   PetscFunctionReturn(0);
348205755b9cSHong Zhang }
348305755b9cSHong Zhang 
3484ac226902SBarry Smith /*@C
3485000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
34863f2090d5SJed Brown   called once at the beginning of each time step.
3487000e7ae3SMatthew Knepley 
34883f9fe445SBarry Smith   Logically Collective on TS
3489000e7ae3SMatthew Knepley 
3490000e7ae3SMatthew Knepley   Input Parameters:
3491000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3492000e7ae3SMatthew Knepley - func - The function
3493000e7ae3SMatthew Knepley 
3494000e7ae3SMatthew Knepley   Calling sequence of func:
3495000e7ae3SMatthew Knepley . func (TS ts);
3496000e7ae3SMatthew Knepley 
3497000e7ae3SMatthew Knepley   Level: intermediate
3498000e7ae3SMatthew Knepley 
3499000e7ae3SMatthew Knepley .keywords: TS, timestep
3500dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep()
3501000e7ae3SMatthew Knepley @*/
35027087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3503000e7ae3SMatthew Knepley {
3504000e7ae3SMatthew Knepley   PetscFunctionBegin;
35050700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3506ae60f76fSBarry Smith   ts->prestep = func;
3507000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3508000e7ae3SMatthew Knepley }
3509000e7ae3SMatthew Knepley 
351009ee8438SJed Brown /*@
35113f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
35123f2090d5SJed Brown 
35133f2090d5SJed Brown   Collective on TS
35143f2090d5SJed Brown 
35153f2090d5SJed Brown   Input Parameters:
35163f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
35173f2090d5SJed Brown 
35183f2090d5SJed Brown   Notes:
35193f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
35203f2090d5SJed Brown   so most users would not generally call this routine themselves.
35213f2090d5SJed Brown 
35223f2090d5SJed Brown   Level: developer
35233f2090d5SJed Brown 
35243f2090d5SJed Brown .keywords: TS, timestep
35259be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
35263f2090d5SJed Brown @*/
35277087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
35283f2090d5SJed Brown {
35293f2090d5SJed Brown   PetscErrorCode ierr;
35303f2090d5SJed Brown 
35313f2090d5SJed Brown   PetscFunctionBegin;
35320700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3533ae60f76fSBarry Smith   if (ts->prestep) {
35345efd42a4SStefano Zampini     Vec              U;
35355efd42a4SStefano Zampini     PetscObjectState sprev,spost;
35365efd42a4SStefano Zampini 
35375efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
35385efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3539ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
35405efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3541dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3542312ce896SJed Brown   }
35433f2090d5SJed Brown   PetscFunctionReturn(0);
35443f2090d5SJed Brown }
35453f2090d5SJed Brown 
3546b8123daeSJed Brown /*@C
3547b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3548b8123daeSJed Brown   called once at the beginning of each stage.
3549b8123daeSJed Brown 
3550b8123daeSJed Brown   Logically Collective on TS
3551b8123daeSJed Brown 
3552b8123daeSJed Brown   Input Parameters:
3553b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3554b8123daeSJed Brown - func - The function
3555b8123daeSJed Brown 
3556b8123daeSJed Brown   Calling sequence of func:
3557b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
3558b8123daeSJed Brown 
3559b8123daeSJed Brown   Level: intermediate
3560b8123daeSJed Brown 
3561b8123daeSJed Brown   Note:
3562b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
356380275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
3564b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3565b8123daeSJed Brown 
3566b8123daeSJed Brown .keywords: TS, timestep
35679be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3568b8123daeSJed Brown @*/
3569b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3570b8123daeSJed Brown {
3571b8123daeSJed Brown   PetscFunctionBegin;
3572b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3573ae60f76fSBarry Smith   ts->prestage = func;
3574b8123daeSJed Brown   PetscFunctionReturn(0);
3575b8123daeSJed Brown }
3576b8123daeSJed Brown 
35779be3e283SDebojyoti Ghosh /*@C
35789be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
35799be3e283SDebojyoti Ghosh   called once at the end of each stage.
35809be3e283SDebojyoti Ghosh 
35819be3e283SDebojyoti Ghosh   Logically Collective on TS
35829be3e283SDebojyoti Ghosh 
35839be3e283SDebojyoti Ghosh   Input Parameters:
35849be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
35859be3e283SDebojyoti Ghosh - func - The function
35869be3e283SDebojyoti Ghosh 
35879be3e283SDebojyoti Ghosh   Calling sequence of func:
35889be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
35899be3e283SDebojyoti Ghosh 
35909be3e283SDebojyoti Ghosh   Level: intermediate
35919be3e283SDebojyoti Ghosh 
35929be3e283SDebojyoti Ghosh   Note:
35939be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
359480275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
35959be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
35969be3e283SDebojyoti Ghosh 
35979be3e283SDebojyoti Ghosh .keywords: TS, timestep
35989be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
35999be3e283SDebojyoti Ghosh @*/
36009be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
36019be3e283SDebojyoti Ghosh {
36029be3e283SDebojyoti Ghosh   PetscFunctionBegin;
36039be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
36049be3e283SDebojyoti Ghosh   ts->poststage = func;
36059be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
36069be3e283SDebojyoti Ghosh }
36079be3e283SDebojyoti Ghosh 
3608c688d042SShri Abhyankar /*@C
3609c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3610c688d042SShri Abhyankar   called once at the end of each step evaluation.
3611c688d042SShri Abhyankar 
3612c688d042SShri Abhyankar   Logically Collective on TS
3613c688d042SShri Abhyankar 
3614c688d042SShri Abhyankar   Input Parameters:
3615c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3616c688d042SShri Abhyankar - func - The function
3617c688d042SShri Abhyankar 
3618c688d042SShri Abhyankar   Calling sequence of func:
3619c688d042SShri Abhyankar . PetscErrorCode func(TS ts);
3620c688d042SShri Abhyankar 
3621c688d042SShri Abhyankar   Level: intermediate
3622c688d042SShri Abhyankar 
3623c688d042SShri Abhyankar   Note:
36241785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
36251785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3626e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3627e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3628e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3629c688d042SShri Abhyankar 
3630c688d042SShri Abhyankar .keywords: TS, timestep
3631c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3632c688d042SShri Abhyankar @*/
3633c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3634c688d042SShri Abhyankar {
3635c688d042SShri Abhyankar   PetscFunctionBegin;
3636c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3637c688d042SShri Abhyankar   ts->postevaluate = func;
3638c688d042SShri Abhyankar   PetscFunctionReturn(0);
3639c688d042SShri Abhyankar }
3640c688d042SShri Abhyankar 
3641b8123daeSJed Brown /*@
3642b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3643b8123daeSJed Brown 
3644b8123daeSJed Brown   Collective on TS
3645b8123daeSJed Brown 
3646b8123daeSJed Brown   Input Parameters:
3647b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
36489be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3649b8123daeSJed Brown 
3650b8123daeSJed Brown   Notes:
3651b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3652b8123daeSJed Brown   most users would not generally call this routine themselves.
3653b8123daeSJed Brown 
3654b8123daeSJed Brown   Level: developer
3655b8123daeSJed Brown 
3656b8123daeSJed Brown .keywords: TS, timestep
36579be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3658b8123daeSJed Brown @*/
3659b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3660b8123daeSJed Brown {
3661b8123daeSJed Brown   PetscErrorCode ierr;
3662b8123daeSJed Brown 
3663b8123daeSJed Brown   PetscFunctionBegin;
3664b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3665ae60f76fSBarry Smith   if (ts->prestage) {
3666ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3667b8123daeSJed Brown   }
3668b8123daeSJed Brown   PetscFunctionReturn(0);
3669b8123daeSJed Brown }
3670b8123daeSJed Brown 
36719be3e283SDebojyoti Ghosh /*@
36729be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
36739be3e283SDebojyoti Ghosh 
36749be3e283SDebojyoti Ghosh   Collective on TS
36759be3e283SDebojyoti Ghosh 
36769be3e283SDebojyoti Ghosh   Input Parameters:
36779be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
36789be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
36799be3e283SDebojyoti Ghosh   stageindex  - Stage number
36809be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
36819be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
36829be3e283SDebojyoti Ghosh 
36839be3e283SDebojyoti Ghosh   Notes:
36849be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
36859be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
36869be3e283SDebojyoti Ghosh 
36879be3e283SDebojyoti Ghosh   Level: developer
36889be3e283SDebojyoti Ghosh 
36899be3e283SDebojyoti Ghosh .keywords: TS, timestep
36909be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
36919be3e283SDebojyoti Ghosh @*/
36929be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
36939be3e283SDebojyoti Ghosh {
36949be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
36959be3e283SDebojyoti Ghosh 
36969be3e283SDebojyoti Ghosh   PetscFunctionBegin;
36979be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
36984beae5d8SLisandro Dalcin   if (ts->poststage) {
36999be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
37009be3e283SDebojyoti Ghosh   }
37019be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
37029be3e283SDebojyoti Ghosh }
37039be3e283SDebojyoti Ghosh 
3704c688d042SShri Abhyankar /*@
3705c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3706c688d042SShri Abhyankar 
3707c688d042SShri Abhyankar   Collective on TS
3708c688d042SShri Abhyankar 
3709c688d042SShri Abhyankar   Input Parameters:
3710c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3711c688d042SShri Abhyankar 
3712c688d042SShri Abhyankar   Notes:
3713c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3714c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3715c688d042SShri Abhyankar 
3716c688d042SShri Abhyankar   Level: developer
3717c688d042SShri Abhyankar 
3718c688d042SShri Abhyankar .keywords: TS, timestep
3719c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3720c688d042SShri Abhyankar @*/
3721c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3722c688d042SShri Abhyankar {
3723c688d042SShri Abhyankar   PetscErrorCode ierr;
3724c688d042SShri Abhyankar 
3725c688d042SShri Abhyankar   PetscFunctionBegin;
3726c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3727c688d042SShri Abhyankar   if (ts->postevaluate) {
3728dcb233daSLisandro Dalcin     Vec              U;
3729dcb233daSLisandro Dalcin     PetscObjectState sprev,spost;
3730dcb233daSLisandro Dalcin 
3731dcb233daSLisandro Dalcin     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
3732dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3733c688d042SShri Abhyankar     PetscStackCallStandard((*ts->postevaluate),(ts));
3734dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3735dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3736c688d042SShri Abhyankar   }
3737c688d042SShri Abhyankar   PetscFunctionReturn(0);
3738c688d042SShri Abhyankar }
3739c688d042SShri Abhyankar 
3740ac226902SBarry Smith /*@C
3741000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
37423f2090d5SJed Brown   called once at the end of each time step.
3743000e7ae3SMatthew Knepley 
37443f9fe445SBarry Smith   Logically Collective on TS
3745000e7ae3SMatthew Knepley 
3746000e7ae3SMatthew Knepley   Input Parameters:
3747000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3748000e7ae3SMatthew Knepley - func - The function
3749000e7ae3SMatthew Knepley 
3750000e7ae3SMatthew Knepley   Calling sequence of func:
3751b8123daeSJed Brown $ func (TS ts);
3752000e7ae3SMatthew Knepley 
37531785ff2aSShri Abhyankar   Notes:
37541785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
37551785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
37561785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
37571785ff2aSShri Abhyankar 
3758000e7ae3SMatthew Knepley   Level: intermediate
3759000e7ae3SMatthew Knepley 
3760000e7ae3SMatthew Knepley .keywords: TS, timestep
3761dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep()
3762000e7ae3SMatthew Knepley @*/
37637087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3764000e7ae3SMatthew Knepley {
3765000e7ae3SMatthew Knepley   PetscFunctionBegin;
37660700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3767ae60f76fSBarry Smith   ts->poststep = func;
3768000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3769000e7ae3SMatthew Knepley }
3770000e7ae3SMatthew Knepley 
377109ee8438SJed Brown /*@
37723f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
37733f2090d5SJed Brown 
37743f2090d5SJed Brown   Collective on TS
37753f2090d5SJed Brown 
37763f2090d5SJed Brown   Input Parameters:
37773f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
37783f2090d5SJed Brown 
37793f2090d5SJed Brown   Notes:
37803f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
37813f2090d5SJed Brown   so most users would not generally call this routine themselves.
37823f2090d5SJed Brown 
37833f2090d5SJed Brown   Level: developer
37843f2090d5SJed Brown 
37853f2090d5SJed Brown .keywords: TS, timestep
37863f2090d5SJed Brown @*/
37877087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
37883f2090d5SJed Brown {
37893f2090d5SJed Brown   PetscErrorCode ierr;
37903f2090d5SJed Brown 
37913f2090d5SJed Brown   PetscFunctionBegin;
37920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3793ae60f76fSBarry Smith   if (ts->poststep) {
37945efd42a4SStefano Zampini     Vec              U;
37955efd42a4SStefano Zampini     PetscObjectState sprev,spost;
37965efd42a4SStefano Zampini 
37975efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
37985efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3799ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
38005efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3801dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
380272ac3e02SJed Brown   }
38033f2090d5SJed Brown   PetscFunctionReturn(0);
38043f2090d5SJed Brown }
38053f2090d5SJed Brown 
3806d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3807d763cef2SBarry Smith 
3808d763cef2SBarry Smith /*@C
3809a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3810d763cef2SBarry Smith    timestep to display the iteration's  progress.
3811d763cef2SBarry Smith 
38123f9fe445SBarry Smith    Logically Collective on TS
3813d763cef2SBarry Smith 
3814d763cef2SBarry Smith    Input Parameters:
3815d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3816e213d8f1SJed Brown .  monitor - monitoring routine
3817329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
38180298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3819b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
38200298fd71SBarry Smith           (may be NULL)
3821d763cef2SBarry Smith 
3822e213d8f1SJed Brown    Calling sequence of monitor:
3823dcb233daSLisandro Dalcin $    PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3824d763cef2SBarry Smith 
3825d763cef2SBarry Smith +    ts - the TS context
382663e21af5SBarry 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)
38271f06c33eSBarry Smith .    time - current time
38280910c330SBarry Smith .    u - current iterate
3829d763cef2SBarry Smith -    mctx - [optional] monitoring context
3830d763cef2SBarry Smith 
3831d763cef2SBarry Smith    Notes:
3832d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3833d763cef2SBarry Smith    already has been loaded.
3834d763cef2SBarry Smith 
3835025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
3836025f1a04SBarry Smith 
3837d763cef2SBarry Smith    Level: intermediate
3838d763cef2SBarry Smith 
3839d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3840d763cef2SBarry Smith 
3841a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3842d763cef2SBarry Smith @*/
3843c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3844d763cef2SBarry Smith {
384578064530SBarry Smith   PetscErrorCode ierr;
384678064530SBarry Smith   PetscInt       i;
384778064530SBarry Smith   PetscBool      identical;
384878064530SBarry Smith 
3849d763cef2SBarry Smith   PetscFunctionBegin;
38500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
385178064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
385278064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
385378064530SBarry Smith     if (identical) PetscFunctionReturn(0);
385478064530SBarry Smith   }
385517186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3856d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
38578704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3858d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3859d763cef2SBarry Smith   PetscFunctionReturn(0);
3860d763cef2SBarry Smith }
3861d763cef2SBarry Smith 
3862d763cef2SBarry Smith /*@C
3863a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3864d763cef2SBarry Smith 
38653f9fe445SBarry Smith    Logically Collective on TS
3866d763cef2SBarry Smith 
3867d763cef2SBarry Smith    Input Parameters:
3868d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3869d763cef2SBarry Smith 
3870d763cef2SBarry Smith    Notes:
3871d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3872d763cef2SBarry Smith 
3873d763cef2SBarry Smith    Level: intermediate
3874d763cef2SBarry Smith 
3875d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3876d763cef2SBarry Smith 
3877a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3878d763cef2SBarry Smith @*/
38797087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3880d763cef2SBarry Smith {
3881d952e501SBarry Smith   PetscErrorCode ierr;
3882d952e501SBarry Smith   PetscInt       i;
3883d952e501SBarry Smith 
3884d763cef2SBarry Smith   PetscFunctionBegin;
38850700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3886d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
38878704b422SBarry Smith     if (ts->monitordestroy[i]) {
38888704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3889d952e501SBarry Smith     }
3890d952e501SBarry Smith   }
3891d763cef2SBarry Smith   ts->numbermonitors = 0;
3892d763cef2SBarry Smith   PetscFunctionReturn(0);
3893d763cef2SBarry Smith }
3894d763cef2SBarry Smith 
3895721cd6eeSBarry Smith /*@C
3896721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
38975516499fSSatish Balay 
38985516499fSSatish Balay    Level: intermediate
389941251cbbSSatish Balay 
39005516499fSSatish Balay .keywords: TS, set, monitor
39015516499fSSatish Balay 
390263e21af5SBarry Smith .seealso:  TSMonitorSet()
390341251cbbSSatish Balay @*/
3904721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3905d763cef2SBarry Smith {
3906dfbe8321SBarry Smith   PetscErrorCode ierr;
3907721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
390841aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3909d132466eSBarry Smith 
3910d763cef2SBarry Smith   PetscFunctionBegin;
39114d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
391241aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
391341aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3914721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
391541aca3d6SBarry Smith   if (iascii) {
3916649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
391763e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
391863e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
391963e21af5SBarry Smith     } else {
39208392e04aSShri 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);
392163e21af5SBarry Smith     }
3922649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
392341aca3d6SBarry Smith   } else if (ibinary) {
392441aca3d6SBarry Smith     PetscMPIInt rank;
392541aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
392641aca3d6SBarry Smith     if (!rank) {
3927450a797fSBarry Smith       PetscBool skipHeader;
3928450a797fSBarry Smith       PetscInt  classid = REAL_FILE_CLASSID;
3929450a797fSBarry Smith 
3930450a797fSBarry Smith       ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr);
3931450a797fSBarry Smith       if (!skipHeader) {
3932450a797fSBarry Smith          ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
3933450a797fSBarry Smith        }
393441aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
393541aca3d6SBarry Smith     } else {
393641aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
393741aca3d6SBarry Smith     }
393841aca3d6SBarry Smith   }
3939721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3940d763cef2SBarry Smith   PetscFunctionReturn(0);
3941d763cef2SBarry Smith }
3942d763cef2SBarry Smith 
39439110b2e7SHong Zhang /*@C
39449110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
39459110b2e7SHong Zhang    timestep to display the iteration's  progress.
39469110b2e7SHong Zhang 
39479110b2e7SHong Zhang    Logically Collective on TS
39489110b2e7SHong Zhang 
39499110b2e7SHong Zhang    Input Parameters:
39509110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
39519110b2e7SHong Zhang .  adjointmonitor - monitoring routine
39529110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
39539110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
39549110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
39559110b2e7SHong Zhang           (may be NULL)
39569110b2e7SHong Zhang 
39579110b2e7SHong Zhang    Calling sequence of monitor:
39589110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
39599110b2e7SHong Zhang 
39609110b2e7SHong Zhang +    ts - the TS context
39619110b2e7SHong 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
39629110b2e7SHong Zhang                                been interpolated to)
39639110b2e7SHong Zhang .    time - current time
39649110b2e7SHong Zhang .    u - current iterate
39659110b2e7SHong Zhang .    numcost - number of cost functionos
39669110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
39679110b2e7SHong Zhang .    mu - sensitivities to parameters
39689110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
39699110b2e7SHong Zhang 
39709110b2e7SHong Zhang    Notes:
39719110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
39729110b2e7SHong Zhang    already has been loaded.
39739110b2e7SHong Zhang 
39749110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
39759110b2e7SHong Zhang 
39769110b2e7SHong Zhang    Level: intermediate
39779110b2e7SHong Zhang 
39789110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
39799110b2e7SHong Zhang 
39809110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
39819110b2e7SHong Zhang @*/
39829110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
39839110b2e7SHong Zhang {
398478064530SBarry Smith   PetscErrorCode ierr;
398578064530SBarry Smith   PetscInt       i;
398678064530SBarry Smith   PetscBool      identical;
398778064530SBarry Smith 
39889110b2e7SHong Zhang   PetscFunctionBegin;
39899110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
399078064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
399178064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr);
399278064530SBarry Smith     if (identical) PetscFunctionReturn(0);
399378064530SBarry Smith   }
39949110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
39959110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
39969110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
39979110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
39989110b2e7SHong Zhang   PetscFunctionReturn(0);
39999110b2e7SHong Zhang }
40009110b2e7SHong Zhang 
40019110b2e7SHong Zhang /*@C
40029110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
40039110b2e7SHong Zhang 
40049110b2e7SHong Zhang    Logically Collective on TS
40059110b2e7SHong Zhang 
40069110b2e7SHong Zhang    Input Parameters:
40079110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
40089110b2e7SHong Zhang 
40099110b2e7SHong Zhang    Notes:
40109110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
40119110b2e7SHong Zhang 
40129110b2e7SHong Zhang    Level: intermediate
40139110b2e7SHong Zhang 
40149110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
40159110b2e7SHong Zhang 
40169110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
40179110b2e7SHong Zhang @*/
40189110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
40199110b2e7SHong Zhang {
40209110b2e7SHong Zhang   PetscErrorCode ierr;
40219110b2e7SHong Zhang   PetscInt       i;
40229110b2e7SHong Zhang 
40239110b2e7SHong Zhang   PetscFunctionBegin;
40249110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
40259110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
40269110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
40279110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
40289110b2e7SHong Zhang     }
40299110b2e7SHong Zhang   }
40309110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
40319110b2e7SHong Zhang   PetscFunctionReturn(0);
40329110b2e7SHong Zhang }
40339110b2e7SHong Zhang 
4034721cd6eeSBarry Smith /*@C
4035721cd6eeSBarry Smith    TSAdjointMonitorDefault - the default monitor of adjoint computations
4036110eb670SHong Zhang 
4037110eb670SHong Zhang    Level: intermediate
4038110eb670SHong Zhang 
4039110eb670SHong Zhang .keywords: TS, set, monitor
4040110eb670SHong Zhang 
4041110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
4042110eb670SHong Zhang @*/
4043721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
4044110eb670SHong Zhang {
4045110eb670SHong Zhang   PetscErrorCode ierr;
4046721cd6eeSBarry Smith   PetscViewer    viewer = vf->viewer;
4047110eb670SHong Zhang 
4048110eb670SHong Zhang   PetscFunctionBegin;
4049110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
4050721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
4051110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
4052110eb670SHong 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);
4053110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
4054721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
4055110eb670SHong Zhang   PetscFunctionReturn(0);
4056110eb670SHong Zhang }
4057110eb670SHong Zhang 
4058cd652676SJed Brown /*@
4059cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
4060cd652676SJed Brown 
4061cd652676SJed Brown    Collective on TS
4062cd652676SJed Brown 
4063cd652676SJed Brown    Input Argument:
4064cd652676SJed Brown +  ts - time stepping context
4065cd652676SJed Brown -  t - time to interpolate to
4066cd652676SJed Brown 
4067cd652676SJed Brown    Output Argument:
40680910c330SBarry Smith .  U - state at given time
4069cd652676SJed Brown 
4070cd652676SJed Brown    Level: intermediate
4071cd652676SJed Brown 
4072cd652676SJed Brown    Developer Notes:
4073cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
4074cd652676SJed Brown 
4075cd652676SJed Brown .keywords: TS, set
4076cd652676SJed Brown 
4077874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
4078cd652676SJed Brown @*/
40790910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
4080cd652676SJed Brown {
4081cd652676SJed Brown   PetscErrorCode ierr;
4082cd652676SJed Brown 
4083cd652676SJed Brown   PetscFunctionBegin;
4084cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4085b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4086be5899b3SLisandro 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);
4087ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
40880910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
4089cd652676SJed Brown   PetscFunctionReturn(0);
4090cd652676SJed Brown }
4091cd652676SJed Brown 
4092d763cef2SBarry Smith /*@
40936d9e5789SSean Farley    TSStep - Steps one time step
4094d763cef2SBarry Smith 
4095d763cef2SBarry Smith    Collective on TS
4096d763cef2SBarry Smith 
4097d763cef2SBarry Smith    Input Parameter:
4098d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4099d763cef2SBarry Smith 
410027829d71SBarry Smith    Level: developer
4101d763cef2SBarry Smith 
4102b8123daeSJed Brown    Notes:
410327829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
410427829d71SBarry Smith 
4105b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
4106b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
4107b8123daeSJed Brown 
410819eac22cSLisandro Dalcin    This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the
410919eac22cSLisandro Dalcin    time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
411025cb2221SBarry Smith 
4111d763cef2SBarry Smith .keywords: TS, timestep, solve
4112d763cef2SBarry Smith 
41139be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
4114d763cef2SBarry Smith @*/
4115193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
4116d763cef2SBarry Smith {
4117dfbe8321SBarry Smith   PetscErrorCode   ierr;
4118fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
4119be5899b3SLisandro Dalcin   PetscReal        ptime;
4120d763cef2SBarry Smith 
4121d763cef2SBarry Smith   PetscFunctionBegin;
41220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4123fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
4124fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
4125fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
4126fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
4127fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
4128fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
4129302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
4130fffbeea8SBarry Smith 
4131d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
413268bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4133d405a339SMatthew Knepley 
4134ef85077eSLisandro 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>");
4135a6772fa2SLisandro 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()");
4136be5899b3SLisandro 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");
4137a6772fa2SLisandro Dalcin 
4138be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
4139be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
41402808aa04SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
4141e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
4142d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
4143193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
4144d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
4145be5899b3SLisandro Dalcin   ts->ptime_prev = ptime;
41462808aa04SLisandro Dalcin   ts->steps++;
4147be5899b3SLisandro Dalcin   ts->steprollback = PETSC_FALSE;
414828d5b5d6SLisandro Dalcin   ts->steprestart  = PETSC_FALSE;
4149362cd11cSLisandro Dalcin 
4150362cd11cSLisandro Dalcin   if (ts->reason < 0) {
4151cef5090cSJed Brown     if (ts->errorifstepfailed) {
415208c7845fSBarry 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]);
415308c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
4154d2daff3dSHong Zhang     }
415508c7845fSBarry Smith   } else if (!ts->reason) {
415608c7845fSBarry Smith     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
415708c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
415808c7845fSBarry Smith   }
415908c7845fSBarry Smith   PetscFunctionReturn(0);
416008c7845fSBarry Smith }
416108c7845fSBarry Smith 
416208c7845fSBarry Smith /*@
4163b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
416408c7845fSBarry Smith 
416508c7845fSBarry Smith    Collective on TS
416608c7845fSBarry Smith 
416708c7845fSBarry Smith    Input Parameter:
416808c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
416908c7845fSBarry Smith 
41706a4d4014SLisandro Dalcin    Level: intermediate
41716a4d4014SLisandro Dalcin 
4172b957a604SHong Zhang .keywords: TS, adjoint, step
41736a4d4014SLisandro Dalcin 
4174b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
41756a4d4014SLisandro Dalcin @*/
417608c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
41776a4d4014SLisandro Dalcin {
417808c7845fSBarry Smith   DM               dm;
41796a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
41806a4d4014SLisandro Dalcin 
41816a4d4014SLisandro Dalcin   PetscFunctionBegin;
41824a2ae208SSatish Balay   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
418308c7845fSBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
418408c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
4185d763cef2SBarry Smith 
4186685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr);
4187d763cef2SBarry Smith 
4188be5899b3SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
4189be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime;
419042f2b339SBarry 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);
4191be5899b3SLisandro Dalcin   ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
419242f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
41938d0ad7a8SHong Zhang   ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
41942808aa04SLisandro Dalcin   ts->adjoint_steps++; ts->steps--;
4195362cd11cSLisandro Dalcin 
4196362cd11cSLisandro Dalcin   if (ts->reason < 0) {
4197cef5090cSJed Brown     if (ts->errorifstepfailed) {
41986c4ed002SBarry 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]);
41996c4ed002SBarry 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]);
42006c4ed002SBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
4201cef5090cSJed Brown     }
4202362cd11cSLisandro Dalcin   } else if (!ts->reason) {
42032808aa04SLisandro Dalcin     if (ts->adjoint_steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
4204362cd11cSLisandro Dalcin   }
4205d763cef2SBarry Smith   PetscFunctionReturn(0);
4206d763cef2SBarry Smith }
4207d763cef2SBarry Smith 
42087cbde773SLisandro Dalcin /*@
42097cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
42107cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
42117cbde773SLisandro Dalcin 
42127cbde773SLisandro Dalcin    Collective on TS
42137cbde773SLisandro Dalcin 
42147cbde773SLisandro Dalcin    Input Arguments:
42157cbde773SLisandro Dalcin +  ts - time stepping context
42167cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
42177cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
42187cbde773SLisandro Dalcin 
42197cbde773SLisandro Dalcin    Output Arguments:
42207cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
42217cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
42227cbde773SLisandro Dalcin 
42237cbde773SLisandro Dalcin    Level: advanced
42247cbde773SLisandro Dalcin 
42257cbde773SLisandro Dalcin    Notes:
42267cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
42277cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
42287cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
42297cbde773SLisandro Dalcin 
42307cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
42317cbde773SLisandro Dalcin @*/
42327cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
42337cbde773SLisandro Dalcin {
42347cbde773SLisandro Dalcin   PetscErrorCode ierr;
42357cbde773SLisandro Dalcin 
42367cbde773SLisandro Dalcin   PetscFunctionBegin;
42377cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
42387cbde773SLisandro Dalcin   PetscValidType(ts,1);
42397cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
42407cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
42417cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
42427cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
42437cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
42447cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
42457cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
42467cbde773SLisandro Dalcin   PetscFunctionReturn(0);
42477cbde773SLisandro Dalcin }
42487cbde773SLisandro Dalcin 
424905175c85SJed Brown /*@
425005175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
425105175c85SJed Brown 
42521c3436cfSJed Brown    Collective on TS
425305175c85SJed Brown 
425405175c85SJed Brown    Input Arguments:
42551c3436cfSJed Brown +  ts - time stepping context
42561c3436cfSJed Brown .  order - desired order of accuracy
42570298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
425805175c85SJed Brown 
425905175c85SJed Brown    Output Arguments:
42600910c330SBarry Smith .  U - state at the end of the current step
426105175c85SJed Brown 
426205175c85SJed Brown    Level: advanced
426305175c85SJed Brown 
4264108c343cSJed Brown    Notes:
4265108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
4266108c343cSJed 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.
4267108c343cSJed Brown 
42681c3436cfSJed Brown .seealso: TSStep(), TSAdapt
426905175c85SJed Brown @*/
42700910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
427105175c85SJed Brown {
427205175c85SJed Brown   PetscErrorCode ierr;
427305175c85SJed Brown 
427405175c85SJed Brown   PetscFunctionBegin;
427505175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
427605175c85SJed Brown   PetscValidType(ts,1);
42770910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4278ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
42790910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
428005175c85SJed Brown   PetscFunctionReturn(0);
428105175c85SJed Brown }
428205175c85SJed Brown 
4283b1cb36f3SHong Zhang /*@
4284b1cb36f3SHong Zhang    TSForwardCostIntegral - Evaluate the cost integral in the forward run.
4285b1cb36f3SHong Zhang 
4286b1cb36f3SHong Zhang    Collective on TS
4287b1cb36f3SHong Zhang 
4288b1cb36f3SHong Zhang    Input Arguments:
4289b1cb36f3SHong Zhang .  ts - time stepping context
4290b1cb36f3SHong Zhang 
4291b1cb36f3SHong Zhang    Level: advanced
4292b1cb36f3SHong Zhang 
4293b1cb36f3SHong Zhang    Notes:
4294b1cb36f3SHong Zhang    This function cannot be called until TSStep() has been completed.
4295b1cb36f3SHong Zhang 
4296b1cb36f3SHong Zhang .seealso: TSSolve(), TSAdjointCostIntegral()
4297b1cb36f3SHong Zhang @*/
4298b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts)
4299b1cb36f3SHong Zhang {
4300b1cb36f3SHong Zhang   PetscErrorCode ierr;
4301b1cb36f3SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4302b1cb36f3SHong 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);
4303b1cb36f3SHong Zhang   ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr);
4304b1cb36f3SHong Zhang   PetscFunctionReturn(0);
4305b1cb36f3SHong Zhang }
4306d67e68b7SBarry Smith 
4307d763cef2SBarry Smith /*@
4308d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
4309d763cef2SBarry Smith 
4310d763cef2SBarry Smith    Collective on TS
4311d763cef2SBarry Smith 
4312d763cef2SBarry Smith    Input Parameter:
4313d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
431463e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
431563e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
43165a3a76d0SJed Brown 
4317d763cef2SBarry Smith    Level: beginner
4318d763cef2SBarry Smith 
43195a3a76d0SJed Brown    Notes:
43205a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
43215a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
43225a3a76d0SJed Brown    stepped over the final time.
43235a3a76d0SJed Brown 
4324d763cef2SBarry Smith .keywords: TS, timestep, solve
4325d763cef2SBarry Smith 
432663e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
4327d763cef2SBarry Smith @*/
4328cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
4329d763cef2SBarry Smith {
4330b06615a5SLisandro Dalcin   Vec               solution;
4331d763cef2SBarry Smith   PetscErrorCode    ierr;
4332d763cef2SBarry Smith 
4333d763cef2SBarry Smith   PetscFunctionBegin;
4334d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4335f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
4336feed9e9dSBarry Smith 
4337ee41a567SStefano 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 */
43380910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
4339b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
4340b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
4341b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
43425a3a76d0SJed Brown     }
43430910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
4344715f1b00SHong Zhang     if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
4345bbd56ea5SKarl Rupp   } else if (u) {
43460910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
43475a3a76d0SJed Brown   }
4348b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
434968bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4350a6772fa2SLisandro Dalcin 
4351ef85077eSLisandro 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>");
4352a6772fa2SLisandro 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()");
4353a6772fa2SLisandro 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");
4354a6772fa2SLisandro Dalcin 
4355715f1b00SHong Zhang   if (ts->forward_solve) {
4356715f1b00SHong Zhang     ierr = TSForwardSetUp(ts);CHKERRQ(ierr);
4357715f1b00SHong Zhang   }
4358715f1b00SHong Zhang 
4359e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
4360715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
4361e7069c78SShri      TSTrajectory to incorrectly save the output files
4362e7069c78SShri   */
4363715f1b00SHong Zhang   /* reset time step and iteration counters */
43642808aa04SLisandro Dalcin   if (!ts->steps) {
43655ef26d82SJed Brown     ts->ksp_its           = 0;
43665ef26d82SJed Brown     ts->snes_its          = 0;
4367c610991cSLisandro Dalcin     ts->num_snes_failures = 0;
4368c610991cSLisandro Dalcin     ts->reject            = 0;
43692808aa04SLisandro Dalcin     ts->steprestart       = PETSC_TRUE;
43702808aa04SLisandro Dalcin     ts->steprollback      = PETSC_FALSE;
43712808aa04SLisandro Dalcin   }
437210bc0e4dSStefano 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;
4373193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
4374193ac0bcSJed Brown 
4375ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
4376f05ece33SBarry Smith 
4377193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
4378193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
4379a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4380cc708dedSBarry Smith     ts->solvetime = ts->ptime;
4381a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
4382be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
4383db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
4384db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
4385e7069c78SShri 
43862808aa04SLisandro Dalcin     if (!ts->steps) {
43872808aa04SLisandro Dalcin       ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
43886427ac75SLisandro Dalcin       ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
43892808aa04SLisandro Dalcin     }
43906427ac75SLisandro Dalcin 
4391e1a7a14fSJed Brown     while (!ts->reason) {
43922808aa04SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
43939687d888SLisandro Dalcin       if (!ts->steprollback) {
43949687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
43959687d888SLisandro Dalcin       }
4396193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
4397e783b05fSHong 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. */
4398b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
4399b1cb36f3SHong Zhang       }
440058818c2dSLisandro Dalcin       if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */
4401715f1b00SHong Zhang         ierr = TSForwardStep(ts);CHKERRQ(ierr);
4402715f1b00SHong Zhang       }
440310b82f12SShri Abhyankar       ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
4404e783b05fSHong 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. */
440558818c2dSLisandro Dalcin       if (ts->steprollback) {
440658818c2dSLisandro Dalcin         ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
440758818c2dSLisandro Dalcin       }
4408e783b05fSHong Zhang       if (!ts->steprollback) {
44092808aa04SLisandro Dalcin         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
44101eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
4411aeb4809dSShri Abhyankar       }
4412193ac0bcSJed Brown     }
44132808aa04SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
44146427ac75SLisandro Dalcin 
441549354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
44160910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
4417cc708dedSBarry Smith       ts->solvetime = ts->max_time;
4418b06615a5SLisandro Dalcin       solution = u;
441963e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
44200574a7fbSJed Brown     } else {
4421ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4422cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4423b06615a5SLisandro Dalcin       solution = ts->vec_sol;
44240574a7fbSJed Brown     }
4425193ac0bcSJed Brown   }
4426d2daff3dSHong Zhang 
4427ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
442863e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
442956f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
4430ef222394SBarry Smith   if (ts->adjoint_solve) {
4431ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
44322b0a91c0SBarry Smith   }
4433d763cef2SBarry Smith   PetscFunctionReturn(0);
4434d763cef2SBarry Smith }
4435d763cef2SBarry Smith 
4436b1cb36f3SHong Zhang /*@
4437b1cb36f3SHong Zhang  TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run.
4438b1cb36f3SHong Zhang 
4439b1cb36f3SHong Zhang  Collective on TS
4440b1cb36f3SHong Zhang 
4441b1cb36f3SHong Zhang  Input Arguments:
4442b1cb36f3SHong Zhang  .  ts - time stepping context
4443b1cb36f3SHong Zhang 
4444b1cb36f3SHong Zhang  Level: advanced
4445b1cb36f3SHong Zhang 
4446b1cb36f3SHong Zhang  Notes:
4447b1cb36f3SHong Zhang  This function cannot be called until TSAdjointStep() has been completed.
4448b1cb36f3SHong Zhang 
4449b1cb36f3SHong Zhang  .seealso: TSAdjointSolve(), TSAdjointStep
4450b1cb36f3SHong Zhang  @*/
4451b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts)
4452b1cb36f3SHong Zhang {
4453b1cb36f3SHong Zhang     PetscErrorCode ierr;
4454b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4455b1cb36f3SHong 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);
4456b1cb36f3SHong Zhang     ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr);
4457b1cb36f3SHong Zhang     PetscFunctionReturn(0);
4458b1cb36f3SHong Zhang }
4459b1cb36f3SHong Zhang 
4460c88f2d44SBarry Smith /*@
4461c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
4462c88f2d44SBarry Smith 
4463c88f2d44SBarry Smith    Collective on TS
4464c88f2d44SBarry Smith 
4465c88f2d44SBarry Smith    Input Parameter:
44662c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
4467c88f2d44SBarry Smith 
4468e87fd094SBarry Smith    Options Database:
4469715f1b00SHong Zhang . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial values
4470e87fd094SBarry Smith 
4471c88f2d44SBarry Smith    Level: intermediate
4472c88f2d44SBarry Smith 
4473c88f2d44SBarry Smith    Notes:
4474c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
4475c88f2d44SBarry Smith 
447673b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
447773b18844SBarry Smith 
4478c88f2d44SBarry Smith .keywords: TS, timestep, solve
4479c88f2d44SBarry Smith 
4480b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
4481c88f2d44SBarry Smith @*/
44822c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
4483c88f2d44SBarry Smith {
4484c88f2d44SBarry Smith   PetscErrorCode    ierr;
4485c88f2d44SBarry Smith 
4486c88f2d44SBarry Smith   PetscFunctionBegin;
4487c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4488c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
448968bece0bSHong Zhang 
4490c88f2d44SBarry Smith   /* reset time step and iteration counters */
44912808aa04SLisandro Dalcin   ts->adjoint_steps     = 0;
4492c88f2d44SBarry Smith   ts->ksp_its           = 0;
4493c88f2d44SBarry Smith   ts->snes_its          = 0;
4494c88f2d44SBarry Smith   ts->num_snes_failures = 0;
4495c88f2d44SBarry Smith   ts->reject            = 0;
4496c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
4497c88f2d44SBarry Smith 
44982808aa04SLisandro Dalcin   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->steps;
44992808aa04SLisandro Dalcin   if (ts->adjoint_steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
4500c88f2d44SBarry Smith 
4501c88f2d44SBarry Smith   while (!ts->reason) {
45022808aa04SLisandro Dalcin     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->steps,&ts->ptime);CHKERRQ(ierr);
45032808aa04SLisandro Dalcin     ierr = TSAdjointMonitor(ts,ts->steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
45046427ac75SLisandro Dalcin     ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr);
4505616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
4506b1cb36f3SHong Zhang     if (ts->vec_costintegral && !ts->costintegralfwd) {
4507b1cb36f3SHong Zhang       ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr);
4508b1cb36f3SHong Zhang     }
4509c88f2d44SBarry Smith   }
45102808aa04SLisandro Dalcin   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->steps,&ts->ptime);CHKERRQ(ierr);
45112808aa04SLisandro Dalcin   ierr = TSAdjointMonitor(ts,ts->steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
4512c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
4513e210cd0eSHong Zhang   ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr);
4514685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
451511e1d5c3SBarry Smith   ts->adjoint_max_steps = 0;
4516c88f2d44SBarry Smith   PetscFunctionReturn(0);
4517c88f2d44SBarry Smith }
4518c88f2d44SBarry Smith 
45197db568b7SBarry Smith /*@C
4520228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4521228d79bcSJed Brown 
4522228d79bcSJed Brown    Collective on TS
4523228d79bcSJed Brown 
4524228d79bcSJed Brown    Input Parameters:
4525228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
4526228d79bcSJed Brown .  step - step number that has just completed
4527228d79bcSJed Brown .  ptime - model time of the state
45280910c330SBarry Smith -  u - state at the current model time
4529228d79bcSJed Brown 
4530228d79bcSJed Brown    Notes:
45317db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
45327db568b7SBarry Smith    Users would almost never call this routine directly.
4533228d79bcSJed Brown 
453463e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
453563e21af5SBarry Smith 
45367db568b7SBarry Smith    Level: developer
4537228d79bcSJed Brown 
4538228d79bcSJed Brown .keywords: TS, timestep
4539228d79bcSJed Brown @*/
45400910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4541d763cef2SBarry Smith {
4542d6152f81SLisandro Dalcin   DM             dm;
4543a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
4544d6152f81SLisandro Dalcin   PetscErrorCode ierr;
4545d763cef2SBarry Smith 
4546d763cef2SBarry Smith   PetscFunctionBegin;
4547b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4548b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4549d6152f81SLisandro Dalcin 
4550d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
4551d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
4552d6152f81SLisandro Dalcin 
45535edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
4554d763cef2SBarry Smith   for (i=0; i<n; i++) {
45550910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
4556d763cef2SBarry Smith   }
45575edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
4558d763cef2SBarry Smith   PetscFunctionReturn(0);
4559d763cef2SBarry Smith }
4560d763cef2SBarry Smith 
45617db568b7SBarry Smith /*@C
45629110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
45639110b2e7SHong Zhang 
45649110b2e7SHong Zhang    Collective on TS
45659110b2e7SHong Zhang 
45669110b2e7SHong Zhang    Input Parameters:
45679110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
45689110b2e7SHong Zhang .  step - step number that has just completed
45699110b2e7SHong Zhang .  ptime - model time of the state
45709110b2e7SHong Zhang .  u - state at the current model time
45719110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
45729110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
45739110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
45749110b2e7SHong Zhang 
45759110b2e7SHong Zhang    Notes:
45767db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
45777db568b7SBarry Smith    Users would almost never call this routine directly.
45789110b2e7SHong Zhang 
45797db568b7SBarry Smith    Level: developer
45809110b2e7SHong Zhang 
45819110b2e7SHong Zhang .keywords: TS, timestep
45829110b2e7SHong Zhang @*/
45839110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
45849110b2e7SHong Zhang {
45859110b2e7SHong Zhang   PetscErrorCode ierr;
45869110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
45879110b2e7SHong Zhang 
45889110b2e7SHong Zhang   PetscFunctionBegin;
45899110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45909110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
45919110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
45929110b2e7SHong Zhang   for (i=0; i<n; i++) {
45939110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
45949110b2e7SHong Zhang   }
45959110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
45969110b2e7SHong Zhang   PetscFunctionReturn(0);
45979110b2e7SHong Zhang }
45989110b2e7SHong Zhang 
4599d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
4600d763cef2SBarry Smith /*@C
46017db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4602a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
4603d763cef2SBarry Smith 
4604d763cef2SBarry Smith    Collective on TS
4605d763cef2SBarry Smith 
4606d763cef2SBarry Smith    Input Parameters:
4607d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
4608d763cef2SBarry Smith .  label - the title to put in the title bar
46097c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
4610a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
4611a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4612d763cef2SBarry Smith 
4613d763cef2SBarry Smith    Output Parameter:
46140b039ecaSBarry Smith .  ctx - the context
4615d763cef2SBarry Smith 
4616d763cef2SBarry Smith    Options Database Key:
46174f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
46188b668821SLisandro Dalcin +  -ts_monitor_lg_timestep_log - automatically sets line graph monitor
46197db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
46207db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
46217db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
46227db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4623b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4624d763cef2SBarry Smith 
4625d763cef2SBarry Smith    Notes:
4626a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
4627d763cef2SBarry Smith 
46287db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
46297db568b7SBarry Smith 
46307db568b7SBarry 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
46317db568b7SBarry 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
46327db568b7SBarry Smith    as the first argument.
46337db568b7SBarry Smith 
46347db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
46357db568b7SBarry Smith 
4636d763cef2SBarry Smith    Level: intermediate
4637d763cef2SBarry Smith 
46387db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
4639d763cef2SBarry Smith 
46407db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
46417db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
46427db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
46437db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
46447db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
46457c922b88SBarry Smith 
4646d763cef2SBarry Smith @*/
4647a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4648d763cef2SBarry Smith {
46497f52daa2SLisandro Dalcin   PetscDraw      draw;
4650dfbe8321SBarry Smith   PetscErrorCode ierr;
4651d763cef2SBarry Smith 
4652d763cef2SBarry Smith   PetscFunctionBegin;
4653b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
46547f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
46557f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
46567f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
4657287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
46587f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
4659a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
4660d763cef2SBarry Smith   PetscFunctionReturn(0);
4661d763cef2SBarry Smith }
4662d763cef2SBarry Smith 
4663b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4664d763cef2SBarry Smith {
46650b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4666c32365f1SBarry Smith   PetscReal      x   = ptime,y;
4667dfbe8321SBarry Smith   PetscErrorCode ierr;
4668d763cef2SBarry Smith 
4669d763cef2SBarry Smith   PetscFunctionBegin;
467063e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
4671b06615a5SLisandro Dalcin   if (!step) {
4672a9f9c1f6SBarry Smith     PetscDrawAxis axis;
46738b668821SLisandro Dalcin     const char *ylabel = ctx->semilogy ? "Log Time Step" : "Time Step";
4674a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
46758b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time",ylabel);CHKERRQ(ierr);
4676a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4677a9f9c1f6SBarry Smith   }
4678c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
46798b668821SLisandro Dalcin   if (ctx->semilogy) y = PetscLog10Real(y);
46800b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
4681b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
46820b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
46836934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
46843923b477SBarry Smith   }
4685d763cef2SBarry Smith   PetscFunctionReturn(0);
4686d763cef2SBarry Smith }
4687d763cef2SBarry Smith 
4688d763cef2SBarry Smith /*@C
4689a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4690a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
4691d763cef2SBarry Smith 
46920b039ecaSBarry Smith    Collective on TSMonitorLGCtx
4693d763cef2SBarry Smith 
4694d763cef2SBarry Smith    Input Parameter:
46950b039ecaSBarry Smith .  ctx - the monitor context
4696d763cef2SBarry Smith 
4697d763cef2SBarry Smith    Level: intermediate
4698d763cef2SBarry Smith 
4699d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
4700d763cef2SBarry Smith 
47014f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
4702d763cef2SBarry Smith @*/
4703a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4704d763cef2SBarry Smith {
4705dfbe8321SBarry Smith   PetscErrorCode ierr;
4706d763cef2SBarry Smith 
4707d763cef2SBarry Smith   PetscFunctionBegin;
47087684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
47097684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
47107684fa3eSBarry Smith   }
47110b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
471231152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
4713387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
4714387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
4715387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
47160b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
4717d763cef2SBarry Smith   PetscFunctionReturn(0);
4718d763cef2SBarry Smith }
4719d763cef2SBarry Smith 
4720d763cef2SBarry Smith /*@
4721b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4722d763cef2SBarry Smith 
4723d763cef2SBarry Smith    Not Collective
4724d763cef2SBarry Smith 
4725d763cef2SBarry Smith    Input Parameter:
4726d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4727d763cef2SBarry Smith 
4728d763cef2SBarry Smith    Output Parameter:
472919eac22cSLisandro Dalcin .  t  - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime().
4730d763cef2SBarry Smith 
4731d763cef2SBarry Smith    Level: beginner
4732d763cef2SBarry Smith 
4733b8123daeSJed Brown    Note:
4734b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
47359be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4736b8123daeSJed Brown 
4737aaa6c58dSLisandro Dalcin .seealso:  TSGetSolveTime(), TSSetTime(), TSGetTimeStep()
4738d763cef2SBarry Smith 
4739d763cef2SBarry Smith .keywords: TS, get, time
4740d763cef2SBarry Smith @*/
47417087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4742d763cef2SBarry Smith {
4743d763cef2SBarry Smith   PetscFunctionBegin;
47440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4745f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4746d763cef2SBarry Smith   *t = ts->ptime;
4747d763cef2SBarry Smith   PetscFunctionReturn(0);
4748d763cef2SBarry Smith }
4749d763cef2SBarry Smith 
4750e5e524a1SHong Zhang /*@
4751e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4752e5e524a1SHong Zhang 
4753e5e524a1SHong Zhang    Not Collective
4754e5e524a1SHong Zhang 
4755e5e524a1SHong Zhang    Input Parameter:
4756e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4757e5e524a1SHong Zhang 
4758e5e524a1SHong Zhang    Output Parameter:
4759e5e524a1SHong Zhang .  t  - the previous time
4760e5e524a1SHong Zhang 
4761e5e524a1SHong Zhang    Level: beginner
4762e5e524a1SHong Zhang 
4763aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep()
4764e5e524a1SHong Zhang 
4765e5e524a1SHong Zhang .keywords: TS, get, time
4766e5e524a1SHong Zhang @*/
4767e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4768e5e524a1SHong Zhang {
4769e5e524a1SHong Zhang   PetscFunctionBegin;
4770e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4771e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4772e5e524a1SHong Zhang   *t = ts->ptime_prev;
4773e5e524a1SHong Zhang   PetscFunctionReturn(0);
4774e5e524a1SHong Zhang }
4775e5e524a1SHong Zhang 
47766a4d4014SLisandro Dalcin /*@
47776a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
47786a4d4014SLisandro Dalcin 
47793f9fe445SBarry Smith    Logically Collective on TS
47806a4d4014SLisandro Dalcin 
47816a4d4014SLisandro Dalcin    Input Parameters:
47826a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
47836a4d4014SLisandro Dalcin -  time - the time
47846a4d4014SLisandro Dalcin 
47856a4d4014SLisandro Dalcin    Level: intermediate
47866a4d4014SLisandro Dalcin 
478719eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps()
47886a4d4014SLisandro Dalcin 
47896a4d4014SLisandro Dalcin .keywords: TS, set, time
47906a4d4014SLisandro Dalcin @*/
47917087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
47926a4d4014SLisandro Dalcin {
47936a4d4014SLisandro Dalcin   PetscFunctionBegin;
47940700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4795c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
47966a4d4014SLisandro Dalcin   ts->ptime = t;
47976a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
47986a4d4014SLisandro Dalcin }
47996a4d4014SLisandro Dalcin 
4800d763cef2SBarry Smith /*@C
4801d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4802d763cef2SBarry Smith    TS options in the database.
4803d763cef2SBarry Smith 
48043f9fe445SBarry Smith    Logically Collective on TS
4805d763cef2SBarry Smith 
4806d763cef2SBarry Smith    Input Parameter:
4807d763cef2SBarry Smith +  ts     - The TS context
4808d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4809d763cef2SBarry Smith 
4810d763cef2SBarry Smith    Notes:
4811d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4812d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4813d763cef2SBarry Smith    hyphen.
4814d763cef2SBarry Smith 
4815d763cef2SBarry Smith    Level: advanced
4816d763cef2SBarry Smith 
4817d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
4818d763cef2SBarry Smith 
4819d763cef2SBarry Smith .seealso: TSSetFromOptions()
4820d763cef2SBarry Smith 
4821d763cef2SBarry Smith @*/
48227087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4823d763cef2SBarry Smith {
4824dfbe8321SBarry Smith   PetscErrorCode ierr;
4825089b2837SJed Brown   SNES           snes;
4826d763cef2SBarry Smith 
4827d763cef2SBarry Smith   PetscFunctionBegin;
48280700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4829d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4830089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4831089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4832d763cef2SBarry Smith   PetscFunctionReturn(0);
4833d763cef2SBarry Smith }
4834d763cef2SBarry Smith 
4835d763cef2SBarry Smith /*@C
4836d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4837d763cef2SBarry Smith    TS options in the database.
4838d763cef2SBarry Smith 
48393f9fe445SBarry Smith    Logically Collective on TS
4840d763cef2SBarry Smith 
4841d763cef2SBarry Smith    Input Parameter:
4842d763cef2SBarry Smith +  ts     - The TS context
4843d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4844d763cef2SBarry Smith 
4845d763cef2SBarry Smith    Notes:
4846d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4847d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4848d763cef2SBarry Smith    hyphen.
4849d763cef2SBarry Smith 
4850d763cef2SBarry Smith    Level: advanced
4851d763cef2SBarry Smith 
4852d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
4853d763cef2SBarry Smith 
4854d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4855d763cef2SBarry Smith 
4856d763cef2SBarry Smith @*/
48577087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4858d763cef2SBarry Smith {
4859dfbe8321SBarry Smith   PetscErrorCode ierr;
4860089b2837SJed Brown   SNES           snes;
4861d763cef2SBarry Smith 
4862d763cef2SBarry Smith   PetscFunctionBegin;
48630700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4864d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4865089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4866089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4867d763cef2SBarry Smith   PetscFunctionReturn(0);
4868d763cef2SBarry Smith }
4869d763cef2SBarry Smith 
4870d763cef2SBarry Smith /*@C
4871d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4872d763cef2SBarry Smith    TS options in the database.
4873d763cef2SBarry Smith 
4874d763cef2SBarry Smith    Not Collective
4875d763cef2SBarry Smith 
4876d763cef2SBarry Smith    Input Parameter:
4877d763cef2SBarry Smith .  ts - The TS context
4878d763cef2SBarry Smith 
4879d763cef2SBarry Smith    Output Parameter:
4880d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4881d763cef2SBarry Smith 
4882d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
4883d763cef2SBarry Smith    sufficient length to hold the prefix.
4884d763cef2SBarry Smith 
4885d763cef2SBarry Smith    Level: intermediate
4886d763cef2SBarry Smith 
4887d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
4888d763cef2SBarry Smith 
4889d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4890d763cef2SBarry Smith @*/
48917087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4892d763cef2SBarry Smith {
4893dfbe8321SBarry Smith   PetscErrorCode ierr;
4894d763cef2SBarry Smith 
4895d763cef2SBarry Smith   PetscFunctionBegin;
48960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48974482741eSBarry Smith   PetscValidPointer(prefix,2);
4898d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4899d763cef2SBarry Smith   PetscFunctionReturn(0);
4900d763cef2SBarry Smith }
4901d763cef2SBarry Smith 
4902d763cef2SBarry Smith /*@C
4903d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4904d763cef2SBarry Smith 
4905d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4906d763cef2SBarry Smith 
4907d763cef2SBarry Smith    Input Parameter:
4908d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4909d763cef2SBarry Smith 
4910d763cef2SBarry Smith    Output Parameters:
4911e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4912e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4913e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4914e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4915d763cef2SBarry Smith 
49160298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
4917d763cef2SBarry Smith 
4918d763cef2SBarry Smith    Level: intermediate
4919d763cef2SBarry Smith 
492080275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
4921d763cef2SBarry Smith 
4922d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
4923d763cef2SBarry Smith @*/
4924e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4925d763cef2SBarry Smith {
4926089b2837SJed Brown   PetscErrorCode ierr;
492724989b8cSPeter Brune   DM             dm;
4928089b2837SJed Brown 
4929d763cef2SBarry Smith   PetscFunctionBegin;
493023a57915SBarry Smith   if (Amat || Pmat) {
493123a57915SBarry Smith     SNES snes;
4932089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
493323a57915SBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4934e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
493523a57915SBarry Smith   }
493624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
493724989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4938d763cef2SBarry Smith   PetscFunctionReturn(0);
4939d763cef2SBarry Smith }
4940d763cef2SBarry Smith 
49412eca1d9cSJed Brown /*@C
49422eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
49432eca1d9cSJed Brown 
49442eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
49452eca1d9cSJed Brown 
49462eca1d9cSJed Brown    Input Parameter:
49472eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
49482eca1d9cSJed Brown 
49492eca1d9cSJed Brown    Output Parameters:
4950e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4951e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
49522eca1d9cSJed Brown .  f   - The function to compute the matrices
49532eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
49542eca1d9cSJed Brown 
49550298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
49562eca1d9cSJed Brown 
49572eca1d9cSJed Brown    Level: advanced
49582eca1d9cSJed Brown 
495980275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
49602eca1d9cSJed Brown 
49612eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
49622eca1d9cSJed Brown @*/
4963e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
49642eca1d9cSJed Brown {
4965089b2837SJed Brown   PetscErrorCode ierr;
496624989b8cSPeter Brune   DM             dm;
49670910c330SBarry Smith 
49682eca1d9cSJed Brown   PetscFunctionBegin;
4969c0aab802Sstefano_zampini   if (Amat || Pmat) {
4970c0aab802Sstefano_zampini     SNES snes;
4971089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4972f7d39f7aSBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4973e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
4974c0aab802Sstefano_zampini   }
497524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
497624989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
49772eca1d9cSJed Brown   PetscFunctionReturn(0);
49782eca1d9cSJed Brown }
49792eca1d9cSJed Brown 
49801713a123SBarry Smith /*@C
498183a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
49821713a123SBarry Smith    VecView() for the solution at each timestep
49831713a123SBarry Smith 
49841713a123SBarry Smith    Collective on TS
49851713a123SBarry Smith 
49861713a123SBarry Smith    Input Parameters:
49871713a123SBarry Smith +  ts - the TS context
49881713a123SBarry Smith .  step - current time-step
4989142b95e3SSatish Balay .  ptime - current time
49900298fd71SBarry Smith -  dummy - either a viewer or NULL
49911713a123SBarry Smith 
499299fdda47SBarry Smith    Options Database:
499399fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
499499fdda47SBarry Smith 
4995387f4636SBarry 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
499699fdda47SBarry Smith        will look bad
499799fdda47SBarry Smith 
49981713a123SBarry Smith    Level: intermediate
49991713a123SBarry Smith 
50001713a123SBarry Smith .keywords: TS,  vector, monitor, view
50011713a123SBarry Smith 
5002a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
50031713a123SBarry Smith @*/
50040910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
50051713a123SBarry Smith {
5006dfbe8321SBarry Smith   PetscErrorCode   ierr;
500783a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
5008473a3ab2SBarry Smith   PetscDraw        draw;
50091713a123SBarry Smith 
50101713a123SBarry Smith   PetscFunctionBegin;
50116083293cSBarry Smith   if (!step && ictx->showinitial) {
50126083293cSBarry Smith     if (!ictx->initialsolution) {
50130910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
50141713a123SBarry Smith     }
50150910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
50166083293cSBarry Smith   }
5017b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
50180dcf80beSBarry Smith 
50196083293cSBarry Smith   if (ictx->showinitial) {
50206083293cSBarry Smith     PetscReal pause;
50216083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
50226083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
50236083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
50246083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
50256083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
50266083293cSBarry Smith   }
50270910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
5028473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
502951fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
5030473a3ab2SBarry Smith     char      time[32];
5031473a3ab2SBarry Smith 
5032473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
503385b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
5034473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
5035473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
503651fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
5037473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
5038473a3ab2SBarry Smith   }
5039473a3ab2SBarry Smith 
50406083293cSBarry Smith   if (ictx->showinitial) {
50416083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
50426083293cSBarry Smith   }
50431713a123SBarry Smith   PetscFunctionReturn(0);
50441713a123SBarry Smith }
50451713a123SBarry Smith 
50469110b2e7SHong Zhang /*@C
50479110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
50489110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
50499110b2e7SHong Zhang 
50509110b2e7SHong Zhang    Collective on TS
50519110b2e7SHong Zhang 
50529110b2e7SHong Zhang    Input Parameters:
50539110b2e7SHong Zhang +  ts - the TS context
50549110b2e7SHong Zhang .  step - current time-step
50559110b2e7SHong Zhang .  ptime - current time
50569110b2e7SHong Zhang .  u - current state
50579110b2e7SHong Zhang .  numcost - number of cost functions
50589110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
50599110b2e7SHong Zhang .  mu - sensitivities to parameters
50609110b2e7SHong Zhang -  dummy - either a viewer or NULL
50619110b2e7SHong Zhang 
50629110b2e7SHong Zhang    Level: intermediate
50639110b2e7SHong Zhang 
50649110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
50659110b2e7SHong Zhang 
50669110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
50679110b2e7SHong Zhang @*/
50689110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
50699110b2e7SHong Zhang {
50709110b2e7SHong Zhang   PetscErrorCode   ierr;
50719110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
50729110b2e7SHong Zhang   PetscDraw        draw;
5073a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
5074a0046e2cSSatish Balay   char             time[32];
50759110b2e7SHong Zhang 
50769110b2e7SHong Zhang   PetscFunctionBegin;
50779110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
50789110b2e7SHong Zhang 
50799110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
50809110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
50819110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
50829110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
50839110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
50849110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
50859110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
50869110b2e7SHong Zhang   PetscFunctionReturn(0);
50879110b2e7SHong Zhang }
50889110b2e7SHong Zhang 
50892d5ee99bSBarry Smith /*@C
50902d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
50912d5ee99bSBarry Smith 
50922d5ee99bSBarry Smith    Collective on TS
50932d5ee99bSBarry Smith 
50942d5ee99bSBarry Smith    Input Parameters:
50952d5ee99bSBarry Smith +  ts - the TS context
50962d5ee99bSBarry Smith .  step - current time-step
50972d5ee99bSBarry Smith .  ptime - current time
50982d5ee99bSBarry Smith -  dummy - either a viewer or NULL
50992d5ee99bSBarry Smith 
51002d5ee99bSBarry Smith    Level: intermediate
51012d5ee99bSBarry Smith 
51022d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
51032d5ee99bSBarry Smith 
51042d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
51052d5ee99bSBarry Smith @*/
51062d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
51072d5ee99bSBarry Smith {
51082d5ee99bSBarry Smith   PetscErrorCode    ierr;
51092d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
51102d5ee99bSBarry Smith   PetscDraw         draw;
51116934998bSLisandro Dalcin   PetscDrawAxis     axis;
51122d5ee99bSBarry Smith   PetscInt          n;
51132d5ee99bSBarry Smith   PetscMPIInt       size;
51146934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
51152d5ee99bSBarry Smith   char              time[32];
51162d5ee99bSBarry Smith   const PetscScalar *U;
51172d5ee99bSBarry Smith 
51182d5ee99bSBarry Smith   PetscFunctionBegin;
51196934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
51206934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
51212d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
51226934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
51232d5ee99bSBarry Smith 
51242d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
51256934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
51266934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
51276934998bSLisandro Dalcin   if (!step) {
51286934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
51296934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
51306934998bSLisandro Dalcin   }
51312d5ee99bSBarry Smith 
51322d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
51336934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
51346934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
5135a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
51366934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
51372d5ee99bSBarry Smith 
51386934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
51396934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
51402d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
51414b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
514285b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
51432d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
514451fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
51452d5ee99bSBarry Smith   }
51466934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
51472d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
514856d62c8fSLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
51496934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
51502d5ee99bSBarry Smith   PetscFunctionReturn(0);
51512d5ee99bSBarry Smith }
51522d5ee99bSBarry Smith 
51536083293cSBarry Smith /*@C
515483a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
51556083293cSBarry Smith 
51566083293cSBarry Smith    Collective on TS
51576083293cSBarry Smith 
51586083293cSBarry Smith    Input Parameters:
51596083293cSBarry Smith .    ctx - the monitor context
51606083293cSBarry Smith 
51616083293cSBarry Smith    Level: intermediate
51626083293cSBarry Smith 
51636083293cSBarry Smith .keywords: TS,  vector, monitor, view
51646083293cSBarry Smith 
516583a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
51666083293cSBarry Smith @*/
516783a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
51686083293cSBarry Smith {
51696083293cSBarry Smith   PetscErrorCode ierr;
51706083293cSBarry Smith 
51716083293cSBarry Smith   PetscFunctionBegin;
517283a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
517383a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
517483a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
51756083293cSBarry Smith   PetscFunctionReturn(0);
51766083293cSBarry Smith }
51776083293cSBarry Smith 
51786083293cSBarry Smith /*@C
517983a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
51806083293cSBarry Smith 
51816083293cSBarry Smith    Collective on TS
51826083293cSBarry Smith 
51836083293cSBarry Smith    Input Parameter:
51846083293cSBarry Smith .    ts - time-step context
51856083293cSBarry Smith 
51866083293cSBarry Smith    Output Patameter:
51876083293cSBarry Smith .    ctx - the monitor context
51886083293cSBarry Smith 
518999fdda47SBarry Smith    Options Database:
519099fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
519199fdda47SBarry Smith 
51926083293cSBarry Smith    Level: intermediate
51936083293cSBarry Smith 
51946083293cSBarry Smith .keywords: TS,  vector, monitor, view
51956083293cSBarry Smith 
519683a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
51976083293cSBarry Smith @*/
519883a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
51996083293cSBarry Smith {
52006083293cSBarry Smith   PetscErrorCode   ierr;
52016083293cSBarry Smith 
52026083293cSBarry Smith   PetscFunctionBegin;
5203b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
520483a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
5205e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
5206bbd56ea5SKarl Rupp 
520783a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
5208473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
5209c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
5210473a3ab2SBarry Smith 
5211473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
5212c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
52136083293cSBarry Smith   PetscFunctionReturn(0);
52146083293cSBarry Smith }
52156083293cSBarry Smith 
52163a471f94SBarry Smith /*@C
52170ed3bfb6SBarry Smith    TSMonitorDrawSolutionFunction - Monitors progress of the TS solvers by calling
52180ed3bfb6SBarry Smith    VecView() for the solution provided by TSSetSolutionFunction() at each timestep
52190ed3bfb6SBarry Smith 
52200ed3bfb6SBarry Smith    Collective on TS
52210ed3bfb6SBarry Smith 
52220ed3bfb6SBarry Smith    Input Parameters:
52230ed3bfb6SBarry Smith +  ts - the TS context
52240ed3bfb6SBarry Smith .  step - current time-step
52250ed3bfb6SBarry Smith .  ptime - current time
52260ed3bfb6SBarry Smith -  dummy - either a viewer or NULL
52270ed3bfb6SBarry Smith 
52280ed3bfb6SBarry Smith    Options Database:
52290ed3bfb6SBarry Smith .  -ts_monitor_draw_solution_function - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
52300ed3bfb6SBarry Smith 
52310ed3bfb6SBarry Smith    Level: intermediate
52320ed3bfb6SBarry Smith 
52330ed3bfb6SBarry Smith .keywords: TS,  vector, monitor, view
52340ed3bfb6SBarry Smith 
52350ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
52360ed3bfb6SBarry Smith @*/
52370ed3bfb6SBarry Smith PetscErrorCode  TSMonitorDrawSolutionFunction(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
52380ed3bfb6SBarry Smith {
52390ed3bfb6SBarry Smith   PetscErrorCode   ierr;
52400ed3bfb6SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
52410ed3bfb6SBarry Smith   PetscViewer      viewer = ctx->viewer;
52420ed3bfb6SBarry Smith   Vec              work;
52430ed3bfb6SBarry Smith 
52440ed3bfb6SBarry Smith   PetscFunctionBegin;
52450ed3bfb6SBarry Smith   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
52460ed3bfb6SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
52470ed3bfb6SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
52480ed3bfb6SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
52490ed3bfb6SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
52500ed3bfb6SBarry Smith   PetscFunctionReturn(0);
52510ed3bfb6SBarry Smith }
52520ed3bfb6SBarry Smith 
52530ed3bfb6SBarry Smith /*@C
525483a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
52553a471f94SBarry Smith    VecView() for the error at each timestep
52563a471f94SBarry Smith 
52573a471f94SBarry Smith    Collective on TS
52583a471f94SBarry Smith 
52593a471f94SBarry Smith    Input Parameters:
52603a471f94SBarry Smith +  ts - the TS context
52613a471f94SBarry Smith .  step - current time-step
52623a471f94SBarry Smith .  ptime - current time
52630298fd71SBarry Smith -  dummy - either a viewer or NULL
52643a471f94SBarry Smith 
52650ed3bfb6SBarry Smith    Options Database:
52660ed3bfb6SBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
52670ed3bfb6SBarry Smith 
52683a471f94SBarry Smith    Level: intermediate
52693a471f94SBarry Smith 
52703a471f94SBarry Smith .keywords: TS,  vector, monitor, view
52713a471f94SBarry Smith 
52720ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
52733a471f94SBarry Smith @*/
52740910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
52753a471f94SBarry Smith {
52763a471f94SBarry Smith   PetscErrorCode   ierr;
527783a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
527883a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
52793a471f94SBarry Smith   Vec              work;
52803a471f94SBarry Smith 
52813a471f94SBarry Smith   PetscFunctionBegin;
5282b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
52830910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
52843a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
52850910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
52863a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
52873a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
52883a471f94SBarry Smith   PetscFunctionReturn(0);
52893a471f94SBarry Smith }
52903a471f94SBarry Smith 
5291af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
52926c699258SBarry Smith /*@
52932a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
52946c699258SBarry Smith 
52953f9fe445SBarry Smith    Logically Collective on TS and DM
52966c699258SBarry Smith 
52976c699258SBarry Smith    Input Parameters:
52982a808120SBarry Smith +  ts - the ODE integrator object
52992a808120SBarry Smith -  dm - the dm, cannot be NULL
53006c699258SBarry Smith 
53016c699258SBarry Smith    Level: intermediate
53026c699258SBarry Smith 
53036c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
53046c699258SBarry Smith @*/
53057087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
53066c699258SBarry Smith {
53076c699258SBarry Smith   PetscErrorCode ierr;
5308089b2837SJed Brown   SNES           snes;
5309942e3340SBarry Smith   DMTS           tsdm;
53106c699258SBarry Smith 
53116c699258SBarry Smith   PetscFunctionBegin;
53120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53132a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
531470663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
5315942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
53162a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
5317942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
5318942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
531924989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
532024989b8cSPeter Brune         tsdm->originaldm = dm;
532124989b8cSPeter Brune       }
532224989b8cSPeter Brune     }
53236bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
532424989b8cSPeter Brune   }
53256c699258SBarry Smith   ts->dm = dm;
5326bbd56ea5SKarl Rupp 
5327089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5328089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
53296c699258SBarry Smith   PetscFunctionReturn(0);
53306c699258SBarry Smith }
53316c699258SBarry Smith 
53326c699258SBarry Smith /*@
53336c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
53346c699258SBarry Smith 
53353f9fe445SBarry Smith    Not Collective
53366c699258SBarry Smith 
53376c699258SBarry Smith    Input Parameter:
53386c699258SBarry Smith . ts - the preconditioner context
53396c699258SBarry Smith 
53406c699258SBarry Smith    Output Parameter:
53416c699258SBarry Smith .  dm - the dm
53426c699258SBarry Smith 
53436c699258SBarry Smith    Level: intermediate
53446c699258SBarry Smith 
53456c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
53466c699258SBarry Smith @*/
53477087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
53486c699258SBarry Smith {
5349496e6a7aSJed Brown   PetscErrorCode ierr;
5350496e6a7aSJed Brown 
53516c699258SBarry Smith   PetscFunctionBegin;
53520700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5353496e6a7aSJed Brown   if (!ts->dm) {
5354ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
5355496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
5356496e6a7aSJed Brown   }
53576c699258SBarry Smith   *dm = ts->dm;
53586c699258SBarry Smith   PetscFunctionReturn(0);
53596c699258SBarry Smith }
53601713a123SBarry Smith 
53610f5c6efeSJed Brown /*@
53620f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
53630f5c6efeSJed Brown 
53643f9fe445SBarry Smith    Logically Collective on SNES
53650f5c6efeSJed Brown 
53660f5c6efeSJed Brown    Input Parameter:
5367d42a1c89SJed Brown + snes - nonlinear solver
53680910c330SBarry Smith . U - the current state at which to evaluate the residual
5369d42a1c89SJed Brown - ctx - user context, must be a TS
53700f5c6efeSJed Brown 
53710f5c6efeSJed Brown    Output Parameter:
53720f5c6efeSJed Brown . F - the nonlinear residual
53730f5c6efeSJed Brown 
53740f5c6efeSJed Brown    Notes:
53750f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
53760f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
53770f5c6efeSJed Brown 
53780f5c6efeSJed Brown    Level: advanced
53790f5c6efeSJed Brown 
53800f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
53810f5c6efeSJed Brown @*/
53820910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
53830f5c6efeSJed Brown {
53840f5c6efeSJed Brown   TS             ts = (TS)ctx;
53850f5c6efeSJed Brown   PetscErrorCode ierr;
53860f5c6efeSJed Brown 
53870f5c6efeSJed Brown   PetscFunctionBegin;
53880f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
53890910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
53900f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
53910f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
53920910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
53930f5c6efeSJed Brown   PetscFunctionReturn(0);
53940f5c6efeSJed Brown }
53950f5c6efeSJed Brown 
53960f5c6efeSJed Brown /*@
53970f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
53980f5c6efeSJed Brown 
53990f5c6efeSJed Brown    Collective on SNES
54000f5c6efeSJed Brown 
54010f5c6efeSJed Brown    Input Parameter:
54020f5c6efeSJed Brown + snes - nonlinear solver
54030910c330SBarry Smith . U - the current state at which to evaluate the residual
54040f5c6efeSJed Brown - ctx - user context, must be a TS
54050f5c6efeSJed Brown 
54060f5c6efeSJed Brown    Output Parameter:
54070f5c6efeSJed Brown + A - the Jacobian
54080f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
54090f5c6efeSJed Brown - flag - indicates any structure change in the matrix
54100f5c6efeSJed Brown 
54110f5c6efeSJed Brown    Notes:
54120f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
54130f5c6efeSJed Brown 
54140f5c6efeSJed Brown    Level: developer
54150f5c6efeSJed Brown 
54160f5c6efeSJed Brown .seealso: SNESSetJacobian()
54170f5c6efeSJed Brown @*/
5418d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
54190f5c6efeSJed Brown {
54200f5c6efeSJed Brown   TS             ts = (TS)ctx;
54210f5c6efeSJed Brown   PetscErrorCode ierr;
54220f5c6efeSJed Brown 
54230f5c6efeSJed Brown   PetscFunctionBegin;
54240f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
54250910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
54260f5c6efeSJed Brown   PetscValidPointer(A,3);
542794ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
54280f5c6efeSJed Brown   PetscValidPointer(B,4);
542994ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
54300f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
5431d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
54320f5c6efeSJed Brown   PetscFunctionReturn(0);
54330f5c6efeSJed Brown }
5434325fc9f4SBarry Smith 
54350e4ef248SJed Brown /*@C
54369ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
54370e4ef248SJed Brown 
54380e4ef248SJed Brown    Collective on TS
54390e4ef248SJed Brown 
54400e4ef248SJed Brown    Input Arguments:
54410e4ef248SJed Brown +  ts - time stepping context
54420e4ef248SJed Brown .  t - time at which to evaluate
54430910c330SBarry Smith .  U - state at which to evaluate
54440e4ef248SJed Brown -  ctx - context
54450e4ef248SJed Brown 
54460e4ef248SJed Brown    Output Arguments:
54470e4ef248SJed Brown .  F - right hand side
54480e4ef248SJed Brown 
54490e4ef248SJed Brown    Level: intermediate
54500e4ef248SJed Brown 
54510e4ef248SJed Brown    Notes:
54520e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
54530e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
54540e4ef248SJed Brown 
54550e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
54560e4ef248SJed Brown @*/
54570910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
54580e4ef248SJed Brown {
54590e4ef248SJed Brown   PetscErrorCode ierr;
54600e4ef248SJed Brown   Mat            Arhs,Brhs;
54610e4ef248SJed Brown 
54620e4ef248SJed Brown   PetscFunctionBegin;
54630e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
5464d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
54650910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
54660e4ef248SJed Brown   PetscFunctionReturn(0);
54670e4ef248SJed Brown }
54680e4ef248SJed Brown 
54690e4ef248SJed Brown /*@C
54700e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
54710e4ef248SJed Brown 
54720e4ef248SJed Brown    Collective on TS
54730e4ef248SJed Brown 
54740e4ef248SJed Brown    Input Arguments:
54750e4ef248SJed Brown +  ts - time stepping context
54760e4ef248SJed Brown .  t - time at which to evaluate
54770910c330SBarry Smith .  U - state at which to evaluate
54780e4ef248SJed Brown -  ctx - context
54790e4ef248SJed Brown 
54800e4ef248SJed Brown    Output Arguments:
54810e4ef248SJed Brown +  A - pointer to operator
54820e4ef248SJed Brown .  B - pointer to preconditioning matrix
54830e4ef248SJed Brown -  flg - matrix structure flag
54840e4ef248SJed Brown 
54850e4ef248SJed Brown    Level: intermediate
54860e4ef248SJed Brown 
54870e4ef248SJed Brown    Notes:
54880e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
54890e4ef248SJed Brown 
54900e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
54910e4ef248SJed Brown @*/
5492d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
54930e4ef248SJed Brown {
54940e4ef248SJed Brown   PetscFunctionBegin;
54950e4ef248SJed Brown   PetscFunctionReturn(0);
54960e4ef248SJed Brown }
54970e4ef248SJed Brown 
54980026cea9SSean Farley /*@C
54990026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
55000026cea9SSean Farley 
55010026cea9SSean Farley    Collective on TS
55020026cea9SSean Farley 
55030026cea9SSean Farley    Input Arguments:
55040026cea9SSean Farley +  ts - time stepping context
55050026cea9SSean Farley .  t - time at which to evaluate
55060910c330SBarry Smith .  U - state at which to evaluate
55070910c330SBarry Smith .  Udot - time derivative of state vector
55080026cea9SSean Farley -  ctx - context
55090026cea9SSean Farley 
55100026cea9SSean Farley    Output Arguments:
55110026cea9SSean Farley .  F - left hand side
55120026cea9SSean Farley 
55130026cea9SSean Farley    Level: intermediate
55140026cea9SSean Farley 
55150026cea9SSean Farley    Notes:
55160910c330SBarry 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
55170026cea9SSean Farley    user is required to write their own TSComputeIFunction.
55180026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
55190026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
55200026cea9SSean Farley 
55219ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
55229ae8fd06SBarry Smith 
55239ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
55240026cea9SSean Farley @*/
55250910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
55260026cea9SSean Farley {
55270026cea9SSean Farley   PetscErrorCode ierr;
55280026cea9SSean Farley   Mat            A,B;
55290026cea9SSean Farley 
55300026cea9SSean Farley   PetscFunctionBegin;
55310298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
5532d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
55330910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
55340026cea9SSean Farley   PetscFunctionReturn(0);
55350026cea9SSean Farley }
55360026cea9SSean Farley 
55370026cea9SSean Farley /*@C
5538b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
55390026cea9SSean Farley 
55400026cea9SSean Farley    Collective on TS
55410026cea9SSean Farley 
55420026cea9SSean Farley    Input Arguments:
55430026cea9SSean Farley +  ts - time stepping context
55440026cea9SSean Farley .  t - time at which to evaluate
55450910c330SBarry Smith .  U - state at which to evaluate
55460910c330SBarry Smith .  Udot - time derivative of state vector
55470026cea9SSean Farley .  shift - shift to apply
55480026cea9SSean Farley -  ctx - context
55490026cea9SSean Farley 
55500026cea9SSean Farley    Output Arguments:
55510026cea9SSean Farley +  A - pointer to operator
55520026cea9SSean Farley .  B - pointer to preconditioning matrix
55530026cea9SSean Farley -  flg - matrix structure flag
55540026cea9SSean Farley 
5555b41af12eSJed Brown    Level: advanced
55560026cea9SSean Farley 
55570026cea9SSean Farley    Notes:
55580026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
55590026cea9SSean Farley 
5560b41af12eSJed Brown    It is only appropriate for problems of the form
5561b41af12eSJed Brown 
5562b41af12eSJed Brown $     M Udot = F(U,t)
5563b41af12eSJed Brown 
5564b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
5565b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5566b41af12eSJed Brown   an implicit operator of the form
5567b41af12eSJed Brown 
5568b41af12eSJed Brown $    shift*M + J
5569b41af12eSJed Brown 
5570b41af12eSJed 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
5571b41af12eSJed Brown   a copy of M or reassemble it when requested.
5572b41af12eSJed Brown 
55730026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
55740026cea9SSean Farley @*/
5575d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
55760026cea9SSean Farley {
5577b41af12eSJed Brown   PetscErrorCode ierr;
5578b41af12eSJed Brown 
55790026cea9SSean Farley   PetscFunctionBegin;
558094ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
5581b41af12eSJed Brown   ts->ijacobian.shift = shift;
55820026cea9SSean Farley   PetscFunctionReturn(0);
55830026cea9SSean Farley }
5584b41af12eSJed Brown 
5585e817cc15SEmil Constantinescu /*@
5586e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
5587e817cc15SEmil Constantinescu 
5588e817cc15SEmil Constantinescu    Not Collective
5589e817cc15SEmil Constantinescu 
5590e817cc15SEmil Constantinescu    Input Parameter:
5591e817cc15SEmil Constantinescu .  ts - the TS context
5592e817cc15SEmil Constantinescu 
5593e817cc15SEmil Constantinescu    Output Parameter:
55944e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
5595e817cc15SEmil Constantinescu 
5596e817cc15SEmil Constantinescu    Level: beginner
5597e817cc15SEmil Constantinescu 
5598e817cc15SEmil Constantinescu .keywords: TS, equation type
5599e817cc15SEmil Constantinescu 
5600e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
5601e817cc15SEmil Constantinescu @*/
5602e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
5603e817cc15SEmil Constantinescu {
5604e817cc15SEmil Constantinescu   PetscFunctionBegin;
5605e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5606e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
5607e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
5608e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5609e817cc15SEmil Constantinescu }
5610e817cc15SEmil Constantinescu 
5611e817cc15SEmil Constantinescu /*@
5612e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
5613e817cc15SEmil Constantinescu 
5614e817cc15SEmil Constantinescu    Not Collective
5615e817cc15SEmil Constantinescu 
5616e817cc15SEmil Constantinescu    Input Parameter:
5617e817cc15SEmil Constantinescu +  ts - the TS context
56181297b224SEmil Constantinescu -  equation_type - see TSEquationType
5619e817cc15SEmil Constantinescu 
5620e817cc15SEmil Constantinescu    Level: advanced
5621e817cc15SEmil Constantinescu 
5622e817cc15SEmil Constantinescu .keywords: TS, equation type
5623e817cc15SEmil Constantinescu 
5624e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
5625e817cc15SEmil Constantinescu @*/
5626e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
5627e817cc15SEmil Constantinescu {
5628e817cc15SEmil Constantinescu   PetscFunctionBegin;
5629e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5630e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
5631e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5632e817cc15SEmil Constantinescu }
56330026cea9SSean Farley 
56344af1b03aSJed Brown /*@
56354af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
56364af1b03aSJed Brown 
56374af1b03aSJed Brown    Not Collective
56384af1b03aSJed Brown 
56394af1b03aSJed Brown    Input Parameter:
56404af1b03aSJed Brown .  ts - the TS context
56414af1b03aSJed Brown 
56424af1b03aSJed Brown    Output Parameter:
56434af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
56444af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
56454af1b03aSJed Brown 
5646487e0bb9SJed Brown    Level: beginner
56474af1b03aSJed Brown 
5648cd652676SJed Brown    Notes:
5649cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
56504af1b03aSJed Brown 
56514af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
56524af1b03aSJed Brown 
56534af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
56544af1b03aSJed Brown @*/
56554af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
56564af1b03aSJed Brown {
56574af1b03aSJed Brown   PetscFunctionBegin;
56584af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
56594af1b03aSJed Brown   PetscValidPointer(reason,2);
56604af1b03aSJed Brown   *reason = ts->reason;
56614af1b03aSJed Brown   PetscFunctionReturn(0);
56624af1b03aSJed Brown }
56634af1b03aSJed Brown 
5664d6ad946cSShri Abhyankar /*@
5665d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5666d6ad946cSShri Abhyankar 
5667d6ad946cSShri Abhyankar    Not Collective
5668d6ad946cSShri Abhyankar 
5669d6ad946cSShri Abhyankar    Input Parameter:
5670d6ad946cSShri Abhyankar +  ts - the TS context
5671d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5672d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
5673d6ad946cSShri Abhyankar 
5674f5abba47SShri Abhyankar    Level: advanced
5675d6ad946cSShri Abhyankar 
5676d6ad946cSShri Abhyankar    Notes:
5677d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
5678d6ad946cSShri Abhyankar 
5679d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
5680d6ad946cSShri Abhyankar 
5681d6ad946cSShri Abhyankar .seealso: TSConvergedReason
5682d6ad946cSShri Abhyankar @*/
5683d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
5684d6ad946cSShri Abhyankar {
5685d6ad946cSShri Abhyankar   PetscFunctionBegin;
5686d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5687d6ad946cSShri Abhyankar   ts->reason = reason;
5688d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
5689d6ad946cSShri Abhyankar }
5690d6ad946cSShri Abhyankar 
5691cc708dedSBarry Smith /*@
5692cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
5693cc708dedSBarry Smith 
5694cc708dedSBarry Smith    Not Collective
5695cc708dedSBarry Smith 
5696cc708dedSBarry Smith    Input Parameter:
5697cc708dedSBarry Smith .  ts - the TS context
5698cc708dedSBarry Smith 
5699cc708dedSBarry Smith    Output Parameter:
570019eac22cSLisandro Dalcin .  ftime - the final time. This time corresponds to the final time set with TSSetMaxTime()
5701cc708dedSBarry Smith 
5702487e0bb9SJed Brown    Level: beginner
5703cc708dedSBarry Smith 
5704cc708dedSBarry Smith    Notes:
5705cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
5706cc708dedSBarry Smith 
5707cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
5708cc708dedSBarry Smith 
5709cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
5710cc708dedSBarry Smith @*/
5711cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
5712cc708dedSBarry Smith {
5713cc708dedSBarry Smith   PetscFunctionBegin;
5714cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5715cc708dedSBarry Smith   PetscValidPointer(ftime,2);
5716cc708dedSBarry Smith   *ftime = ts->solvetime;
5717cc708dedSBarry Smith   PetscFunctionReturn(0);
5718cc708dedSBarry Smith }
5719cc708dedSBarry Smith 
57202c18e0fdSBarry Smith /*@
57215ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
57229f67acb7SJed Brown    used by the time integrator.
57239f67acb7SJed Brown 
57249f67acb7SJed Brown    Not Collective
57259f67acb7SJed Brown 
57269f67acb7SJed Brown    Input Parameter:
57279f67acb7SJed Brown .  ts - TS context
57289f67acb7SJed Brown 
57299f67acb7SJed Brown    Output Parameter:
57309f67acb7SJed Brown .  nits - number of nonlinear iterations
57319f67acb7SJed Brown 
57329f67acb7SJed Brown    Notes:
57339f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
57349f67acb7SJed Brown 
57359f67acb7SJed Brown    Level: intermediate
57369f67acb7SJed Brown 
57379f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
57389f67acb7SJed Brown 
57395ef26d82SJed Brown .seealso:  TSGetKSPIterations()
57409f67acb7SJed Brown @*/
57415ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
57429f67acb7SJed Brown {
57439f67acb7SJed Brown   PetscFunctionBegin;
57449f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
57459f67acb7SJed Brown   PetscValidIntPointer(nits,2);
57465ef26d82SJed Brown   *nits = ts->snes_its;
57479f67acb7SJed Brown   PetscFunctionReturn(0);
57489f67acb7SJed Brown }
57499f67acb7SJed Brown 
57509f67acb7SJed Brown /*@
57515ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
57529f67acb7SJed Brown    used by the time integrator.
57539f67acb7SJed Brown 
57549f67acb7SJed Brown    Not Collective
57559f67acb7SJed Brown 
57569f67acb7SJed Brown    Input Parameter:
57579f67acb7SJed Brown .  ts - TS context
57589f67acb7SJed Brown 
57599f67acb7SJed Brown    Output Parameter:
57609f67acb7SJed Brown .  lits - number of linear iterations
57619f67acb7SJed Brown 
57629f67acb7SJed Brown    Notes:
57639f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
57649f67acb7SJed Brown 
57659f67acb7SJed Brown    Level: intermediate
57669f67acb7SJed Brown 
57679f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
57689f67acb7SJed Brown 
57695ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
57709f67acb7SJed Brown @*/
57715ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
57729f67acb7SJed Brown {
57739f67acb7SJed Brown   PetscFunctionBegin;
57749f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
57759f67acb7SJed Brown   PetscValidIntPointer(lits,2);
57765ef26d82SJed Brown   *lits = ts->ksp_its;
57779f67acb7SJed Brown   PetscFunctionReturn(0);
57789f67acb7SJed Brown }
57799f67acb7SJed Brown 
5780cef5090cSJed Brown /*@
5781cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5782cef5090cSJed Brown 
5783cef5090cSJed Brown    Not Collective
5784cef5090cSJed Brown 
5785cef5090cSJed Brown    Input Parameter:
5786cef5090cSJed Brown .  ts - TS context
5787cef5090cSJed Brown 
5788cef5090cSJed Brown    Output Parameter:
5789cef5090cSJed Brown .  rejects - number of steps rejected
5790cef5090cSJed Brown 
5791cef5090cSJed Brown    Notes:
5792cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5793cef5090cSJed Brown 
5794cef5090cSJed Brown    Level: intermediate
5795cef5090cSJed Brown 
5796cef5090cSJed Brown .keywords: TS, get, number
5797cef5090cSJed Brown 
57985ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5799cef5090cSJed Brown @*/
5800cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5801cef5090cSJed Brown {
5802cef5090cSJed Brown   PetscFunctionBegin;
5803cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5804cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5805cef5090cSJed Brown   *rejects = ts->reject;
5806cef5090cSJed Brown   PetscFunctionReturn(0);
5807cef5090cSJed Brown }
5808cef5090cSJed Brown 
5809cef5090cSJed Brown /*@
5810cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5811cef5090cSJed Brown 
5812cef5090cSJed Brown    Not Collective
5813cef5090cSJed Brown 
5814cef5090cSJed Brown    Input Parameter:
5815cef5090cSJed Brown .  ts - TS context
5816cef5090cSJed Brown 
5817cef5090cSJed Brown    Output Parameter:
5818cef5090cSJed Brown .  fails - number of failed nonlinear solves
5819cef5090cSJed Brown 
5820cef5090cSJed Brown    Notes:
5821cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5822cef5090cSJed Brown 
5823cef5090cSJed Brown    Level: intermediate
5824cef5090cSJed Brown 
5825cef5090cSJed Brown .keywords: TS, get, number
5826cef5090cSJed Brown 
58275ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5828cef5090cSJed Brown @*/
5829cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5830cef5090cSJed Brown {
5831cef5090cSJed Brown   PetscFunctionBegin;
5832cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5833cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5834cef5090cSJed Brown   *fails = ts->num_snes_failures;
5835cef5090cSJed Brown   PetscFunctionReturn(0);
5836cef5090cSJed Brown }
5837cef5090cSJed Brown 
5838cef5090cSJed Brown /*@
5839cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5840cef5090cSJed Brown 
5841cef5090cSJed Brown    Not Collective
5842cef5090cSJed Brown 
5843cef5090cSJed Brown    Input Parameter:
5844cef5090cSJed Brown +  ts - TS context
5845cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5846cef5090cSJed Brown 
5847cef5090cSJed Brown    Notes:
5848cef5090cSJed Brown    The counter is reset to zero for each step
5849cef5090cSJed Brown 
5850cef5090cSJed Brown    Options Database Key:
5851cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5852cef5090cSJed Brown 
5853cef5090cSJed Brown    Level: intermediate
5854cef5090cSJed Brown 
5855cef5090cSJed Brown .keywords: TS, set, maximum, number
5856cef5090cSJed Brown 
58575ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5858cef5090cSJed Brown @*/
5859cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5860cef5090cSJed Brown {
5861cef5090cSJed Brown   PetscFunctionBegin;
5862cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5863cef5090cSJed Brown   ts->max_reject = rejects;
5864cef5090cSJed Brown   PetscFunctionReturn(0);
5865cef5090cSJed Brown }
5866cef5090cSJed Brown 
5867cef5090cSJed Brown /*@
5868cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5869cef5090cSJed Brown 
5870cef5090cSJed Brown    Not Collective
5871cef5090cSJed Brown 
5872cef5090cSJed Brown    Input Parameter:
5873cef5090cSJed Brown +  ts - TS context
5874cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5875cef5090cSJed Brown 
5876cef5090cSJed Brown    Notes:
5877cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5878cef5090cSJed Brown 
5879cef5090cSJed Brown    Options Database Key:
5880cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5881cef5090cSJed Brown 
5882cef5090cSJed Brown    Level: intermediate
5883cef5090cSJed Brown 
5884cef5090cSJed Brown .keywords: TS, set, maximum, number
5885cef5090cSJed Brown 
58865ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5887cef5090cSJed Brown @*/
5888cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5889cef5090cSJed Brown {
5890cef5090cSJed Brown   PetscFunctionBegin;
5891cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5892cef5090cSJed Brown   ts->max_snes_failures = fails;
5893cef5090cSJed Brown   PetscFunctionReturn(0);
5894cef5090cSJed Brown }
5895cef5090cSJed Brown 
5896cef5090cSJed Brown /*@
5897cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5898cef5090cSJed Brown 
5899cef5090cSJed Brown    Not Collective
5900cef5090cSJed Brown 
5901cef5090cSJed Brown    Input Parameter:
5902cef5090cSJed Brown +  ts - TS context
5903cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5904cef5090cSJed Brown 
5905cef5090cSJed Brown    Options Database Key:
5906cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5907cef5090cSJed Brown 
5908cef5090cSJed Brown    Level: intermediate
5909cef5090cSJed Brown 
5910cef5090cSJed Brown .keywords: TS, set, error
5911cef5090cSJed Brown 
59125ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5913cef5090cSJed Brown @*/
5914cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5915cef5090cSJed Brown {
5916cef5090cSJed Brown   PetscFunctionBegin;
5917cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5918cef5090cSJed Brown   ts->errorifstepfailed = err;
5919cef5090cSJed Brown   PetscFunctionReturn(0);
5920cef5090cSJed Brown }
5921cef5090cSJed Brown 
5922fb1732b5SBarry Smith /*@C
5923fde5950dSBarry 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
5924fb1732b5SBarry Smith 
5925fb1732b5SBarry Smith    Collective on TS
5926fb1732b5SBarry Smith 
5927fb1732b5SBarry Smith    Input Parameters:
5928fb1732b5SBarry Smith +  ts - the TS context
5929fb1732b5SBarry Smith .  step - current time-step
5930fb1732b5SBarry Smith .  ptime - current time
59310910c330SBarry Smith .  u - current state
5932721cd6eeSBarry Smith -  vf - viewer and its format
5933fb1732b5SBarry Smith 
5934fb1732b5SBarry Smith    Level: intermediate
5935fb1732b5SBarry Smith 
5936fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
5937fb1732b5SBarry Smith 
5938fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5939fb1732b5SBarry Smith @*/
5940721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5941fb1732b5SBarry Smith {
5942fb1732b5SBarry Smith   PetscErrorCode ierr;
5943fb1732b5SBarry Smith 
5944fb1732b5SBarry Smith   PetscFunctionBegin;
5945721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5946721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5947721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5948ed81e22dSJed Brown   PetscFunctionReturn(0);
5949ed81e22dSJed Brown }
5950ed81e22dSJed Brown 
5951ed81e22dSJed Brown /*@C
5952ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5953ed81e22dSJed Brown 
5954ed81e22dSJed Brown    Collective on TS
5955ed81e22dSJed Brown 
5956ed81e22dSJed Brown    Input Parameters:
5957ed81e22dSJed Brown +  ts - the TS context
5958ed81e22dSJed Brown .  step - current time-step
5959ed81e22dSJed Brown .  ptime - current time
59600910c330SBarry Smith .  u - current state
5961ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5962ed81e22dSJed Brown 
5963ed81e22dSJed Brown    Level: intermediate
5964ed81e22dSJed Brown 
5965ed81e22dSJed Brown    Notes:
5966ed81e22dSJed 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.
5967ed81e22dSJed Brown    These are named according to the file name template.
5968ed81e22dSJed Brown 
5969ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5970ed81e22dSJed Brown 
5971ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5972ed81e22dSJed Brown 
5973ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5974ed81e22dSJed Brown @*/
59750910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5976ed81e22dSJed Brown {
5977ed81e22dSJed Brown   PetscErrorCode ierr;
5978ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5979ed81e22dSJed Brown   PetscViewer    viewer;
5980ed81e22dSJed Brown 
5981ed81e22dSJed Brown   PetscFunctionBegin;
598263e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
59838caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5984ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
59850910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5986ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5987ed81e22dSJed Brown   PetscFunctionReturn(0);
5988ed81e22dSJed Brown }
5989ed81e22dSJed Brown 
5990ed81e22dSJed Brown /*@C
5991ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5992ed81e22dSJed Brown 
5993ed81e22dSJed Brown    Collective on TS
5994ed81e22dSJed Brown 
5995ed81e22dSJed Brown    Input Parameters:
5996ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5997ed81e22dSJed Brown 
5998ed81e22dSJed Brown    Level: intermediate
5999ed81e22dSJed Brown 
6000ed81e22dSJed Brown    Note:
6001ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
6002ed81e22dSJed Brown 
6003ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
6004ed81e22dSJed Brown 
6005ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
6006ed81e22dSJed Brown @*/
6007ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
6008ed81e22dSJed Brown {
6009ed81e22dSJed Brown   PetscErrorCode ierr;
6010ed81e22dSJed Brown 
6011ed81e22dSJed Brown   PetscFunctionBegin;
6012ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
6013fb1732b5SBarry Smith   PetscFunctionReturn(0);
6014fb1732b5SBarry Smith }
6015fb1732b5SBarry Smith 
601684df9cb4SJed Brown /*@
6017552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
601884df9cb4SJed Brown 
6019ed81e22dSJed Brown    Collective on TS if controller has not been created yet
602084df9cb4SJed Brown 
602184df9cb4SJed Brown    Input Arguments:
6022ed81e22dSJed Brown .  ts - time stepping context
602384df9cb4SJed Brown 
602484df9cb4SJed Brown    Output Arguments:
6025ed81e22dSJed Brown .  adapt - adaptive controller
602684df9cb4SJed Brown 
602784df9cb4SJed Brown    Level: intermediate
602884df9cb4SJed Brown 
6029ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
603084df9cb4SJed Brown @*/
6031552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
603284df9cb4SJed Brown {
603384df9cb4SJed Brown   PetscErrorCode ierr;
603484df9cb4SJed Brown 
603584df9cb4SJed Brown   PetscFunctionBegin;
603684df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6037bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
603884df9cb4SJed Brown   if (!ts->adapt) {
6039ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
60403bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
60411c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
604284df9cb4SJed Brown   }
6043bec58848SLisandro Dalcin   *adapt = ts->adapt;
604484df9cb4SJed Brown   PetscFunctionReturn(0);
604584df9cb4SJed Brown }
6046d6ebe24aSShri Abhyankar 
60471c3436cfSJed Brown /*@
60481c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
60491c3436cfSJed Brown 
60501c3436cfSJed Brown    Logically Collective
60511c3436cfSJed Brown 
60521c3436cfSJed Brown    Input Arguments:
60531c3436cfSJed Brown +  ts - time integration context
60541c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
60550298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
60561c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
60570298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
60581c3436cfSJed Brown 
6059a3cdaa26SBarry Smith    Options Database keys:
6060a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
6061a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
6062a3cdaa26SBarry Smith 
60633ff766beSShri Abhyankar    Notes:
60643ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
60653ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
60663ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
60673ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
60683ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
60693ff766beSShri Abhyankar    differential variables.
60703ff766beSShri Abhyankar 
60711c3436cfSJed Brown    Level: beginner
60721c3436cfSJed Brown 
6073c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
60741c3436cfSJed Brown @*/
60751c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
60761c3436cfSJed Brown {
60771c3436cfSJed Brown   PetscErrorCode ierr;
60781c3436cfSJed Brown 
60791c3436cfSJed Brown   PetscFunctionBegin;
6080c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
60811c3436cfSJed Brown   if (vatol) {
60821c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
60831c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
60841c3436cfSJed Brown     ts->vatol = vatol;
60851c3436cfSJed Brown   }
6086c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
60871c3436cfSJed Brown   if (vrtol) {
60881c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
60891c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
60901c3436cfSJed Brown     ts->vrtol = vrtol;
60911c3436cfSJed Brown   }
60921c3436cfSJed Brown   PetscFunctionReturn(0);
60931c3436cfSJed Brown }
60941c3436cfSJed Brown 
6095c5033834SJed Brown /*@
6096c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
6097c5033834SJed Brown 
6098c5033834SJed Brown    Logically Collective
6099c5033834SJed Brown 
6100c5033834SJed Brown    Input Arguments:
6101c5033834SJed Brown .  ts - time integration context
6102c5033834SJed Brown 
6103c5033834SJed Brown    Output Arguments:
61040298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
61050298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
61060298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
61070298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
6108c5033834SJed Brown 
6109c5033834SJed Brown    Level: beginner
6110c5033834SJed Brown 
6111c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
6112c5033834SJed Brown @*/
6113c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
6114c5033834SJed Brown {
6115c5033834SJed Brown   PetscFunctionBegin;
6116c5033834SJed Brown   if (atol)  *atol  = ts->atol;
6117c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
6118c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
6119c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
6120c5033834SJed Brown   PetscFunctionReturn(0);
6121c5033834SJed Brown }
6122c5033834SJed Brown 
61239c6b16b5SShri Abhyankar /*@
6124a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
61259c6b16b5SShri Abhyankar 
61269c6b16b5SShri Abhyankar    Collective on TS
61279c6b16b5SShri Abhyankar 
61289c6b16b5SShri Abhyankar    Input Arguments:
61299c6b16b5SShri Abhyankar +  ts - time stepping context
6130a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6131a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
61329c6b16b5SShri Abhyankar 
61339c6b16b5SShri Abhyankar    Output Arguments:
61347453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
61357453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
61367453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
61379c6b16b5SShri Abhyankar 
61389c6b16b5SShri Abhyankar    Level: developer
61399c6b16b5SShri Abhyankar 
6140deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
61419c6b16b5SShri Abhyankar @*/
61427453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
61439c6b16b5SShri Abhyankar {
61449c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
61459c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
61467453f775SEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
61477453f775SEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
61489c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
61497453f775SEmil Constantinescu   PetscReal         sum,suma,sumr,gsum,gsuma,gsumr,diff;
61507453f775SEmil Constantinescu   PetscReal         tol,tola,tolr;
61517453f775SEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
61529c6b16b5SShri Abhyankar 
61539c6b16b5SShri Abhyankar   PetscFunctionBegin;
61549c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6155a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
6156a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
6157a4868fbcSLisandro Dalcin   PetscValidType(U,2);
6158a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
6159a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
6160a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
61618a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
61628a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
6163a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
61649c6b16b5SShri Abhyankar 
61659c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
61669c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
61679c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
61689c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
61699c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
61707453f775SEmil Constantinescu   sum  = 0.; n_loc  = 0;
61717453f775SEmil Constantinescu   suma = 0.; na_loc = 0;
61727453f775SEmil Constantinescu   sumr = 0.; nr_loc = 0;
61739c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
61749c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
61759c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61769c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61779c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
61787453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
61797453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
61807453f775SEmil Constantinescu       if(tola>0.){
61817453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
61827453f775SEmil Constantinescu         na_loc++;
61837453f775SEmil Constantinescu       }
61847453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61857453f775SEmil Constantinescu       if(tolr>0.){
61867453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
61877453f775SEmil Constantinescu         nr_loc++;
61887453f775SEmil Constantinescu       }
61897453f775SEmil Constantinescu       tol=tola+tolr;
61907453f775SEmil Constantinescu       if(tol>0.){
61917453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
61927453f775SEmil Constantinescu         n_loc++;
61937453f775SEmil Constantinescu       }
61949c6b16b5SShri Abhyankar     }
61959c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61969c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61979c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
61989c6b16b5SShri Abhyankar     const PetscScalar *atol;
61999c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
62009c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
62017453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
62027453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
62037453f775SEmil Constantinescu       if(tola>0.){
62047453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
62057453f775SEmil Constantinescu         na_loc++;
62067453f775SEmil Constantinescu       }
62077453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62087453f775SEmil Constantinescu       if(tolr>0.){
62097453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
62107453f775SEmil Constantinescu         nr_loc++;
62117453f775SEmil Constantinescu       }
62127453f775SEmil Constantinescu       tol=tola+tolr;
62137453f775SEmil Constantinescu       if(tol>0.){
62147453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
62157453f775SEmil Constantinescu         n_loc++;
62167453f775SEmil Constantinescu       }
62179c6b16b5SShri Abhyankar     }
62189c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
62199c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
62209c6b16b5SShri Abhyankar     const PetscScalar *rtol;
62219c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62229c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
62237453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
62247453f775SEmil Constantinescu       tola = ts->atol;
62257453f775SEmil Constantinescu       if(tola>0.){
62267453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
62277453f775SEmil Constantinescu         na_loc++;
62287453f775SEmil Constantinescu       }
62297453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62307453f775SEmil Constantinescu       if(tolr>0.){
62317453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
62327453f775SEmil Constantinescu         nr_loc++;
62337453f775SEmil Constantinescu       }
62347453f775SEmil Constantinescu       tol=tola+tolr;
62357453f775SEmil Constantinescu       if(tol>0.){
62367453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
62377453f775SEmil Constantinescu         n_loc++;
62387453f775SEmil Constantinescu       }
62399c6b16b5SShri Abhyankar     }
62409c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62419c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
62429c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
62437453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
62447453f775SEmil Constantinescu      tola = ts->atol;
62457453f775SEmil Constantinescu       if(tola>0.){
62467453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
62477453f775SEmil Constantinescu         na_loc++;
62487453f775SEmil Constantinescu       }
62497453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62507453f775SEmil Constantinescu       if(tolr>0.){
62517453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
62527453f775SEmil Constantinescu         nr_loc++;
62537453f775SEmil Constantinescu       }
62547453f775SEmil Constantinescu       tol=tola+tolr;
62557453f775SEmil Constantinescu       if(tol>0.){
62567453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
62577453f775SEmil Constantinescu         n_loc++;
62587453f775SEmil Constantinescu       }
62599c6b16b5SShri Abhyankar     }
62609c6b16b5SShri Abhyankar   }
62619c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
62629c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
62639c6b16b5SShri Abhyankar 
62647453f775SEmil Constantinescu   err_loc[0] = sum;
62657453f775SEmil Constantinescu   err_loc[1] = suma;
62667453f775SEmil Constantinescu   err_loc[2] = sumr;
62677453f775SEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
62687453f775SEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
62697453f775SEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
62707453f775SEmil Constantinescu 
6271a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
62727453f775SEmil Constantinescu 
62737453f775SEmil Constantinescu   gsum   = err_glb[0];
62747453f775SEmil Constantinescu   gsuma  = err_glb[1];
62757453f775SEmil Constantinescu   gsumr  = err_glb[2];
62767453f775SEmil Constantinescu   n_glb  = err_glb[3];
62777453f775SEmil Constantinescu   na_glb = err_glb[4];
62787453f775SEmil Constantinescu   nr_glb = err_glb[5];
62797453f775SEmil Constantinescu 
6280b1316ef9SEmil Constantinescu   *norm  = 0.;
6281b1316ef9SEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
6282b1316ef9SEmil Constantinescu   *norma = 0.;
6283b1316ef9SEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
6284b1316ef9SEmil Constantinescu   *normr = 0.;
6285b1316ef9SEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
62869c6b16b5SShri Abhyankar 
62879c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
62887453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
62897453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
62909c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
62919c6b16b5SShri Abhyankar }
62929c6b16b5SShri Abhyankar 
62939c6b16b5SShri Abhyankar /*@
6294a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
62959c6b16b5SShri Abhyankar 
62969c6b16b5SShri Abhyankar    Collective on TS
62979c6b16b5SShri Abhyankar 
62989c6b16b5SShri Abhyankar    Input Arguments:
62999c6b16b5SShri Abhyankar +  ts - time stepping context
6300a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6301a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
63029c6b16b5SShri Abhyankar 
63039c6b16b5SShri Abhyankar    Output Arguments:
63047453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
63057453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
63067453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
63079c6b16b5SShri Abhyankar 
63089c6b16b5SShri Abhyankar    Level: developer
63099c6b16b5SShri Abhyankar 
6310deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
63119c6b16b5SShri Abhyankar @*/
63127453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
63139c6b16b5SShri Abhyankar {
63149c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
63157453f775SEmil Constantinescu   PetscInt          i,n,N,rstart;
63169c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
63177453f775SEmil Constantinescu   PetscReal         max,gmax,maxa,gmaxa,maxr,gmaxr;
63187453f775SEmil Constantinescu   PetscReal         tol,tola,tolr,diff;
63197453f775SEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
63209c6b16b5SShri Abhyankar 
63219c6b16b5SShri Abhyankar   PetscFunctionBegin;
63229c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6323a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
6324a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
6325a4868fbcSLisandro Dalcin   PetscValidType(U,2);
6326a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
6327a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
6328a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
63298a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
63308a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
6331a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
63329c6b16b5SShri Abhyankar 
63339c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
63349c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
63359c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
63369c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
63379c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
63387453f775SEmil Constantinescu 
63397453f775SEmil Constantinescu   max=0.;
63407453f775SEmil Constantinescu   maxa=0.;
63417453f775SEmil Constantinescu   maxr=0.;
63427453f775SEmil Constantinescu 
63437453f775SEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
63449c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
63459c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63469c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63477453f775SEmil Constantinescu 
63487453f775SEmil Constantinescu     for (i=0; i<n; i++) {
63497453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
63507453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
63517453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63527453f775SEmil Constantinescu       tol  = tola+tolr;
63537453f775SEmil Constantinescu       if(tola>0.){
63547453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
63557453f775SEmil Constantinescu       }
63567453f775SEmil Constantinescu       if(tolr>0.){
63577453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
63587453f775SEmil Constantinescu       }
63597453f775SEmil Constantinescu       if(tol>0.){
63607453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
63617453f775SEmil Constantinescu       }
63629c6b16b5SShri Abhyankar     }
63639c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63649c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63659c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
63669c6b16b5SShri Abhyankar     const PetscScalar *atol;
63679c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63687453f775SEmil Constantinescu     for (i=0; i<n; i++) {
63697453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
63707453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
63717453f775SEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63727453f775SEmil Constantinescu       tol  = tola+tolr;
63737453f775SEmil Constantinescu       if(tola>0.){
63747453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
63757453f775SEmil Constantinescu       }
63767453f775SEmil Constantinescu       if(tolr>0.){
63777453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
63787453f775SEmil Constantinescu       }
63797453f775SEmil Constantinescu       if(tol>0.){
63807453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
63817453f775SEmil Constantinescu       }
63829c6b16b5SShri Abhyankar     }
63839c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63849c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
63859c6b16b5SShri Abhyankar     const PetscScalar *rtol;
63869c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63877453f775SEmil Constantinescu 
63887453f775SEmil Constantinescu     for (i=0; i<n; i++) {
63897453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
63907453f775SEmil Constantinescu       tola = ts->atol;
63917453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63927453f775SEmil Constantinescu       tol  = tola+tolr;
63937453f775SEmil Constantinescu       if(tola>0.){
63947453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
63957453f775SEmil Constantinescu       }
63967453f775SEmil Constantinescu       if(tolr>0.){
63977453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
63987453f775SEmil Constantinescu       }
63997453f775SEmil Constantinescu       if(tol>0.){
64007453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
64017453f775SEmil Constantinescu       }
64029c6b16b5SShri Abhyankar     }
64039c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
64049c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
64057453f775SEmil Constantinescu 
64067453f775SEmil Constantinescu     for (i=0; i<n; i++) {
64077453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
64087453f775SEmil Constantinescu       tola = ts->atol;
64097453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
64107453f775SEmil Constantinescu       tol  = tola+tolr;
64117453f775SEmil Constantinescu       if(tola>0.){
64127453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
64137453f775SEmil Constantinescu       }
64147453f775SEmil Constantinescu       if(tolr>0.){
64157453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
64167453f775SEmil Constantinescu       }
64177453f775SEmil Constantinescu       if(tol>0.){
64187453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
64197453f775SEmil Constantinescu       }
64209c6b16b5SShri Abhyankar     }
64219c6b16b5SShri Abhyankar   }
64229c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
64239c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
64247453f775SEmil Constantinescu   err_loc[0] = max;
64257453f775SEmil Constantinescu   err_loc[1] = maxa;
64267453f775SEmil Constantinescu   err_loc[2] = maxr;
6427a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
64287453f775SEmil Constantinescu   gmax   = err_glb[0];
64297453f775SEmil Constantinescu   gmaxa  = err_glb[1];
64307453f775SEmil Constantinescu   gmaxr  = err_glb[2];
64319c6b16b5SShri Abhyankar 
64329c6b16b5SShri Abhyankar   *norm = gmax;
64337453f775SEmil Constantinescu   *norma = gmaxa;
64347453f775SEmil Constantinescu   *normr = gmaxr;
64359c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
64367453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
64377453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
64389c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
64399c6b16b5SShri Abhyankar }
64409c6b16b5SShri Abhyankar 
64411c3436cfSJed Brown /*@
64428a175baeSEmil Constantinescu    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
64431c3436cfSJed Brown 
64441c3436cfSJed Brown    Collective on TS
64451c3436cfSJed Brown 
64461c3436cfSJed Brown    Input Arguments:
64471c3436cfSJed Brown +  ts - time stepping context
6448a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6449a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
6450a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
64517619abb3SShri 
64521c3436cfSJed Brown    Output Arguments:
64538a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
64548a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
64558a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
6456a4868fbcSLisandro Dalcin 
6457a4868fbcSLisandro Dalcin    Options Database Keys:
6458a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
6459a4868fbcSLisandro Dalcin 
64601c3436cfSJed Brown    Level: developer
64611c3436cfSJed Brown 
64628a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm
64631c3436cfSJed Brown @*/
64647453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
64651c3436cfSJed Brown {
64668beabaa1SBarry Smith   PetscErrorCode ierr;
64671c3436cfSJed Brown 
64681c3436cfSJed Brown   PetscFunctionBegin;
6469a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
64707453f775SEmil Constantinescu     ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6471a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
64727453f775SEmil Constantinescu     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6473a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
64741c3436cfSJed Brown   PetscFunctionReturn(0);
64751c3436cfSJed Brown }
64761c3436cfSJed Brown 
64778a175baeSEmil Constantinescu 
64788a175baeSEmil Constantinescu /*@
64798a175baeSEmil Constantinescu    TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances
64808a175baeSEmil Constantinescu 
64818a175baeSEmil Constantinescu    Collective on TS
64828a175baeSEmil Constantinescu 
64838a175baeSEmil Constantinescu    Input Arguments:
64848a175baeSEmil Constantinescu +  ts - time stepping context
64858a175baeSEmil Constantinescu .  E - error vector
64868a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
64878a175baeSEmil Constantinescu -  Y - state vector, previous time step
64888a175baeSEmil Constantinescu 
64898a175baeSEmil Constantinescu    Output Arguments:
64908a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
64918a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
64928a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
64938a175baeSEmil Constantinescu 
64948a175baeSEmil Constantinescu    Level: developer
64958a175baeSEmil Constantinescu 
64968a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity()
64978a175baeSEmil Constantinescu @*/
64988a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
64998a175baeSEmil Constantinescu {
65008a175baeSEmil Constantinescu   PetscErrorCode    ierr;
65018a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
65028a175baeSEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
65038a175baeSEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
65048a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
65058a175baeSEmil Constantinescu   PetscReal         err,sum,suma,sumr,gsum,gsuma,gsumr;
65068a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
65078a175baeSEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
65088a175baeSEmil Constantinescu 
65098a175baeSEmil Constantinescu   PetscFunctionBegin;
65108a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
65118a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
65128a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
65138a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
65148a175baeSEmil Constantinescu   PetscValidType(E,2);
65158a175baeSEmil Constantinescu   PetscValidType(U,3);
65168a175baeSEmil Constantinescu   PetscValidType(Y,4);
65178a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
65188a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
65198a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
65208a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
65218a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
65228a175baeSEmil Constantinescu 
65238a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
65248a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
65258a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
65268a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
65278a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
65288a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
65298a175baeSEmil Constantinescu   sum  = 0.; n_loc  = 0;
65308a175baeSEmil Constantinescu   suma = 0.; na_loc = 0;
65318a175baeSEmil Constantinescu   sumr = 0.; nr_loc = 0;
65328a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {
65338a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
65348a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65358a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65368a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65378a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65388a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
65398a175baeSEmil Constantinescu       if(tola>0.){
65408a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
65418a175baeSEmil Constantinescu         na_loc++;
65428a175baeSEmil Constantinescu       }
65438a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65448a175baeSEmil Constantinescu       if(tolr>0.){
65458a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
65468a175baeSEmil Constantinescu         nr_loc++;
65478a175baeSEmil Constantinescu       }
65488a175baeSEmil Constantinescu       tol=tola+tolr;
65498a175baeSEmil Constantinescu       if(tol>0.){
65508a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
65518a175baeSEmil Constantinescu         n_loc++;
65528a175baeSEmil Constantinescu       }
65538a175baeSEmil Constantinescu     }
65548a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65558a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65568a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
65578a175baeSEmil Constantinescu     const PetscScalar *atol;
65588a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65598a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65608a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65618a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
65628a175baeSEmil Constantinescu       if(tola>0.){
65638a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
65648a175baeSEmil Constantinescu         na_loc++;
65658a175baeSEmil Constantinescu       }
65668a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65678a175baeSEmil Constantinescu       if(tolr>0.){
65688a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
65698a175baeSEmil Constantinescu         nr_loc++;
65708a175baeSEmil Constantinescu       }
65718a175baeSEmil Constantinescu       tol=tola+tolr;
65728a175baeSEmil Constantinescu       if(tol>0.){
65738a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
65748a175baeSEmil Constantinescu         n_loc++;
65758a175baeSEmil Constantinescu       }
65768a175baeSEmil Constantinescu     }
65778a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65788a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
65798a175baeSEmil Constantinescu     const PetscScalar *rtol;
65808a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65818a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65828a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65838a175baeSEmil Constantinescu       tola = ts->atol;
65848a175baeSEmil Constantinescu       if(tola>0.){
65858a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
65868a175baeSEmil Constantinescu         na_loc++;
65878a175baeSEmil Constantinescu       }
65888a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65898a175baeSEmil Constantinescu       if(tolr>0.){
65908a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
65918a175baeSEmil Constantinescu         nr_loc++;
65928a175baeSEmil Constantinescu       }
65938a175baeSEmil Constantinescu       tol=tola+tolr;
65948a175baeSEmil Constantinescu       if(tol>0.){
65958a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
65968a175baeSEmil Constantinescu         n_loc++;
65978a175baeSEmil Constantinescu       }
65988a175baeSEmil Constantinescu     }
65998a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
66008a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
66018a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
66028a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
66038a175baeSEmil Constantinescu      tola = ts->atol;
66048a175baeSEmil Constantinescu       if(tola>0.){
66058a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
66068a175baeSEmil Constantinescu         na_loc++;
66078a175baeSEmil Constantinescu       }
66088a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
66098a175baeSEmil Constantinescu       if(tolr>0.){
66108a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
66118a175baeSEmil Constantinescu         nr_loc++;
66128a175baeSEmil Constantinescu       }
66138a175baeSEmil Constantinescu       tol=tola+tolr;
66148a175baeSEmil Constantinescu       if(tol>0.){
66158a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
66168a175baeSEmil Constantinescu         n_loc++;
66178a175baeSEmil Constantinescu       }
66188a175baeSEmil Constantinescu     }
66198a175baeSEmil Constantinescu   }
66208a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
66218a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
66228a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
66238a175baeSEmil Constantinescu 
66248a175baeSEmil Constantinescu   err_loc[0] = sum;
66258a175baeSEmil Constantinescu   err_loc[1] = suma;
66268a175baeSEmil Constantinescu   err_loc[2] = sumr;
66278a175baeSEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
66288a175baeSEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
66298a175baeSEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
66308a175baeSEmil Constantinescu 
6631a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
66328a175baeSEmil Constantinescu 
66338a175baeSEmil Constantinescu   gsum   = err_glb[0];
66348a175baeSEmil Constantinescu   gsuma  = err_glb[1];
66358a175baeSEmil Constantinescu   gsumr  = err_glb[2];
66368a175baeSEmil Constantinescu   n_glb  = err_glb[3];
66378a175baeSEmil Constantinescu   na_glb = err_glb[4];
66388a175baeSEmil Constantinescu   nr_glb = err_glb[5];
66398a175baeSEmil Constantinescu 
66408a175baeSEmil Constantinescu   *norm  = 0.;
66418a175baeSEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
66428a175baeSEmil Constantinescu   *norma = 0.;
66438a175baeSEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
66448a175baeSEmil Constantinescu   *normr = 0.;
66458a175baeSEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
66468a175baeSEmil Constantinescu 
66478a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
66488a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
66498a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
66508a175baeSEmil Constantinescu   PetscFunctionReturn(0);
66518a175baeSEmil Constantinescu }
66528a175baeSEmil Constantinescu 
66538a175baeSEmil Constantinescu /*@
66548a175baeSEmil Constantinescu    TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances
66558a175baeSEmil Constantinescu    Collective on TS
66568a175baeSEmil Constantinescu 
66578a175baeSEmil Constantinescu    Input Arguments:
66588a175baeSEmil Constantinescu +  ts - time stepping context
66598a175baeSEmil Constantinescu .  E - error vector
66608a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
66618a175baeSEmil Constantinescu -  Y - state vector, previous time step
66628a175baeSEmil Constantinescu 
66638a175baeSEmil Constantinescu    Output Arguments:
66648a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
66658a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
66668a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
66678a175baeSEmil Constantinescu 
66688a175baeSEmil Constantinescu    Level: developer
66698a175baeSEmil Constantinescu 
66708a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2()
66718a175baeSEmil Constantinescu @*/
66728a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
66738a175baeSEmil Constantinescu {
66748a175baeSEmil Constantinescu   PetscErrorCode    ierr;
66758a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
66768a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
66778a175baeSEmil Constantinescu   PetscReal         err,max,gmax,maxa,gmaxa,maxr,gmaxr;
66788a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
66798a175baeSEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
66808a175baeSEmil Constantinescu 
66818a175baeSEmil Constantinescu   PetscFunctionBegin;
66828a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
66838a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
66848a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
66858a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
66868a175baeSEmil Constantinescu   PetscValidType(E,2);
66878a175baeSEmil Constantinescu   PetscValidType(U,3);
66888a175baeSEmil Constantinescu   PetscValidType(Y,4);
66898a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
66908a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
66918a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
66928a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
66938a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
66948a175baeSEmil Constantinescu 
66958a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
66968a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
66978a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
66988a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
66998a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
67008a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
67018a175baeSEmil Constantinescu 
67028a175baeSEmil Constantinescu   max=0.;
67038a175baeSEmil Constantinescu   maxa=0.;
67048a175baeSEmil Constantinescu   maxr=0.;
67058a175baeSEmil Constantinescu 
67068a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
67078a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
67088a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67098a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67108a175baeSEmil Constantinescu 
67118a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67128a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67138a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
67148a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67158a175baeSEmil Constantinescu       tol  = tola+tolr;
67168a175baeSEmil Constantinescu       if(tola>0.){
67178a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67188a175baeSEmil Constantinescu       }
67198a175baeSEmil Constantinescu       if(tolr>0.){
67208a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67218a175baeSEmil Constantinescu       }
67228a175baeSEmil Constantinescu       if(tol>0.){
67238a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67248a175baeSEmil Constantinescu       }
67258a175baeSEmil Constantinescu     }
67268a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67278a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67288a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
67298a175baeSEmil Constantinescu     const PetscScalar *atol;
67308a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67318a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67328a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67338a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
67348a175baeSEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67358a175baeSEmil Constantinescu       tol  = tola+tolr;
67368a175baeSEmil Constantinescu       if(tola>0.){
67378a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67388a175baeSEmil Constantinescu       }
67398a175baeSEmil Constantinescu       if(tolr>0.){
67408a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67418a175baeSEmil Constantinescu       }
67428a175baeSEmil Constantinescu       if(tol>0.){
67438a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67448a175baeSEmil Constantinescu       }
67458a175baeSEmil Constantinescu     }
67468a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
67478a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
67488a175baeSEmil Constantinescu     const PetscScalar *rtol;
67498a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67508a175baeSEmil Constantinescu 
67518a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67528a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67538a175baeSEmil Constantinescu       tola = ts->atol;
67548a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67558a175baeSEmil Constantinescu       tol  = tola+tolr;
67568a175baeSEmil Constantinescu       if(tola>0.){
67578a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67588a175baeSEmil Constantinescu       }
67598a175baeSEmil Constantinescu       if(tolr>0.){
67608a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67618a175baeSEmil Constantinescu       }
67628a175baeSEmil Constantinescu       if(tol>0.){
67638a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67648a175baeSEmil Constantinescu       }
67658a175baeSEmil Constantinescu     }
67668a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
67678a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
67688a175baeSEmil Constantinescu 
67698a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
67708a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
67718a175baeSEmil Constantinescu       tola = ts->atol;
67728a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
67738a175baeSEmil Constantinescu       tol  = tola+tolr;
67748a175baeSEmil Constantinescu       if(tola>0.){
67758a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
67768a175baeSEmil Constantinescu       }
67778a175baeSEmil Constantinescu       if(tolr>0.){
67788a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
67798a175baeSEmil Constantinescu       }
67808a175baeSEmil Constantinescu       if(tol>0.){
67818a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
67828a175baeSEmil Constantinescu       }
67838a175baeSEmil Constantinescu     }
67848a175baeSEmil Constantinescu   }
67858a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
67868a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
67878a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
67888a175baeSEmil Constantinescu   err_loc[0] = max;
67898a175baeSEmil Constantinescu   err_loc[1] = maxa;
67908a175baeSEmil Constantinescu   err_loc[2] = maxr;
6791a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
67928a175baeSEmil Constantinescu   gmax   = err_glb[0];
67938a175baeSEmil Constantinescu   gmaxa  = err_glb[1];
67948a175baeSEmil Constantinescu   gmaxr  = err_glb[2];
67958a175baeSEmil Constantinescu 
67968a175baeSEmil Constantinescu   *norm = gmax;
67978a175baeSEmil Constantinescu   *norma = gmaxa;
67988a175baeSEmil Constantinescu   *normr = gmaxr;
67998a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
68008a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
68018a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
68028a175baeSEmil Constantinescu   PetscFunctionReturn(0);
68038a175baeSEmil Constantinescu }
68048a175baeSEmil Constantinescu 
68058a175baeSEmil Constantinescu /*@
68068a175baeSEmil Constantinescu    TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
68078a175baeSEmil Constantinescu 
68088a175baeSEmil Constantinescu    Collective on TS
68098a175baeSEmil Constantinescu 
68108a175baeSEmil Constantinescu    Input Arguments:
68118a175baeSEmil Constantinescu +  ts - time stepping context
68128a175baeSEmil Constantinescu .  E - error vector
68138a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
68148a175baeSEmil Constantinescu .  Y - state vector, previous time step
68158a175baeSEmil Constantinescu -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
68168a175baeSEmil Constantinescu 
68178a175baeSEmil Constantinescu    Output Arguments:
68188a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
68198a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
68208a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
68218a175baeSEmil Constantinescu 
68228a175baeSEmil Constantinescu    Options Database Keys:
68238a175baeSEmil Constantinescu .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
68248a175baeSEmil Constantinescu 
68258a175baeSEmil Constantinescu    Level: developer
68268a175baeSEmil Constantinescu 
68278a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
68288a175baeSEmil Constantinescu @*/
68298a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
68308a175baeSEmil Constantinescu {
68318a175baeSEmil Constantinescu   PetscErrorCode ierr;
68328a175baeSEmil Constantinescu 
68338a175baeSEmil Constantinescu   PetscFunctionBegin;
68348a175baeSEmil Constantinescu   if (wnormtype == NORM_2) {
68358a175baeSEmil Constantinescu     ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
68368a175baeSEmil Constantinescu   } else if(wnormtype == NORM_INFINITY) {
68378a175baeSEmil Constantinescu     ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
68388a175baeSEmil Constantinescu   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
68398a175baeSEmil Constantinescu   PetscFunctionReturn(0);
68408a175baeSEmil Constantinescu }
68418a175baeSEmil Constantinescu 
68428a175baeSEmil Constantinescu 
68438d59e960SJed Brown /*@
68448d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
68458d59e960SJed Brown 
68468d59e960SJed Brown    Logically Collective on TS
68478d59e960SJed Brown 
68488d59e960SJed Brown    Input Arguments:
68498d59e960SJed Brown +  ts - time stepping context
68508d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
68518d59e960SJed Brown 
68528d59e960SJed Brown    Note:
68538d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
68548d59e960SJed Brown 
68558d59e960SJed Brown    Level: intermediate
68568d59e960SJed Brown 
68578d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
68588d59e960SJed Brown @*/
68598d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
68608d59e960SJed Brown {
68618d59e960SJed Brown   PetscFunctionBegin;
68628d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
68638d59e960SJed Brown   ts->cfltime_local = cfltime;
68648d59e960SJed Brown   ts->cfltime       = -1.;
68658d59e960SJed Brown   PetscFunctionReturn(0);
68668d59e960SJed Brown }
68678d59e960SJed Brown 
68688d59e960SJed Brown /*@
68698d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
68708d59e960SJed Brown 
68718d59e960SJed Brown    Collective on TS
68728d59e960SJed Brown 
68738d59e960SJed Brown    Input Arguments:
68748d59e960SJed Brown .  ts - time stepping context
68758d59e960SJed Brown 
68768d59e960SJed Brown    Output Arguments:
68778d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
68788d59e960SJed Brown 
68798d59e960SJed Brown    Level: advanced
68808d59e960SJed Brown 
68818d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
68828d59e960SJed Brown @*/
68838d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
68848d59e960SJed Brown {
68858d59e960SJed Brown   PetscErrorCode ierr;
68868d59e960SJed Brown 
68878d59e960SJed Brown   PetscFunctionBegin;
68888d59e960SJed Brown   if (ts->cfltime < 0) {
6889b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
68908d59e960SJed Brown   }
68918d59e960SJed Brown   *cfltime = ts->cfltime;
68928d59e960SJed Brown   PetscFunctionReturn(0);
68938d59e960SJed Brown }
68948d59e960SJed Brown 
6895d6ebe24aSShri Abhyankar /*@
6896d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6897d6ebe24aSShri Abhyankar 
6898d6ebe24aSShri Abhyankar    Input Parameters:
6899d6ebe24aSShri Abhyankar .  ts   - the TS context.
6900d6ebe24aSShri Abhyankar .  xl   - lower bound.
6901d6ebe24aSShri Abhyankar .  xu   - upper bound.
6902d6ebe24aSShri Abhyankar 
6903d6ebe24aSShri Abhyankar    Notes:
6904d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6905e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6906d6ebe24aSShri Abhyankar 
69072bd2b0e6SSatish Balay    Level: advanced
69082bd2b0e6SSatish Balay 
6909d6ebe24aSShri Abhyankar @*/
6910d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6911d6ebe24aSShri Abhyankar {
6912d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6913d6ebe24aSShri Abhyankar   SNES           snes;
6914d6ebe24aSShri Abhyankar 
6915d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6916d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6917d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6918d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6919d6ebe24aSShri Abhyankar }
6920d6ebe24aSShri Abhyankar 
6921325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
6922c6db04a5SJed Brown #include <mex.h>
6923325fc9f4SBarry Smith 
6924325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
6925325fc9f4SBarry Smith 
6926325fc9f4SBarry Smith /*
6927325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
6928325fc9f4SBarry Smith                          TSSetFunctionMatlab().
6929325fc9f4SBarry Smith 
6930325fc9f4SBarry Smith    Collective on TS
6931325fc9f4SBarry Smith 
6932325fc9f4SBarry Smith    Input Parameters:
6933325fc9f4SBarry Smith +  snes - the TS context
69340910c330SBarry Smith -  u - input vector
6935325fc9f4SBarry Smith 
6936325fc9f4SBarry Smith    Output Parameter:
6937325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
6938325fc9f4SBarry Smith 
6939325fc9f4SBarry Smith    Notes:
6940325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
6941325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
6942325fc9f4SBarry Smith    themselves.
6943325fc9f4SBarry Smith 
6944325fc9f4SBarry Smith    Level: developer
6945325fc9f4SBarry Smith 
6946325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6947325fc9f4SBarry Smith 
6948325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6949325fc9f4SBarry Smith */
69500910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
6951325fc9f4SBarry Smith {
6952325fc9f4SBarry Smith   PetscErrorCode  ierr;
6953325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6954325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
6955325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
6956325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
6957325fc9f4SBarry Smith 
6958325fc9f4SBarry Smith   PetscFunctionBegin;
6959325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
69600910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
69610910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
6962325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
69630910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
6964325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
6965325fc9f4SBarry Smith 
6966325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
69670910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
69680910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
69690910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
6970bbd56ea5SKarl Rupp 
6971325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6972325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
6973325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6974325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6975325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
6976325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
6977325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
6978325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
6979325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6980325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6981325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6982325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6983325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6984325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6985325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6986325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6987325fc9f4SBarry Smith   PetscFunctionReturn(0);
6988325fc9f4SBarry Smith }
6989325fc9f4SBarry Smith 
6990325fc9f4SBarry Smith /*
6991325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
6992325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
6993e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
6994325fc9f4SBarry Smith 
6995325fc9f4SBarry Smith    Logically Collective on TS
6996325fc9f4SBarry Smith 
6997325fc9f4SBarry Smith    Input Parameters:
6998325fc9f4SBarry Smith +  ts - the TS context
6999325fc9f4SBarry Smith -  func - function evaluation routine
7000325fc9f4SBarry Smith 
7001325fc9f4SBarry Smith    Calling sequence of func:
70020910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
7003325fc9f4SBarry Smith 
7004325fc9f4SBarry Smith    Level: beginner
7005325fc9f4SBarry Smith 
7006325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
7007325fc9f4SBarry Smith 
7008325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
7009325fc9f4SBarry Smith */
7010cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
7011325fc9f4SBarry Smith {
7012325fc9f4SBarry Smith   PetscErrorCode  ierr;
7013325fc9f4SBarry Smith   TSMatlabContext *sctx;
7014325fc9f4SBarry Smith 
7015325fc9f4SBarry Smith   PetscFunctionBegin;
7016325fc9f4SBarry Smith   /* currently sctx is memory bleed */
701795dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
7018325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
7019325fc9f4SBarry Smith   /*
7020325fc9f4SBarry Smith      This should work, but it doesn't
7021325fc9f4SBarry Smith   sctx->ctx = ctx;
7022325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
7023325fc9f4SBarry Smith   */
7024325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
7025bbd56ea5SKarl Rupp 
70260298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
7027325fc9f4SBarry Smith   PetscFunctionReturn(0);
7028325fc9f4SBarry Smith }
7029325fc9f4SBarry Smith 
7030325fc9f4SBarry Smith /*
7031325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
7032325fc9f4SBarry Smith                          TSSetJacobianMatlab().
7033325fc9f4SBarry Smith 
7034325fc9f4SBarry Smith    Collective on TS
7035325fc9f4SBarry Smith 
7036325fc9f4SBarry Smith    Input Parameters:
7037cdcf91faSSean Farley +  ts - the TS context
70380910c330SBarry Smith .  u - input vector
7039325fc9f4SBarry Smith .  A, B - the matrices
7040325fc9f4SBarry Smith -  ctx - user context
7041325fc9f4SBarry Smith 
7042325fc9f4SBarry Smith    Level: developer
7043325fc9f4SBarry Smith 
7044325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
7045325fc9f4SBarry Smith 
7046325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
7047325fc9f4SBarry Smith @*/
7048f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
7049325fc9f4SBarry Smith {
7050325fc9f4SBarry Smith   PetscErrorCode  ierr;
7051325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
7052325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
7053325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
7054325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
7055325fc9f4SBarry Smith 
7056325fc9f4SBarry Smith   PetscFunctionBegin;
7057cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
70580910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
7059325fc9f4SBarry Smith 
70600910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
7061325fc9f4SBarry Smith 
7062cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
70630910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
70640910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
70650910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
70660910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
7067bbd56ea5SKarl Rupp 
7068325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
7069325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
7070325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
7071325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
7072325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
7073325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
7074325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
7075325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
7076325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
7077325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
7078325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
7079325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
7080325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
7081325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
7082325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
7083325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
7084325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
7085325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
7086325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
7087325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
7088325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
7089325fc9f4SBarry Smith   PetscFunctionReturn(0);
7090325fc9f4SBarry Smith }
7091325fc9f4SBarry Smith 
7092325fc9f4SBarry Smith /*
7093325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
7094e3c5b3baSBarry 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
7095325fc9f4SBarry Smith 
7096325fc9f4SBarry Smith    Logically Collective on TS
7097325fc9f4SBarry Smith 
7098325fc9f4SBarry Smith    Input Parameters:
7099cdcf91faSSean Farley +  ts - the TS context
7100325fc9f4SBarry Smith .  A,B - Jacobian matrices
7101325fc9f4SBarry Smith .  func - function evaluation routine
7102325fc9f4SBarry Smith -  ctx - user context
7103325fc9f4SBarry Smith 
7104325fc9f4SBarry Smith    Calling sequence of func:
71050910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
7106325fc9f4SBarry Smith 
7107325fc9f4SBarry Smith    Level: developer
7108325fc9f4SBarry Smith 
7109325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
7110325fc9f4SBarry Smith 
7111325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
7112325fc9f4SBarry Smith */
7113cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
7114325fc9f4SBarry Smith {
7115325fc9f4SBarry Smith   PetscErrorCode  ierr;
7116325fc9f4SBarry Smith   TSMatlabContext *sctx;
7117325fc9f4SBarry Smith 
7118325fc9f4SBarry Smith   PetscFunctionBegin;
7119325fc9f4SBarry Smith   /* currently sctx is memory bleed */
712095dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
7121325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
7122325fc9f4SBarry Smith   /*
7123325fc9f4SBarry Smith      This should work, but it doesn't
7124325fc9f4SBarry Smith   sctx->ctx = ctx;
7125325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
7126325fc9f4SBarry Smith   */
7127325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
7128bbd56ea5SKarl Rupp 
7129cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
7130325fc9f4SBarry Smith   PetscFunctionReturn(0);
7131325fc9f4SBarry Smith }
7132325fc9f4SBarry Smith 
7133b5b1a830SBarry Smith /*
7134b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
7135b5b1a830SBarry Smith 
7136b5b1a830SBarry Smith    Collective on TS
7137b5b1a830SBarry Smith 
7138b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
7139b5b1a830SBarry Smith @*/
71400910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
7141b5b1a830SBarry Smith {
7142b5b1a830SBarry Smith   PetscErrorCode  ierr;
7143b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
7144a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
7145b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
7146b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
7147b5b1a830SBarry Smith 
7148b5b1a830SBarry Smith   PetscFunctionBegin;
7149cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
71500910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
7151b5b1a830SBarry Smith 
7152cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
71530910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
7154bbd56ea5SKarl Rupp 
7155b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
7156b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
7157b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
7158b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
7159b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
7160b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
7161b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
7162b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
7163b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
7164b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
7165b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
7166b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
7167b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
7168b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
7169b5b1a830SBarry Smith   PetscFunctionReturn(0);
7170b5b1a830SBarry Smith }
7171b5b1a830SBarry Smith 
7172b5b1a830SBarry Smith /*
7173b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
7174b5b1a830SBarry Smith 
7175b5b1a830SBarry Smith    Level: developer
7176b5b1a830SBarry Smith 
7177b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
7178b5b1a830SBarry Smith 
7179b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
7180b5b1a830SBarry Smith */
7181cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
7182b5b1a830SBarry Smith {
7183b5b1a830SBarry Smith   PetscErrorCode  ierr;
7184b5b1a830SBarry Smith   TSMatlabContext *sctx;
7185b5b1a830SBarry Smith 
7186b5b1a830SBarry Smith   PetscFunctionBegin;
7187b5b1a830SBarry Smith   /* currently sctx is memory bleed */
718895dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
7189b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
7190b5b1a830SBarry Smith   /*
7191b5b1a830SBarry Smith      This should work, but it doesn't
7192b5b1a830SBarry Smith   sctx->ctx = ctx;
7193b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
7194b5b1a830SBarry Smith   */
7195b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
7196bbd56ea5SKarl Rupp 
71970298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
7198b5b1a830SBarry Smith   PetscFunctionReturn(0);
7199b5b1a830SBarry Smith }
7200325fc9f4SBarry Smith #endif
7201b3603a34SBarry Smith 
7202b3603a34SBarry Smith /*@C
72034f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
7204b3603a34SBarry Smith        in a time based line graph
7205b3603a34SBarry Smith 
7206b3603a34SBarry Smith    Collective on TS
7207b3603a34SBarry Smith 
7208b3603a34SBarry Smith    Input Parameters:
7209b3603a34SBarry Smith +  ts - the TS context
7210b3603a34SBarry Smith .  step - current time-step
7211b3603a34SBarry Smith .  ptime - current time
72127db568b7SBarry Smith .  u - current solution
72137db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
7214b3603a34SBarry Smith 
7215b3d3934dSBarry Smith    Options Database:
72169ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
7217b3d3934dSBarry Smith 
7218b3603a34SBarry Smith    Level: intermediate
7219b3603a34SBarry Smith 
72206934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component solutions in a separate window
7221b3603a34SBarry Smith 
7222b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
7223b3603a34SBarry Smith 
72247db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
72257db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
72267db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
72277db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
7228b3603a34SBarry Smith @*/
72297db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7230b3603a34SBarry Smith {
7231b3603a34SBarry Smith   PetscErrorCode    ierr;
72327db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
7233b3603a34SBarry Smith   const PetscScalar *yy;
723480666b62SBarry Smith   Vec               v;
7235b3603a34SBarry Smith 
7236b3603a34SBarry Smith   PetscFunctionBegin;
723763e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
723858ff32f7SBarry Smith   if (!step) {
7239a9f9c1f6SBarry Smith     PetscDrawAxis axis;
72406934998bSLisandro Dalcin     PetscInt      dim;
7241a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7242a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
7243bab0a581SBarry Smith     if (!ctx->names) {
7244bab0a581SBarry Smith       PetscBool flg;
7245bab0a581SBarry Smith       /* user provides names of variables to plot but no names has been set so assume names are integer values */
7246bab0a581SBarry Smith       ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr);
7247bab0a581SBarry Smith       if (flg) {
7248bab0a581SBarry Smith         PetscInt i,n;
7249bab0a581SBarry Smith         char     **names;
7250bab0a581SBarry Smith         ierr = VecGetSize(u,&n);CHKERRQ(ierr);
7251bab0a581SBarry Smith         ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr);
7252bab0a581SBarry Smith         for (i=0; i<n; i++) {
7253bab0a581SBarry Smith           ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr);
7254bab0a581SBarry Smith           ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr);
7255bab0a581SBarry Smith         }
7256bab0a581SBarry Smith         names[n] = NULL;
7257bab0a581SBarry Smith         ctx->names = names;
7258bab0a581SBarry Smith       }
7259bab0a581SBarry Smith     }
7260387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
7261387f4636SBarry Smith       char      **displaynames;
7262387f4636SBarry Smith       PetscBool flg;
7263387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
726495dccacaSBarry Smith       ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr);
7265387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
7266c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
7267387f4636SBarry Smith       if (flg) {
7268a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
7269387f4636SBarry Smith       }
7270387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
7271387f4636SBarry Smith     }
7272387f4636SBarry Smith     if (ctx->displaynames) {
7273387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
7274387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
7275387f4636SBarry Smith     } else if (ctx->names) {
72760910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
72770b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7278387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
7279b0bc92c6SBarry Smith     } else {
7280b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
7281b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7282387f4636SBarry Smith     }
72830b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
728458ff32f7SBarry Smith   }
72856934998bSLisandro Dalcin 
72866934998bSLisandro Dalcin   if (!ctx->transform) v = u;
72876934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
728880666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
72896934998bSLisandro Dalcin   if (ctx->displaynames) {
72906934998bSLisandro Dalcin     PetscInt i;
72916934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
72926934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
72936934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
72946934998bSLisandro Dalcin   } else {
7295e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
7296e3efe391SJed Brown     PetscInt  i,n;
72976934998bSLisandro Dalcin     PetscReal *yreal;
729880666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
7299785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
7300e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
73010b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
7302e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
7303e3efe391SJed Brown #else
73040b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
7305e3efe391SJed Brown #endif
730680666b62SBarry Smith   }
73076934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
73086934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
73096934998bSLisandro Dalcin 
7310b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
73110b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
73126934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
73133923b477SBarry Smith   }
7314b3603a34SBarry Smith   PetscFunctionReturn(0);
7315b3603a34SBarry Smith }
7316b3603a34SBarry Smith 
7317b037adc7SBarry Smith /*@C
731831152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
7319b037adc7SBarry Smith 
7320b037adc7SBarry Smith    Collective on TS
7321b037adc7SBarry Smith 
7322b037adc7SBarry Smith    Input Parameters:
7323b037adc7SBarry Smith +  ts - the TS context
7324b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
7325b037adc7SBarry Smith 
7326b037adc7SBarry Smith    Level: intermediate
7327b037adc7SBarry Smith 
73287db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
73297db568b7SBarry Smith 
7330b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
7331b037adc7SBarry Smith 
7332a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
7333b037adc7SBarry Smith @*/
733431152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
7335b037adc7SBarry Smith {
7336b037adc7SBarry Smith   PetscErrorCode    ierr;
7337b037adc7SBarry Smith   PetscInt          i;
7338b037adc7SBarry Smith 
7339b037adc7SBarry Smith   PetscFunctionBegin;
7340b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7341b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
73425537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
7343b3d3934dSBarry Smith       break;
7344b3d3934dSBarry Smith     }
7345b3d3934dSBarry Smith   }
7346b3d3934dSBarry Smith   PetscFunctionReturn(0);
7347b3d3934dSBarry Smith }
7348b3d3934dSBarry Smith 
7349e673d494SBarry Smith /*@C
7350e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
7351e673d494SBarry Smith 
7352e673d494SBarry Smith    Collective on TS
7353e673d494SBarry Smith 
7354e673d494SBarry Smith    Input Parameters:
7355e673d494SBarry Smith +  ts - the TS context
7356e673d494SBarry Smith -  names - the names of the components, final string must be NULL
7357e673d494SBarry Smith 
7358e673d494SBarry Smith    Level: intermediate
7359e673d494SBarry Smith 
7360e673d494SBarry Smith .keywords: TS,  vector, monitor, view
7361e673d494SBarry Smith 
7362a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
7363e673d494SBarry Smith @*/
7364e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
7365e673d494SBarry Smith {
7366e673d494SBarry Smith   PetscErrorCode    ierr;
7367e673d494SBarry Smith 
7368e673d494SBarry Smith   PetscFunctionBegin;
7369e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
7370e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
7371e673d494SBarry Smith   PetscFunctionReturn(0);
7372e673d494SBarry Smith }
7373e673d494SBarry Smith 
7374b3d3934dSBarry Smith /*@C
7375b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
7376b3d3934dSBarry Smith 
7377b3d3934dSBarry Smith    Collective on TS
7378b3d3934dSBarry Smith 
7379b3d3934dSBarry Smith    Input Parameter:
7380b3d3934dSBarry Smith .  ts - the TS context
7381b3d3934dSBarry Smith 
7382b3d3934dSBarry Smith    Output Parameter:
7383b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
7384b3d3934dSBarry Smith 
7385b3d3934dSBarry Smith    Level: intermediate
7386b3d3934dSBarry Smith 
73877db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
73887db568b7SBarry Smith 
7389b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7390b3d3934dSBarry Smith 
7391b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7392b3d3934dSBarry Smith @*/
7393b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
7394b3d3934dSBarry Smith {
7395b3d3934dSBarry Smith   PetscInt       i;
7396b3d3934dSBarry Smith 
7397b3d3934dSBarry Smith   PetscFunctionBegin;
7398b3d3934dSBarry Smith   *names = NULL;
7399b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7400b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
74015537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
7402b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
7403b3d3934dSBarry Smith       break;
7404387f4636SBarry Smith     }
7405387f4636SBarry Smith   }
7406387f4636SBarry Smith   PetscFunctionReturn(0);
7407387f4636SBarry Smith }
7408387f4636SBarry Smith 
7409a66092f1SBarry Smith /*@C
7410a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
7411a66092f1SBarry Smith 
7412a66092f1SBarry Smith    Collective on TS
7413a66092f1SBarry Smith 
7414a66092f1SBarry Smith    Input Parameters:
7415a66092f1SBarry Smith +  ctx - the TSMonitorLG context
7416a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
7417a66092f1SBarry Smith 
7418a66092f1SBarry Smith    Level: intermediate
7419a66092f1SBarry Smith 
7420a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
7421a66092f1SBarry Smith 
7422a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
7423a66092f1SBarry Smith @*/
7424a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
7425a66092f1SBarry Smith {
7426a66092f1SBarry Smith   PetscInt          j = 0,k;
7427a66092f1SBarry Smith   PetscErrorCode    ierr;
7428a66092f1SBarry Smith 
7429a66092f1SBarry Smith   PetscFunctionBegin;
7430a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
7431a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
7432a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
7433a66092f1SBarry Smith   while (displaynames[j]) j++;
7434a66092f1SBarry Smith   ctx->ndisplayvariables = j;
7435a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
7436a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
7437a66092f1SBarry Smith   j = 0;
7438a66092f1SBarry Smith   while (displaynames[j]) {
7439a66092f1SBarry Smith     k = 0;
7440a66092f1SBarry Smith     while (ctx->names[k]) {
7441a66092f1SBarry Smith       PetscBool flg;
7442a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
7443a66092f1SBarry Smith       if (flg) {
7444a66092f1SBarry Smith         ctx->displayvariables[j] = k;
7445a66092f1SBarry Smith         break;
7446a66092f1SBarry Smith       }
7447a66092f1SBarry Smith       k++;
7448a66092f1SBarry Smith     }
7449a66092f1SBarry Smith     j++;
7450a66092f1SBarry Smith   }
7451a66092f1SBarry Smith   PetscFunctionReturn(0);
7452a66092f1SBarry Smith }
7453a66092f1SBarry Smith 
7454387f4636SBarry Smith /*@C
7455387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
7456387f4636SBarry Smith 
7457387f4636SBarry Smith    Collective on TS
7458387f4636SBarry Smith 
7459387f4636SBarry Smith    Input Parameters:
7460387f4636SBarry Smith +  ts - the TS context
7461387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
7462387f4636SBarry Smith 
74637db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
74647db568b7SBarry Smith 
7465387f4636SBarry Smith    Level: intermediate
7466387f4636SBarry Smith 
7467387f4636SBarry Smith .keywords: TS,  vector, monitor, view
7468387f4636SBarry Smith 
7469387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
7470387f4636SBarry Smith @*/
7471387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
7472387f4636SBarry Smith {
7473a66092f1SBarry Smith   PetscInt          i;
7474387f4636SBarry Smith   PetscErrorCode    ierr;
7475387f4636SBarry Smith 
7476387f4636SBarry Smith   PetscFunctionBegin;
7477387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7478387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
74795537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
7480b3d3934dSBarry Smith       break;
7481b037adc7SBarry Smith     }
7482b037adc7SBarry Smith   }
7483b037adc7SBarry Smith   PetscFunctionReturn(0);
7484b037adc7SBarry Smith }
7485b037adc7SBarry Smith 
748680666b62SBarry Smith /*@C
748780666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
748880666b62SBarry Smith 
748980666b62SBarry Smith    Collective on TS
749080666b62SBarry Smith 
749180666b62SBarry Smith    Input Parameters:
749280666b62SBarry Smith +  ts - the TS context
749380666b62SBarry Smith .  transform - the transform function
74947684fa3eSBarry Smith .  destroy - function to destroy the optional context
749580666b62SBarry Smith -  ctx - optional context used by transform function
749680666b62SBarry Smith 
74977db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
74987db568b7SBarry Smith 
749980666b62SBarry Smith    Level: intermediate
750080666b62SBarry Smith 
750180666b62SBarry Smith .keywords: TS,  vector, monitor, view
750280666b62SBarry Smith 
7503a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
750480666b62SBarry Smith @*/
75057684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
750680666b62SBarry Smith {
750780666b62SBarry Smith   PetscInt          i;
7508a66092f1SBarry Smith   PetscErrorCode    ierr;
750980666b62SBarry Smith 
751080666b62SBarry Smith   PetscFunctionBegin;
751180666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
751280666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
75135537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
751480666b62SBarry Smith     }
751580666b62SBarry Smith   }
751680666b62SBarry Smith   PetscFunctionReturn(0);
751780666b62SBarry Smith }
751880666b62SBarry Smith 
7519e673d494SBarry Smith /*@C
7520e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
7521e673d494SBarry Smith 
7522e673d494SBarry Smith    Collective on TSLGCtx
7523e673d494SBarry Smith 
7524e673d494SBarry Smith    Input Parameters:
7525e673d494SBarry Smith +  ts - the TS context
7526e673d494SBarry Smith .  transform - the transform function
75277684fa3eSBarry Smith .  destroy - function to destroy the optional context
7528e673d494SBarry Smith -  ctx - optional context used by transform function
7529e673d494SBarry Smith 
7530e673d494SBarry Smith    Level: intermediate
7531e673d494SBarry Smith 
7532e673d494SBarry Smith .keywords: TS,  vector, monitor, view
7533e673d494SBarry Smith 
7534a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
7535e673d494SBarry Smith @*/
75367684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
7537e673d494SBarry Smith {
7538e673d494SBarry Smith   PetscFunctionBegin;
7539e673d494SBarry Smith   ctx->transform    = transform;
75407684fa3eSBarry Smith   ctx->transformdestroy = destroy;
7541e673d494SBarry Smith   ctx->transformctx = tctx;
7542e673d494SBarry Smith   PetscFunctionReturn(0);
7543e673d494SBarry Smith }
7544e673d494SBarry Smith 
7545ef20d060SBarry Smith /*@C
75468b668821SLisandro Dalcin    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the error
7547ef20d060SBarry Smith        in a time based line graph
7548ef20d060SBarry Smith 
7549ef20d060SBarry Smith    Collective on TS
7550ef20d060SBarry Smith 
7551ef20d060SBarry Smith    Input Parameters:
7552ef20d060SBarry Smith +  ts - the TS context
7553ef20d060SBarry Smith .  step - current time-step
7554ef20d060SBarry Smith .  ptime - current time
75557db568b7SBarry Smith .  u - current solution
75567db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
7557ef20d060SBarry Smith 
7558ef20d060SBarry Smith    Level: intermediate
7559ef20d060SBarry Smith 
75606934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component errors in a separate window
7561abd5a294SJed Brown 
7562abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
7563abd5a294SJed Brown 
7564abd5a294SJed Brown    Options Database Keys:
75654f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
7566ef20d060SBarry Smith 
7567ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
7568ef20d060SBarry Smith 
7569abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
7570ef20d060SBarry Smith @*/
75710910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
7572ef20d060SBarry Smith {
7573ef20d060SBarry Smith   PetscErrorCode    ierr;
75740b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
7575ef20d060SBarry Smith   const PetscScalar *yy;
7576ef20d060SBarry Smith   Vec               y;
7577ef20d060SBarry Smith 
7578ef20d060SBarry Smith   PetscFunctionBegin;
7579a9f9c1f6SBarry Smith   if (!step) {
7580a9f9c1f6SBarry Smith     PetscDrawAxis axis;
75816934998bSLisandro Dalcin     PetscInt      dim;
7582a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
75838b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Error");CHKERRQ(ierr);
75840910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
7585a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7586a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7587a9f9c1f6SBarry Smith   }
75880910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
7589ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
75900910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
7591ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
7592e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
7593e3efe391SJed Brown   {
7594e3efe391SJed Brown     PetscReal *yreal;
7595e3efe391SJed Brown     PetscInt  i,n;
7596e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
7597785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
7598e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
75990b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
7600e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
7601e3efe391SJed Brown   }
7602e3efe391SJed Brown #else
76030b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
7604e3efe391SJed Brown #endif
7605ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
7606ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
7607b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
76080b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
76096934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
76103923b477SBarry Smith   }
7611ef20d060SBarry Smith   PetscFunctionReturn(0);
7612ef20d060SBarry Smith }
7613ef20d060SBarry Smith 
7614*7cf37e64SBarry Smith /*@C
7615*7cf37e64SBarry Smith    TSMonitorError - Monitors progress of the TS solvers by printing the 2 norm of the error at each timestep
7616*7cf37e64SBarry Smith 
7617*7cf37e64SBarry Smith    Collective on TS
7618*7cf37e64SBarry Smith 
7619*7cf37e64SBarry Smith    Input Parameters:
7620*7cf37e64SBarry Smith +  ts - the TS context
7621*7cf37e64SBarry Smith .  step - current time-step
7622*7cf37e64SBarry Smith .  ptime - current time
7623*7cf37e64SBarry Smith .  u - current solution
7624*7cf37e64SBarry Smith -  dctx - unused context
7625*7cf37e64SBarry Smith 
7626*7cf37e64SBarry Smith    Level: intermediate
7627*7cf37e64SBarry Smith 
7628*7cf37e64SBarry Smith    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
7629*7cf37e64SBarry Smith 
7630*7cf37e64SBarry Smith    Options Database Keys:
7631*7cf37e64SBarry Smith .  -ts_monitor_error - create a graphical monitor of error history
7632*7cf37e64SBarry Smith 
7633*7cf37e64SBarry Smith .keywords: TS,  vector, monitor, view
7634*7cf37e64SBarry Smith 
7635*7cf37e64SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
7636*7cf37e64SBarry Smith @*/
7637*7cf37e64SBarry Smith PetscErrorCode  TSMonitorError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
7638*7cf37e64SBarry Smith {
7639*7cf37e64SBarry Smith   PetscErrorCode    ierr;
7640*7cf37e64SBarry Smith   Vec               y;
7641*7cf37e64SBarry Smith   PetscReal         nrm;
7642*7cf37e64SBarry Smith 
7643*7cf37e64SBarry Smith   PetscFunctionBegin;
7644*7cf37e64SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
7645*7cf37e64SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
7646*7cf37e64SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
7647*7cf37e64SBarry Smith   ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
7648*7cf37e64SBarry Smith   ierr = PetscPrintf(PetscObjectComm((PetscObject)ts),"2-norm of error %g\n",(double)nrm);CHKERRQ(ierr);
7649*7cf37e64SBarry Smith   PetscFunctionReturn(0);
7650*7cf37e64SBarry Smith }
7651*7cf37e64SBarry Smith 
7652201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7653201da799SBarry Smith {
7654201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7655201da799SBarry Smith   PetscReal      x   = ptime,y;
7656201da799SBarry Smith   PetscErrorCode ierr;
7657201da799SBarry Smith   PetscInt       its;
7658201da799SBarry Smith 
7659201da799SBarry Smith   PetscFunctionBegin;
766063e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7661201da799SBarry Smith   if (!n) {
7662201da799SBarry Smith     PetscDrawAxis axis;
7663201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7664201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
7665201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7666201da799SBarry Smith     ctx->snes_its = 0;
7667201da799SBarry Smith   }
7668201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
7669201da799SBarry Smith   y    = its - ctx->snes_its;
7670201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
76713fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7672201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
76736934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7674201da799SBarry Smith   }
7675201da799SBarry Smith   ctx->snes_its = its;
7676201da799SBarry Smith   PetscFunctionReturn(0);
7677201da799SBarry Smith }
7678201da799SBarry Smith 
7679201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7680201da799SBarry Smith {
7681201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7682201da799SBarry Smith   PetscReal      x   = ptime,y;
7683201da799SBarry Smith   PetscErrorCode ierr;
7684201da799SBarry Smith   PetscInt       its;
7685201da799SBarry Smith 
7686201da799SBarry Smith   PetscFunctionBegin;
768763e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7688201da799SBarry Smith   if (!n) {
7689201da799SBarry Smith     PetscDrawAxis axis;
7690201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7691201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
7692201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7693201da799SBarry Smith     ctx->ksp_its = 0;
7694201da799SBarry Smith   }
7695201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
7696201da799SBarry Smith   y    = its - ctx->ksp_its;
7697201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
769899fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7699201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
77006934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7701201da799SBarry Smith   }
7702201da799SBarry Smith   ctx->ksp_its = its;
7703201da799SBarry Smith   PetscFunctionReturn(0);
7704201da799SBarry Smith }
7705f9c1d6abSBarry Smith 
7706f9c1d6abSBarry Smith /*@
7707f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
7708f9c1d6abSBarry Smith 
7709f9c1d6abSBarry Smith    Collective on TS and Vec
7710f9c1d6abSBarry Smith 
7711f9c1d6abSBarry Smith    Input Parameters:
7712f9c1d6abSBarry Smith +  ts - the TS context
7713f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
7714f9c1d6abSBarry Smith 
7715f9c1d6abSBarry Smith    Output Parameters:
7716f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
7717f9c1d6abSBarry Smith 
7718f9c1d6abSBarry Smith    Level: developer
7719f9c1d6abSBarry Smith 
7720f9c1d6abSBarry Smith .keywords: TS, compute
7721f9c1d6abSBarry Smith 
7722f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
7723f9c1d6abSBarry Smith @*/
7724f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
7725f9c1d6abSBarry Smith {
7726f9c1d6abSBarry Smith   PetscErrorCode ierr;
7727f9c1d6abSBarry Smith 
7728f9c1d6abSBarry Smith   PetscFunctionBegin;
7729f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7730ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
7731f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
7732f9c1d6abSBarry Smith   PetscFunctionReturn(0);
7733f9c1d6abSBarry Smith }
773424655328SShri 
7735b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
7736b3d3934dSBarry Smith /*@C
7737b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
7738b3d3934dSBarry Smith 
7739b3d3934dSBarry Smith    Collective on TS
7740b3d3934dSBarry Smith 
7741b3d3934dSBarry Smith    Input Parameters:
7742b3d3934dSBarry Smith .  ts  - the ODE solver object
7743b3d3934dSBarry Smith 
7744b3d3934dSBarry Smith    Output Parameter:
7745b3d3934dSBarry Smith .  ctx - the context
7746b3d3934dSBarry Smith 
7747b3d3934dSBarry Smith    Level: intermediate
7748b3d3934dSBarry Smith 
7749b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
7750b3d3934dSBarry Smith 
7751b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
7752b3d3934dSBarry Smith 
7753b3d3934dSBarry Smith @*/
7754b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
7755b3d3934dSBarry Smith {
7756b3d3934dSBarry Smith   PetscErrorCode ierr;
7757b3d3934dSBarry Smith 
7758b3d3934dSBarry Smith   PetscFunctionBegin;
7759a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
7760b3d3934dSBarry Smith   PetscFunctionReturn(0);
7761b3d3934dSBarry Smith }
7762b3d3934dSBarry Smith 
7763b3d3934dSBarry Smith /*@C
7764b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
7765b3d3934dSBarry Smith 
7766b3d3934dSBarry Smith    Collective on TS
7767b3d3934dSBarry Smith 
7768b3d3934dSBarry Smith    Input Parameters:
7769b3d3934dSBarry Smith +  ts - the TS context
7770b3d3934dSBarry Smith .  step - current time-step
7771b3d3934dSBarry Smith .  ptime - current time
77727db568b7SBarry Smith .  u  - current solution
77737db568b7SBarry Smith -  dctx - the envelope context
7774b3d3934dSBarry Smith 
7775b3d3934dSBarry Smith    Options Database:
7776b3d3934dSBarry Smith .  -ts_monitor_envelope
7777b3d3934dSBarry Smith 
7778b3d3934dSBarry Smith    Level: intermediate
7779b3d3934dSBarry Smith 
7780b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
7781b3d3934dSBarry Smith 
7782b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7783b3d3934dSBarry Smith 
77847db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
7785b3d3934dSBarry Smith @*/
77867db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7787b3d3934dSBarry Smith {
7788b3d3934dSBarry Smith   PetscErrorCode       ierr;
77897db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
7790b3d3934dSBarry Smith 
7791b3d3934dSBarry Smith   PetscFunctionBegin;
7792b3d3934dSBarry Smith   if (!ctx->max) {
7793b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
7794b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
7795b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
7796b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
7797b3d3934dSBarry Smith   } else {
7798b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
7799b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
7800b3d3934dSBarry Smith   }
7801b3d3934dSBarry Smith   PetscFunctionReturn(0);
7802b3d3934dSBarry Smith }
7803b3d3934dSBarry Smith 
7804b3d3934dSBarry Smith /*@C
7805b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
7806b3d3934dSBarry Smith 
7807b3d3934dSBarry Smith    Collective on TS
7808b3d3934dSBarry Smith 
7809b3d3934dSBarry Smith    Input Parameter:
7810b3d3934dSBarry Smith .  ts - the TS context
7811b3d3934dSBarry Smith 
7812b3d3934dSBarry Smith    Output Parameter:
7813b3d3934dSBarry Smith +  max - the maximum values
7814b3d3934dSBarry Smith -  min - the minimum values
7815b3d3934dSBarry Smith 
78167db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
78177db568b7SBarry Smith 
7818b3d3934dSBarry Smith    Level: intermediate
7819b3d3934dSBarry Smith 
7820b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7821b3d3934dSBarry Smith 
7822b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7823b3d3934dSBarry Smith @*/
7824b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
7825b3d3934dSBarry Smith {
7826b3d3934dSBarry Smith   PetscInt i;
7827b3d3934dSBarry Smith 
7828b3d3934dSBarry Smith   PetscFunctionBegin;
7829b3d3934dSBarry Smith   if (max) *max = NULL;
7830b3d3934dSBarry Smith   if (min) *min = NULL;
7831b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7832b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
78335537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7834b3d3934dSBarry Smith       if (max) *max = ctx->max;
7835b3d3934dSBarry Smith       if (min) *min = ctx->min;
7836b3d3934dSBarry Smith       break;
7837b3d3934dSBarry Smith     }
7838b3d3934dSBarry Smith   }
7839b3d3934dSBarry Smith   PetscFunctionReturn(0);
7840b3d3934dSBarry Smith }
7841b3d3934dSBarry Smith 
7842b3d3934dSBarry Smith /*@C
7843b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7844b3d3934dSBarry Smith 
7845b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7846b3d3934dSBarry Smith 
7847b3d3934dSBarry Smith    Input Parameter:
7848b3d3934dSBarry Smith .  ctx - the monitor context
7849b3d3934dSBarry Smith 
7850b3d3934dSBarry Smith    Level: intermediate
7851b3d3934dSBarry Smith 
7852b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
7853b3d3934dSBarry Smith 
78547db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7855b3d3934dSBarry Smith @*/
7856b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7857b3d3934dSBarry Smith {
7858b3d3934dSBarry Smith   PetscErrorCode ierr;
7859b3d3934dSBarry Smith 
7860b3d3934dSBarry Smith   PetscFunctionBegin;
7861b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7862b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7863b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7864b3d3934dSBarry Smith   PetscFunctionReturn(0);
7865b3d3934dSBarry Smith }
7866f2dee214SBarry Smith 
786724655328SShri /*@
7868dcb233daSLisandro Dalcin    TSRestartStep - Flags the solver to restart the next step
7869dcb233daSLisandro Dalcin 
7870dcb233daSLisandro Dalcin    Collective on TS
7871dcb233daSLisandro Dalcin 
7872dcb233daSLisandro Dalcin    Input Parameter:
7873dcb233daSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
7874dcb233daSLisandro Dalcin 
7875dcb233daSLisandro Dalcin    Level: advanced
7876dcb233daSLisandro Dalcin 
7877dcb233daSLisandro Dalcin    Notes:
7878dcb233daSLisandro Dalcin    Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of
7879dcb233daSLisandro Dalcin    discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution
7880dcb233daSLisandro Dalcin    vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For
7881dcb233daSLisandro Dalcin    the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce
7882dcb233daSLisandro Dalcin    discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with
7883dcb233daSLisandro Dalcin    discontinuous source terms).
7884dcb233daSLisandro Dalcin 
7885dcb233daSLisandro Dalcin .keywords: TS, timestep, restart
7886dcb233daSLisandro Dalcin 
7887dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep()
7888dcb233daSLisandro Dalcin @*/
7889dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts)
7890dcb233daSLisandro Dalcin {
7891dcb233daSLisandro Dalcin   PetscFunctionBegin;
7892dcb233daSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7893dcb233daSLisandro Dalcin   ts->steprestart = PETSC_TRUE;
7894dcb233daSLisandro Dalcin   PetscFunctionReturn(0);
7895dcb233daSLisandro Dalcin }
7896dcb233daSLisandro Dalcin 
7897dcb233daSLisandro Dalcin /*@
789824655328SShri    TSRollBack - Rolls back one time step
789924655328SShri 
790024655328SShri    Collective on TS
790124655328SShri 
790224655328SShri    Input Parameter:
790324655328SShri .  ts - the TS context obtained from TSCreate()
790424655328SShri 
790524655328SShri    Level: advanced
790624655328SShri 
790724655328SShri .keywords: TS, timestep, rollback
790824655328SShri 
790924655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
791024655328SShri @*/
791124655328SShri PetscErrorCode  TSRollBack(TS ts)
791224655328SShri {
791324655328SShri   PetscErrorCode ierr;
791424655328SShri 
791524655328SShri   PetscFunctionBegin;
791624655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7917b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
791824655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
791924655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
792024655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
792124655328SShri   ts->ptime = ts->ptime_prev;
7922be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
79232808aa04SLisandro Dalcin   ts->steps--;
7924b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
792524655328SShri   PetscFunctionReturn(0);
792624655328SShri }
7927aeb4809dSShri Abhyankar 
7928ff22ae23SHong Zhang /*@
7929ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7930ff22ae23SHong Zhang 
7931ff22ae23SHong Zhang    Input Parameter:
7932ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7933ff22ae23SHong Zhang 
7934ff22ae23SHong Zhang    Level: advanced
7935ff22ae23SHong Zhang 
7936ff22ae23SHong Zhang .keywords: TS, getstages
7937ff22ae23SHong Zhang 
7938ff22ae23SHong Zhang .seealso: TSCreate()
7939ff22ae23SHong Zhang @*/
7940ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7941ff22ae23SHong Zhang {
7942ff22ae23SHong Zhang   PetscErrorCode ierr;
7943ff22ae23SHong Zhang 
7944ff22ae23SHong Zhang   PetscFunctionBegin;
7945ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7946ff22ae23SHong Zhang   PetscValidPointer(ns,2);
7947ff22ae23SHong Zhang 
7948ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
7949ff22ae23SHong Zhang   else {
7950ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7951ff22ae23SHong Zhang   }
7952ff22ae23SHong Zhang   PetscFunctionReturn(0);
7953ff22ae23SHong Zhang }
7954ff22ae23SHong Zhang 
7955847ff0e1SMatthew G. Knepley /*@C
7956847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7957847ff0e1SMatthew G. Knepley 
7958847ff0e1SMatthew G. Knepley   Collective on SNES
7959847ff0e1SMatthew G. Knepley 
7960847ff0e1SMatthew G. Knepley   Input Parameters:
7961847ff0e1SMatthew G. Knepley + ts - the TS context
7962847ff0e1SMatthew G. Knepley . t - current timestep
7963847ff0e1SMatthew G. Knepley . U - state vector
7964847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7965847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7966847ff0e1SMatthew G. Knepley - ctx - an optional user context
7967847ff0e1SMatthew G. Knepley 
7968847ff0e1SMatthew G. Knepley   Output Parameters:
7969847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7970847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7971847ff0e1SMatthew G. Knepley 
7972847ff0e1SMatthew G. Knepley   Level: intermediate
7973847ff0e1SMatthew G. Knepley 
7974847ff0e1SMatthew G. Knepley   Notes:
7975847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7976847ff0e1SMatthew G. Knepley 
7977847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7978847ff0e1SMatthew G. Knepley 
7979847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7980847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7981847ff0e1SMatthew G. Knepley 
7982847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7983847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7984847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7985847ff0e1SMatthew G. Knepley 
7986847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
7987847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7988847ff0e1SMatthew G. Knepley @*/
7989847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7990847ff0e1SMatthew G. Knepley {
7991847ff0e1SMatthew G. Knepley   SNES           snes;
7992847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7993847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7994847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
7995847ff0e1SMatthew G. Knepley 
7996847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
7997c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
7998847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
7999847ff0e1SMatthew G. Knepley   if (!color) {
8000847ff0e1SMatthew G. Knepley     DM         dm;
8001847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
8002847ff0e1SMatthew G. Knepley 
8003847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
8004847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
8005847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
8006847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
8007847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
8008847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
8009847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
8010847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
8011847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
8012847ff0e1SMatthew G. Knepley     } else {
8013847ff0e1SMatthew G. Knepley       MatColoring mc;
8014847ff0e1SMatthew G. Knepley 
8015847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
8016847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
8017847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
8018847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
8019847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
8020847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
8021847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
8022847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
8023847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
8024847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
8025847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
8026847ff0e1SMatthew G. Knepley     }
8027847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
8028847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
8029847ff0e1SMatthew G. Knepley   }
8030847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
8031847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
8032847ff0e1SMatthew G. Knepley   if (J != B) {
8033847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
8034847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
8035847ff0e1SMatthew G. Knepley   }
8036847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
8037847ff0e1SMatthew G. Knepley }
803893b34091SDebojyoti Ghosh 
8039cb9d8021SPierre Barbier de Reuille /*@
8040cb9d8021SPierre Barbier de Reuille     TSSetFunctionDomainError - Set the function testing if the current state vector is valid
8041cb9d8021SPierre Barbier de Reuille 
8042cb9d8021SPierre Barbier de Reuille     Input Parameters:
8043cb9d8021SPierre Barbier de Reuille     ts - the TS context
8044cb9d8021SPierre Barbier de Reuille     func - function called within TSFunctionDomainError
8045cb9d8021SPierre Barbier de Reuille 
8046cb9d8021SPierre Barbier de Reuille     Level: intermediate
8047cb9d8021SPierre Barbier de Reuille 
8048cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain
8049cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
8050cb9d8021SPierre Barbier de Reuille @*/
8051cb9d8021SPierre Barbier de Reuille 
8052d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
8053cb9d8021SPierre Barbier de Reuille {
8054cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
8055cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
8056cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
8057cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
8058cb9d8021SPierre Barbier de Reuille }
8059cb9d8021SPierre Barbier de Reuille 
8060cb9d8021SPierre Barbier de Reuille /*@
8061cb9d8021SPierre Barbier de Reuille     TSFunctionDomainError - Check if the current state is valid
8062cb9d8021SPierre Barbier de Reuille 
8063cb9d8021SPierre Barbier de Reuille     Input Parameters:
8064cb9d8021SPierre Barbier de Reuille     ts - the TS context
8065cb9d8021SPierre Barbier de Reuille     stagetime - time of the simulation
8066d183316bSPierre Barbier de Reuille     Y - state vector to check.
8067cb9d8021SPierre Barbier de Reuille 
8068cb9d8021SPierre Barbier de Reuille     Output Parameter:
8069cb9d8021SPierre Barbier de Reuille     accept - Set to PETSC_FALSE if the current state vector is valid.
8070cb9d8021SPierre Barbier de Reuille 
8071cb9d8021SPierre Barbier de Reuille     Note:
8072cb9d8021SPierre Barbier de Reuille     This function should be used to ensure the state is in a valid part of the space.
8073cb9d8021SPierre Barbier de Reuille     For example, one can ensure here all values are positive.
807496a0c994SBarry Smith 
807596a0c994SBarry Smith     Level: advanced
8076cb9d8021SPierre Barbier de Reuille @*/
8077d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
8078cb9d8021SPierre Barbier de Reuille {
8079cb9d8021SPierre Barbier de Reuille   PetscErrorCode ierr;
8080cb9d8021SPierre Barbier de Reuille 
8081cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
8082cb9d8021SPierre Barbier de Reuille 
8083cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8084cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
8085cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
8086d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
8087cb9d8021SPierre Barbier de Reuille   }
8088cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
8089cb9d8021SPierre Barbier de Reuille }
80901ceb14c0SBarry Smith 
809193b34091SDebojyoti Ghosh /*@C
8092e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
809393b34091SDebojyoti Ghosh 
809493b34091SDebojyoti Ghosh   Collective on MPI_Comm
809593b34091SDebojyoti Ghosh 
809693b34091SDebojyoti Ghosh   Input Parameter:
809793b34091SDebojyoti Ghosh . tsin    - The input TS
809893b34091SDebojyoti Ghosh 
809993b34091SDebojyoti Ghosh   Output Parameter:
8100e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
810193b34091SDebojyoti Ghosh 
81025eca1a21SEmil Constantinescu   Notes:
81035eca1a21SEmil 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.
81045eca1a21SEmil Constantinescu 
8105baa10174SEmil 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);
81065eca1a21SEmil Constantinescu 
81075eca1a21SEmil Constantinescu   Level: developer
810893b34091SDebojyoti Ghosh 
8109e5168f73SEmil Constantinescu .keywords: TS, clone
8110e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
811193b34091SDebojyoti Ghosh @*/
8112baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
811393b34091SDebojyoti Ghosh {
811493b34091SDebojyoti Ghosh   TS             t;
811593b34091SDebojyoti Ghosh   PetscErrorCode ierr;
8116dc846ba4SSatish Balay   SNES           snes_start;
8117dc846ba4SSatish Balay   DM             dm;
8118dc846ba4SSatish Balay   TSType         type;
811993b34091SDebojyoti Ghosh 
812093b34091SDebojyoti Ghosh   PetscFunctionBegin;
812193b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
812293b34091SDebojyoti Ghosh   *tsout = NULL;
812393b34091SDebojyoti Ghosh 
81247a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
812593b34091SDebojyoti Ghosh 
812693b34091SDebojyoti Ghosh   /* General TS description */
812793b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
812893b34091SDebojyoti Ghosh   t->setupcalled       = 0;
812993b34091SDebojyoti Ghosh   t->ksp_its           = 0;
813093b34091SDebojyoti Ghosh   t->snes_its          = 0;
813193b34091SDebojyoti Ghosh   t->nwork             = 0;
813293b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
813393b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
813493b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
813593b34091SDebojyoti Ghosh 
813634561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
813734561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
8138d15a3a53SEmil Constantinescu 
813993b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
814093b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
814193b34091SDebojyoti Ghosh 
814293b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
814351699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
814493b34091SDebojyoti Ghosh 
8145e7069c78SShri   t->trajectory = tsin->trajectory;
8146e7069c78SShri   ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr);
8147e7069c78SShri 
8148e7069c78SShri   t->event = tsin->event;
81496b10a48eSSatish Balay   if (t->event) t->event->refct++;
8150e7069c78SShri 
815193b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
815293b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
8153e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
815493b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
815593b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
815693b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
815793b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
815893b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
815993b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
816093b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
816193b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
816293b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
816393b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
816493b34091SDebojyoti Ghosh 
816593b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
816693b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
816793b34091SDebojyoti Ghosh 
816893b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
816993b34091SDebojyoti Ghosh 
817093b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
817193b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
817293b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
817393b34091SDebojyoti Ghosh 
817493b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
817593b34091SDebojyoti Ghosh 
81760d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
81770d4fed19SBarry Smith     PetscInt i;
81780d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
81790d4fed19SBarry Smith     for (i=0; i<10; i++) {
81800d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
81810d4fed19SBarry Smith     }
81820d4fed19SBarry Smith   }
818393b34091SDebojyoti Ghosh   *tsout = t;
818493b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
818593b34091SDebojyoti Ghosh }
8186