xref: /petsc/src/ts/interface/ts.c (revision cdf0de3d692bb24a2cdc9616c5d5ec3bb1371201)
1 
2 #include <petsc-private/tsimpl.h>        /*I "petscts.h"  I*/
3 #include <petscdmshell.h>
4 #include <petscdmda.h>
5 #include <petscviewer.h>
6 #include <petscdraw.h>
7 
8 /* Logging support */
9 PetscClassId  TS_CLASSID, DMTS_CLASSID;
10 PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
11 
12 const char *const TSExactFinalTimeOptions[] = {"STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0};
13 
14 struct _n_TSMonitorDrawCtx {
15   PetscViewer   viewer;
16   PetscDrawAxis axis;
17   Vec           initialsolution;
18   PetscBool     showinitial;
19   PetscInt      howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
20   PetscBool     showtimestepandtime;
21   int           color;
22 };
23 
24 #undef __FUNCT__
25 #define __FUNCT__ "TSSetFromOptions"
26 /*@
27    TSSetFromOptions - Sets various TS parameters from user options.
28 
29    Collective on TS
30 
31    Input Parameter:
32 .  ts - the TS context obtained from TSCreate()
33 
34    Options Database Keys:
35 +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP
36 .  -ts_save_tracjectories - checkpoint the solution at each time-step
37 .  -ts_max_steps <maxsteps> - maximum number of time-steps to take
38 .  -ts_final_time <time> - maximum time to compute to
39 .  -ts_dt <dt> - initial time step
40 .  -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
41 .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
42 .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
43 .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
44 .  -ts_rtol <rtol> - relative tolerance for local truncation error
45 .  -ts_atol <atol> Absolute tolerance for local truncation error
46 .  -ts_monitor - print information at each timestep
47 .  -ts_monitor_lg_timestep - Monitor timestep size graphically
48 .  -ts_monitor_lg_solution - Monitor solution graphically
49 .  -ts_monitor_lg_error - Monitor error graphically
50 .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
51 .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
52 .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
53 .  -ts_monitor_draw_solution - Monitor solution graphically
54 .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
55 .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
56 .  -ts_monitor_solution_binary <filename> - Save each solution to a binary file
57 -  -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts
58 
59    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
60 
61    Level: beginner
62 
63 .keywords: TS, timestep, set, options, database
64 
65 .seealso: TSGetType()
66 @*/
67 PetscErrorCode  TSSetFromOptions(TS ts)
68 {
69   PetscBool              opt,flg,tflg;
70   PetscErrorCode         ierr;
71   PetscViewer            monviewer;
72   char                   monfilename[PETSC_MAX_PATH_LEN];
73   SNES                   snes;
74   TSAdapt                adapt;
75   PetscReal              time_step;
76   TSExactFinalTimeOption eftopt;
77   char                   dir[16];
78   const char             *defaultType;
79   char                   typeName[256];
80 
81   PetscFunctionBegin;
82   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
83   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
84   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
85   else defaultType = TSEULER;
86 
87   ierr = TSRegisterAll();CHKERRQ(ierr);
88   ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr);
89   if (opt) {
90     ierr = TSSetType(ts, typeName);CHKERRQ(ierr);
91   } else {
92     ierr = TSSetType(ts, defaultType);CHKERRQ(ierr);
93   }
94 
95   /* Handle generic TS options */
96   if (ts->trajectory) tflg = PETSC_TRUE;
97   else tflg = PETSC_FALSE;
98   ierr = PetscOptionsBool("-ts_save_trajectories","Checkpoint for adjoint sensitivity analysis","TSSetSaveTrajectories",tflg,&tflg,NULL);CHKERRQ(ierr);
99   if (tflg) {ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);}
100   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
101   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
102   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
103   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
104   if (flg) {
105     ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
106   }
107   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);
108   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
109   ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL);CHKERRQ(ierr);
110   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
111   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
112   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
113   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
114 
115 #if defined(PETSC_HAVE_SAWS)
116   {
117   PetscBool set;
118   flg  = PETSC_FALSE;
119   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
120   if (set) {
121     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
122   }
123   }
124 #endif
125 
126   /* Monitor options */
127   ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
128   if (flg) {
129     ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr);
130     ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
131   }
132   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
133   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
134 
135   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
136   if (opt) {
137     TSMonitorLGCtx ctx;
138     PetscInt       howoften = 1;
139 
140     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
141     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
142     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
143   }
144   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
145   if (opt) {
146     TSMonitorLGCtx ctx;
147     PetscInt       howoften = 1;
148 
149     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
150     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
151     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
152   }
153   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
154   if (opt) {
155     TSMonitorLGCtx ctx;
156     PetscInt       howoften = 1;
157 
158     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
159     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
160     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
161   }
162   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
163   if (opt) {
164     TSMonitorLGCtx ctx;
165     PetscInt       howoften = 1;
166 
167     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
168     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
169     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
170   }
171   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
172   if (opt) {
173     TSMonitorLGCtx ctx;
174     PetscInt       howoften = 1;
175 
176     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
177     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
178     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
179   }
180   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
181   if (opt) {
182     TSMonitorSPEigCtx ctx;
183     PetscInt          howoften = 1;
184 
185     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
186     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
187     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
188   }
189   opt  = PETSC_FALSE;
190   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
191   if (opt) {
192     TSMonitorDrawCtx ctx;
193     PetscInt         howoften = 1;
194 
195     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
196     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
197     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
198   }
199   opt  = PETSC_FALSE;
200   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
201   if (opt) {
202     TSMonitorDrawCtx ctx;
203     PetscReal        bounds[4];
204     PetscInt         n = 4;
205     PetscDraw        draw;
206 
207     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
208     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
209     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr);
210     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
211     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
212     ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr);
213     ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
214     ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
215     ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr);
216     /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */
217     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
218   }
219   opt  = PETSC_FALSE;
220   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
221   if (opt) {
222     TSMonitorDrawCtx ctx;
223     PetscInt         howoften = 1;
224 
225     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
226     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
227     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
228   }
229   opt  = PETSC_FALSE;
230   ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
231   if (flg) {
232     PetscViewer ctx;
233     if (monfilename[0]) {
234       ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr);
235       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
236     } else {
237       ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts));
238       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr);
239     }
240   }
241   opt  = PETSC_FALSE;
242   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);
243   if (flg) {
244     const char *ptr,*ptr2;
245     char       *filetemplate;
246     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
247     /* Do some cursory validation of the input. */
248     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
249     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
250     for (ptr++; ptr && *ptr; ptr++) {
251       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
252       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");
253       if (ptr2) break;
254     }
255     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
256     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
257   }
258 
259   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
260   if (flg) {
261     TSMonitorDMDARayCtx *rayctx;
262     int                  ray = 0;
263     DMDADirection        ddir;
264     DM                   da;
265     PetscMPIInt          rank;
266 
267     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
268     if (dir[0] == 'x') ddir = DMDA_X;
269     else if (dir[0] == 'y') ddir = DMDA_Y;
270     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
271     sscanf(dir+2,"%d",&ray);
272 
273     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
274     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
275     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
276     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
277     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
278     if (!rank) {
279       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
280     }
281     rayctx->lgctx = NULL;
282     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
283   }
284   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
285   if (flg) {
286     TSMonitorDMDARayCtx *rayctx;
287     int                 ray = 0;
288     DMDADirection       ddir;
289     DM                  da;
290     PetscInt            howoften = 1;
291 
292     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
293     if      (dir[0] == 'x') ddir = DMDA_X;
294     else if (dir[0] == 'y') ddir = DMDA_Y;
295     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
296     sscanf(dir+2, "%d", &ray);
297 
298     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
299     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
300     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
301     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
302     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
303     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
304   }
305 
306   /*
307      This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui
308      will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin()
309   */
310   ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
311   ierr = TSAdaptSetFromOptions(PetscOptionsObject,adapt);CHKERRQ(ierr);
312 
313     /* Handle specific TS options */
314   if (ts->ops->setfromoptions) {
315     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
316   }
317   ierr = PetscOptionsEnd();CHKERRQ(ierr);
318 
319   /* process any options handlers added with PetscObjectAddOptionsHandler() */
320   ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr);
321 
322   if (ts->trajectory) {
323     ierr = TSTrajectorySetFromOptions(ts->trajectory);CHKERRQ(ierr);
324   }
325 
326   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
327   if (snes) {
328     if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
329     ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
330   }
331   PetscFunctionReturn(0);
332 }
333 
334 #undef __FUNCT__
335 #define __FUNCT__ "TSSetSaveTrajectory"
336 /*@
337    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
338 
339    Collective on TS
340 
341    Input Parameters:
342 .  ts - the TS context obtained from TSCreate()
343 
344 
345    Level: intermediate
346 
347 .seealso: TSGetTrajectory(), TSAdjointSolve()
348 
349 .keywords: TS, set, checkpoint,
350 @*/
351 PetscErrorCode  TSSetSaveTrajectory(TS ts)
352 {
353   PetscErrorCode ierr;
354 
355   PetscFunctionBegin;
356   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
357   if (!ts->trajectory) {
358     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
359     /* should it set a default trajectory? */
360   }
361   PetscFunctionReturn(0);
362 }
363 
364 #undef __FUNCT__
365 #define __FUNCT__ "TSComputeRHSJacobian"
366 /*@
367    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
368       set with TSSetRHSJacobian().
369 
370    Collective on TS and Vec
371 
372    Input Parameters:
373 +  ts - the TS context
374 .  t - current timestep
375 -  U - input vector
376 
377    Output Parameters:
378 +  A - Jacobian matrix
379 .  B - optional preconditioning matrix
380 -  flag - flag indicating matrix structure
381 
382    Notes:
383    Most users should not need to explicitly call this routine, as it
384    is used internally within the nonlinear solvers.
385 
386    See KSPSetOperators() for important information about setting the
387    flag parameter.
388 
389    Level: developer
390 
391 .keywords: SNES, compute, Jacobian, matrix
392 
393 .seealso:  TSSetRHSJacobian(), KSPSetOperators()
394 @*/
395 PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
396 {
397   PetscErrorCode ierr;
398   PetscObjectState Ustate;
399   DM             dm;
400   DMTS           tsdm;
401   TSRHSJacobian  rhsjacobianfunc;
402   void           *ctx;
403   TSIJacobian    ijacobianfunc;
404 
405   PetscFunctionBegin;
406   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
407   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
408   PetscCheckSameComm(ts,1,U,3);
409   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
410   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
411   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
412   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
413   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
414   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) {
415     PetscFunctionReturn(0);
416   }
417 
418   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
419 
420   if (ts->rhsjacobian.reuse) {
421     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
422     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
423     if (A != B) {
424       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
425       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
426     }
427     ts->rhsjacobian.shift = 0;
428     ts->rhsjacobian.scale = 1.;
429   }
430 
431   if (rhsjacobianfunc) {
432     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
433     PetscStackPush("TS user Jacobian function");
434     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
435     PetscStackPop;
436     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
437     /* make sure user returned a correct Jacobian and preconditioner */
438     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
439     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
440   } else {
441     ierr = MatZeroEntries(A);CHKERRQ(ierr);
442     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
443   }
444   ts->rhsjacobian.time       = t;
445   ts->rhsjacobian.X          = U;
446   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
447   PetscFunctionReturn(0);
448 }
449 
450 #undef __FUNCT__
451 #define __FUNCT__ "TSComputeRHSFunction"
452 /*@
453    TSComputeRHSFunction - Evaluates the right-hand-side function.
454 
455    Collective on TS and Vec
456 
457    Input Parameters:
458 +  ts - the TS context
459 .  t - current time
460 -  U - state vector
461 
462    Output Parameter:
463 .  y - right hand side
464 
465    Note:
466    Most users should not need to explicitly call this routine, as it
467    is used internally within the nonlinear solvers.
468 
469    Level: developer
470 
471 .keywords: TS, compute
472 
473 .seealso: TSSetRHSFunction(), TSComputeIFunction()
474 @*/
475 PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
476 {
477   PetscErrorCode ierr;
478   TSRHSFunction  rhsfunction;
479   TSIFunction    ifunction;
480   void           *ctx;
481   DM             dm;
482 
483   PetscFunctionBegin;
484   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
485   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
486   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
487   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
488   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
489   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
490 
491   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
492 
493   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
494   if (rhsfunction) {
495     PetscStackPush("TS user right-hand-side function");
496     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
497     PetscStackPop;
498   } else {
499     ierr = VecZeroEntries(y);CHKERRQ(ierr);
500   }
501 
502   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
503   PetscFunctionReturn(0);
504 }
505 
506 #undef __FUNCT__
507 #define __FUNCT__ "TSComputeSolutionFunction"
508 /*@
509    TSComputeSolutionFunction - Evaluates the solution function.
510 
511    Collective on TS and Vec
512 
513    Input Parameters:
514 +  ts - the TS context
515 -  t - current time
516 
517    Output Parameter:
518 .  U - the solution
519 
520    Note:
521    Most users should not need to explicitly call this routine, as it
522    is used internally within the nonlinear solvers.
523 
524    Level: developer
525 
526 .keywords: TS, compute
527 
528 .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
529 @*/
530 PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
531 {
532   PetscErrorCode     ierr;
533   TSSolutionFunction solutionfunction;
534   void               *ctx;
535   DM                 dm;
536 
537   PetscFunctionBegin;
538   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
539   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
540   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
541   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
542 
543   if (solutionfunction) {
544     PetscStackPush("TS user solution function");
545     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
546     PetscStackPop;
547   }
548   PetscFunctionReturn(0);
549 }
550 #undef __FUNCT__
551 #define __FUNCT__ "TSComputeForcingFunction"
552 /*@
553    TSComputeForcingFunction - Evaluates the forcing function.
554 
555    Collective on TS and Vec
556 
557    Input Parameters:
558 +  ts - the TS context
559 -  t - current time
560 
561    Output Parameter:
562 .  U - the function value
563 
564    Note:
565    Most users should not need to explicitly call this routine, as it
566    is used internally within the nonlinear solvers.
567 
568    Level: developer
569 
570 .keywords: TS, compute
571 
572 .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
573 @*/
574 PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
575 {
576   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
577   void               *ctx;
578   DM                 dm;
579 
580   PetscFunctionBegin;
581   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
582   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
583   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
584   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
585 
586   if (forcing) {
587     PetscStackPush("TS user forcing function");
588     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
589     PetscStackPop;
590   }
591   PetscFunctionReturn(0);
592 }
593 
594 #undef __FUNCT__
595 #define __FUNCT__ "TSGetRHSVec_Private"
596 static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
597 {
598   Vec            F;
599   PetscErrorCode ierr;
600 
601   PetscFunctionBegin;
602   *Frhs = NULL;
603   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
604   if (!ts->Frhs) {
605     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
606   }
607   *Frhs = ts->Frhs;
608   PetscFunctionReturn(0);
609 }
610 
611 #undef __FUNCT__
612 #define __FUNCT__ "TSGetRHSMats_Private"
613 static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
614 {
615   Mat            A,B;
616   PetscErrorCode ierr;
617 
618   PetscFunctionBegin;
619   if (Arhs) *Arhs = NULL;
620   if (Brhs) *Brhs = NULL;
621   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
622   if (Arhs) {
623     if (!ts->Arhs) {
624       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
625     }
626     *Arhs = ts->Arhs;
627   }
628   if (Brhs) {
629     if (!ts->Brhs) {
630       if (A != B) {
631         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
632       } else {
633         ts->Brhs = ts->Arhs;
634         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
635       }
636     }
637     *Brhs = ts->Brhs;
638   }
639   PetscFunctionReturn(0);
640 }
641 
642 #undef __FUNCT__
643 #define __FUNCT__ "TSComputeIFunction"
644 /*@
645    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
646 
647    Collective on TS and Vec
648 
649    Input Parameters:
650 +  ts - the TS context
651 .  t - current time
652 .  U - state vector
653 .  Udot - time derivative of state vector
654 -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
655 
656    Output Parameter:
657 .  Y - right hand side
658 
659    Note:
660    Most users should not need to explicitly call this routine, as it
661    is used internally within the nonlinear solvers.
662 
663    If the user did did not write their equations in implicit form, this
664    function recasts them in implicit form.
665 
666    Level: developer
667 
668 .keywords: TS, compute
669 
670 .seealso: TSSetIFunction(), TSComputeRHSFunction()
671 @*/
672 PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
673 {
674   PetscErrorCode ierr;
675   TSIFunction    ifunction;
676   TSRHSFunction  rhsfunction;
677   void           *ctx;
678   DM             dm;
679 
680   PetscFunctionBegin;
681   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
682   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
683   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
684   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
685 
686   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
687   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
688   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
689 
690   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
691 
692   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
693   if (ifunction) {
694     PetscStackPush("TS user implicit function");
695     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
696     PetscStackPop;
697   }
698   if (imex) {
699     if (!ifunction) {
700       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
701     }
702   } else if (rhsfunction) {
703     if (ifunction) {
704       Vec Frhs;
705       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
706       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
707       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
708     } else {
709       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
710       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
711     }
712   }
713   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
714   PetscFunctionReturn(0);
715 }
716 
717 #undef __FUNCT__
718 #define __FUNCT__ "TSComputeIJacobian"
719 /*@
720    TSComputeIJacobian - Evaluates the Jacobian of the DAE
721 
722    Collective on TS and Vec
723 
724    Input
725       Input Parameters:
726 +  ts - the TS context
727 .  t - current timestep
728 .  U - state vector
729 .  Udot - time derivative of state vector
730 .  shift - shift to apply, see note below
731 -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
732 
733    Output Parameters:
734 +  A - Jacobian matrix
735 .  B - optional preconditioning matrix
736 -  flag - flag indicating matrix structure
737 
738    Notes:
739    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
740 
741    dF/dU + shift*dF/dUdot
742 
743    Most users should not need to explicitly call this routine, as it
744    is used internally within the nonlinear solvers.
745 
746    Level: developer
747 
748 .keywords: TS, compute, Jacobian, matrix
749 
750 .seealso:  TSSetIJacobian()
751 @*/
752 PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
753 {
754   PetscErrorCode ierr;
755   TSIJacobian    ijacobian;
756   TSRHSJacobian  rhsjacobian;
757   DM             dm;
758   void           *ctx;
759 
760   PetscFunctionBegin;
761   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
762   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
763   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
764   PetscValidPointer(A,6);
765   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
766   PetscValidPointer(B,7);
767   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
768 
769   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
770   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
771   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
772 
773   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
774 
775   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
776   if (ijacobian) {
777     PetscStackPush("TS user implicit Jacobian");
778     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
779     PetscStackPop;
780     /* make sure user returned a correct Jacobian and preconditioner */
781     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
782     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
783   }
784   if (imex) {
785     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
786       ierr = MatZeroEntries(A);CHKERRQ(ierr);
787       ierr = MatShift(A,shift);CHKERRQ(ierr);
788       if (A != B) {
789         ierr = MatZeroEntries(B);CHKERRQ(ierr);
790         ierr = MatShift(B,shift);CHKERRQ(ierr);
791       }
792     }
793   } else {
794     Mat Arhs = NULL,Brhs = NULL;
795     if (rhsjacobian) {
796       if (ijacobian) {
797         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
798       } else {
799         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
800       }
801       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
802     }
803     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
804       ts->rhsjacobian.scale = -1;
805       ts->rhsjacobian.shift = shift;
806       ierr = MatScale(A,-1);CHKERRQ(ierr);
807       ierr = MatShift(A,shift);CHKERRQ(ierr);
808       if (A != B) {
809         ierr = MatScale(B,-1);CHKERRQ(ierr);
810         ierr = MatShift(B,shift);CHKERRQ(ierr);
811       }
812     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
813       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
814       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
815         ierr = MatZeroEntries(A);CHKERRQ(ierr);
816         ierr = MatShift(A,shift);CHKERRQ(ierr);
817         if (A != B) {
818           ierr = MatZeroEntries(B);CHKERRQ(ierr);
819           ierr = MatShift(B,shift);CHKERRQ(ierr);
820         }
821       }
822       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
823       if (A != B) {
824         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
825       }
826     }
827   }
828   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
829   PetscFunctionReturn(0);
830 }
831 
832 #undef __FUNCT__
833 #define __FUNCT__ "TSSetRHSFunction"
834 /*@C
835     TSSetRHSFunction - Sets the routine for evaluating the function,
836     where U_t = G(t,u).
837 
838     Logically Collective on TS
839 
840     Input Parameters:
841 +   ts - the TS context obtained from TSCreate()
842 .   r - vector to put the computed right hand side (or NULL to have it created)
843 .   f - routine for evaluating the right-hand-side function
844 -   ctx - [optional] user-defined context for private data for the
845           function evaluation routine (may be NULL)
846 
847     Calling sequence of func:
848 $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
849 
850 +   t - current timestep
851 .   u - input vector
852 .   F - function vector
853 -   ctx - [optional] user-defined function context
854 
855     Level: beginner
856 
857     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
858 
859 .keywords: TS, timestep, set, right-hand-side, function
860 
861 .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
862 @*/
863 PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
864 {
865   PetscErrorCode ierr;
866   SNES           snes;
867   Vec            ralloc = NULL;
868   DM             dm;
869 
870   PetscFunctionBegin;
871   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
872   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
873 
874   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
875   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
876   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
877   if (!r && !ts->dm && ts->vec_sol) {
878     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
879     r    = ralloc;
880   }
881   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
882   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
883   PetscFunctionReturn(0);
884 }
885 
886 #undef __FUNCT__
887 #define __FUNCT__ "TSSetSolutionFunction"
888 /*@C
889     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
890 
891     Logically Collective on TS
892 
893     Input Parameters:
894 +   ts - the TS context obtained from TSCreate()
895 .   f - routine for evaluating the solution
896 -   ctx - [optional] user-defined context for private data for the
897           function evaluation routine (may be NULL)
898 
899     Calling sequence of func:
900 $     func (TS ts,PetscReal t,Vec u,void *ctx);
901 
902 +   t - current timestep
903 .   u - output vector
904 -   ctx - [optional] user-defined function context
905 
906     Notes:
907     This routine is used for testing accuracy of time integration schemes when you already know the solution.
908     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
909     create closed-form solutions with non-physical forcing terms.
910 
911     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
912 
913     Level: beginner
914 
915 .keywords: TS, timestep, set, right-hand-side, function
916 
917 .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
918 @*/
919 PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
920 {
921   PetscErrorCode ierr;
922   DM             dm;
923 
924   PetscFunctionBegin;
925   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
926   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
927   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
928   PetscFunctionReturn(0);
929 }
930 
931 #undef __FUNCT__
932 #define __FUNCT__ "TSSetForcingFunction"
933 /*@C
934     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
935 
936     Logically Collective on TS
937 
938     Input Parameters:
939 +   ts - the TS context obtained from TSCreate()
940 .   f - routine for evaluating the forcing function
941 -   ctx - [optional] user-defined context for private data for the
942           function evaluation routine (may be NULL)
943 
944     Calling sequence of func:
945 $     func (TS ts,PetscReal t,Vec u,void *ctx);
946 
947 +   t - current timestep
948 .   u - output vector
949 -   ctx - [optional] user-defined function context
950 
951     Notes:
952     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
953     create closed-form solutions with a non-physical forcing term.
954 
955     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
956 
957     Level: beginner
958 
959 .keywords: TS, timestep, set, right-hand-side, function
960 
961 .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
962 @*/
963 PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
964 {
965   PetscErrorCode ierr;
966   DM             dm;
967 
968   PetscFunctionBegin;
969   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
970   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
971   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
972   PetscFunctionReturn(0);
973 }
974 
975 #undef __FUNCT__
976 #define __FUNCT__ "TSSetRHSJacobian"
977 /*@C
978    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
979    where U_t = G(U,t), as well as the location to store the matrix.
980 
981    Logically Collective on TS
982 
983    Input Parameters:
984 +  ts  - the TS context obtained from TSCreate()
985 .  Amat - (approximate) Jacobian matrix
986 .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
987 .  f   - the Jacobian evaluation routine
988 -  ctx - [optional] user-defined context for private data for the
989          Jacobian evaluation routine (may be NULL)
990 
991    Calling sequence of f:
992 $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
993 
994 +  t - current timestep
995 .  u - input vector
996 .  Amat - (approximate) Jacobian matrix
997 .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
998 -  ctx - [optional] user-defined context for matrix evaluation routine
999 
1000 
1001    Level: beginner
1002 
1003 .keywords: TS, timestep, set, right-hand-side, Jacobian
1004 
1005 .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1006 
1007 @*/
1008 PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1009 {
1010   PetscErrorCode ierr;
1011   SNES           snes;
1012   DM             dm;
1013   TSIJacobian    ijacobian;
1014 
1015   PetscFunctionBegin;
1016   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1017   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1018   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1019   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1020   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1021 
1022   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1023   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1024   if (f == TSComputeRHSJacobianConstant) {
1025     /* Handle this case automatically for the user; otherwise user should call themselves. */
1026     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1027   }
1028   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1029   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1030   if (!ijacobian) {
1031     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1032   }
1033   if (Amat) {
1034     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
1035     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1036 
1037     ts->Arhs = Amat;
1038   }
1039   if (Pmat) {
1040     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
1041     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1042 
1043     ts->Brhs = Pmat;
1044   }
1045   PetscFunctionReturn(0);
1046 }
1047 
1048 
1049 #undef __FUNCT__
1050 #define __FUNCT__ "TSSetIFunction"
1051 /*@C
1052    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1053 
1054    Logically Collective on TS
1055 
1056    Input Parameters:
1057 +  ts  - the TS context obtained from TSCreate()
1058 .  r   - vector to hold the residual (or NULL to have it created internally)
1059 .  f   - the function evaluation routine
1060 -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1061 
1062    Calling sequence of f:
1063 $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1064 
1065 +  t   - time at step/stage being solved
1066 .  u   - state vector
1067 .  u_t - time derivative of state vector
1068 .  F   - function vector
1069 -  ctx - [optional] user-defined context for matrix evaluation routine
1070 
1071    Important:
1072    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1073 
1074    Level: beginner
1075 
1076 .keywords: TS, timestep, set, DAE, Jacobian
1077 
1078 .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1079 @*/
1080 PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1081 {
1082   PetscErrorCode ierr;
1083   SNES           snes;
1084   Vec            resalloc = NULL;
1085   DM             dm;
1086 
1087   PetscFunctionBegin;
1088   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1089   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
1090 
1091   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1092   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
1093 
1094   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1095   if (!res && !ts->dm && ts->vec_sol) {
1096     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1097     res  = resalloc;
1098   }
1099   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1100   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1101   PetscFunctionReturn(0);
1102 }
1103 
1104 #undef __FUNCT__
1105 #define __FUNCT__ "TSGetIFunction"
1106 /*@C
1107    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1108 
1109    Not Collective
1110 
1111    Input Parameter:
1112 .  ts - the TS context
1113 
1114    Output Parameter:
1115 +  r - vector to hold residual (or NULL)
1116 .  func - the function to compute residual (or NULL)
1117 -  ctx - the function context (or NULL)
1118 
1119    Level: advanced
1120 
1121 .keywords: TS, nonlinear, get, function
1122 
1123 .seealso: TSSetIFunction(), SNESGetFunction()
1124 @*/
1125 PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1126 {
1127   PetscErrorCode ierr;
1128   SNES           snes;
1129   DM             dm;
1130 
1131   PetscFunctionBegin;
1132   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1133   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1134   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1135   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1136   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1137   PetscFunctionReturn(0);
1138 }
1139 
1140 #undef __FUNCT__
1141 #define __FUNCT__ "TSGetRHSFunction"
1142 /*@C
1143    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1144 
1145    Not Collective
1146 
1147    Input Parameter:
1148 .  ts - the TS context
1149 
1150    Output Parameter:
1151 +  r - vector to hold computed right hand side (or NULL)
1152 .  func - the function to compute right hand side (or NULL)
1153 -  ctx - the function context (or NULL)
1154 
1155    Level: advanced
1156 
1157 .keywords: TS, nonlinear, get, function
1158 
1159 .seealso: TSSetRHSFunction(), SNESGetFunction()
1160 @*/
1161 PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1162 {
1163   PetscErrorCode ierr;
1164   SNES           snes;
1165   DM             dm;
1166 
1167   PetscFunctionBegin;
1168   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1169   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1170   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1171   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1172   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1173   PetscFunctionReturn(0);
1174 }
1175 
1176 #undef __FUNCT__
1177 #define __FUNCT__ "TSSetIJacobian"
1178 /*@C
1179    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1180         provided with TSSetIFunction().
1181 
1182    Logically Collective on TS
1183 
1184    Input Parameters:
1185 +  ts  - the TS context obtained from TSCreate()
1186 .  Amat - (approximate) Jacobian matrix
1187 .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1188 .  f   - the Jacobian evaluation routine
1189 -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1190 
1191    Calling sequence of f:
1192 $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1193 
1194 +  t    - time at step/stage being solved
1195 .  U    - state vector
1196 .  U_t  - time derivative of state vector
1197 .  a    - shift
1198 .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1199 .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1200 -  ctx  - [optional] user-defined context for matrix evaluation routine
1201 
1202    Notes:
1203    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1204 
1205    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1206    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1207    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1208    a and vector W depend on the integration method, step size, and past states. For example with
1209    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1210    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1211 
1212    Level: beginner
1213 
1214 .keywords: TS, timestep, DAE, Jacobian
1215 
1216 .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1217 
1218 @*/
1219 PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1220 {
1221   PetscErrorCode ierr;
1222   SNES           snes;
1223   DM             dm;
1224 
1225   PetscFunctionBegin;
1226   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1227   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1228   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1229   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1230   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1231 
1232   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1233   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
1234 
1235   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1236   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1237   PetscFunctionReturn(0);
1238 }
1239 
1240 #undef __FUNCT__
1241 #define __FUNCT__ "TSRHSJacobianSetReuse"
1242 /*@
1243    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1244    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1245    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1246    not been changed by the TS.
1247 
1248    Logically Collective
1249 
1250    Input Arguments:
1251 +  ts - TS context obtained from TSCreate()
1252 -  reuse - PETSC_TRUE if the RHS Jacobian
1253 
1254    Level: intermediate
1255 
1256 .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1257 @*/
1258 PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1259 {
1260   PetscFunctionBegin;
1261   ts->rhsjacobian.reuse = reuse;
1262   PetscFunctionReturn(0);
1263 }
1264 
1265 #undef __FUNCT__
1266 #define __FUNCT__ "TSLoad"
1267 /*@C
1268   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
1269 
1270   Collective on PetscViewer
1271 
1272   Input Parameters:
1273 + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
1274            some related function before a call to TSLoad().
1275 - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
1276 
1277    Level: intermediate
1278 
1279   Notes:
1280    The type is determined by the data in the file, any type set into the TS before this call is ignored.
1281 
1282   Notes for advanced users:
1283   Most users should not need to know the details of the binary storage
1284   format, since TSLoad() and TSView() completely hide these details.
1285   But for anyone who's interested, the standard binary matrix storage
1286   format is
1287 .vb
1288      has not yet been determined
1289 .ve
1290 
1291 .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
1292 @*/
1293 PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
1294 {
1295   PetscErrorCode ierr;
1296   PetscBool      isbinary;
1297   PetscInt       classid;
1298   char           type[256];
1299   DMTS           sdm;
1300   DM             dm;
1301 
1302   PetscFunctionBegin;
1303   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1304   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1305   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
1306   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
1307 
1308   ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
1309   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1310   ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
1311   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1312   if (ts->ops->load) {
1313     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1314   }
1315   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1316   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1317   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1318   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1319   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
1320   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
1321   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
1322   PetscFunctionReturn(0);
1323 }
1324 
1325 #include <petscdraw.h>
1326 #if defined(PETSC_HAVE_SAWS)
1327 #include <petscviewersaws.h>
1328 #endif
1329 #undef __FUNCT__
1330 #define __FUNCT__ "TSView"
1331 /*@C
1332     TSView - Prints the TS data structure.
1333 
1334     Collective on TS
1335 
1336     Input Parameters:
1337 +   ts - the TS context obtained from TSCreate()
1338 -   viewer - visualization context
1339 
1340     Options Database Key:
1341 .   -ts_view - calls TSView() at end of TSStep()
1342 
1343     Notes:
1344     The available visualization contexts include
1345 +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1346 -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1347          output where only the first processor opens
1348          the file.  All other processors send their
1349          data to the first processor to print.
1350 
1351     The user can open an alternative visualization context with
1352     PetscViewerASCIIOpen() - output to a specified file.
1353 
1354     Level: beginner
1355 
1356 .keywords: TS, timestep, view
1357 
1358 .seealso: PetscViewerASCIIOpen()
1359 @*/
1360 PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1361 {
1362   PetscErrorCode ierr;
1363   TSType         type;
1364   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
1365   DMTS           sdm;
1366 #if defined(PETSC_HAVE_SAWS)
1367   PetscBool      issaws;
1368 #endif
1369 
1370   PetscFunctionBegin;
1371   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1372   if (!viewer) {
1373     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
1374   }
1375   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1376   PetscCheckSameComm(ts,1,viewer,2);
1377 
1378   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1379   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
1380   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
1381   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1382 #if defined(PETSC_HAVE_SAWS)
1383   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1384 #endif
1385   if (iascii) {
1386     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
1387     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
1388     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1389     if (ts->problem_type == TS_NONLINEAR) {
1390       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1391       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1392     }
1393     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1394     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
1395     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
1396     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1397     if (ts->ops->view) {
1398       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1399       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1400       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1401     }
1402   } else if (isstring) {
1403     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1404     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
1405   } else if (isbinary) {
1406     PetscInt    classid = TS_FILE_CLASSID;
1407     MPI_Comm    comm;
1408     PetscMPIInt rank;
1409     char        type[256];
1410 
1411     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
1412     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
1413     if (!rank) {
1414       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
1415       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
1416       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
1417     }
1418     if (ts->ops->view) {
1419       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1420     }
1421     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1422     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
1423     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
1424     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1425   } else if (isdraw) {
1426     PetscDraw draw;
1427     char      str[36];
1428     PetscReal x,y,bottom,h;
1429 
1430     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
1431     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
1432     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
1433     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
1434     ierr   = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
1435     bottom = y - h;
1436     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
1437     if (ts->ops->view) {
1438       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1439     }
1440     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1441 #if defined(PETSC_HAVE_SAWS)
1442   } else if (issaws) {
1443     PetscMPIInt rank;
1444     const char  *name;
1445 
1446     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1447     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1448     if (!((PetscObject)ts)->amsmem && !rank) {
1449       char       dir[1024];
1450 
1451       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1452       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
1453       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
1454       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
1455       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1456     }
1457     if (ts->ops->view) {
1458       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1459     }
1460 #endif
1461   }
1462 
1463   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1464   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1465   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1466   PetscFunctionReturn(0);
1467 }
1468 
1469 
1470 #undef __FUNCT__
1471 #define __FUNCT__ "TSSetApplicationContext"
1472 /*@
1473    TSSetApplicationContext - Sets an optional user-defined context for
1474    the timesteppers.
1475 
1476    Logically Collective on TS
1477 
1478    Input Parameters:
1479 +  ts - the TS context obtained from TSCreate()
1480 -  usrP - optional user context
1481 
1482    Level: intermediate
1483 
1484 .keywords: TS, timestep, set, application, context
1485 
1486 .seealso: TSGetApplicationContext()
1487 @*/
1488 PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1489 {
1490   PetscFunctionBegin;
1491   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1492   ts->user = usrP;
1493   PetscFunctionReturn(0);
1494 }
1495 
1496 #undef __FUNCT__
1497 #define __FUNCT__ "TSGetApplicationContext"
1498 /*@
1499     TSGetApplicationContext - Gets the user-defined context for the
1500     timestepper.
1501 
1502     Not Collective
1503 
1504     Input Parameter:
1505 .   ts - the TS context obtained from TSCreate()
1506 
1507     Output Parameter:
1508 .   usrP - user context
1509 
1510     Level: intermediate
1511 
1512 .keywords: TS, timestep, get, application, context
1513 
1514 .seealso: TSSetApplicationContext()
1515 @*/
1516 PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1517 {
1518   PetscFunctionBegin;
1519   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1520   *(void**)usrP = ts->user;
1521   PetscFunctionReturn(0);
1522 }
1523 
1524 #undef __FUNCT__
1525 #define __FUNCT__ "TSGetTimeStepNumber"
1526 /*@
1527    TSGetTimeStepNumber - Gets the number of time steps completed.
1528 
1529    Not Collective
1530 
1531    Input Parameter:
1532 .  ts - the TS context obtained from TSCreate()
1533 
1534    Output Parameter:
1535 .  iter - number of steps completed so far
1536 
1537    Level: intermediate
1538 
1539 .keywords: TS, timestep, get, iteration, number
1540 .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1541 @*/
1542 PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1543 {
1544   PetscFunctionBegin;
1545   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1546   PetscValidIntPointer(iter,2);
1547   *iter = ts->steps;
1548   PetscFunctionReturn(0);
1549 }
1550 
1551 #undef __FUNCT__
1552 #define __FUNCT__ "TSSetInitialTimeStep"
1553 /*@
1554    TSSetInitialTimeStep - Sets the initial timestep to be used,
1555    as well as the initial time.
1556 
1557    Logically Collective on TS
1558 
1559    Input Parameters:
1560 +  ts - the TS context obtained from TSCreate()
1561 .  initial_time - the initial time
1562 -  time_step - the size of the timestep
1563 
1564    Level: intermediate
1565 
1566 .seealso: TSSetTimeStep(), TSGetTimeStep()
1567 
1568 .keywords: TS, set, initial, timestep
1569 @*/
1570 PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1571 {
1572   PetscErrorCode ierr;
1573 
1574   PetscFunctionBegin;
1575   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1576   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1577   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1578   PetscFunctionReturn(0);
1579 }
1580 
1581 #undef __FUNCT__
1582 #define __FUNCT__ "TSSetTimeStep"
1583 /*@
1584    TSSetTimeStep - Allows one to reset the timestep at any time,
1585    useful for simple pseudo-timestepping codes.
1586 
1587    Logically Collective on TS
1588 
1589    Input Parameters:
1590 +  ts - the TS context obtained from TSCreate()
1591 -  time_step - the size of the timestep
1592 
1593    Level: intermediate
1594 
1595 .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1596 
1597 .keywords: TS, set, timestep
1598 @*/
1599 PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1600 {
1601   PetscFunctionBegin;
1602   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1603   PetscValidLogicalCollectiveReal(ts,time_step,2);
1604   ts->time_step      = time_step;
1605   ts->time_step_orig = time_step;
1606   PetscFunctionReturn(0);
1607 }
1608 
1609 #undef __FUNCT__
1610 #define __FUNCT__ "TSSetExactFinalTime"
1611 /*@
1612    TSSetExactFinalTime - Determines whether to adapt the final time step to
1613      match the exact final time, interpolate solution to the exact final time,
1614      or just return at the final time TS computed.
1615 
1616   Logically Collective on TS
1617 
1618    Input Parameter:
1619 +   ts - the time-step context
1620 -   eftopt - exact final time option
1621 
1622    Level: beginner
1623 
1624 .seealso: TSExactFinalTimeOption
1625 @*/
1626 PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1627 {
1628   PetscFunctionBegin;
1629   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1630   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
1631   ts->exact_final_time = eftopt;
1632   PetscFunctionReturn(0);
1633 }
1634 
1635 #undef __FUNCT__
1636 #define __FUNCT__ "TSGetTimeStep"
1637 /*@
1638    TSGetTimeStep - Gets the current timestep size.
1639 
1640    Not Collective
1641 
1642    Input Parameter:
1643 .  ts - the TS context obtained from TSCreate()
1644 
1645    Output Parameter:
1646 .  dt - the current timestep size
1647 
1648    Level: intermediate
1649 
1650 .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1651 
1652 .keywords: TS, get, timestep
1653 @*/
1654 PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1655 {
1656   PetscFunctionBegin;
1657   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1658   PetscValidRealPointer(dt,2);
1659   *dt = ts->time_step;
1660   PetscFunctionReturn(0);
1661 }
1662 
1663 #undef __FUNCT__
1664 #define __FUNCT__ "TSGetSolution"
1665 /*@
1666    TSGetSolution - Returns the solution at the present timestep. It
1667    is valid to call this routine inside the function that you are evaluating
1668    in order to move to the new timestep. This vector not changed until
1669    the solution at the next timestep has been calculated.
1670 
1671    Not Collective, but Vec returned is parallel if TS is parallel
1672 
1673    Input Parameter:
1674 .  ts - the TS context obtained from TSCreate()
1675 
1676    Output Parameter:
1677 .  v - the vector containing the solution
1678 
1679    Level: intermediate
1680 
1681 .seealso: TSGetTimeStep()
1682 
1683 .keywords: TS, timestep, get, solution
1684 @*/
1685 PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1686 {
1687   PetscFunctionBegin;
1688   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1689   PetscValidPointer(v,2);
1690   *v = ts->vec_sol;
1691   PetscFunctionReturn(0);
1692 }
1693 
1694 #undef __FUNCT__
1695 #define __FUNCT__ "TSAdjointGetCostGradients"
1696 /*@
1697    TSAdjointGetCostGradients - Returns the gradients from the TSAdjointSolve()
1698 
1699    Not Collective, but Vec returned is parallel if TS is parallel
1700 
1701    Input Parameter:
1702 .  ts - the TS context obtained from TSCreate()
1703 
1704    Output Parameter:
1705 +  v - vectors containing the gradients with respect to the ODE/DAE solution variables
1706 -  w - vectors containing the gradients with respect to the problem parameters
1707 
1708    Level: intermediate
1709 
1710 .seealso: TSGetTimeStep()
1711 
1712 .keywords: TS, timestep, get, sensitivity
1713 @*/
1714 PetscErrorCode  TSAdjointGetCostGradients(TS ts,PetscInt *numberadjs,Vec **v,Vec **w)
1715 {
1716   PetscFunctionBegin;
1717   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1718   if (numberadjs) *numberadjs = ts->numberadjs;
1719   if (v)          *v          = ts->vecs_sensi;
1720   if (w)          *w          = ts->vecs_sensip;
1721   PetscFunctionReturn(0);
1722 }
1723 
1724 /* ----- Routines to initialize and destroy a timestepper ---- */
1725 #undef __FUNCT__
1726 #define __FUNCT__ "TSSetProblemType"
1727 /*@
1728   TSSetProblemType - Sets the type of problem to be solved.
1729 
1730   Not collective
1731 
1732   Input Parameters:
1733 + ts   - The TS
1734 - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1735 .vb
1736          U_t - A U = 0      (linear)
1737          U_t - A(t) U = 0   (linear)
1738          F(t,U,U_t) = 0     (nonlinear)
1739 .ve
1740 
1741    Level: beginner
1742 
1743 .keywords: TS, problem type
1744 .seealso: TSSetUp(), TSProblemType, TS
1745 @*/
1746 PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1747 {
1748   PetscErrorCode ierr;
1749 
1750   PetscFunctionBegin;
1751   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1752   ts->problem_type = type;
1753   if (type == TS_LINEAR) {
1754     SNES snes;
1755     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1756     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
1757   }
1758   PetscFunctionReturn(0);
1759 }
1760 
1761 #undef __FUNCT__
1762 #define __FUNCT__ "TSGetProblemType"
1763 /*@C
1764   TSGetProblemType - Gets the type of problem to be solved.
1765 
1766   Not collective
1767 
1768   Input Parameter:
1769 . ts   - The TS
1770 
1771   Output Parameter:
1772 . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1773 .vb
1774          M U_t = A U
1775          M(t) U_t = A(t) U
1776          F(t,U,U_t)
1777 .ve
1778 
1779    Level: beginner
1780 
1781 .keywords: TS, problem type
1782 .seealso: TSSetUp(), TSProblemType, TS
1783 @*/
1784 PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1785 {
1786   PetscFunctionBegin;
1787   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1788   PetscValidIntPointer(type,2);
1789   *type = ts->problem_type;
1790   PetscFunctionReturn(0);
1791 }
1792 
1793 #undef __FUNCT__
1794 #define __FUNCT__ "TSSetUp"
1795 /*@
1796    TSSetUp - Sets up the internal data structures for the later use
1797    of a timestepper.
1798 
1799    Collective on TS
1800 
1801    Input Parameter:
1802 .  ts - the TS context obtained from TSCreate()
1803 
1804    Notes:
1805    For basic use of the TS solvers the user need not explicitly call
1806    TSSetUp(), since these actions will automatically occur during
1807    the call to TSStep().  However, if one wishes to control this
1808    phase separately, TSSetUp() should be called after TSCreate()
1809    and optional routines of the form TSSetXXX(), but before TSStep().
1810 
1811    Level: advanced
1812 
1813 .keywords: TS, timestep, setup
1814 
1815 .seealso: TSCreate(), TSStep(), TSDestroy()
1816 @*/
1817 PetscErrorCode  TSSetUp(TS ts)
1818 {
1819   PetscErrorCode ierr;
1820   DM             dm;
1821   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1822   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
1823   TSIJacobian    ijac;
1824   TSRHSJacobian  rhsjac;
1825 
1826   PetscFunctionBegin;
1827   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1828   if (ts->setupcalled) PetscFunctionReturn(0);
1829 
1830   ts->total_steps = 0;
1831   if (!((PetscObject)ts)->type_name) {
1832     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1833   }
1834 
1835   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1836 
1837 
1838   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
1839 
1840   if (ts->rhsjacobian.reuse) {
1841     Mat Amat,Pmat;
1842     SNES snes;
1843     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1844     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
1845     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
1846      * have displaced the RHS matrix */
1847     if (Amat == ts->Arhs) {
1848       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
1849       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
1850       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
1851     }
1852     if (Pmat == ts->Brhs) {
1853       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
1854       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
1855       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
1856     }
1857   }
1858   if (ts->ops->setup) {
1859     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1860   }
1861 
1862   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
1863    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
1864    */
1865   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1866   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
1867   if (!func) {
1868     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
1869   }
1870   /* if the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it.
1871      Otherwise, the SNES will use coloring internally to form the Jacobian.
1872    */
1873   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
1874   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
1875   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
1876   if (!jac && (ijac || rhsjac)) {
1877     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1878   }
1879   ts->setupcalled = PETSC_TRUE;
1880   PetscFunctionReturn(0);
1881 }
1882 
1883 #undef __FUNCT__
1884 #define __FUNCT__ "TSAdjointSetUp"
1885 /*@
1886    TSAdjointSetUp - Sets up the internal data structures for the later use
1887    of an adjoint solver
1888 
1889    Collective on TS
1890 
1891    Input Parameter:
1892 .  ts - the TS context obtained from TSCreate()
1893 
1894    Notes:
1895    For basic use of the TS solvers the user need not explicitly call
1896    TSSetUp(), since these actions will automatically occur during
1897    the call to TSStep().  However, if one wishes to control this
1898    phase separately, TSSetUp() should be called after TSCreate()
1899    and optional routines of the form TSSetXXX(), but before TSStep().
1900 
1901    Level: advanced
1902 
1903 .keywords: TS, timestep, setup
1904 
1905 .seealso: TSCreate(), TSStep(), TSDestroy()
1906 @*/
1907 PetscErrorCode  TSAdjointSetUp(TS ts)
1908 {
1909   PetscErrorCode ierr;
1910 
1911   PetscFunctionBegin;
1912   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1913   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
1914   if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSAdjointSetCostGradients() first");
1915   if (ts->ops->adjointsetup) {
1916     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
1917   }
1918   ts->adjointsetupcalled = PETSC_TRUE;
1919   PetscFunctionReturn(0);
1920 }
1921 
1922 #undef __FUNCT__
1923 #define __FUNCT__ "TSReset"
1924 /*@
1925    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1926 
1927    Collective on TS
1928 
1929    Input Parameter:
1930 .  ts - the TS context obtained from TSCreate()
1931 
1932    Level: beginner
1933 
1934 .keywords: TS, timestep, reset
1935 
1936 .seealso: TSCreate(), TSSetup(), TSDestroy()
1937 @*/
1938 PetscErrorCode  TSReset(TS ts)
1939 {
1940   PetscErrorCode ierr;
1941 
1942   PetscFunctionBegin;
1943   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1944 
1945   if (ts->ops->reset) {
1946     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
1947   }
1948   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
1949 
1950   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1951   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1952   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
1953   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
1954   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
1955   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
1956   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
1957   ts->vecs_sensi = 0;
1958   ts->vecs_sensip = 0;
1959   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
1960   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
1961   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
1962   ts->setupcalled = PETSC_FALSE;
1963   PetscFunctionReturn(0);
1964 }
1965 
1966 #undef __FUNCT__
1967 #define __FUNCT__ "TSDestroy"
1968 /*@
1969    TSDestroy - Destroys the timestepper context that was created
1970    with TSCreate().
1971 
1972    Collective on TS
1973 
1974    Input Parameter:
1975 .  ts - the TS context obtained from TSCreate()
1976 
1977    Level: beginner
1978 
1979 .keywords: TS, timestepper, destroy
1980 
1981 .seealso: TSCreate(), TSSetUp(), TSSolve()
1982 @*/
1983 PetscErrorCode  TSDestroy(TS *ts)
1984 {
1985   PetscErrorCode ierr;
1986 
1987   PetscFunctionBegin;
1988   if (!*ts) PetscFunctionReturn(0);
1989   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
1990   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
1991 
1992   ierr = TSReset((*ts));CHKERRQ(ierr);
1993 
1994   /* if memory was published with SAWs then destroy it */
1995   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
1996   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
1997 
1998   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
1999 
2000   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
2001   if ((*ts)->event) {
2002     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
2003   }
2004   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
2005   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
2006   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
2007 
2008   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2009   PetscFunctionReturn(0);
2010 }
2011 
2012 #undef __FUNCT__
2013 #define __FUNCT__ "TSGetSNES"
2014 /*@
2015    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2016    a TS (timestepper) context. Valid only for nonlinear problems.
2017 
2018    Not Collective, but SNES is parallel if TS is parallel
2019 
2020    Input Parameter:
2021 .  ts - the TS context obtained from TSCreate()
2022 
2023    Output Parameter:
2024 .  snes - the nonlinear solver context
2025 
2026    Notes:
2027    The user can then directly manipulate the SNES context to set various
2028    options, etc.  Likewise, the user can then extract and manipulate the
2029    KSP, KSP, and PC contexts as well.
2030 
2031    TSGetSNES() does not work for integrators that do not use SNES; in
2032    this case TSGetSNES() returns NULL in snes.
2033 
2034    Level: beginner
2035 
2036 .keywords: timestep, get, SNES
2037 @*/
2038 PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2039 {
2040   PetscErrorCode ierr;
2041 
2042   PetscFunctionBegin;
2043   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2044   PetscValidPointer(snes,2);
2045   if (!ts->snes) {
2046     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
2047     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
2048     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2049     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2050     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
2051     if (ts->problem_type == TS_LINEAR) {
2052       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
2053     }
2054   }
2055   *snes = ts->snes;
2056   PetscFunctionReturn(0);
2057 }
2058 
2059 #undef __FUNCT__
2060 #define __FUNCT__ "TSSetSNES"
2061 /*@
2062    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2063 
2064    Collective
2065 
2066    Input Parameter:
2067 +  ts - the TS context obtained from TSCreate()
2068 -  snes - the nonlinear solver context
2069 
2070    Notes:
2071    Most users should have the TS created by calling TSGetSNES()
2072 
2073    Level: developer
2074 
2075 .keywords: timestep, set, SNES
2076 @*/
2077 PetscErrorCode TSSetSNES(TS ts,SNES snes)
2078 {
2079   PetscErrorCode ierr;
2080   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2081 
2082   PetscFunctionBegin;
2083   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2084   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2085   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2086   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2087 
2088   ts->snes = snes;
2089 
2090   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
2091   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2092   if (func == SNESTSFormJacobian) {
2093     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2094   }
2095   PetscFunctionReturn(0);
2096 }
2097 
2098 #undef __FUNCT__
2099 #define __FUNCT__ "TSGetKSP"
2100 /*@
2101    TSGetKSP - Returns the KSP (linear solver) associated with
2102    a TS (timestepper) context.
2103 
2104    Not Collective, but KSP is parallel if TS is parallel
2105 
2106    Input Parameter:
2107 .  ts - the TS context obtained from TSCreate()
2108 
2109    Output Parameter:
2110 .  ksp - the nonlinear solver context
2111 
2112    Notes:
2113    The user can then directly manipulate the KSP context to set various
2114    options, etc.  Likewise, the user can then extract and manipulate the
2115    KSP and PC contexts as well.
2116 
2117    TSGetKSP() does not work for integrators that do not use KSP;
2118    in this case TSGetKSP() returns NULL in ksp.
2119 
2120    Level: beginner
2121 
2122 .keywords: timestep, get, KSP
2123 @*/
2124 PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2125 {
2126   PetscErrorCode ierr;
2127   SNES           snes;
2128 
2129   PetscFunctionBegin;
2130   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2131   PetscValidPointer(ksp,2);
2132   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2133   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2134   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2135   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2136   PetscFunctionReturn(0);
2137 }
2138 
2139 /* ----------- Routines to set solver parameters ---------- */
2140 
2141 #undef __FUNCT__
2142 #define __FUNCT__ "TSGetDuration"
2143 /*@
2144    TSGetDuration - Gets the maximum number of timesteps to use and
2145    maximum time for iteration.
2146 
2147    Not Collective
2148 
2149    Input Parameters:
2150 +  ts       - the TS context obtained from TSCreate()
2151 .  maxsteps - maximum number of iterations to use, or NULL
2152 -  maxtime  - final time to iterate to, or NULL
2153 
2154    Level: intermediate
2155 
2156 .keywords: TS, timestep, get, maximum, iterations, time
2157 @*/
2158 PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2159 {
2160   PetscFunctionBegin;
2161   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2162   if (maxsteps) {
2163     PetscValidIntPointer(maxsteps,2);
2164     *maxsteps = ts->max_steps;
2165   }
2166   if (maxtime) {
2167     PetscValidScalarPointer(maxtime,3);
2168     *maxtime = ts->max_time;
2169   }
2170   PetscFunctionReturn(0);
2171 }
2172 
2173 #undef __FUNCT__
2174 #define __FUNCT__ "TSSetDuration"
2175 /*@
2176    TSSetDuration - Sets the maximum number of timesteps to use and
2177    maximum time for iteration.
2178 
2179    Logically Collective on TS
2180 
2181    Input Parameters:
2182 +  ts - the TS context obtained from TSCreate()
2183 .  maxsteps - maximum number of iterations to use
2184 -  maxtime - final time to iterate to
2185 
2186    Options Database Keys:
2187 .  -ts_max_steps <maxsteps> - Sets maxsteps
2188 .  -ts_final_time <maxtime> - Sets maxtime
2189 
2190    Notes:
2191    The default maximum number of iterations is 5000. Default time is 5.0
2192 
2193    Level: intermediate
2194 
2195 .keywords: TS, timestep, set, maximum, iterations
2196 
2197 .seealso: TSSetExactFinalTime()
2198 @*/
2199 PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2200 {
2201   PetscFunctionBegin;
2202   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2203   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2204   PetscValidLogicalCollectiveReal(ts,maxtime,2);
2205   if (maxsteps >= 0) ts->max_steps = maxsteps;
2206   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2207   PetscFunctionReturn(0);
2208 }
2209 
2210 #undef __FUNCT__
2211 #define __FUNCT__ "TSSetSolution"
2212 /*@
2213    TSSetSolution - Sets the initial solution vector
2214    for use by the TS routines.
2215 
2216    Logically Collective on TS and Vec
2217 
2218    Input Parameters:
2219 +  ts - the TS context obtained from TSCreate()
2220 -  u - the solution vector
2221 
2222    Level: beginner
2223 
2224 .keywords: TS, timestep, set, solution, initial conditions
2225 @*/
2226 PetscErrorCode  TSSetSolution(TS ts,Vec u)
2227 {
2228   PetscErrorCode ierr;
2229   DM             dm;
2230 
2231   PetscFunctionBegin;
2232   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2233   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
2234   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
2235   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2236 
2237   ts->vec_sol = u;
2238 
2239   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
2240   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2241   PetscFunctionReturn(0);
2242 }
2243 
2244 #undef __FUNCT__
2245 #define __FUNCT__ "TSAdjointSetSteps"
2246 /*@
2247    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
2248 
2249    Logically Collective on TS
2250 
2251    Input Parameters:
2252 +  ts - the TS context obtained from TSCreate()
2253 .  steps - number of steps to use
2254 
2255    Level: intermediate
2256 
2257    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
2258           so as to integrate back to less than the original timestep
2259 
2260 .keywords: TS, timestep, set, maximum, iterations
2261 
2262 .seealso: TSSetExactFinalTime()
2263 @*/
2264 PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
2265 {
2266   PetscFunctionBegin;
2267   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2268   PetscValidLogicalCollectiveInt(ts,steps,2);
2269   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
2270   if (steps > ts->total_steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps");
2271   ts->adjoint_max_steps = steps;
2272   PetscFunctionReturn(0);
2273 }
2274 
2275 #undef __FUNCT__
2276 #define __FUNCT__ "TSAdjointSetCostGradients"
2277 /*@
2278    TSAdjointSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial conditions and w.r.t. the problem parameters
2279       for use by the TSAdjoint routines.
2280 
2281    Logically Collective on TS and Vec
2282 
2283    Input Parameters:
2284 +  ts - the TS context obtained from TSCreate()
2285 .  u - gradients with respect to the initial condition variables, the dimension and parallel layout of these vectors is the same as the ODE solution vector
2286 -  w - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2287 
2288    Level: beginner
2289 
2290    Notes: the entries in these vectors must be correctly initialized with the values ????
2291 
2292 .keywords: TS, timestep, set, sensitivity, initial conditions
2293 @*/
2294 PetscErrorCode  TSAdjointSetCostGradients(TS ts,PetscInt numberadjs,Vec *u,Vec *w)
2295 {
2296   PetscFunctionBegin;
2297   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2298   PetscValidPointer(u,2);
2299   ts->vecs_sensi  = u;
2300   ts->vecs_sensip = w;
2301   ts->numberadjs  = numberadjs;
2302   PetscFunctionReturn(0);
2303 }
2304 
2305 #undef __FUNCT__
2306 #define __FUNCT__ "TSAdjointSetRHSJacobian"
2307 /*@C
2308   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.
2309 
2310   Logically Collective on TS
2311 
2312   Input Parameters:
2313 + ts   - The TS context obtained from TSCreate()
2314 - func - The function
2315 
2316   Calling sequence of func:
2317 $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
2318 +   t - current timestep
2319 .   y - input vector (current ODE solution)
2320 .   A - output matrix
2321 -   ctx - [optional] user-defined function context
2322 
2323   Level: intermediate
2324 
2325   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
2326 
2327 .keywords: TS, sensitivity
2328 .seealso:
2329 @*/
2330 PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2331 {
2332   PetscErrorCode ierr;
2333 
2334   PetscFunctionBegin;
2335   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2336   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2337 
2338   ts->rhsjacobianp    = func;
2339   ts->rhsjacobianpctx = ctx;
2340   if(Amat) {
2341     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2342     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2343     ts->Jacp = Amat;
2344   }
2345   PetscFunctionReturn(0);
2346 }
2347 
2348 #undef __FUNCT__
2349 #define __FUNCT__ "TSAdjointComputeRHSJacobian"
2350 /*@C
2351   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2352 
2353   Collective on TS
2354 
2355   Input Parameters:
2356 . ts   - The TS context obtained from TSCreate()
2357 
2358   Level: developer
2359 
2360 .keywords: TS, sensitivity
2361 .seealso: TSAdjointSetRHSJacobian()
2362 @*/
2363 PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2364 {
2365   PetscErrorCode ierr;
2366 
2367   PetscFunctionBegin;
2368   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2369   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2370   PetscValidPointer(Amat,4);
2371 
2372   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2373   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2374   PetscStackPop;
2375   PetscFunctionReturn(0);
2376 }
2377 
2378 #undef __FUNCT__
2379 #define __FUNCT__ "TSAdjointSetCostIntegrand"
2380 /*@C
2381     TSAdjointSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
2382 
2383     Logically Collective on TS
2384 
2385     Input Parameters:
2386 +   ts - the TS context obtained from TSCreate()
2387 .   numberadjs - number of gradients to be computed, this is the number of cost functions
2388 .   rf - routine for evaluating the integrand function
2389 .   drdy - array of vectors to contain the gradients of the r's with respect to y, NULL if not a function of y, each vector has the same size and parallel layout as the vector y
2390 .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2391 .   drdp - array of vectors to contain the gradients of the r's with respect to p, NULL if not a function of p, each vector has the same size as p.
2392 .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
2393 -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
2394 
2395     Calling sequence of rf:
2396 $     rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
2397 
2398 +   t - current timestep
2399 .   y - input vector
2400 .   f - function result; one vector entry for each cost function
2401 -   ctx - [optional] user-defined function context
2402 
2403    Calling sequence of drdyf:
2404 $    PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
2405 
2406    Calling sequence of drdpf:
2407 $    PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
2408 
2409     Level: intermediate
2410 
2411     Notes: For optimization there is generally a single cost function, numberadjs = 1. For sensitivities there may be multiple cost functions
2412 
2413 .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
2414 
2415 .seealso: TSAdjointSetRHSJacobian(),TSAdjointGetCostGradients(), TSAdjointSetCostGradients()
2416 @*/
2417 PetscErrorCode  TSAdjointSetCostIntegrand(TS ts,PetscInt numberadjs,          PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
2418                                                                     Vec *drdy,PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
2419                                                                     Vec *drdp,PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),void *ctx)
2420 {
2421   PetscErrorCode ierr;
2422 
2423   PetscFunctionBegin;
2424   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2425   if (!ts->numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Call TSAdjointSetCostGradients() first so that the number of cost functions can be determined.");
2426   if (ts->numberadjs && ts->numberadjs!=numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSAdjointSetCostIntegrand()) is inconsistent with the one set by TSAdjointSetCostGradients()");
2427 
2428   ierr                  = VecCreateSeq(PETSC_COMM_SELF,numberadjs,&ts->vec_costintegral);CHKERRQ(ierr);
2429   ierr                  = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
2430   ts->costintegrand     = rf;
2431   ts->costintegrandctx  = ctx;
2432 
2433   ts->drdyfunction    = drdyf;
2434   ts->vecs_drdy       = drdy;
2435 
2436   ts->drdpfunction    = drdpf;
2437   ts->vecs_drdp       = drdp;
2438 
2439   PetscFunctionReturn(0);
2440 }
2441 
2442 #undef __FUNCT__
2443 #define __FUNCT__ "TSAdjointGetCostIntegral"
2444 /*@
2445    TSAdjointGetCostIntegral - Returns the values of the integral term in the cost functions.
2446    It is valid to call the routine after a backward run.
2447 
2448    Not Collective
2449 
2450    Input Parameter:
2451 .  ts - the TS context obtained from TSCreate()
2452 
2453    Output Parameter:
2454 .  v - the vector containing the integrals for each cost function
2455 
2456    Level: intermediate
2457 
2458 .seealso: TSAdjointSetCostIntegrand()
2459 
2460 .keywords: TS, sensitivity analysis
2461 @*/
2462 PetscErrorCode  TSAdjointGetCostIntegral(TS ts,Vec *v)
2463 {
2464   PetscFunctionBegin;
2465   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2466   PetscValidPointer(v,2);
2467   *v = ts->vec_costintegral;
2468   PetscFunctionReturn(0);
2469 }
2470 
2471 #undef __FUNCT__
2472 #define __FUNCT__ "TSAdjointComputeCostIntegrand"
2473 /*@
2474    TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
2475 
2476    Input Parameters:
2477 +  ts - the TS context
2478 .  t - current time
2479 -  y - state vector, i.e. current solution
2480 
2481    Output Parameter:
2482 .  q - vector of size numberadjs to hold the outputs
2483 
2484    Note:
2485    Most users should not need to explicitly call this routine, as it
2486    is used internally within the sensitivity analysis context.
2487 
2488    Level: developer
2489 
2490 .keywords: TS, compute
2491 
2492 .seealso: TSAdjointSetCostIntegrand()
2493 @*/
2494 PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
2495 {
2496   PetscErrorCode ierr;
2497 
2498   PetscFunctionBegin;
2499   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2500   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
2501   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
2502 
2503   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
2504   if (ts->costintegrand) {
2505     PetscStackPush("TS user integrand in the cost function");
2506     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
2507     PetscStackPop;
2508   } else {
2509     ierr = VecZeroEntries(q);CHKERRQ(ierr);
2510   }
2511 
2512   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
2513   PetscFunctionReturn(0);
2514 }
2515 
2516 #undef __FUNCT__
2517 #define __FUNCT__ "TSAdjointComputeDRDYFunction"
2518 /*@
2519   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
2520 
2521   Collective on TS
2522 
2523   Input Parameters:
2524 . ts   - The TS context obtained from TSCreate()
2525 
2526   Notes:
2527   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
2528   so most users would not generally call this routine themselves.
2529 
2530   Level: developer
2531 
2532 .keywords: TS, sensitivity
2533 .seealso: TSAdjointComputeDRDYFunction()
2534 @*/
2535 PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
2536 {
2537   PetscErrorCode ierr;
2538 
2539   PetscFunctionBegin;
2540   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2541   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
2542 
2543   PetscStackPush("TS user DRDY function for sensitivity analysis");
2544   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
2545   PetscStackPop;
2546   PetscFunctionReturn(0);
2547 }
2548 
2549 #undef __FUNCT__
2550 #define __FUNCT__ "TSAdjointComputeDRDPFunction"
2551 /*@
2552   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
2553 
2554   Collective on TS
2555 
2556   Input Parameters:
2557 . ts   - The TS context obtained from TSCreate()
2558 
2559   Notes:
2560   TSDRDPFunction() is typically used for sensitivity implementation,
2561   so most users would not generally call this routine themselves.
2562 
2563   Level: developer
2564 
2565 .keywords: TS, sensitivity
2566 .seealso: TSAdjointSetDRDPFunction()
2567 @*/
2568 PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
2569 {
2570   PetscErrorCode ierr;
2571 
2572   PetscFunctionBegin;
2573   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2574   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
2575 
2576   PetscStackPush("TS user DRDP function for sensitivity analysis");
2577   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
2578   PetscStackPop;
2579   PetscFunctionReturn(0);
2580 }
2581 
2582 #undef __FUNCT__
2583 #define __FUNCT__ "TSSetPreStep"
2584 /*@C
2585   TSSetPreStep - Sets the general-purpose function
2586   called once at the beginning of each time step.
2587 
2588   Logically Collective on TS
2589 
2590   Input Parameters:
2591 + ts   - The TS context obtained from TSCreate()
2592 - func - The function
2593 
2594   Calling sequence of func:
2595 . func (TS ts);
2596 
2597   Level: intermediate
2598 
2599   Note:
2600   If a step is rejected, TSStep() will call this routine again before each attempt.
2601   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2602   size of the step being attempted can be obtained using TSGetTimeStep().
2603 
2604 .keywords: TS, timestep
2605 .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2606 @*/
2607 PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2608 {
2609   PetscFunctionBegin;
2610   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2611   ts->prestep = func;
2612   PetscFunctionReturn(0);
2613 }
2614 
2615 #undef __FUNCT__
2616 #define __FUNCT__ "TSPreStep"
2617 /*@
2618   TSPreStep - Runs the user-defined pre-step function.
2619 
2620   Collective on TS
2621 
2622   Input Parameters:
2623 . ts   - The TS context obtained from TSCreate()
2624 
2625   Notes:
2626   TSPreStep() is typically used within time stepping implementations,
2627   so most users would not generally call this routine themselves.
2628 
2629   Level: developer
2630 
2631 .keywords: TS, timestep
2632 .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
2633 @*/
2634 PetscErrorCode  TSPreStep(TS ts)
2635 {
2636   PetscErrorCode ierr;
2637 
2638   PetscFunctionBegin;
2639   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2640   if (ts->prestep) {
2641     PetscStackCallStandard((*ts->prestep),(ts));
2642   }
2643   PetscFunctionReturn(0);
2644 }
2645 
2646 #undef __FUNCT__
2647 #define __FUNCT__ "TSSetPreStage"
2648 /*@C
2649   TSSetPreStage - Sets the general-purpose function
2650   called once at the beginning of each stage.
2651 
2652   Logically Collective on TS
2653 
2654   Input Parameters:
2655 + ts   - The TS context obtained from TSCreate()
2656 - func - The function
2657 
2658   Calling sequence of func:
2659 . PetscErrorCode func(TS ts, PetscReal stagetime);
2660 
2661   Level: intermediate
2662 
2663   Note:
2664   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2665   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2666   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2667 
2668 .keywords: TS, timestep
2669 .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2670 @*/
2671 PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2672 {
2673   PetscFunctionBegin;
2674   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2675   ts->prestage = func;
2676   PetscFunctionReturn(0);
2677 }
2678 
2679 #undef __FUNCT__
2680 #define __FUNCT__ "TSSetPostStage"
2681 /*@C
2682   TSSetPostStage - Sets the general-purpose function
2683   called once at the end of each stage.
2684 
2685   Logically Collective on TS
2686 
2687   Input Parameters:
2688 + ts   - The TS context obtained from TSCreate()
2689 - func - The function
2690 
2691   Calling sequence of func:
2692 . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
2693 
2694   Level: intermediate
2695 
2696   Note:
2697   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2698   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2699   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2700 
2701 .keywords: TS, timestep
2702 .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2703 @*/
2704 PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
2705 {
2706   PetscFunctionBegin;
2707   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2708   ts->poststage = func;
2709   PetscFunctionReturn(0);
2710 }
2711 
2712 #undef __FUNCT__
2713 #define __FUNCT__ "TSPreStage"
2714 /*@
2715   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2716 
2717   Collective on TS
2718 
2719   Input Parameters:
2720 . ts          - The TS context obtained from TSCreate()
2721   stagetime   - The absolute time of the current stage
2722 
2723   Notes:
2724   TSPreStage() is typically used within time stepping implementations,
2725   most users would not generally call this routine themselves.
2726 
2727   Level: developer
2728 
2729 .keywords: TS, timestep
2730 .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2731 @*/
2732 PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2733 {
2734   PetscErrorCode ierr;
2735 
2736   PetscFunctionBegin;
2737   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2738   if (ts->prestage) {
2739     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2740   }
2741   PetscFunctionReturn(0);
2742 }
2743 
2744 #undef __FUNCT__
2745 #define __FUNCT__ "TSPostStage"
2746 /*@
2747   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
2748 
2749   Collective on TS
2750 
2751   Input Parameters:
2752 . ts          - The TS context obtained from TSCreate()
2753   stagetime   - The absolute time of the current stage
2754   stageindex  - Stage number
2755   Y           - Array of vectors (of size = total number
2756                 of stages) with the stage solutions
2757 
2758   Notes:
2759   TSPostStage() is typically used within time stepping implementations,
2760   most users would not generally call this routine themselves.
2761 
2762   Level: developer
2763 
2764 .keywords: TS, timestep
2765 .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2766 @*/
2767 PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
2768 {
2769   PetscErrorCode ierr;
2770 
2771   PetscFunctionBegin;
2772   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2773   if (ts->poststage) {
2774     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
2775   }
2776   PetscFunctionReturn(0);
2777 }
2778 
2779 #undef __FUNCT__
2780 #define __FUNCT__ "TSSetPostStep"
2781 /*@C
2782   TSSetPostStep - Sets the general-purpose function
2783   called once at the end of each time step.
2784 
2785   Logically Collective on TS
2786 
2787   Input Parameters:
2788 + ts   - The TS context obtained from TSCreate()
2789 - func - The function
2790 
2791   Calling sequence of func:
2792 $ func (TS ts);
2793 
2794   Level: intermediate
2795 
2796 .keywords: TS, timestep
2797 .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2798 @*/
2799 PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2800 {
2801   PetscFunctionBegin;
2802   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2803   ts->poststep = func;
2804   PetscFunctionReturn(0);
2805 }
2806 
2807 #undef __FUNCT__
2808 #define __FUNCT__ "TSPostStep"
2809 /*@
2810   TSPostStep - Runs the user-defined post-step function.
2811 
2812   Collective on TS
2813 
2814   Input Parameters:
2815 . ts   - The TS context obtained from TSCreate()
2816 
2817   Notes:
2818   TSPostStep() is typically used within time stepping implementations,
2819   so most users would not generally call this routine themselves.
2820 
2821   Level: developer
2822 
2823 .keywords: TS, timestep
2824 @*/
2825 PetscErrorCode  TSPostStep(TS ts)
2826 {
2827   PetscErrorCode ierr;
2828 
2829   PetscFunctionBegin;
2830   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2831   if (ts->poststep) {
2832     PetscStackCallStandard((*ts->poststep),(ts));
2833   }
2834   PetscFunctionReturn(0);
2835 }
2836 
2837 /* ------------ Routines to set performance monitoring options ----------- */
2838 
2839 #undef __FUNCT__
2840 #define __FUNCT__ "TSMonitorSet"
2841 /*@C
2842    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2843    timestep to display the iteration's  progress.
2844 
2845    Logically Collective on TS
2846 
2847    Input Parameters:
2848 +  ts - the TS context obtained from TSCreate()
2849 .  monitor - monitoring routine
2850 .  mctx - [optional] user-defined context for private data for the
2851              monitor routine (use NULL if no context is desired)
2852 -  monitordestroy - [optional] routine that frees monitor context
2853           (may be NULL)
2854 
2855    Calling sequence of monitor:
2856 $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2857 
2858 +    ts - the TS context
2859 .    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
2860                                been interpolated to)
2861 .    time - current time
2862 .    u - current iterate
2863 -    mctx - [optional] monitoring context
2864 
2865    Notes:
2866    This routine adds an additional monitor to the list of monitors that
2867    already has been loaded.
2868 
2869    Fortran notes: Only a single monitor function can be set for each TS object
2870 
2871    Level: intermediate
2872 
2873 .keywords: TS, timestep, set, monitor
2874 
2875 .seealso: TSMonitorDefault(), TSMonitorCancel()
2876 @*/
2877 PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2878 {
2879   PetscFunctionBegin;
2880   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2881   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2882   ts->monitor[ts->numbermonitors]          = monitor;
2883   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
2884   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
2885   PetscFunctionReturn(0);
2886 }
2887 
2888 #undef __FUNCT__
2889 #define __FUNCT__ "TSMonitorCancel"
2890 /*@C
2891    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2892 
2893    Logically Collective on TS
2894 
2895    Input Parameters:
2896 .  ts - the TS context obtained from TSCreate()
2897 
2898    Notes:
2899    There is no way to remove a single, specific monitor.
2900 
2901    Level: intermediate
2902 
2903 .keywords: TS, timestep, set, monitor
2904 
2905 .seealso: TSMonitorDefault(), TSMonitorSet()
2906 @*/
2907 PetscErrorCode  TSMonitorCancel(TS ts)
2908 {
2909   PetscErrorCode ierr;
2910   PetscInt       i;
2911 
2912   PetscFunctionBegin;
2913   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2914   for (i=0; i<ts->numbermonitors; i++) {
2915     if (ts->monitordestroy[i]) {
2916       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2917     }
2918   }
2919   ts->numbermonitors = 0;
2920   PetscFunctionReturn(0);
2921 }
2922 
2923 #undef __FUNCT__
2924 #define __FUNCT__ "TSMonitorDefault"
2925 /*@
2926    TSMonitorDefault - Sets the Default monitor
2927 
2928    Level: intermediate
2929 
2930 .keywords: TS, set, monitor
2931 
2932 .seealso: TSMonitorDefault(), TSMonitorSet()
2933 @*/
2934 PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
2935 {
2936   PetscErrorCode ierr;
2937   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts));
2938 
2939   PetscFunctionBegin;
2940   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2941   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g %s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? "(r)\n" : "\n");CHKERRQ(ierr);
2942   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2943   PetscFunctionReturn(0);
2944 }
2945 
2946 #undef __FUNCT__
2947 #define __FUNCT__ "TSSetRetainStages"
2948 /*@
2949    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
2950 
2951    Logically Collective on TS
2952 
2953    Input Argument:
2954 .  ts - time stepping context
2955 
2956    Output Argument:
2957 .  flg - PETSC_TRUE or PETSC_FALSE
2958 
2959    Level: intermediate
2960 
2961 .keywords: TS, set
2962 
2963 .seealso: TSInterpolate(), TSSetPostStep()
2964 @*/
2965 PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
2966 {
2967   PetscFunctionBegin;
2968   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2969   ts->retain_stages = flg;
2970   PetscFunctionReturn(0);
2971 }
2972 
2973 #undef __FUNCT__
2974 #define __FUNCT__ "TSInterpolate"
2975 /*@
2976    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
2977 
2978    Collective on TS
2979 
2980    Input Argument:
2981 +  ts - time stepping context
2982 -  t - time to interpolate to
2983 
2984    Output Argument:
2985 .  U - state at given time
2986 
2987    Notes:
2988    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
2989 
2990    Level: intermediate
2991 
2992    Developer Notes:
2993    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
2994 
2995 .keywords: TS, set
2996 
2997 .seealso: TSSetRetainStages(), TSSetPostStep()
2998 @*/
2999 PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3000 {
3001   PetscErrorCode ierr;
3002 
3003   PetscFunctionBegin;
3004   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3005   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3006   if (t < ts->ptime - ts->time_step_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-ts->time_step_prev),(double)ts->ptime);
3007   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
3008   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3009   PetscFunctionReturn(0);
3010 }
3011 
3012 #undef __FUNCT__
3013 #define __FUNCT__ "TSStep"
3014 /*@
3015    TSStep - Steps one time step
3016 
3017    Collective on TS
3018 
3019    Input Parameter:
3020 .  ts - the TS context obtained from TSCreate()
3021 
3022    Level: developer
3023 
3024    Notes:
3025    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
3026 
3027    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3028    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3029 
3030    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
3031    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
3032 
3033 .keywords: TS, timestep, solve
3034 
3035 .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3036 @*/
3037 PetscErrorCode  TSStep(TS ts)
3038 {
3039   DM               dm;
3040   PetscErrorCode   ierr;
3041   static PetscBool cite = PETSC_FALSE;
3042 
3043   PetscFunctionBegin;
3044   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3045   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3046                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3047                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3048                                 "  type        = {Preprint},\n"
3049                                 "  number      = {ANL/MCS-P5061-0114},\n"
3050                                 "  institution = {Argonne National Laboratory},\n"
3051                                 "  year        = {2014}\n}\n",&cite);
3052 
3053   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3054   ierr = TSSetUp(ts);CHKERRQ(ierr);
3055 
3056   ts->reason = TS_CONVERGED_ITERATING;
3057   ts->ptime_prev = ts->ptime;
3058   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3059 
3060   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3061   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3062   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3063   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3064 
3065   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3066   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3067 
3068   if (ts->reason < 0) {
3069     if (ts->errorifstepfailed) {
3070       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]);
3071       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3072     }
3073   } else if (!ts->reason) {
3074     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3075     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3076   }
3077   ts->total_steps++;
3078   ts->steprollback = PETSC_FALSE;
3079   PetscFunctionReturn(0);
3080 }
3081 
3082 #undef __FUNCT__
3083 #define __FUNCT__ "TSAdjointStep"
3084 /*@
3085    TSAdjointStep - Steps one time step
3086 
3087    Collective on TS
3088 
3089    Input Parameter:
3090 .  ts - the TS context obtained from TSCreate()
3091 
3092    Level: intermediate
3093 
3094    Notes:
3095    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3096    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3097 
3098    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
3099    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
3100 
3101 .keywords: TS, timestep, solve
3102 
3103 .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3104 @*/
3105 PetscErrorCode  TSAdjointStep(TS ts)
3106 {
3107   DM               dm;
3108   PetscErrorCode   ierr;
3109 
3110   PetscFunctionBegin;
3111   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3112   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3113   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3114 
3115   ts->reason = TS_CONVERGED_ITERATING;
3116   ts->ptime_prev = ts->ptime;
3117   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3118   ierr = VecViewFromOptions(ts->vec_sol, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3119 
3120   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3121   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);
3122   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
3123   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3124 
3125   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3126   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3127 
3128   if (ts->reason < 0) {
3129     if (ts->errorifstepfailed) {
3130       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) {
3131         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]);
3132       } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) {
3133         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]);
3134       } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3135     }
3136   } else if (!ts->reason) {
3137     if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3138     else if (ts->ptime >= ts->max_time)         ts->reason = TS_CONVERGED_TIME;
3139   }
3140   ts->total_steps--;
3141   PetscFunctionReturn(0);
3142 }
3143 
3144 #undef __FUNCT__
3145 #define __FUNCT__ "TSEvaluateStep"
3146 /*@
3147    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
3148 
3149    Collective on TS
3150 
3151    Input Arguments:
3152 +  ts - time stepping context
3153 .  order - desired order of accuracy
3154 -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
3155 
3156    Output Arguments:
3157 .  U - state at the end of the current step
3158 
3159    Level: advanced
3160 
3161    Notes:
3162    This function cannot be called until all stages have been evaluated.
3163    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.
3164 
3165 .seealso: TSStep(), TSAdapt
3166 @*/
3167 PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
3168 {
3169   PetscErrorCode ierr;
3170 
3171   PetscFunctionBegin;
3172   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3173   PetscValidType(ts,1);
3174   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3175   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3176   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
3177   PetscFunctionReturn(0);
3178 }
3179 
3180 
3181 #undef __FUNCT__
3182 #define __FUNCT__ "TSSolve"
3183 /*@
3184    TSSolve - Steps the requested number of timesteps.
3185 
3186    Collective on TS
3187 
3188    Input Parameter:
3189 +  ts - the TS context obtained from TSCreate()
3190 -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
3191 
3192    Level: beginner
3193 
3194    Notes:
3195    The final time returned by this function may be different from the time of the internally
3196    held state accessible by TSGetSolution() and TSGetTime() because the method may have
3197    stepped over the final time.
3198 
3199 .keywords: TS, timestep, solve
3200 
3201 .seealso: TSCreate(), TSSetSolution(), TSStep()
3202 @*/
3203 PetscErrorCode TSSolve(TS ts,Vec u)
3204 {
3205   Vec               solution;
3206   PetscErrorCode    ierr;
3207 
3208   PetscFunctionBegin;
3209   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3210   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3211   if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE) {   /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */
3212     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3213     if (!ts->vec_sol || u == ts->vec_sol) {
3214       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3215       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3216       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
3217     }
3218     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3219   } else if (u) {
3220     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
3221   }
3222   ierr = TSSetUp(ts);CHKERRQ(ierr); /*compute adj coefficients if the reverse mode is on*/
3223   /* reset time step and iteration counters */
3224   ts->steps             = 0;
3225   ts->ksp_its           = 0;
3226   ts->snes_its          = 0;
3227   ts->num_snes_failures = 0;
3228   ts->reject            = 0;
3229   ts->reason            = TS_CONVERGED_ITERATING;
3230 
3231   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3232 
3233   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
3234     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
3235     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
3236     ts->solvetime = ts->ptime;
3237   } else {
3238     /* steps the requested number of timesteps. */
3239     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3240     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3241     ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3242     while (!ts->reason) {
3243       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3244       ierr = TSStep(ts);CHKERRQ(ierr);
3245       if (ts->event) {
3246 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
3247       }
3248       if(!ts->steprollback) {
3249 	ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3250 	ierr = TSPostStep(ts);CHKERRQ(ierr);
3251       }
3252     }
3253     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
3254       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3255       ts->solvetime = ts->max_time;
3256       solution = u;
3257     } else {
3258       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3259       ts->solvetime = ts->ptime;
3260       solution = ts->vec_sol;
3261     }
3262     ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
3263     ierr = VecViewFromOptions(solution, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3264   }
3265 
3266   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
3267   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
3268   PetscFunctionReturn(0);
3269 }
3270 
3271 #undef __FUNCT__
3272 #define __FUNCT__ "TSAdjointSolve"
3273 /*@
3274    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
3275 
3276    Collective on TS
3277 
3278    Input Parameter:
3279 .  ts - the TS context obtained from TSCreate()
3280 
3281    Level: intermediate
3282 
3283    Notes:
3284    This must be called after a call to TSSolve() that solves the forward problem
3285 
3286    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
3287 
3288 .keywords: TS, timestep, solve
3289 
3290 .seealso: TSCreate(), TSSetSolution(), TSStep()
3291 @*/
3292 PetscErrorCode TSAdjointSolve(TS ts)
3293 {
3294   PetscErrorCode    ierr;
3295 
3296   PetscFunctionBegin;
3297   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3298   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3299   /* reset time step and iteration counters */
3300   ts->steps             = 0;
3301   ts->ksp_its           = 0;
3302   ts->snes_its          = 0;
3303   ts->num_snes_failures = 0;
3304   ts->reject            = 0;
3305   ts->reason            = TS_CONVERGED_ITERATING;
3306 
3307   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
3308 
3309   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3310   while (!ts->reason) {
3311     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->adjoint_max_steps-ts->steps,ts->ptime);CHKERRQ(ierr);
3312     ierr = TSMonitor(ts,ts->adjoint_max_steps-ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3313     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
3314     if (ts->event) {
3315       ierr = TSEventMonitor(ts);CHKERRQ(ierr);
3316       if (ts->event->status != TSEVENT_PROCESSING) {
3317         ierr = TSPostStep(ts);CHKERRQ(ierr);
3318       }
3319     } else {
3320       ierr = TSPostStep(ts);CHKERRQ(ierr);
3321     }
3322   }
3323   ts->solvetime = ts->ptime;
3324   PetscFunctionReturn(0);
3325 }
3326 
3327 #undef __FUNCT__
3328 #define __FUNCT__ "TSMonitor"
3329 /*@
3330    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3331 
3332    Collective on TS
3333 
3334    Input Parameters:
3335 +  ts - time stepping context obtained from TSCreate()
3336 .  step - step number that has just completed
3337 .  ptime - model time of the state
3338 -  u - state at the current model time
3339 
3340    Notes:
3341    TSMonitor() is typically used within the time stepping implementations.
3342    Users might call this function when using the TSStep() interface instead of TSSolve().
3343 
3344    Level: advanced
3345 
3346 .keywords: TS, timestep
3347 @*/
3348 PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3349 {
3350   PetscErrorCode ierr;
3351   PetscInt       i,n = ts->numbermonitors;
3352 
3353   PetscFunctionBegin;
3354   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3355   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
3356   ierr = VecLockPush(u);CHKERRQ(ierr);
3357   for (i=0; i<n; i++) {
3358     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3359   }
3360   ierr = VecLockPop(u);CHKERRQ(ierr);
3361   PetscFunctionReturn(0);
3362 }
3363 
3364 /* ------------------------------------------------------------------------*/
3365 #undef __FUNCT__
3366 #define __FUNCT__ "TSMonitorLGCtxCreate"
3367 /*@C
3368    TSMonitorLGCtxCreate - Creates a line graph context for use with
3369    TS to monitor the solution process graphically in various ways
3370 
3371    Collective on TS
3372 
3373    Input Parameters:
3374 +  host - the X display to open, or null for the local machine
3375 .  label - the title to put in the title bar
3376 .  x, y - the screen coordinates of the upper left coordinate of the window
3377 .  m, n - the screen width and height in pixels
3378 -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3379 
3380    Output Parameter:
3381 .  ctx - the context
3382 
3383    Options Database Key:
3384 +  -ts_monitor_lg_timestep - automatically sets line graph monitor
3385 .  -ts_monitor_lg_solution -
3386 .  -ts_monitor_lg_error -
3387 .  -ts_monitor_lg_ksp_iterations -
3388 .  -ts_monitor_lg_snes_iterations -
3389 -  -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true
3390 
3391    Notes:
3392    Use TSMonitorLGCtxDestroy() to destroy.
3393 
3394    Level: intermediate
3395 
3396 .keywords: TS, monitor, line graph, residual, seealso
3397 
3398 .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
3399 
3400 @*/
3401 PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3402 {
3403   PetscDraw      win;
3404   PetscErrorCode ierr;
3405 
3406   PetscFunctionBegin;
3407   ierr = PetscNew(ctx);CHKERRQ(ierr);
3408   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr);
3409   ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr);
3410   ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr);
3411   ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr);
3412   ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3413   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
3414   (*ctx)->howoften = howoften;
3415   PetscFunctionReturn(0);
3416 }
3417 
3418 #undef __FUNCT__
3419 #define __FUNCT__ "TSMonitorLGTimeStep"
3420 PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3421 {
3422   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3423   PetscReal      x   = ptime,y;
3424   PetscErrorCode ierr;
3425 
3426   PetscFunctionBegin;
3427   if (!step) {
3428     PetscDrawAxis axis;
3429     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
3430     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
3431     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3432     ierr = PetscDrawLGIndicateDataPoints(ctx->lg,PETSC_TRUE);CHKERRQ(ierr);
3433   }
3434   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
3435   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3436   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
3437     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
3438   }
3439   PetscFunctionReturn(0);
3440 }
3441 
3442 #undef __FUNCT__
3443 #define __FUNCT__ "TSMonitorLGCtxDestroy"
3444 /*@C
3445    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3446    with TSMonitorLGCtxCreate().
3447 
3448    Collective on TSMonitorLGCtx
3449 
3450    Input Parameter:
3451 .  ctx - the monitor context
3452 
3453    Level: intermediate
3454 
3455 .keywords: TS, monitor, line graph, destroy
3456 
3457 .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3458 @*/
3459 PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3460 {
3461   PetscDraw      draw;
3462   PetscErrorCode ierr;
3463 
3464   PetscFunctionBegin;
3465   ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr);
3466   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
3467   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
3468   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3469   PetscFunctionReturn(0);
3470 }
3471 
3472 #undef __FUNCT__
3473 #define __FUNCT__ "TSGetTime"
3474 /*@
3475    TSGetTime - Gets the time of the most recently completed step.
3476 
3477    Not Collective
3478 
3479    Input Parameter:
3480 .  ts - the TS context obtained from TSCreate()
3481 
3482    Output Parameter:
3483 .  t  - the current time
3484 
3485    Level: beginner
3486 
3487    Note:
3488    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
3489    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3490 
3491 .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3492 
3493 .keywords: TS, get, time
3494 @*/
3495 PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3496 {
3497   PetscFunctionBegin;
3498   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3499   PetscValidRealPointer(t,2);
3500   *t = ts->ptime;
3501   PetscFunctionReturn(0);
3502 }
3503 
3504 #undef __FUNCT__
3505 #define __FUNCT__ "TSGetPrevTime"
3506 /*@
3507    TSGetPrevTime - Gets the starting time of the previously completed step.
3508 
3509    Not Collective
3510 
3511    Input Parameter:
3512 .  ts - the TS context obtained from TSCreate()
3513 
3514    Output Parameter:
3515 .  t  - the previous time
3516 
3517    Level: beginner
3518 
3519 .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3520 
3521 .keywords: TS, get, time
3522 @*/
3523 PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3524 {
3525   PetscFunctionBegin;
3526   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3527   PetscValidRealPointer(t,2);
3528   *t = ts->ptime_prev;
3529   PetscFunctionReturn(0);
3530 }
3531 
3532 #undef __FUNCT__
3533 #define __FUNCT__ "TSSetTime"
3534 /*@
3535    TSSetTime - Allows one to reset the time.
3536 
3537    Logically Collective on TS
3538 
3539    Input Parameters:
3540 +  ts - the TS context obtained from TSCreate()
3541 -  time - the time
3542 
3543    Level: intermediate
3544 
3545 .seealso: TSGetTime(), TSSetDuration()
3546 
3547 .keywords: TS, set, time
3548 @*/
3549 PetscErrorCode  TSSetTime(TS ts, PetscReal t)
3550 {
3551   PetscFunctionBegin;
3552   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3553   PetscValidLogicalCollectiveReal(ts,t,2);
3554   ts->ptime = t;
3555   PetscFunctionReturn(0);
3556 }
3557 
3558 #undef __FUNCT__
3559 #define __FUNCT__ "TSSetOptionsPrefix"
3560 /*@C
3561    TSSetOptionsPrefix - Sets the prefix used for searching for all
3562    TS options in the database.
3563 
3564    Logically Collective on TS
3565 
3566    Input Parameter:
3567 +  ts     - The TS context
3568 -  prefix - The prefix to prepend to all option names
3569 
3570    Notes:
3571    A hyphen (-) must NOT be given at the beginning of the prefix name.
3572    The first character of all runtime options is AUTOMATICALLY the
3573    hyphen.
3574 
3575    Level: advanced
3576 
3577 .keywords: TS, set, options, prefix, database
3578 
3579 .seealso: TSSetFromOptions()
3580 
3581 @*/
3582 PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3583 {
3584   PetscErrorCode ierr;
3585   SNES           snes;
3586 
3587   PetscFunctionBegin;
3588   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3589   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3590   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3591   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3592   PetscFunctionReturn(0);
3593 }
3594 
3595 
3596 #undef __FUNCT__
3597 #define __FUNCT__ "TSAppendOptionsPrefix"
3598 /*@C
3599    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3600    TS options in the database.
3601 
3602    Logically Collective on TS
3603 
3604    Input Parameter:
3605 +  ts     - The TS context
3606 -  prefix - The prefix to prepend to all option names
3607 
3608    Notes:
3609    A hyphen (-) must NOT be given at the beginning of the prefix name.
3610    The first character of all runtime options is AUTOMATICALLY the
3611    hyphen.
3612 
3613    Level: advanced
3614 
3615 .keywords: TS, append, options, prefix, database
3616 
3617 .seealso: TSGetOptionsPrefix()
3618 
3619 @*/
3620 PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3621 {
3622   PetscErrorCode ierr;
3623   SNES           snes;
3624 
3625   PetscFunctionBegin;
3626   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3627   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3628   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3629   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3630   PetscFunctionReturn(0);
3631 }
3632 
3633 #undef __FUNCT__
3634 #define __FUNCT__ "TSGetOptionsPrefix"
3635 /*@C
3636    TSGetOptionsPrefix - Sets the prefix used for searching for all
3637    TS options in the database.
3638 
3639    Not Collective
3640 
3641    Input Parameter:
3642 .  ts - The TS context
3643 
3644    Output Parameter:
3645 .  prefix - A pointer to the prefix string used
3646 
3647    Notes: On the fortran side, the user should pass in a string 'prifix' of
3648    sufficient length to hold the prefix.
3649 
3650    Level: intermediate
3651 
3652 .keywords: TS, get, options, prefix, database
3653 
3654 .seealso: TSAppendOptionsPrefix()
3655 @*/
3656 PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3657 {
3658   PetscErrorCode ierr;
3659 
3660   PetscFunctionBegin;
3661   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3662   PetscValidPointer(prefix,2);
3663   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3664   PetscFunctionReturn(0);
3665 }
3666 
3667 #undef __FUNCT__
3668 #define __FUNCT__ "TSGetRHSJacobian"
3669 /*@C
3670    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
3671 
3672    Not Collective, but parallel objects are returned if TS is parallel
3673 
3674    Input Parameter:
3675 .  ts  - The TS context obtained from TSCreate()
3676 
3677    Output Parameters:
3678 +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
3679 .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
3680 .  func - Function to compute the Jacobian of the RHS  (or NULL)
3681 -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
3682 
3683    Notes: You can pass in NULL for any return argument you do not need.
3684 
3685    Level: intermediate
3686 
3687 .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3688 
3689 .keywords: TS, timestep, get, matrix, Jacobian
3690 @*/
3691 PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
3692 {
3693   PetscErrorCode ierr;
3694   SNES           snes;
3695   DM             dm;
3696 
3697   PetscFunctionBegin;
3698   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3699   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
3700   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
3701   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
3702   PetscFunctionReturn(0);
3703 }
3704 
3705 #undef __FUNCT__
3706 #define __FUNCT__ "TSGetIJacobian"
3707 /*@C
3708    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
3709 
3710    Not Collective, but parallel objects are returned if TS is parallel
3711 
3712    Input Parameter:
3713 .  ts  - The TS context obtained from TSCreate()
3714 
3715    Output Parameters:
3716 +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
3717 .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
3718 .  f   - The function to compute the matrices
3719 - ctx - User-defined context for Jacobian evaluation routine
3720 
3721    Notes: You can pass in NULL for any return argument you do not need.
3722 
3723    Level: advanced
3724 
3725 .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3726 
3727 .keywords: TS, timestep, get, matrix, Jacobian
3728 @*/
3729 PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
3730 {
3731   PetscErrorCode ierr;
3732   SNES           snes;
3733   DM             dm;
3734 
3735   PetscFunctionBegin;
3736   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3737   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
3738   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
3739   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
3740   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
3741   PetscFunctionReturn(0);
3742 }
3743 
3744 
3745 #undef __FUNCT__
3746 #define __FUNCT__ "TSMonitorDrawSolution"
3747 /*@C
3748    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
3749    VecView() for the solution at each timestep
3750 
3751    Collective on TS
3752 
3753    Input Parameters:
3754 +  ts - the TS context
3755 .  step - current time-step
3756 .  ptime - current time
3757 -  dummy - either a viewer or NULL
3758 
3759    Options Database:
3760 .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
3761 
3762    Notes: the initial solution and current solution are not displayed with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
3763        will look bad
3764 
3765    Level: intermediate
3766 
3767 .keywords: TS,  vector, monitor, view
3768 
3769 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
3770 @*/
3771 PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
3772 {
3773   PetscErrorCode   ierr;
3774   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
3775   PetscDraw        draw;
3776 
3777   PetscFunctionBegin;
3778   if (!step && ictx->showinitial) {
3779     if (!ictx->initialsolution) {
3780       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
3781     }
3782     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
3783   }
3784   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
3785 
3786   if (ictx->showinitial) {
3787     PetscReal pause;
3788     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
3789     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
3790     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
3791     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
3792     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
3793   }
3794   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
3795   if (ictx->showtimestepandtime) {
3796     PetscReal xl,yl,xr,yr,tw,w,h;
3797     char      time[32];
3798     size_t    len;
3799 
3800     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
3801     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
3802     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
3803     ierr =  PetscStrlen(time,&len);CHKERRQ(ierr);
3804     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
3805     w    = xl + .5*(xr - xl) - .5*len*tw;
3806     h    = yl + .95*(yr - yl);
3807     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
3808     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
3809   }
3810 
3811   if (ictx->showinitial) {
3812     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
3813   }
3814   PetscFunctionReturn(0);
3815 }
3816 
3817 #undef __FUNCT__
3818 #define __FUNCT__ "TSMonitorDrawSolutionPhase"
3819 /*@C
3820    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
3821 
3822    Collective on TS
3823 
3824    Input Parameters:
3825 +  ts - the TS context
3826 .  step - current time-step
3827 .  ptime - current time
3828 -  dummy - either a viewer or NULL
3829 
3830    Level: intermediate
3831 
3832 .keywords: TS,  vector, monitor, view
3833 
3834 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
3835 @*/
3836 PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
3837 {
3838   PetscErrorCode    ierr;
3839   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
3840   PetscDraw         draw;
3841   MPI_Comm          comm;
3842   PetscInt          n;
3843   PetscMPIInt       size;
3844   PetscReal         xl,yl,xr,yr,tw,w,h;
3845   char              time[32];
3846   size_t            len;
3847   const PetscScalar *U;
3848 
3849   PetscFunctionBegin;
3850   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
3851   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
3852   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
3853   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
3854   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
3855 
3856   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
3857 
3858   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
3859   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
3860   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
3861       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
3862       PetscFunctionReturn(0);
3863   }
3864   if (!step) ictx->color++;
3865   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
3866   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
3867 
3868   if (ictx->showtimestepandtime) {
3869     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
3870     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
3871     ierr = PetscStrlen(time,&len);CHKERRQ(ierr);
3872     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
3873     w    = xl + .5*(xr - xl) - .5*len*tw;
3874     h    = yl + .95*(yr - yl);
3875     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
3876   }
3877   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
3878   PetscFunctionReturn(0);
3879 }
3880 
3881 
3882 #undef __FUNCT__
3883 #define __FUNCT__ "TSMonitorDrawCtxDestroy"
3884 /*@C
3885    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
3886 
3887    Collective on TS
3888 
3889    Input Parameters:
3890 .    ctx - the monitor context
3891 
3892    Level: intermediate
3893 
3894 .keywords: TS,  vector, monitor, view
3895 
3896 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
3897 @*/
3898 PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
3899 {
3900   PetscErrorCode ierr;
3901 
3902   PetscFunctionBegin;
3903   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
3904   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
3905   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
3906   ierr = PetscFree(*ictx);CHKERRQ(ierr);
3907   PetscFunctionReturn(0);
3908 }
3909 
3910 #undef __FUNCT__
3911 #define __FUNCT__ "TSMonitorDrawCtxCreate"
3912 /*@C
3913    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
3914 
3915    Collective on TS
3916 
3917    Input Parameter:
3918 .    ts - time-step context
3919 
3920    Output Patameter:
3921 .    ctx - the monitor context
3922 
3923    Options Database:
3924 .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
3925 
3926    Level: intermediate
3927 
3928 .keywords: TS,  vector, monitor, view
3929 
3930 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
3931 @*/
3932 PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
3933 {
3934   PetscErrorCode   ierr;
3935 
3936   PetscFunctionBegin;
3937   ierr = PetscNew(ctx);CHKERRQ(ierr);
3938   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
3939   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
3940 
3941   (*ctx)->howoften    = howoften;
3942   (*ctx)->showinitial = PETSC_FALSE;
3943   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
3944 
3945   (*ctx)->showtimestepandtime = PETSC_FALSE;
3946   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
3947   (*ctx)->color = PETSC_DRAW_WHITE;
3948   PetscFunctionReturn(0);
3949 }
3950 
3951 #undef __FUNCT__
3952 #define __FUNCT__ "TSMonitorDrawError"
3953 /*@C
3954    TSMonitorDrawError - Monitors progress of the TS solvers by calling
3955    VecView() for the error at each timestep
3956 
3957    Collective on TS
3958 
3959    Input Parameters:
3960 +  ts - the TS context
3961 .  step - current time-step
3962 .  ptime - current time
3963 -  dummy - either a viewer or NULL
3964 
3965    Level: intermediate
3966 
3967 .keywords: TS,  vector, monitor, view
3968 
3969 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
3970 @*/
3971 PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
3972 {
3973   PetscErrorCode   ierr;
3974   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
3975   PetscViewer      viewer = ctx->viewer;
3976   Vec              work;
3977 
3978   PetscFunctionBegin;
3979   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
3980   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
3981   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
3982   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
3983   ierr = VecView(work,viewer);CHKERRQ(ierr);
3984   ierr = VecDestroy(&work);CHKERRQ(ierr);
3985   PetscFunctionReturn(0);
3986 }
3987 
3988 #include <petsc-private/dmimpl.h>
3989 #undef __FUNCT__
3990 #define __FUNCT__ "TSSetDM"
3991 /*@
3992    TSSetDM - Sets the DM that may be used by some preconditioners
3993 
3994    Logically Collective on TS and DM
3995 
3996    Input Parameters:
3997 +  ts - the preconditioner context
3998 -  dm - the dm
3999 
4000    Level: intermediate
4001 
4002 
4003 .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
4004 @*/
4005 PetscErrorCode  TSSetDM(TS ts,DM dm)
4006 {
4007   PetscErrorCode ierr;
4008   SNES           snes;
4009   DMTS           tsdm;
4010 
4011   PetscFunctionBegin;
4012   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4013   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4014   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
4015     if (ts->dm->dmts && !dm->dmts) {
4016       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4017       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
4018       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
4019         tsdm->originaldm = dm;
4020       }
4021     }
4022     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
4023   }
4024   ts->dm = dm;
4025 
4026   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4027   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
4028   PetscFunctionReturn(0);
4029 }
4030 
4031 #undef __FUNCT__
4032 #define __FUNCT__ "TSGetDM"
4033 /*@
4034    TSGetDM - Gets the DM that may be used by some preconditioners
4035 
4036    Not Collective
4037 
4038    Input Parameter:
4039 . ts - the preconditioner context
4040 
4041    Output Parameter:
4042 .  dm - the dm
4043 
4044    Level: intermediate
4045 
4046 
4047 .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
4048 @*/
4049 PetscErrorCode  TSGetDM(TS ts,DM *dm)
4050 {
4051   PetscErrorCode ierr;
4052 
4053   PetscFunctionBegin;
4054   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4055   if (!ts->dm) {
4056     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4057     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4058   }
4059   *dm = ts->dm;
4060   PetscFunctionReturn(0);
4061 }
4062 
4063 #undef __FUNCT__
4064 #define __FUNCT__ "SNESTSFormFunction"
4065 /*@
4066    SNESTSFormFunction - Function to evaluate nonlinear residual
4067 
4068    Logically Collective on SNES
4069 
4070    Input Parameter:
4071 + snes - nonlinear solver
4072 . U - the current state at which to evaluate the residual
4073 - ctx - user context, must be a TS
4074 
4075    Output Parameter:
4076 . F - the nonlinear residual
4077 
4078    Notes:
4079    This function is not normally called by users and is automatically registered with the SNES used by TS.
4080    It is most frequently passed to MatFDColoringSetFunction().
4081 
4082    Level: advanced
4083 
4084 .seealso: SNESSetFunction(), MatFDColoringSetFunction()
4085 @*/
4086 PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
4087 {
4088   TS             ts = (TS)ctx;
4089   PetscErrorCode ierr;
4090 
4091   PetscFunctionBegin;
4092   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4093   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
4094   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
4095   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
4096   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
4097   PetscFunctionReturn(0);
4098 }
4099 
4100 #undef __FUNCT__
4101 #define __FUNCT__ "SNESTSFormJacobian"
4102 /*@
4103    SNESTSFormJacobian - Function to evaluate the Jacobian
4104 
4105    Collective on SNES
4106 
4107    Input Parameter:
4108 + snes - nonlinear solver
4109 . U - the current state at which to evaluate the residual
4110 - ctx - user context, must be a TS
4111 
4112    Output Parameter:
4113 + A - the Jacobian
4114 . B - the preconditioning matrix (may be the same as A)
4115 - flag - indicates any structure change in the matrix
4116 
4117    Notes:
4118    This function is not normally called by users and is automatically registered with the SNES used by TS.
4119 
4120    Level: developer
4121 
4122 .seealso: SNESSetJacobian()
4123 @*/
4124 PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
4125 {
4126   TS             ts = (TS)ctx;
4127   PetscErrorCode ierr;
4128 
4129   PetscFunctionBegin;
4130   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4131   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
4132   PetscValidPointer(A,3);
4133   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
4134   PetscValidPointer(B,4);
4135   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
4136   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4137   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
4138   PetscFunctionReturn(0);
4139 }
4140 
4141 #undef __FUNCT__
4142 #define __FUNCT__ "TSComputeRHSFunctionLinear"
4143 /*@C
4144    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
4145 
4146    Collective on TS
4147 
4148    Input Arguments:
4149 +  ts - time stepping context
4150 .  t - time at which to evaluate
4151 .  U - state at which to evaluate
4152 -  ctx - context
4153 
4154    Output Arguments:
4155 .  F - right hand side
4156 
4157    Level: intermediate
4158 
4159    Notes:
4160    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
4161    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
4162 
4163 .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
4164 @*/
4165 PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
4166 {
4167   PetscErrorCode ierr;
4168   Mat            Arhs,Brhs;
4169 
4170   PetscFunctionBegin;
4171   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4172   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
4173   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
4174   PetscFunctionReturn(0);
4175 }
4176 
4177 #undef __FUNCT__
4178 #define __FUNCT__ "TSComputeRHSJacobianConstant"
4179 /*@C
4180    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
4181 
4182    Collective on TS
4183 
4184    Input Arguments:
4185 +  ts - time stepping context
4186 .  t - time at which to evaluate
4187 .  U - state at which to evaluate
4188 -  ctx - context
4189 
4190    Output Arguments:
4191 +  A - pointer to operator
4192 .  B - pointer to preconditioning matrix
4193 -  flg - matrix structure flag
4194 
4195    Level: intermediate
4196 
4197    Notes:
4198    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
4199 
4200 .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
4201 @*/
4202 PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
4203 {
4204   PetscFunctionBegin;
4205   PetscFunctionReturn(0);
4206 }
4207 
4208 #undef __FUNCT__
4209 #define __FUNCT__ "TSComputeIFunctionLinear"
4210 /*@C
4211    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
4212 
4213    Collective on TS
4214 
4215    Input Arguments:
4216 +  ts - time stepping context
4217 .  t - time at which to evaluate
4218 .  U - state at which to evaluate
4219 .  Udot - time derivative of state vector
4220 -  ctx - context
4221 
4222    Output Arguments:
4223 .  F - left hand side
4224 
4225    Level: intermediate
4226 
4227    Notes:
4228    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
4229    user is required to write their own TSComputeIFunction.
4230    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
4231    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
4232 
4233 .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
4234 @*/
4235 PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
4236 {
4237   PetscErrorCode ierr;
4238   Mat            A,B;
4239 
4240   PetscFunctionBegin;
4241   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4242   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
4243   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
4244   PetscFunctionReturn(0);
4245 }
4246 
4247 #undef __FUNCT__
4248 #define __FUNCT__ "TSComputeIJacobianConstant"
4249 /*@C
4250    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
4251 
4252    Collective on TS
4253 
4254    Input Arguments:
4255 +  ts - time stepping context
4256 .  t - time at which to evaluate
4257 .  U - state at which to evaluate
4258 .  Udot - time derivative of state vector
4259 .  shift - shift to apply
4260 -  ctx - context
4261 
4262    Output Arguments:
4263 +  A - pointer to operator
4264 .  B - pointer to preconditioning matrix
4265 -  flg - matrix structure flag
4266 
4267    Level: advanced
4268 
4269    Notes:
4270    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
4271 
4272    It is only appropriate for problems of the form
4273 
4274 $     M Udot = F(U,t)
4275 
4276   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4277   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4278   an implicit operator of the form
4279 
4280 $    shift*M + J
4281 
4282   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
4283   a copy of M or reassemble it when requested.
4284 
4285 .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
4286 @*/
4287 PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
4288 {
4289   PetscErrorCode ierr;
4290 
4291   PetscFunctionBegin;
4292   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4293   ts->ijacobian.shift = shift;
4294   PetscFunctionReturn(0);
4295 }
4296 
4297 #undef __FUNCT__
4298 #define __FUNCT__ "TSGetEquationType"
4299 /*@
4300    TSGetEquationType - Gets the type of the equation that TS is solving.
4301 
4302    Not Collective
4303 
4304    Input Parameter:
4305 .  ts - the TS context
4306 
4307    Output Parameter:
4308 .  equation_type - see TSEquationType
4309 
4310    Level: beginner
4311 
4312 .keywords: TS, equation type
4313 
4314 .seealso: TSSetEquationType(), TSEquationType
4315 @*/
4316 PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4317 {
4318   PetscFunctionBegin;
4319   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4320   PetscValidPointer(equation_type,2);
4321   *equation_type = ts->equation_type;
4322   PetscFunctionReturn(0);
4323 }
4324 
4325 #undef __FUNCT__
4326 #define __FUNCT__ "TSSetEquationType"
4327 /*@
4328    TSSetEquationType - Sets the type of the equation that TS is solving.
4329 
4330    Not Collective
4331 
4332    Input Parameter:
4333 +  ts - the TS context
4334 .  equation_type - see TSEquationType
4335 
4336    Level: advanced
4337 
4338 .keywords: TS, equation type
4339 
4340 .seealso: TSGetEquationType(), TSEquationType
4341 @*/
4342 PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4343 {
4344   PetscFunctionBegin;
4345   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4346   ts->equation_type = equation_type;
4347   PetscFunctionReturn(0);
4348 }
4349 
4350 #undef __FUNCT__
4351 #define __FUNCT__ "TSGetConvergedReason"
4352 /*@
4353    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
4354 
4355    Not Collective
4356 
4357    Input Parameter:
4358 .  ts - the TS context
4359 
4360    Output Parameter:
4361 .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4362             manual pages for the individual convergence tests for complete lists
4363 
4364    Level: beginner
4365 
4366    Notes:
4367    Can only be called after the call to TSSolve() is complete.
4368 
4369 .keywords: TS, nonlinear, set, convergence, test
4370 
4371 .seealso: TSSetConvergenceTest(), TSConvergedReason
4372 @*/
4373 PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
4374 {
4375   PetscFunctionBegin;
4376   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4377   PetscValidPointer(reason,2);
4378   *reason = ts->reason;
4379   PetscFunctionReturn(0);
4380 }
4381 
4382 #undef __FUNCT__
4383 #define __FUNCT__ "TSSetConvergedReason"
4384 /*@
4385    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4386 
4387    Not Collective
4388 
4389    Input Parameter:
4390 +  ts - the TS context
4391 .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4392             manual pages for the individual convergence tests for complete lists
4393 
4394    Level: advanced
4395 
4396    Notes:
4397    Can only be called during TSSolve() is active.
4398 
4399 .keywords: TS, nonlinear, set, convergence, test
4400 
4401 .seealso: TSConvergedReason
4402 @*/
4403 PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4404 {
4405   PetscFunctionBegin;
4406   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4407   ts->reason = reason;
4408   PetscFunctionReturn(0);
4409 }
4410 
4411 #undef __FUNCT__
4412 #define __FUNCT__ "TSGetSolveTime"
4413 /*@
4414    TSGetSolveTime - Gets the time after a call to TSSolve()
4415 
4416    Not Collective
4417 
4418    Input Parameter:
4419 .  ts - the TS context
4420 
4421    Output Parameter:
4422 .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4423 
4424    Level: beginner
4425 
4426    Notes:
4427    Can only be called after the call to TSSolve() is complete.
4428 
4429 .keywords: TS, nonlinear, set, convergence, test
4430 
4431 .seealso: TSSetConvergenceTest(), TSConvergedReason
4432 @*/
4433 PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4434 {
4435   PetscFunctionBegin;
4436   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4437   PetscValidPointer(ftime,2);
4438   *ftime = ts->solvetime;
4439   PetscFunctionReturn(0);
4440 }
4441 
4442 #undef __FUNCT__
4443 #define __FUNCT__ "TSGetTotalSteps"
4444 /*@
4445    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
4446 
4447    Not Collective
4448 
4449    Input Parameter:
4450 .  ts - the TS context
4451 
4452    Output Parameter:
4453 .  steps - the number of steps
4454 
4455    Level: beginner
4456 
4457    Notes:
4458    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
4459 
4460 .keywords: TS, nonlinear, set, convergence, test
4461 
4462 .seealso: TSSetConvergenceTest(), TSConvergedReason
4463 @*/
4464 PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
4465 {
4466   PetscFunctionBegin;
4467   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4468   PetscValidPointer(steps,2);
4469   *steps = ts->total_steps;
4470   PetscFunctionReturn(0);
4471 }
4472 
4473 #undef __FUNCT__
4474 #define __FUNCT__ "TSGetSNESIterations"
4475 /*@
4476    TSGetSNESIterations - Gets the total number of nonlinear iterations
4477    used by the time integrator.
4478 
4479    Not Collective
4480 
4481    Input Parameter:
4482 .  ts - TS context
4483 
4484    Output Parameter:
4485 .  nits - number of nonlinear iterations
4486 
4487    Notes:
4488    This counter is reset to zero for each successive call to TSSolve().
4489 
4490    Level: intermediate
4491 
4492 .keywords: TS, get, number, nonlinear, iterations
4493 
4494 .seealso:  TSGetKSPIterations()
4495 @*/
4496 PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
4497 {
4498   PetscFunctionBegin;
4499   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4500   PetscValidIntPointer(nits,2);
4501   *nits = ts->snes_its;
4502   PetscFunctionReturn(0);
4503 }
4504 
4505 #undef __FUNCT__
4506 #define __FUNCT__ "TSGetKSPIterations"
4507 /*@
4508    TSGetKSPIterations - Gets the total number of linear iterations
4509    used by the time integrator.
4510 
4511    Not Collective
4512 
4513    Input Parameter:
4514 .  ts - TS context
4515 
4516    Output Parameter:
4517 .  lits - number of linear iterations
4518 
4519    Notes:
4520    This counter is reset to zero for each successive call to TSSolve().
4521 
4522    Level: intermediate
4523 
4524 .keywords: TS, get, number, linear, iterations
4525 
4526 .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
4527 @*/
4528 PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
4529 {
4530   PetscFunctionBegin;
4531   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4532   PetscValidIntPointer(lits,2);
4533   *lits = ts->ksp_its;
4534   PetscFunctionReturn(0);
4535 }
4536 
4537 #undef __FUNCT__
4538 #define __FUNCT__ "TSGetStepRejections"
4539 /*@
4540    TSGetStepRejections - Gets the total number of rejected steps.
4541 
4542    Not Collective
4543 
4544    Input Parameter:
4545 .  ts - TS context
4546 
4547    Output Parameter:
4548 .  rejects - number of steps rejected
4549 
4550    Notes:
4551    This counter is reset to zero for each successive call to TSSolve().
4552 
4553    Level: intermediate
4554 
4555 .keywords: TS, get, number
4556 
4557 .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4558 @*/
4559 PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4560 {
4561   PetscFunctionBegin;
4562   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4563   PetscValidIntPointer(rejects,2);
4564   *rejects = ts->reject;
4565   PetscFunctionReturn(0);
4566 }
4567 
4568 #undef __FUNCT__
4569 #define __FUNCT__ "TSGetSNESFailures"
4570 /*@
4571    TSGetSNESFailures - Gets the total number of failed SNES solves
4572 
4573    Not Collective
4574 
4575    Input Parameter:
4576 .  ts - TS context
4577 
4578    Output Parameter:
4579 .  fails - number of failed nonlinear solves
4580 
4581    Notes:
4582    This counter is reset to zero for each successive call to TSSolve().
4583 
4584    Level: intermediate
4585 
4586 .keywords: TS, get, number
4587 
4588 .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4589 @*/
4590 PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4591 {
4592   PetscFunctionBegin;
4593   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4594   PetscValidIntPointer(fails,2);
4595   *fails = ts->num_snes_failures;
4596   PetscFunctionReturn(0);
4597 }
4598 
4599 #undef __FUNCT__
4600 #define __FUNCT__ "TSSetMaxStepRejections"
4601 /*@
4602    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4603 
4604    Not Collective
4605 
4606    Input Parameter:
4607 +  ts - TS context
4608 -  rejects - maximum number of rejected steps, pass -1 for unlimited
4609 
4610    Notes:
4611    The counter is reset to zero for each step
4612 
4613    Options Database Key:
4614  .  -ts_max_reject - Maximum number of step rejections before a step fails
4615 
4616    Level: intermediate
4617 
4618 .keywords: TS, set, maximum, number
4619 
4620 .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4621 @*/
4622 PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4623 {
4624   PetscFunctionBegin;
4625   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4626   ts->max_reject = rejects;
4627   PetscFunctionReturn(0);
4628 }
4629 
4630 #undef __FUNCT__
4631 #define __FUNCT__ "TSSetMaxSNESFailures"
4632 /*@
4633    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4634 
4635    Not Collective
4636 
4637    Input Parameter:
4638 +  ts - TS context
4639 -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4640 
4641    Notes:
4642    The counter is reset to zero for each successive call to TSSolve().
4643 
4644    Options Database Key:
4645  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4646 
4647    Level: intermediate
4648 
4649 .keywords: TS, set, maximum, number
4650 
4651 .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4652 @*/
4653 PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4654 {
4655   PetscFunctionBegin;
4656   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4657   ts->max_snes_failures = fails;
4658   PetscFunctionReturn(0);
4659 }
4660 
4661 #undef __FUNCT__
4662 #define __FUNCT__ "TSSetErrorIfStepFails"
4663 /*@
4664    TSSetErrorIfStepFails - Error if no step succeeds
4665 
4666    Not Collective
4667 
4668    Input Parameter:
4669 +  ts - TS context
4670 -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4671 
4672    Options Database Key:
4673  .  -ts_error_if_step_fails - Error if no step succeeds
4674 
4675    Level: intermediate
4676 
4677 .keywords: TS, set, error
4678 
4679 .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4680 @*/
4681 PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4682 {
4683   PetscFunctionBegin;
4684   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4685   ts->errorifstepfailed = err;
4686   PetscFunctionReturn(0);
4687 }
4688 
4689 #undef __FUNCT__
4690 #define __FUNCT__ "TSMonitorSolutionBinary"
4691 /*@C
4692    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
4693 
4694    Collective on TS
4695 
4696    Input Parameters:
4697 +  ts - the TS context
4698 .  step - current time-step
4699 .  ptime - current time
4700 .  u - current state
4701 -  viewer - binary viewer
4702 
4703    Level: intermediate
4704 
4705 .keywords: TS,  vector, monitor, view
4706 
4707 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4708 @*/
4709 PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
4710 {
4711   PetscErrorCode ierr;
4712   PetscViewer    v = (PetscViewer)viewer;
4713 
4714   PetscFunctionBegin;
4715   ierr = VecView(u,v);CHKERRQ(ierr);
4716   PetscFunctionReturn(0);
4717 }
4718 
4719 #undef __FUNCT__
4720 #define __FUNCT__ "TSMonitorSolutionVTK"
4721 /*@C
4722    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
4723 
4724    Collective on TS
4725 
4726    Input Parameters:
4727 +  ts - the TS context
4728 .  step - current time-step
4729 .  ptime - current time
4730 .  u - current state
4731 -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4732 
4733    Level: intermediate
4734 
4735    Notes:
4736    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.
4737    These are named according to the file name template.
4738 
4739    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
4740 
4741 .keywords: TS,  vector, monitor, view
4742 
4743 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4744 @*/
4745 PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
4746 {
4747   PetscErrorCode ierr;
4748   char           filename[PETSC_MAX_PATH_LEN];
4749   PetscViewer    viewer;
4750 
4751   PetscFunctionBegin;
4752   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
4753   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
4754   ierr = VecView(u,viewer);CHKERRQ(ierr);
4755   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4756   PetscFunctionReturn(0);
4757 }
4758 
4759 #undef __FUNCT__
4760 #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
4761 /*@C
4762    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
4763 
4764    Collective on TS
4765 
4766    Input Parameters:
4767 .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4768 
4769    Level: intermediate
4770 
4771    Note:
4772    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
4773 
4774 .keywords: TS,  vector, monitor, view
4775 
4776 .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
4777 @*/
4778 PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
4779 {
4780   PetscErrorCode ierr;
4781 
4782   PetscFunctionBegin;
4783   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
4784   PetscFunctionReturn(0);
4785 }
4786 
4787 #undef __FUNCT__
4788 #define __FUNCT__ "TSGetAdapt"
4789 /*@
4790    TSGetAdapt - Get the adaptive controller context for the current method
4791 
4792    Collective on TS if controller has not been created yet
4793 
4794    Input Arguments:
4795 .  ts - time stepping context
4796 
4797    Output Arguments:
4798 .  adapt - adaptive controller
4799 
4800    Level: intermediate
4801 
4802 .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
4803 @*/
4804 PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
4805 {
4806   PetscErrorCode ierr;
4807 
4808   PetscFunctionBegin;
4809   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4810   PetscValidPointer(adapt,2);
4811   if (!ts->adapt) {
4812     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
4813     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
4814     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
4815   }
4816   *adapt = ts->adapt;
4817   PetscFunctionReturn(0);
4818 }
4819 
4820 #undef __FUNCT__
4821 #define __FUNCT__ "TSSetTolerances"
4822 /*@
4823    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
4824 
4825    Logically Collective
4826 
4827    Input Arguments:
4828 +  ts - time integration context
4829 .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
4830 .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
4831 .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
4832 -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
4833 
4834    Options Database keys:
4835 +  -ts_rtol <rtol> - relative tolerance for local truncation error
4836 -  -ts_atol <atol> Absolute tolerance for local truncation error
4837 
4838    Level: beginner
4839 
4840 .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
4841 @*/
4842 PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
4843 {
4844   PetscErrorCode ierr;
4845 
4846   PetscFunctionBegin;
4847   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
4848   if (vatol) {
4849     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
4850     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
4851 
4852     ts->vatol = vatol;
4853   }
4854   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
4855   if (vrtol) {
4856     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
4857     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
4858 
4859     ts->vrtol = vrtol;
4860   }
4861   PetscFunctionReturn(0);
4862 }
4863 
4864 #undef __FUNCT__
4865 #define __FUNCT__ "TSGetTolerances"
4866 /*@
4867    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
4868 
4869    Logically Collective
4870 
4871    Input Arguments:
4872 .  ts - time integration context
4873 
4874    Output Arguments:
4875 +  atol - scalar absolute tolerances, NULL to ignore
4876 .  vatol - vector of absolute tolerances, NULL to ignore
4877 .  rtol - scalar relative tolerances, NULL to ignore
4878 -  vrtol - vector of relative tolerances, NULL to ignore
4879 
4880    Level: beginner
4881 
4882 .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
4883 @*/
4884 PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
4885 {
4886   PetscFunctionBegin;
4887   if (atol)  *atol  = ts->atol;
4888   if (vatol) *vatol = ts->vatol;
4889   if (rtol)  *rtol  = ts->rtol;
4890   if (vrtol) *vrtol = ts->vrtol;
4891   PetscFunctionReturn(0);
4892 }
4893 
4894 #undef __FUNCT__
4895 #define __FUNCT__ "TSErrorNormWRMS"
4896 /*@
4897    TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state
4898 
4899    Collective on TS
4900 
4901    Input Arguments:
4902 +  ts - time stepping context
4903 -  Y - state vector to be compared to ts->vec_sol
4904 
4905    Output Arguments:
4906 .  norm - weighted norm, a value of 1.0 is considered small
4907 
4908    Level: developer
4909 
4910 .seealso: TSSetTolerances()
4911 @*/
4912 PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm)
4913 {
4914   PetscErrorCode    ierr;
4915   PetscInt          i,n,N;
4916   const PetscScalar *u,*y;
4917   Vec               U;
4918   PetscReal         sum,gsum;
4919 
4920   PetscFunctionBegin;
4921   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4922   PetscValidHeaderSpecific(Y,VEC_CLASSID,2);
4923   PetscValidPointer(norm,3);
4924   U = ts->vec_sol;
4925   PetscCheckSameTypeAndComm(U,1,Y,2);
4926   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector");
4927 
4928   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
4929   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
4930   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
4931   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
4932   sum  = 0.;
4933   if (ts->vatol && ts->vrtol) {
4934     const PetscScalar *atol,*rtol;
4935     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4936     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4937     for (i=0; i<n; i++) {
4938       PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
4939       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4940     }
4941     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4942     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4943   } else if (ts->vatol) {       /* vector atol, scalar rtol */
4944     const PetscScalar *atol;
4945     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4946     for (i=0; i<n; i++) {
4947       PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
4948       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4949     }
4950     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4951   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
4952     const PetscScalar *rtol;
4953     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4954     for (i=0; i<n; i++) {
4955       PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
4956       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4957     }
4958     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4959   } else {                      /* scalar atol, scalar rtol */
4960     for (i=0; i<n; i++) {
4961       PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
4962       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4963     }
4964   }
4965   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
4966   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
4967 
4968   ierr  = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
4969   *norm = PetscSqrtReal(gsum / N);
4970   if (PetscIsInfOrNanReal(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
4971   PetscFunctionReturn(0);
4972 }
4973 
4974 #undef __FUNCT__
4975 #define __FUNCT__ "TSSetCFLTimeLocal"
4976 /*@
4977    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
4978 
4979    Logically Collective on TS
4980 
4981    Input Arguments:
4982 +  ts - time stepping context
4983 -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
4984 
4985    Note:
4986    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
4987 
4988    Level: intermediate
4989 
4990 .seealso: TSGetCFLTime(), TSADAPTCFL
4991 @*/
4992 PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
4993 {
4994   PetscFunctionBegin;
4995   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4996   ts->cfltime_local = cfltime;
4997   ts->cfltime       = -1.;
4998   PetscFunctionReturn(0);
4999 }
5000 
5001 #undef __FUNCT__
5002 #define __FUNCT__ "TSGetCFLTime"
5003 /*@
5004    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
5005 
5006    Collective on TS
5007 
5008    Input Arguments:
5009 .  ts - time stepping context
5010 
5011    Output Arguments:
5012 .  cfltime - maximum stable time step for forward Euler
5013 
5014    Level: advanced
5015 
5016 .seealso: TSSetCFLTimeLocal()
5017 @*/
5018 PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
5019 {
5020   PetscErrorCode ierr;
5021 
5022   PetscFunctionBegin;
5023   if (ts->cfltime < 0) {
5024     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
5025   }
5026   *cfltime = ts->cfltime;
5027   PetscFunctionReturn(0);
5028 }
5029 
5030 #undef __FUNCT__
5031 #define __FUNCT__ "TSVISetVariableBounds"
5032 /*@
5033    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5034 
5035    Input Parameters:
5036 .  ts   - the TS context.
5037 .  xl   - lower bound.
5038 .  xu   - upper bound.
5039 
5040    Notes:
5041    If this routine is not called then the lower and upper bounds are set to
5042    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
5043 
5044    Level: advanced
5045 
5046 @*/
5047 PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5048 {
5049   PetscErrorCode ierr;
5050   SNES           snes;
5051 
5052   PetscFunctionBegin;
5053   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5054   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
5055   PetscFunctionReturn(0);
5056 }
5057 
5058 #if defined(PETSC_HAVE_MATLAB_ENGINE)
5059 #include <mex.h>
5060 
5061 typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
5062 
5063 #undef __FUNCT__
5064 #define __FUNCT__ "TSComputeFunction_Matlab"
5065 /*
5066    TSComputeFunction_Matlab - Calls the function that has been set with
5067                          TSSetFunctionMatlab().
5068 
5069    Collective on TS
5070 
5071    Input Parameters:
5072 +  snes - the TS context
5073 -  u - input vector
5074 
5075    Output Parameter:
5076 .  y - function vector, as set by TSSetFunction()
5077 
5078    Notes:
5079    TSComputeFunction() is typically used within nonlinear solvers
5080    implementations, so most users would not generally call this routine
5081    themselves.
5082 
5083    Level: developer
5084 
5085 .keywords: TS, nonlinear, compute, function
5086 
5087 .seealso: TSSetFunction(), TSGetFunction()
5088 */
5089 PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
5090 {
5091   PetscErrorCode  ierr;
5092   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5093   int             nlhs  = 1,nrhs = 7;
5094   mxArray         *plhs[1],*prhs[7];
5095   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
5096 
5097   PetscFunctionBegin;
5098   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
5099   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5100   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
5101   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
5102   PetscCheckSameComm(snes,1,u,3);
5103   PetscCheckSameComm(snes,1,y,5);
5104 
5105   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
5106   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5107   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
5108   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
5109 
5110   prhs[0] =  mxCreateDoubleScalar((double)ls);
5111   prhs[1] =  mxCreateDoubleScalar(time);
5112   prhs[2] =  mxCreateDoubleScalar((double)lx);
5113   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5114   prhs[4] =  mxCreateDoubleScalar((double)ly);
5115   prhs[5] =  mxCreateString(sctx->funcname);
5116   prhs[6] =  sctx->ctx;
5117   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
5118   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5119   mxDestroyArray(prhs[0]);
5120   mxDestroyArray(prhs[1]);
5121   mxDestroyArray(prhs[2]);
5122   mxDestroyArray(prhs[3]);
5123   mxDestroyArray(prhs[4]);
5124   mxDestroyArray(prhs[5]);
5125   mxDestroyArray(plhs[0]);
5126   PetscFunctionReturn(0);
5127 }
5128 
5129 
5130 #undef __FUNCT__
5131 #define __FUNCT__ "TSSetFunctionMatlab"
5132 /*
5133    TSSetFunctionMatlab - Sets the function evaluation routine and function
5134    vector for use by the TS routines in solving ODEs
5135    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
5136 
5137    Logically Collective on TS
5138 
5139    Input Parameters:
5140 +  ts - the TS context
5141 -  func - function evaluation routine
5142 
5143    Calling sequence of func:
5144 $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
5145 
5146    Level: beginner
5147 
5148 .keywords: TS, nonlinear, set, function
5149 
5150 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5151 */
5152 PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
5153 {
5154   PetscErrorCode  ierr;
5155   TSMatlabContext *sctx;
5156 
5157   PetscFunctionBegin;
5158   /* currently sctx is memory bleed */
5159   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5160   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5161   /*
5162      This should work, but it doesn't
5163   sctx->ctx = ctx;
5164   mexMakeArrayPersistent(sctx->ctx);
5165   */
5166   sctx->ctx = mxDuplicateArray(ctx);
5167 
5168   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
5169   PetscFunctionReturn(0);
5170 }
5171 
5172 #undef __FUNCT__
5173 #define __FUNCT__ "TSComputeJacobian_Matlab"
5174 /*
5175    TSComputeJacobian_Matlab - Calls the function that has been set with
5176                          TSSetJacobianMatlab().
5177 
5178    Collective on TS
5179 
5180    Input Parameters:
5181 +  ts - the TS context
5182 .  u - input vector
5183 .  A, B - the matrices
5184 -  ctx - user context
5185 
5186    Level: developer
5187 
5188 .keywords: TS, nonlinear, compute, function
5189 
5190 .seealso: TSSetFunction(), TSGetFunction()
5191 @*/
5192 PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
5193 {
5194   PetscErrorCode  ierr;
5195   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5196   int             nlhs  = 2,nrhs = 9;
5197   mxArray         *plhs[2],*prhs[9];
5198   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
5199 
5200   PetscFunctionBegin;
5201   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5202   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5203 
5204   /* call Matlab function in ctx with arguments u and y */
5205 
5206   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
5207   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5208   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
5209   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
5210   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
5211 
5212   prhs[0] =  mxCreateDoubleScalar((double)ls);
5213   prhs[1] =  mxCreateDoubleScalar((double)time);
5214   prhs[2] =  mxCreateDoubleScalar((double)lx);
5215   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5216   prhs[4] =  mxCreateDoubleScalar((double)shift);
5217   prhs[5] =  mxCreateDoubleScalar((double)lA);
5218   prhs[6] =  mxCreateDoubleScalar((double)lB);
5219   prhs[7] =  mxCreateString(sctx->funcname);
5220   prhs[8] =  sctx->ctx;
5221   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
5222   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5223   mxDestroyArray(prhs[0]);
5224   mxDestroyArray(prhs[1]);
5225   mxDestroyArray(prhs[2]);
5226   mxDestroyArray(prhs[3]);
5227   mxDestroyArray(prhs[4]);
5228   mxDestroyArray(prhs[5]);
5229   mxDestroyArray(prhs[6]);
5230   mxDestroyArray(prhs[7]);
5231   mxDestroyArray(plhs[0]);
5232   mxDestroyArray(plhs[1]);
5233   PetscFunctionReturn(0);
5234 }
5235 
5236 
5237 #undef __FUNCT__
5238 #define __FUNCT__ "TSSetJacobianMatlab"
5239 /*
5240    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
5241    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
5242 
5243    Logically Collective on TS
5244 
5245    Input Parameters:
5246 +  ts - the TS context
5247 .  A,B - Jacobian matrices
5248 .  func - function evaluation routine
5249 -  ctx - user context
5250 
5251    Calling sequence of func:
5252 $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
5253 
5254 
5255    Level: developer
5256 
5257 .keywords: TS, nonlinear, set, function
5258 
5259 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5260 */
5261 PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
5262 {
5263   PetscErrorCode  ierr;
5264   TSMatlabContext *sctx;
5265 
5266   PetscFunctionBegin;
5267   /* currently sctx is memory bleed */
5268   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5269   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5270   /*
5271      This should work, but it doesn't
5272   sctx->ctx = ctx;
5273   mexMakeArrayPersistent(sctx->ctx);
5274   */
5275   sctx->ctx = mxDuplicateArray(ctx);
5276 
5277   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
5278   PetscFunctionReturn(0);
5279 }
5280 
5281 #undef __FUNCT__
5282 #define __FUNCT__ "TSMonitor_Matlab"
5283 /*
5284    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
5285 
5286    Collective on TS
5287 
5288 .seealso: TSSetFunction(), TSGetFunction()
5289 @*/
5290 PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
5291 {
5292   PetscErrorCode  ierr;
5293   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5294   int             nlhs  = 1,nrhs = 6;
5295   mxArray         *plhs[1],*prhs[6];
5296   long long int   lx = 0,ls = 0;
5297 
5298   PetscFunctionBegin;
5299   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5300   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
5301 
5302   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
5303   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5304 
5305   prhs[0] =  mxCreateDoubleScalar((double)ls);
5306   prhs[1] =  mxCreateDoubleScalar((double)it);
5307   prhs[2] =  mxCreateDoubleScalar((double)time);
5308   prhs[3] =  mxCreateDoubleScalar((double)lx);
5309   prhs[4] =  mxCreateString(sctx->funcname);
5310   prhs[5] =  sctx->ctx;
5311   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
5312   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5313   mxDestroyArray(prhs[0]);
5314   mxDestroyArray(prhs[1]);
5315   mxDestroyArray(prhs[2]);
5316   mxDestroyArray(prhs[3]);
5317   mxDestroyArray(prhs[4]);
5318   mxDestroyArray(plhs[0]);
5319   PetscFunctionReturn(0);
5320 }
5321 
5322 
5323 #undef __FUNCT__
5324 #define __FUNCT__ "TSMonitorSetMatlab"
5325 /*
5326    TSMonitorSetMatlab - Sets the monitor function from Matlab
5327 
5328    Level: developer
5329 
5330 .keywords: TS, nonlinear, set, function
5331 
5332 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5333 */
5334 PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
5335 {
5336   PetscErrorCode  ierr;
5337   TSMatlabContext *sctx;
5338 
5339   PetscFunctionBegin;
5340   /* currently sctx is memory bleed */
5341   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5342   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5343   /*
5344      This should work, but it doesn't
5345   sctx->ctx = ctx;
5346   mexMakeArrayPersistent(sctx->ctx);
5347   */
5348   sctx->ctx = mxDuplicateArray(ctx);
5349 
5350   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5351   PetscFunctionReturn(0);
5352 }
5353 #endif
5354 
5355 
5356 
5357 #undef __FUNCT__
5358 #define __FUNCT__ "TSMonitorLGSolution"
5359 /*@C
5360    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5361        in a time based line graph
5362 
5363    Collective on TS
5364 
5365    Input Parameters:
5366 +  ts - the TS context
5367 .  step - current time-step
5368 .  ptime - current time
5369 -  lg - a line graph object
5370 
5371    Level: intermediate
5372 
5373     Notes: each process in a parallel run displays its component solutions in a separate window
5374 
5375 .keywords: TS,  vector, monitor, view
5376 
5377 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5378 @*/
5379 PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5380 {
5381   PetscErrorCode    ierr;
5382   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5383   const PetscScalar *yy;
5384   PetscInt          dim;
5385 
5386   PetscFunctionBegin;
5387   if (!step) {
5388     PetscDrawAxis axis;
5389     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5390     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
5391     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5392     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5393     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5394   }
5395   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
5396 #if defined(PETSC_USE_COMPLEX)
5397   {
5398     PetscReal *yreal;
5399     PetscInt  i,n;
5400     ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr);
5401     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5402     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
5403     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5404     ierr = PetscFree(yreal);CHKERRQ(ierr);
5405   }
5406 #else
5407   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5408 #endif
5409   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
5410   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
5411     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5412   }
5413   PetscFunctionReturn(0);
5414 }
5415 
5416 #undef __FUNCT__
5417 #define __FUNCT__ "TSMonitorLGError"
5418 /*@C
5419    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
5420        in a time based line graph
5421 
5422    Collective on TS
5423 
5424    Input Parameters:
5425 +  ts - the TS context
5426 .  step - current time-step
5427 .  ptime - current time
5428 -  lg - a line graph object
5429 
5430    Level: intermediate
5431 
5432    Notes:
5433    Only for sequential solves.
5434 
5435    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
5436 
5437    Options Database Keys:
5438 .  -ts_monitor_lg_error - create a graphical monitor of error history
5439 
5440 .keywords: TS,  vector, monitor, view
5441 
5442 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
5443 @*/
5444 PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5445 {
5446   PetscErrorCode    ierr;
5447   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5448   const PetscScalar *yy;
5449   Vec               y;
5450   PetscInt          dim;
5451 
5452   PetscFunctionBegin;
5453   if (!step) {
5454     PetscDrawAxis axis;
5455     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5456     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
5457     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5458     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5459     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5460   }
5461   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
5462   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
5463   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
5464   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
5465 #if defined(PETSC_USE_COMPLEX)
5466   {
5467     PetscReal *yreal;
5468     PetscInt  i,n;
5469     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
5470     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5471     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
5472     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5473     ierr = PetscFree(yreal);CHKERRQ(ierr);
5474   }
5475 #else
5476   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5477 #endif
5478   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
5479   ierr = VecDestroy(&y);CHKERRQ(ierr);
5480   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
5481     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5482   }
5483   PetscFunctionReturn(0);
5484 }
5485 
5486 #undef __FUNCT__
5487 #define __FUNCT__ "TSMonitorLGSNESIterations"
5488 PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5489 {
5490   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5491   PetscReal      x   = ptime,y;
5492   PetscErrorCode ierr;
5493   PetscInt       its;
5494 
5495   PetscFunctionBegin;
5496   if (!n) {
5497     PetscDrawAxis axis;
5498 
5499     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5500     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
5501     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5502 
5503     ctx->snes_its = 0;
5504   }
5505   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
5506   y    = its - ctx->snes_its;
5507   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
5508   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5509     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5510   }
5511   ctx->snes_its = its;
5512   PetscFunctionReturn(0);
5513 }
5514 
5515 #undef __FUNCT__
5516 #define __FUNCT__ "TSMonitorLGKSPIterations"
5517 PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5518 {
5519   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5520   PetscReal      x   = ptime,y;
5521   PetscErrorCode ierr;
5522   PetscInt       its;
5523 
5524   PetscFunctionBegin;
5525   if (!n) {
5526     PetscDrawAxis axis;
5527 
5528     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5529     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
5530     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5531 
5532     ctx->ksp_its = 0;
5533   }
5534   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
5535   y    = its - ctx->ksp_its;
5536   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
5537   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5538     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5539   }
5540   ctx->ksp_its = its;
5541   PetscFunctionReturn(0);
5542 }
5543 
5544 #undef __FUNCT__
5545 #define __FUNCT__ "TSComputeLinearStability"
5546 /*@
5547    TSComputeLinearStability - computes the linear stability function at a point
5548 
5549    Collective on TS and Vec
5550 
5551    Input Parameters:
5552 +  ts - the TS context
5553 -  xr,xi - real and imaginary part of input arguments
5554 
5555    Output Parameters:
5556 .  yr,yi - real and imaginary part of function value
5557 
5558    Level: developer
5559 
5560 .keywords: TS, compute
5561 
5562 .seealso: TSSetRHSFunction(), TSComputeIFunction()
5563 @*/
5564 PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
5565 {
5566   PetscErrorCode ierr;
5567 
5568   PetscFunctionBegin;
5569   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5570   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
5571   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
5572   PetscFunctionReturn(0);
5573 }
5574 
5575 #undef __FUNCT__
5576 #define __FUNCT__ "TSRollBack"
5577 /*@
5578    TSRollBack - Rolls back one time step
5579 
5580    Collective on TS
5581 
5582    Input Parameter:
5583 .  ts - the TS context obtained from TSCreate()
5584 
5585    Level: advanced
5586 
5587 .keywords: TS, timestep, rollback
5588 
5589 .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
5590 @*/
5591 PetscErrorCode  TSRollBack(TS ts)
5592 {
5593   PetscErrorCode ierr;
5594 
5595   PetscFunctionBegin;
5596   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
5597 
5598   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
5599   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
5600   ts->time_step = ts->ptime - ts->ptime_prev;
5601   ts->ptime = ts->ptime_prev;
5602   ts->steprollback = PETSC_TRUE; /* Flag to indicate that the step is rollbacked */
5603   PetscFunctionReturn(0);
5604 }
5605 
5606 #undef __FUNCT__
5607 #define __FUNCT__ "TSGetStages"
5608 /*@
5609    TSGetStages - Get the number of stages and stage values
5610 
5611    Input Parameter:
5612 .  ts - the TS context obtained from TSCreate()
5613 
5614    Level: advanced
5615 
5616 .keywords: TS, getstages
5617 
5618 .seealso: TSCreate()
5619 @*/
5620 PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
5621 {
5622   PetscErrorCode ierr;
5623 
5624   PetscFunctionBegin;
5625   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
5626   PetscValidPointer(ns,2);
5627 
5628   if (!ts->ops->getstages) *ns=0;
5629   else {
5630     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
5631   }
5632   PetscFunctionReturn(0);
5633 }
5634 
5635