xref: /petsc/src/ts/interface/ts.c (revision c0517034d67f92a56cd022850bb947bfeaed5dde)
163dd3a1aSKris Buschelman 
2af0996ceSBarry Smith #include <petsc/private/tsimpl.h>        /*I "petscts.h"  I*/
3496e6a7aSJed Brown #include <petscdmshell.h>
41e25c274SJed Brown #include <petscdmda.h>
52d5ee99bSBarry Smith #include <petscviewer.h>
62d5ee99bSBarry Smith #include <petscdraw.h>
7d763cef2SBarry Smith 
8d5ba7fb7SMatthew Knepley /* Logging support */
9d74926cbSBarry Smith PetscClassId  TS_CLASSID, DMTS_CLASSID;
108d0ad7a8SHong Zhang PetscLogEvent TS_AdjointStep, TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
11d405a339SMatthew Knepley 
12feed9e9dSBarry Smith const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0};
1349354f04SShri Abhyankar 
142d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx {
152d5ee99bSBarry Smith   PetscViewer   viewer;
162d5ee99bSBarry Smith   Vec           initialsolution;
172d5ee99bSBarry Smith   PetscBool     showinitial;
182d5ee99bSBarry Smith   PetscInt      howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
192d5ee99bSBarry Smith   PetscBool     showtimestepandtime;
202d5ee99bSBarry Smith };
212d5ee99bSBarry Smith 
22bdad233fSMatthew Knepley #undef __FUNCT__
23fde5950dSBarry Smith #define __FUNCT__ "TSMonitorSetFromOptions"
24fde5950dSBarry Smith /*@C
25fde5950dSBarry Smith    TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
26fde5950dSBarry Smith 
27fde5950dSBarry Smith    Collective on TS
28fde5950dSBarry Smith 
29fde5950dSBarry Smith    Input Parameters:
30fde5950dSBarry Smith +  ts - TS object you wish to monitor
31fde5950dSBarry Smith .  name - the monitor type one is seeking
32fde5950dSBarry Smith .  help - message indicating what monitoring is done
33fde5950dSBarry Smith .  manual - manual page for the monitor
34fde5950dSBarry Smith .  monitor - the monitor function
35fde5950dSBarry Smith -  monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects
36fde5950dSBarry Smith 
37fde5950dSBarry Smith    Level: developer
38fde5950dSBarry Smith 
39fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
40fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
41fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
42fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
43fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
44fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
45fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
46fde5950dSBarry Smith @*/
47721cd6eeSBarry Smith PetscErrorCode  TSMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*))
48fde5950dSBarry Smith {
49fde5950dSBarry Smith   PetscErrorCode    ierr;
50fde5950dSBarry Smith   PetscViewer       viewer;
51fde5950dSBarry Smith   PetscViewerFormat format;
52fde5950dSBarry Smith   PetscBool         flg;
53fde5950dSBarry Smith 
54fde5950dSBarry Smith   PetscFunctionBegin;
55fde5950dSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
56fde5950dSBarry Smith   if (flg) {
57721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
58721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
59721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
60fde5950dSBarry Smith     if (monitorsetup) {
61721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
62fde5950dSBarry Smith     }
63721cd6eeSBarry Smith     ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr);
64fde5950dSBarry Smith   }
65fde5950dSBarry Smith   PetscFunctionReturn(0);
66fde5950dSBarry Smith }
67fde5950dSBarry Smith 
68fde5950dSBarry Smith #undef __FUNCT__
69fde5950dSBarry Smith #define __FUNCT__ "TSAdjointMonitorSetFromOptions"
70fde5950dSBarry Smith /*@C
71fde5950dSBarry Smith    TSAdjointMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
72fde5950dSBarry Smith 
73fde5950dSBarry Smith    Collective on TS
74fde5950dSBarry Smith 
75fde5950dSBarry Smith    Input Parameters:
76fde5950dSBarry Smith +  ts - TS object you wish to monitor
77fde5950dSBarry Smith .  name - the monitor type one is seeking
78fde5950dSBarry Smith .  help - message indicating what monitoring is done
79fde5950dSBarry Smith .  manual - manual page for the monitor
80fde5950dSBarry Smith .  monitor - the monitor function
81fde5950dSBarry Smith -  monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects
82fde5950dSBarry Smith 
83fde5950dSBarry Smith    Level: developer
84fde5950dSBarry Smith 
85fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
86fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
87fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
88fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
89fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
90fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
91fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
92fde5950dSBarry Smith @*/
93721cd6eeSBarry Smith PetscErrorCode  TSAdjointMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*))
94fde5950dSBarry Smith {
95fde5950dSBarry Smith   PetscErrorCode    ierr;
96fde5950dSBarry Smith   PetscViewer       viewer;
97fde5950dSBarry Smith   PetscViewerFormat format;
98fde5950dSBarry Smith   PetscBool         flg;
99fde5950dSBarry Smith 
100fde5950dSBarry Smith   PetscFunctionBegin;
101fde5950dSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
102fde5950dSBarry Smith   if (flg) {
103721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
104721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
105721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
106fde5950dSBarry Smith     if (monitorsetup) {
107721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
108fde5950dSBarry Smith     }
109721cd6eeSBarry Smith     ierr = TSAdjointMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr);
110fde5950dSBarry Smith   }
111fde5950dSBarry Smith   PetscFunctionReturn(0);
112fde5950dSBarry Smith }
113fde5950dSBarry Smith 
114fde5950dSBarry Smith #undef __FUNCT__
115bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions"
116bdad233fSMatthew Knepley /*@
117bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
118bdad233fSMatthew Knepley 
119bdad233fSMatthew Knepley    Collective on TS
120bdad233fSMatthew Knepley 
121bdad233fSMatthew Knepley    Input Parameter:
122bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
123bdad233fSMatthew Knepley 
124bdad233fSMatthew Knepley    Options Database Keys:
125b6a60446SDebojyoti Ghosh +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE
126ef222394SBarry Smith .  -ts_save_trajectory - checkpoint the solution at each time-step
1273e4cdcaaSBarry Smith .  -ts_max_steps <maxsteps> - maximum number of time-steps to take
1283e4cdcaaSBarry Smith .  -ts_final_time <time> - maximum time to compute to
1293e4cdcaaSBarry Smith .  -ts_dt <dt> - initial time step
130a3cdaa26SBarry Smith .  -ts_exact_final_time <stepover,interpolate,matchstep> whether to stop at the exact given final time and how to compute the solution at that ti,e
131a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
132a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
133a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
134a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
135a3cdaa26SBarry Smith .  -ts_atol <atol> Absolute tolerance for local truncation error
136ef222394SBarry Smith .  -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
137847ff0e1SMatthew G. Knepley .  -ts_fd_color - Use finite differences with coloring to compute IJacobian
138bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
139de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
140de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
1416934998bSLisandro Dalcin .  -ts_monitor_lg_timestep - Monitor timestep size graphically
142de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
143de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
144de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
145de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
1463e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
1473e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
148fde5950dSBarry Smith .  -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep
149b3d3934dSBarry Smith .  -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts
150110eb670SHong Zhang .  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
151110eb670SHong Zhang .  -ts_adjoint_monitor - print information at each adjoint time step
15253ea634cSHong Zhang -  -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically
15353ea634cSHong Zhang 
15491b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
155bdad233fSMatthew Knepley 
156bdad233fSMatthew Knepley    Level: beginner
157bdad233fSMatthew Knepley 
158bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
159bdad233fSMatthew Knepley 
160a313700dSBarry Smith .seealso: TSGetType()
161bdad233fSMatthew Knepley @*/
1627087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
163bdad233fSMatthew Knepley {
164bc952696SBarry Smith   PetscBool              opt,flg,tflg;
165dfbe8321SBarry Smith   PetscErrorCode         ierr;
166eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
16731748224SBarry Smith   PetscReal              time_step;
16849354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
169d1212d36SBarry Smith   char                   dir[16];
170cd11d68dSLisandro Dalcin   TSIFunction            ifun;
1716991f827SBarry Smith   const char             *defaultType;
1726991f827SBarry Smith   char                   typeName[256];
173bdad233fSMatthew Knepley 
174bdad233fSMatthew Knepley   PetscFunctionBegin;
1750700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1766991f827SBarry Smith 
1776991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
178cd11d68dSLisandro Dalcin   ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
179cd11d68dSLisandro Dalcin 
180cd11d68dSLisandro Dalcin   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
181cd11d68dSLisandro Dalcin   if (((PetscObject)ts)->type_name)
182cd11d68dSLisandro Dalcin     defaultType = ((PetscObject)ts)->type_name;
183cd11d68dSLisandro Dalcin   else
184cd11d68dSLisandro Dalcin     defaultType = ifun ? TSBEULER : TSEULER;
1856991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr);
1866991f827SBarry Smith   if (opt) {
1876991f827SBarry Smith     ierr = TSSetType(ts,typeName);CHKERRQ(ierr);
1886991f827SBarry Smith   } else {
1896991f827SBarry Smith     ierr = TSSetType(ts,defaultType);CHKERRQ(ierr);
1906991f827SBarry Smith   }
191bdad233fSMatthew Knepley 
192bdad233fSMatthew Knepley   /* Handle generic TS options */
1930298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1940298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
1950298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
19631748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
197cd11d68dSLisandro Dalcin   if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);}
19849354f04SShri Abhyankar   ierr = PetscOptionsEnum("-ts_exact_final_time","Option for handling of final time step","TSSetExactFinalTime",TSExactFinalTimeOptions,(PetscEnum)ts->exact_final_time,(PetscEnum*)&eftopt,&flg);CHKERRQ(ierr);
19949354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
2000298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL);CHKERRQ(ierr);
2010298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
2020298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
2030298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
2040298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
205bdad233fSMatthew Knepley 
20656f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
20756f85f32SBarry Smith   {
20856f85f32SBarry Smith   PetscBool set;
20956f85f32SBarry Smith   flg  = PETSC_FALSE;
21056f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
21156f85f32SBarry Smith   if (set) {
21256f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
21356f85f32SBarry Smith   }
21456f85f32SBarry Smith   }
21556f85f32SBarry Smith #endif
21656f85f32SBarry Smith 
217bdad233fSMatthew Knepley   /* Monitor options */
218cd11d68dSLisandro Dalcin   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr);
219fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr);
220fde5950dSBarry Smith   ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);CHKERRQ(ierr);
221fde5950dSBarry Smith 
2225180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
2235180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
2245180491cSLisandro Dalcin 
2254f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
226b3603a34SBarry Smith   if (opt) {
2270b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2283923b477SBarry Smith     PetscInt       howoften = 1;
229b3603a34SBarry Smith 
2300298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
2316ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2324f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
233bdad233fSMatthew Knepley   }
2346ba87a44SLisandro Dalcin 
2354f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
236ef20d060SBarry Smith   if (opt) {
2370b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2383923b477SBarry Smith     PetscInt       howoften = 1;
239ef20d060SBarry Smith 
2400298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
2416ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2424f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
243ef20d060SBarry Smith   }
2446934998bSLisandro Dalcin 
2456934998bSLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2466934998bSLisandro Dalcin   if (opt) {
2476934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
2486934998bSLisandro Dalcin     PetscInt       howoften = 1;
2496934998bSLisandro Dalcin 
2506934998bSLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2516ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2526934998bSLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2536934998bSLisandro Dalcin   }
254201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
255201da799SBarry Smith   if (opt) {
256201da799SBarry Smith     TSMonitorLGCtx ctx;
257201da799SBarry Smith     PetscInt       howoften = 1;
258201da799SBarry Smith 
2590298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2606ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
261201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
262201da799SBarry Smith   }
263201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
264201da799SBarry Smith   if (opt) {
265201da799SBarry Smith     TSMonitorLGCtx ctx;
266201da799SBarry Smith     PetscInt       howoften = 1;
267201da799SBarry Smith 
2680298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2696ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
270201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
271201da799SBarry Smith   }
2728189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
2738189c53fSBarry Smith   if (opt) {
2748189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2758189c53fSBarry Smith     PetscInt          howoften = 1;
2768189c53fSBarry Smith 
2770298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
2786934998bSLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2798189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
2808189c53fSBarry Smith   }
281ef20d060SBarry Smith   opt  = PETSC_FALSE;
2820dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
283a7cc72afSBarry Smith   if (opt) {
28483a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
28583a4ac43SBarry Smith     PetscInt         howoften = 1;
286a80ad3e0SBarry Smith 
2870298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
2886934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
28983a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
290bdad233fSMatthew Knepley   }
291fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2929110b2e7SHong Zhang   ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr);
2939110b2e7SHong Zhang   if (opt) {
2949110b2e7SHong Zhang     TSMonitorDrawCtx ctx;
2959110b2e7SHong Zhang     PetscInt         howoften = 1;
2969110b2e7SHong Zhang 
2979110b2e7SHong Zhang     ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr);
2986934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2999110b2e7SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3009110b2e7SHong Zhang   }
3019110b2e7SHong Zhang   opt  = PETSC_FALSE;
3022d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
3032d5ee99bSBarry Smith   if (opt) {
3042d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
3052d5ee99bSBarry Smith     PetscReal        bounds[4];
3062d5ee99bSBarry Smith     PetscInt         n = 4;
3072d5ee99bSBarry Smith     PetscDraw        draw;
3086934998bSLisandro Dalcin     PetscDrawAxis    axis;
3092d5ee99bSBarry Smith 
3102d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
3112d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
3126934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr);
3132d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
3146934998bSLisandro Dalcin     ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr);
3156934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
3166934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
3172d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3182d5ee99bSBarry Smith   }
3192d5ee99bSBarry Smith   opt  = PETSC_FALSE;
3200dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
3213a471f94SBarry Smith   if (opt) {
32283a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
32383a4ac43SBarry Smith     PetscInt         howoften = 1;
3243a471f94SBarry Smith 
3250298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
3266934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
32783a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3283a471f94SBarry Smith   }
329fde5950dSBarry Smith 
330ed81e22dSJed Brown   opt  = PETSC_FALSE;
33191b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
332ed81e22dSJed Brown   if (flg) {
333ed81e22dSJed Brown     const char *ptr,*ptr2;
334ed81e22dSJed Brown     char       *filetemplate;
335ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
336ed81e22dSJed Brown     /* Do some cursory validation of the input. */
337ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
338ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
339ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
340ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
341ce94432eSBarry Smith       if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03D.vts");
342ed81e22dSJed Brown       if (ptr2) break;
343ed81e22dSJed Brown     }
344ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
345ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
346ed81e22dSJed Brown   }
347bdad233fSMatthew Knepley 
348d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
349d1212d36SBarry Smith   if (flg) {
350d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
351d1212d36SBarry Smith     int                  ray = 0;
352d1212d36SBarry Smith     DMDADirection        ddir;
353d1212d36SBarry Smith     DM                   da;
354d1212d36SBarry Smith     PetscMPIInt          rank;
355d1212d36SBarry Smith 
356ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
357d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
358d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
359ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
360d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
361d1212d36SBarry Smith 
362d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
363b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
364d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
365d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
366ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
367d1212d36SBarry Smith     if (!rank) {
368d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
369d1212d36SBarry Smith     }
37051b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
371d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
372d1212d36SBarry Smith   }
37351b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
37451b4a12fSMatthew G. Knepley   if (flg) {
37551b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
37651b4a12fSMatthew G. Knepley     int                 ray = 0;
37751b4a12fSMatthew G. Knepley     DMDADirection       ddir;
37851b4a12fSMatthew G. Knepley     DM                  da;
37951b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
380d1212d36SBarry Smith 
38151b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
38251b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
38351b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
38451b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
38551b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3861c3436cfSJed Brown 
38751b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
388b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
38951b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
39051b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
39151b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
39251b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
39351b4a12fSMatthew G. Knepley   }
394a7a1495cSBarry Smith 
395b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
396b3d3934dSBarry Smith   if (opt) {
397b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
398b3d3934dSBarry Smith 
399b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
400b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
401b3d3934dSBarry Smith   }
402b3d3934dSBarry Smith 
403847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
404847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
405847ff0e1SMatthew G. Knepley   if (flg) {
406847ff0e1SMatthew G. Knepley     DM   dm;
407847ff0e1SMatthew G. Knepley     DMTS tdm;
408847ff0e1SMatthew G. Knepley 
409847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
410847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
411847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
412847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
413847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
414847ff0e1SMatthew G. Knepley   }
415847ff0e1SMatthew G. Knepley 
416ee346746SBarry Smith   if (ts->adapt) {
417ee346746SBarry Smith     ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr);
418ee346746SBarry Smith   }
419d763cef2SBarry Smith 
420d763cef2SBarry Smith   /* Handle specific TS options */
421d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
4226991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
423d763cef2SBarry Smith   }
424fbc52257SHong Zhang 
42568bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
4264f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
42768bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
42868bece0bSHong Zhang   if (tflg) {
42968bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
43068bece0bSHong Zhang   }
4314f122a70SLisandro Dalcin   tflg = ts->adjoint_solve ? PETSC_TRUE : PETSC_FALSE;
43268bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
43368bece0bSHong Zhang   if (flg) {
43468bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
43568bece0bSHong Zhang     ts->adjoint_solve = tflg;
43668bece0bSHong Zhang   }
437d763cef2SBarry Smith 
438d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
4390633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
440fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
441d763cef2SBarry Smith 
4424f122a70SLisandro Dalcin   if (ts->trajectory) {
4434f122a70SLisandro Dalcin     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
444d763cef2SBarry Smith   }
44568bece0bSHong Zhang 
4464f122a70SLisandro Dalcin   ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr);
4474f122a70SLisandro Dalcin   if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);}
4484f122a70SLisandro Dalcin   ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
449d763cef2SBarry Smith   PetscFunctionReturn(0);
450d763cef2SBarry Smith }
451d763cef2SBarry Smith 
452d763cef2SBarry Smith #undef __FUNCT__
453bc952696SBarry Smith #define __FUNCT__ "TSSetSaveTrajectory"
454d2daff3dSHong Zhang /*@
455bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
456d2daff3dSHong Zhang 
457d2daff3dSHong Zhang    Collective on TS
458d2daff3dSHong Zhang 
459d2daff3dSHong Zhang    Input Parameters:
460bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
461bc952696SBarry Smith 
46268bece0bSHong Zhang Note: This routine should be called after all TS options have been set
463d2daff3dSHong Zhang 
464d2daff3dSHong Zhang    Level: intermediate
465d2daff3dSHong Zhang 
466bc952696SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve()
467d2daff3dSHong Zhang 
468bc952696SBarry Smith .keywords: TS, set, checkpoint,
469d2daff3dSHong Zhang @*/
470bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
471d2daff3dSHong Zhang {
472bc952696SBarry Smith   PetscErrorCode ierr;
473bc952696SBarry Smith 
474d2daff3dSHong Zhang   PetscFunctionBegin;
475d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
476bc952696SBarry Smith   if (!ts->trajectory) {
477bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
478972caf09SHong Zhang     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
479bc952696SBarry Smith   }
480d2daff3dSHong Zhang   PetscFunctionReturn(0);
481d2daff3dSHong Zhang }
482d2daff3dSHong Zhang 
483a7a1495cSBarry Smith #undef __FUNCT__
484a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
485a7a1495cSBarry Smith /*@
486a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
487a7a1495cSBarry Smith       set with TSSetRHSJacobian().
488a7a1495cSBarry Smith 
489a7a1495cSBarry Smith    Collective on TS and Vec
490a7a1495cSBarry Smith 
491a7a1495cSBarry Smith    Input Parameters:
492316643e7SJed Brown +  ts - the TS context
493a7a1495cSBarry Smith .  t - current timestep
4940910c330SBarry Smith -  U - input vector
495a7a1495cSBarry Smith 
496a7a1495cSBarry Smith    Output Parameters:
497a7a1495cSBarry Smith +  A - Jacobian matrix
498a7a1495cSBarry Smith .  B - optional preconditioning matrix
499a7a1495cSBarry Smith -  flag - flag indicating matrix structure
500a7a1495cSBarry Smith 
501a7a1495cSBarry Smith    Notes:
502a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
503a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
504a7a1495cSBarry Smith 
50594b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
506a7a1495cSBarry Smith    flag parameter.
507a7a1495cSBarry Smith 
508a7a1495cSBarry Smith    Level: developer
509a7a1495cSBarry Smith 
510a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
511a7a1495cSBarry Smith 
51294b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
513a7a1495cSBarry Smith @*/
514d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
515a7a1495cSBarry Smith {
516dfbe8321SBarry Smith   PetscErrorCode ierr;
517270bf2e7SJed Brown   PetscObjectState Ustate;
51824989b8cSPeter Brune   DM             dm;
519942e3340SBarry Smith   DMTS           tsdm;
52024989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
52124989b8cSPeter Brune   void           *ctx;
52224989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
523b2df71adSDebojyoti Ghosh   TSRHSFunction  rhsfunction;
524a7a1495cSBarry Smith 
525a7a1495cSBarry Smith   PetscFunctionBegin;
5260700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5270910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5280910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
52924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
530942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
53124989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
5320298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
533b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
53459e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
535b2df71adSDebojyoti Ghosh   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
5360e4ef248SJed Brown     PetscFunctionReturn(0);
537f8ede8e7SJed Brown   }
538d90be118SSean Farley 
539ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
540d90be118SSean Farley 
541e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
54294ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
54394ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
54494ab13aaSBarry Smith     if (A != B) {
54594ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
54694ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
547e1244c69SJed Brown     }
548e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
549e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
550e1244c69SJed Brown   }
551e1244c69SJed Brown 
55224989b8cSPeter Brune   if (rhsjacobianfunc) {
5536cd88445SBarry Smith     PetscBool missing;
55494ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
555a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
556d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
557a7a1495cSBarry Smith     PetscStackPop;
55894ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
5596cd88445SBarry Smith     if (A) {
5606cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
5616cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
5626cd88445SBarry Smith     }
5636cd88445SBarry Smith     if (B && B != A) {
5646cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
5656cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
5666cd88445SBarry Smith     }
567ef66eb69SBarry Smith   } else {
56894ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
56994ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
570ef66eb69SBarry Smith   }
5710e4ef248SJed Brown   ts->rhsjacobian.time       = t;
5720910c330SBarry Smith   ts->rhsjacobian.X          = U;
57359e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
574a7a1495cSBarry Smith   PetscFunctionReturn(0);
575a7a1495cSBarry Smith }
576a7a1495cSBarry Smith 
5774a2ae208SSatish Balay #undef __FUNCT__
5784a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
579316643e7SJed Brown /*@
580d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
581d763cef2SBarry Smith 
582316643e7SJed Brown    Collective on TS and Vec
583316643e7SJed Brown 
584316643e7SJed Brown    Input Parameters:
585316643e7SJed Brown +  ts - the TS context
586316643e7SJed Brown .  t - current time
5870910c330SBarry Smith -  U - state vector
588316643e7SJed Brown 
589316643e7SJed Brown    Output Parameter:
590316643e7SJed Brown .  y - right hand side
591316643e7SJed Brown 
592316643e7SJed Brown    Note:
593316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
594316643e7SJed Brown    is used internally within the nonlinear solvers.
595316643e7SJed Brown 
596316643e7SJed Brown    Level: developer
597316643e7SJed Brown 
598316643e7SJed Brown .keywords: TS, compute
599316643e7SJed Brown 
600316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
601316643e7SJed Brown @*/
6020910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
603d763cef2SBarry Smith {
604dfbe8321SBarry Smith   PetscErrorCode ierr;
60524989b8cSPeter Brune   TSRHSFunction  rhsfunction;
60624989b8cSPeter Brune   TSIFunction    ifunction;
60724989b8cSPeter Brune   void           *ctx;
60824989b8cSPeter Brune   DM             dm;
60924989b8cSPeter Brune 
610d763cef2SBarry Smith   PetscFunctionBegin;
6110700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6120910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6130700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
61424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
61524989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
6160298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
617d763cef2SBarry Smith 
618ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
619d763cef2SBarry Smith 
6200910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
62124989b8cSPeter Brune   if (rhsfunction) {
622d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
6230910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
624d763cef2SBarry Smith     PetscStackPop;
625214bc6a2SJed Brown   } else {
626214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
627b2cd27e8SJed Brown   }
62844a41b28SSean Farley 
6290910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
630d763cef2SBarry Smith   PetscFunctionReturn(0);
631d763cef2SBarry Smith }
632d763cef2SBarry Smith 
6334a2ae208SSatish Balay #undef __FUNCT__
634ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
635ef20d060SBarry Smith /*@
636ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
637ef20d060SBarry Smith 
638ef20d060SBarry Smith    Collective on TS and Vec
639ef20d060SBarry Smith 
640ef20d060SBarry Smith    Input Parameters:
641ef20d060SBarry Smith +  ts - the TS context
642ef20d060SBarry Smith -  t - current time
643ef20d060SBarry Smith 
644ef20d060SBarry Smith    Output Parameter:
6450910c330SBarry Smith .  U - the solution
646ef20d060SBarry Smith 
647ef20d060SBarry Smith    Note:
648ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
649ef20d060SBarry Smith    is used internally within the nonlinear solvers.
650ef20d060SBarry Smith 
651ef20d060SBarry Smith    Level: developer
652ef20d060SBarry Smith 
653ef20d060SBarry Smith .keywords: TS, compute
654ef20d060SBarry Smith 
655abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
656ef20d060SBarry Smith @*/
6570910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
658ef20d060SBarry Smith {
659ef20d060SBarry Smith   PetscErrorCode     ierr;
660ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
661ef20d060SBarry Smith   void               *ctx;
662ef20d060SBarry Smith   DM                 dm;
663ef20d060SBarry Smith 
664ef20d060SBarry Smith   PetscFunctionBegin;
665ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6660910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
667ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
668ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
669ef20d060SBarry Smith 
670ef20d060SBarry Smith   if (solutionfunction) {
6719b7cd975SBarry Smith     PetscStackPush("TS user solution function");
6720910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
673ef20d060SBarry Smith     PetscStackPop;
674ef20d060SBarry Smith   }
675ef20d060SBarry Smith   PetscFunctionReturn(0);
676ef20d060SBarry Smith }
6779b7cd975SBarry Smith #undef __FUNCT__
6789b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
6799b7cd975SBarry Smith /*@
6809b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
6819b7cd975SBarry Smith 
6829b7cd975SBarry Smith    Collective on TS and Vec
6839b7cd975SBarry Smith 
6849b7cd975SBarry Smith    Input Parameters:
6859b7cd975SBarry Smith +  ts - the TS context
6869b7cd975SBarry Smith -  t - current time
6879b7cd975SBarry Smith 
6889b7cd975SBarry Smith    Output Parameter:
6899b7cd975SBarry Smith .  U - the function value
6909b7cd975SBarry Smith 
6919b7cd975SBarry Smith    Note:
6929b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
6939b7cd975SBarry Smith    is used internally within the nonlinear solvers.
6949b7cd975SBarry Smith 
6959b7cd975SBarry Smith    Level: developer
6969b7cd975SBarry Smith 
6979b7cd975SBarry Smith .keywords: TS, compute
6989b7cd975SBarry Smith 
6999b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7009b7cd975SBarry Smith @*/
7019b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7029b7cd975SBarry Smith {
7039b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7049b7cd975SBarry Smith   void               *ctx;
7059b7cd975SBarry Smith   DM                 dm;
7069b7cd975SBarry Smith 
7079b7cd975SBarry Smith   PetscFunctionBegin;
7089b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7099b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7109b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7119b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7129b7cd975SBarry Smith 
7139b7cd975SBarry Smith   if (forcing) {
7149b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
7159b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
7169b7cd975SBarry Smith     PetscStackPop;
7179b7cd975SBarry Smith   }
7189b7cd975SBarry Smith   PetscFunctionReturn(0);
7199b7cd975SBarry Smith }
720ef20d060SBarry Smith 
721ef20d060SBarry Smith #undef __FUNCT__
722214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
723214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
724214bc6a2SJed Brown {
7252dd45cf8SJed Brown   Vec            F;
726214bc6a2SJed Brown   PetscErrorCode ierr;
727214bc6a2SJed Brown 
728214bc6a2SJed Brown   PetscFunctionBegin;
7290298fd71SBarry Smith   *Frhs = NULL;
7300298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
731214bc6a2SJed Brown   if (!ts->Frhs) {
7322dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
733214bc6a2SJed Brown   }
734214bc6a2SJed Brown   *Frhs = ts->Frhs;
735214bc6a2SJed Brown   PetscFunctionReturn(0);
736214bc6a2SJed Brown }
737214bc6a2SJed Brown 
738214bc6a2SJed Brown #undef __FUNCT__
739214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
740214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
741214bc6a2SJed Brown {
742214bc6a2SJed Brown   Mat            A,B;
7432dd45cf8SJed Brown   PetscErrorCode ierr;
744214bc6a2SJed Brown 
745214bc6a2SJed Brown   PetscFunctionBegin;
746c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
747c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
7480298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
749214bc6a2SJed Brown   if (Arhs) {
750214bc6a2SJed Brown     if (!ts->Arhs) {
751214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
752214bc6a2SJed Brown     }
753214bc6a2SJed Brown     *Arhs = ts->Arhs;
754214bc6a2SJed Brown   }
755214bc6a2SJed Brown   if (Brhs) {
756214bc6a2SJed Brown     if (!ts->Brhs) {
757bdb70873SJed Brown       if (A != B) {
758214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
759bdb70873SJed Brown       } else {
760bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
76151699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
762bdb70873SJed Brown       }
763214bc6a2SJed Brown     }
764214bc6a2SJed Brown     *Brhs = ts->Brhs;
765214bc6a2SJed Brown   }
766214bc6a2SJed Brown   PetscFunctionReturn(0);
767214bc6a2SJed Brown }
768214bc6a2SJed Brown 
769214bc6a2SJed Brown #undef __FUNCT__
770316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
771316643e7SJed Brown /*@
7720910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
773316643e7SJed Brown 
774316643e7SJed Brown    Collective on TS and Vec
775316643e7SJed Brown 
776316643e7SJed Brown    Input Parameters:
777316643e7SJed Brown +  ts - the TS context
778316643e7SJed Brown .  t - current time
7790910c330SBarry Smith .  U - state vector
7800910c330SBarry Smith .  Udot - time derivative of state vector
781214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
782316643e7SJed Brown 
783316643e7SJed Brown    Output Parameter:
784316643e7SJed Brown .  Y - right hand side
785316643e7SJed Brown 
786316643e7SJed Brown    Note:
787316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
788316643e7SJed Brown    is used internally within the nonlinear solvers.
789316643e7SJed Brown 
790316643e7SJed Brown    If the user did did not write their equations in implicit form, this
791316643e7SJed Brown    function recasts them in implicit form.
792316643e7SJed Brown 
793316643e7SJed Brown    Level: developer
794316643e7SJed Brown 
795316643e7SJed Brown .keywords: TS, compute
796316643e7SJed Brown 
797316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
798316643e7SJed Brown @*/
7990910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
800316643e7SJed Brown {
801316643e7SJed Brown   PetscErrorCode ierr;
80224989b8cSPeter Brune   TSIFunction    ifunction;
80324989b8cSPeter Brune   TSRHSFunction  rhsfunction;
80424989b8cSPeter Brune   void           *ctx;
80524989b8cSPeter Brune   DM             dm;
806316643e7SJed Brown 
807316643e7SJed Brown   PetscFunctionBegin;
8080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8090910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8100910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
8110700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
812316643e7SJed Brown 
81324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
81424989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
8150298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
81624989b8cSPeter Brune 
817ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
818d90be118SSean Farley 
8190910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
82024989b8cSPeter Brune   if (ifunction) {
821316643e7SJed Brown     PetscStackPush("TS user implicit function");
8220910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
823316643e7SJed Brown     PetscStackPop;
824214bc6a2SJed Brown   }
825214bc6a2SJed Brown   if (imex) {
82624989b8cSPeter Brune     if (!ifunction) {
8270910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
8282dd45cf8SJed Brown     }
82924989b8cSPeter Brune   } else if (rhsfunction) {
83024989b8cSPeter Brune     if (ifunction) {
831214bc6a2SJed Brown       Vec Frhs;
832214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
8330910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
834214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
8352dd45cf8SJed Brown     } else {
8360910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
8370910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
838316643e7SJed Brown     }
8394a6899ffSJed Brown   }
8400910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
841316643e7SJed Brown   PetscFunctionReturn(0);
842316643e7SJed Brown }
843316643e7SJed Brown 
844316643e7SJed Brown #undef __FUNCT__
845316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
846316643e7SJed Brown /*@
847316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
848316643e7SJed Brown 
849316643e7SJed Brown    Collective on TS and Vec
850316643e7SJed Brown 
851316643e7SJed Brown    Input
852316643e7SJed Brown       Input Parameters:
853316643e7SJed Brown +  ts - the TS context
854316643e7SJed Brown .  t - current timestep
8550910c330SBarry Smith .  U - state vector
8560910c330SBarry Smith .  Udot - time derivative of state vector
857214bc6a2SJed Brown .  shift - shift to apply, see note below
858214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
859316643e7SJed Brown 
860316643e7SJed Brown    Output Parameters:
861316643e7SJed Brown +  A - Jacobian matrix
862316643e7SJed Brown .  B - optional preconditioning matrix
863316643e7SJed Brown -  flag - flag indicating matrix structure
864316643e7SJed Brown 
865316643e7SJed Brown    Notes:
8660910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
867316643e7SJed Brown 
8680910c330SBarry Smith    dF/dU + shift*dF/dUdot
869316643e7SJed Brown 
870316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
871316643e7SJed Brown    is used internally within the nonlinear solvers.
872316643e7SJed Brown 
873316643e7SJed Brown    Level: developer
874316643e7SJed Brown 
875316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
876316643e7SJed Brown 
877316643e7SJed Brown .seealso:  TSSetIJacobian()
87863495f91SJed Brown @*/
879d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
880316643e7SJed Brown {
881316643e7SJed Brown   PetscErrorCode ierr;
88224989b8cSPeter Brune   TSIJacobian    ijacobian;
88324989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
88424989b8cSPeter Brune   DM             dm;
88524989b8cSPeter Brune   void           *ctx;
886316643e7SJed Brown 
887316643e7SJed Brown   PetscFunctionBegin;
8880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8890910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8900910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
891316643e7SJed Brown   PetscValidPointer(A,6);
89294ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
893316643e7SJed Brown   PetscValidPointer(B,7);
89494ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
89524989b8cSPeter Brune 
89624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
89724989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
8980298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
89924989b8cSPeter Brune 
900ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
901316643e7SJed Brown 
90294ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
90324989b8cSPeter Brune   if (ijacobian) {
9046cd88445SBarry Smith     PetscBool missing;
905316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
906d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
907316643e7SJed Brown     PetscStackPop;
9086cd88445SBarry Smith     if (A) {
9096cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
9106cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
9116cd88445SBarry Smith     }
9126cd88445SBarry Smith     if (B && B != A) {
9136cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
9146cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
9156cd88445SBarry Smith     }
9164a6899ffSJed Brown   }
917214bc6a2SJed Brown   if (imex) {
918b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
91994ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
92094ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
92194ab13aaSBarry Smith       if (A != B) {
92294ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
92394ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
924214bc6a2SJed Brown       }
925214bc6a2SJed Brown     }
926214bc6a2SJed Brown   } else {
927e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
928e1244c69SJed Brown     if (rhsjacobian) {
929214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
930d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
931e1244c69SJed Brown     }
93294ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
933e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
934e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
93594ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
93694ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
93794ab13aaSBarry Smith       if (A != B) {
93894ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
93994ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
940316643e7SJed Brown       }
941e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
942e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
943e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
94494ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
94594ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
94694ab13aaSBarry Smith         if (A != B) {
94794ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
94894ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
949214bc6a2SJed Brown         }
950316643e7SJed Brown       }
95194ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
95294ab13aaSBarry Smith       if (A != B) {
95394ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
954316643e7SJed Brown       }
955316643e7SJed Brown     }
956316643e7SJed Brown   }
95794ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
958316643e7SJed Brown   PetscFunctionReturn(0);
959316643e7SJed Brown }
960316643e7SJed Brown 
961316643e7SJed Brown #undef __FUNCT__
9624a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
963d763cef2SBarry Smith /*@C
964d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
965b5abc632SBarry Smith     where U_t = G(t,u).
966d763cef2SBarry Smith 
9673f9fe445SBarry Smith     Logically Collective on TS
968d763cef2SBarry Smith 
969d763cef2SBarry Smith     Input Parameters:
970d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
9710298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
972d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
973d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
9740298fd71SBarry Smith           function evaluation routine (may be NULL)
975d763cef2SBarry Smith 
976d763cef2SBarry Smith     Calling sequence of func:
97787828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
978d763cef2SBarry Smith 
979d763cef2SBarry Smith +   t - current timestep
980d763cef2SBarry Smith .   u - input vector
981d763cef2SBarry Smith .   F - function vector
982d763cef2SBarry Smith -   ctx - [optional] user-defined function context
983d763cef2SBarry Smith 
984d763cef2SBarry Smith     Level: beginner
985d763cef2SBarry Smith 
9862bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
9872bbac0d3SBarry Smith 
988d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
989d763cef2SBarry Smith 
990ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
991d763cef2SBarry Smith @*/
992089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
993d763cef2SBarry Smith {
994089b2837SJed Brown   PetscErrorCode ierr;
995089b2837SJed Brown   SNES           snes;
9960298fd71SBarry Smith   Vec            ralloc = NULL;
99724989b8cSPeter Brune   DM             dm;
998d763cef2SBarry Smith 
999089b2837SJed Brown   PetscFunctionBegin;
10000700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1001ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
100224989b8cSPeter Brune 
100324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
100424989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1005089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1006e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1007e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1008e856ceecSJed Brown     r = ralloc;
1009e856ceecSJed Brown   }
1010089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1011e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1012d763cef2SBarry Smith   PetscFunctionReturn(0);
1013d763cef2SBarry Smith }
1014d763cef2SBarry Smith 
10154a2ae208SSatish Balay #undef __FUNCT__
1016ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
1017ef20d060SBarry Smith /*@C
1018abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1019ef20d060SBarry Smith 
1020ef20d060SBarry Smith     Logically Collective on TS
1021ef20d060SBarry Smith 
1022ef20d060SBarry Smith     Input Parameters:
1023ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1024ef20d060SBarry Smith .   f - routine for evaluating the solution
1025ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
10260298fd71SBarry Smith           function evaluation routine (may be NULL)
1027ef20d060SBarry Smith 
1028ef20d060SBarry Smith     Calling sequence of func:
1029ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
1030ef20d060SBarry Smith 
1031ef20d060SBarry Smith +   t - current timestep
1032ef20d060SBarry Smith .   u - output vector
1033ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1034ef20d060SBarry Smith 
1035abd5a294SJed Brown     Notes:
1036abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1037abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1038abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1039abd5a294SJed Brown 
10404f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1041abd5a294SJed Brown 
1042ef20d060SBarry Smith     Level: beginner
1043ef20d060SBarry Smith 
1044ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1045ef20d060SBarry Smith 
10469b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
1047ef20d060SBarry Smith @*/
1048ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1049ef20d060SBarry Smith {
1050ef20d060SBarry Smith   PetscErrorCode ierr;
1051ef20d060SBarry Smith   DM             dm;
1052ef20d060SBarry Smith 
1053ef20d060SBarry Smith   PetscFunctionBegin;
1054ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1055ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1056ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1057ef20d060SBarry Smith   PetscFunctionReturn(0);
1058ef20d060SBarry Smith }
1059ef20d060SBarry Smith 
1060ef20d060SBarry Smith #undef __FUNCT__
10619b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
10629b7cd975SBarry Smith /*@C
10639b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
10649b7cd975SBarry Smith 
10659b7cd975SBarry Smith     Logically Collective on TS
10669b7cd975SBarry Smith 
10679b7cd975SBarry Smith     Input Parameters:
10689b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
10699b7cd975SBarry Smith .   f - routine for evaluating the forcing function
10709b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
10710298fd71SBarry Smith           function evaluation routine (may be NULL)
10729b7cd975SBarry Smith 
10739b7cd975SBarry Smith     Calling sequence of func:
10749b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
10759b7cd975SBarry Smith 
10769b7cd975SBarry Smith +   t - current timestep
10779b7cd975SBarry Smith .   u - output vector
10789b7cd975SBarry Smith -   ctx - [optional] user-defined function context
10799b7cd975SBarry Smith 
10809b7cd975SBarry Smith     Notes:
10819b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
10829b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
10839b7cd975SBarry Smith 
10849b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
10859b7cd975SBarry Smith 
10869b7cd975SBarry Smith     Level: beginner
10879b7cd975SBarry Smith 
10889b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
10899b7cd975SBarry Smith 
10909b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
10919b7cd975SBarry Smith @*/
1092d56366bfSLisandro Dalcin PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction f,void *ctx)
10939b7cd975SBarry Smith {
10949b7cd975SBarry Smith   PetscErrorCode ierr;
10959b7cd975SBarry Smith   DM             dm;
10969b7cd975SBarry Smith 
10979b7cd975SBarry Smith   PetscFunctionBegin;
10989b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10999b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
11009b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
11019b7cd975SBarry Smith   PetscFunctionReturn(0);
11029b7cd975SBarry Smith }
11039b7cd975SBarry Smith 
11049b7cd975SBarry Smith #undef __FUNCT__
11054a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
1106d763cef2SBarry Smith /*@C
1107f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1108b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1109d763cef2SBarry Smith 
11103f9fe445SBarry Smith    Logically Collective on TS
1111d763cef2SBarry Smith 
1112d763cef2SBarry Smith    Input Parameters:
1113d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1114e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1115e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1116d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1117d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
11180298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1119d763cef2SBarry Smith 
1120f7ab8db6SBarry Smith    Calling sequence of f:
1121ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1122d763cef2SBarry Smith 
1123d763cef2SBarry Smith +  t - current timestep
1124d763cef2SBarry Smith .  u - input vector
1125e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1126e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1127d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1128d763cef2SBarry Smith 
11296cd88445SBarry Smith    Notes:
11306cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
11316cd88445SBarry Smith 
11326cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1133ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1134d763cef2SBarry Smith 
1135d763cef2SBarry Smith    Level: beginner
1136d763cef2SBarry Smith 
1137d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1138d763cef2SBarry Smith 
1139ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1140d763cef2SBarry Smith 
1141d763cef2SBarry Smith @*/
1142e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1143d763cef2SBarry Smith {
1144277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1145089b2837SJed Brown   SNES           snes;
114624989b8cSPeter Brune   DM             dm;
114724989b8cSPeter Brune   TSIJacobian    ijacobian;
1148277b19d0SLisandro Dalcin 
1149d763cef2SBarry Smith   PetscFunctionBegin;
11500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1151e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1152e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1153e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1154e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1155d763cef2SBarry Smith 
115624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
115724989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1158e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1159e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1160e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1161e1244c69SJed Brown   }
11620298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1163089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11645f659677SPeter Brune   if (!ijacobian) {
1165e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
11660e4ef248SJed Brown   }
1167e5d3d808SBarry Smith   if (Amat) {
1168e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
11690e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1170e5d3d808SBarry Smith     ts->Arhs = Amat;
11710e4ef248SJed Brown   }
1172e5d3d808SBarry Smith   if (Pmat) {
1173e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
11740e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1175e5d3d808SBarry Smith     ts->Brhs = Pmat;
11760e4ef248SJed Brown   }
1177d763cef2SBarry Smith   PetscFunctionReturn(0);
1178d763cef2SBarry Smith }
1179d763cef2SBarry Smith 
1180316643e7SJed Brown 
1181316643e7SJed Brown #undef __FUNCT__
1182316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1183316643e7SJed Brown /*@C
1184b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1185316643e7SJed Brown 
11863f9fe445SBarry Smith    Logically Collective on TS
1187316643e7SJed Brown 
1188316643e7SJed Brown    Input Parameters:
1189316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
11900298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1191316643e7SJed Brown .  f   - the function evaluation routine
11920298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1193316643e7SJed Brown 
1194316643e7SJed Brown    Calling sequence of f:
1195316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1196316643e7SJed Brown 
1197316643e7SJed Brown +  t   - time at step/stage being solved
1198316643e7SJed Brown .  u   - state vector
1199316643e7SJed Brown .  u_t - time derivative of state vector
1200316643e7SJed Brown .  F   - function vector
1201316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1202316643e7SJed Brown 
1203316643e7SJed Brown    Important:
12042bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1205316643e7SJed Brown 
1206316643e7SJed Brown    Level: beginner
1207316643e7SJed Brown 
1208316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1209316643e7SJed Brown 
1210d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1211316643e7SJed Brown @*/
121251699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1213316643e7SJed Brown {
1214089b2837SJed Brown   PetscErrorCode ierr;
1215089b2837SJed Brown   SNES           snes;
121651699248SLisandro Dalcin   Vec            ralloc = NULL;
121724989b8cSPeter Brune   DM             dm;
1218316643e7SJed Brown 
1219316643e7SJed Brown   PetscFunctionBegin;
12200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
122151699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
122224989b8cSPeter Brune 
122324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
122424989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
122524989b8cSPeter Brune 
1226089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
122751699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
122851699248SLisandro Dalcin     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
122951699248SLisandro Dalcin     r  = ralloc;
1230e856ceecSJed Brown   }
123151699248SLisandro Dalcin   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
123251699248SLisandro Dalcin   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1233089b2837SJed Brown   PetscFunctionReturn(0);
1234089b2837SJed Brown }
1235089b2837SJed Brown 
1236089b2837SJed Brown #undef __FUNCT__
1237089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1238089b2837SJed Brown /*@C
1239089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1240089b2837SJed Brown 
1241089b2837SJed Brown    Not Collective
1242089b2837SJed Brown 
1243089b2837SJed Brown    Input Parameter:
1244089b2837SJed Brown .  ts - the TS context
1245089b2837SJed Brown 
1246089b2837SJed Brown    Output Parameter:
12470298fd71SBarry Smith +  r - vector to hold residual (or NULL)
12480298fd71SBarry Smith .  func - the function to compute residual (or NULL)
12490298fd71SBarry Smith -  ctx - the function context (or NULL)
1250089b2837SJed Brown 
1251089b2837SJed Brown    Level: advanced
1252089b2837SJed Brown 
1253089b2837SJed Brown .keywords: TS, nonlinear, get, function
1254089b2837SJed Brown 
1255089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1256089b2837SJed Brown @*/
1257089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1258089b2837SJed Brown {
1259089b2837SJed Brown   PetscErrorCode ierr;
1260089b2837SJed Brown   SNES           snes;
126124989b8cSPeter Brune   DM             dm;
1262089b2837SJed Brown 
1263089b2837SJed Brown   PetscFunctionBegin;
1264089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1265089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12660298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
126724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
126824989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1269089b2837SJed Brown   PetscFunctionReturn(0);
1270089b2837SJed Brown }
1271089b2837SJed Brown 
1272089b2837SJed Brown #undef __FUNCT__
1273089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1274089b2837SJed Brown /*@C
1275089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1276089b2837SJed Brown 
1277089b2837SJed Brown    Not Collective
1278089b2837SJed Brown 
1279089b2837SJed Brown    Input Parameter:
1280089b2837SJed Brown .  ts - the TS context
1281089b2837SJed Brown 
1282089b2837SJed Brown    Output Parameter:
12830298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
12840298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
12850298fd71SBarry Smith -  ctx - the function context (or NULL)
1286089b2837SJed Brown 
1287089b2837SJed Brown    Level: advanced
1288089b2837SJed Brown 
1289089b2837SJed Brown .keywords: TS, nonlinear, get, function
1290089b2837SJed Brown 
12912bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1292089b2837SJed Brown @*/
1293089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1294089b2837SJed Brown {
1295089b2837SJed Brown   PetscErrorCode ierr;
1296089b2837SJed Brown   SNES           snes;
129724989b8cSPeter Brune   DM             dm;
1298089b2837SJed Brown 
1299089b2837SJed Brown   PetscFunctionBegin;
1300089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1301089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13020298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
130324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
130424989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1305316643e7SJed Brown   PetscFunctionReturn(0);
1306316643e7SJed Brown }
1307316643e7SJed Brown 
1308316643e7SJed Brown #undef __FUNCT__
1309316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1310316643e7SJed Brown /*@C
1311a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1312ae8867d6SBarry Smith         provided with TSSetIFunction().
1313316643e7SJed Brown 
13143f9fe445SBarry Smith    Logically Collective on TS
1315316643e7SJed Brown 
1316316643e7SJed Brown    Input Parameters:
1317316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1318e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1319e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1320316643e7SJed Brown .  f   - the Jacobian evaluation routine
13210298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1322316643e7SJed Brown 
1323316643e7SJed Brown    Calling sequence of f:
1324ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1325316643e7SJed Brown 
1326316643e7SJed Brown +  t    - time at step/stage being solved
13271b4a444bSJed Brown .  U    - state vector
13281b4a444bSJed Brown .  U_t  - time derivative of state vector
1329316643e7SJed Brown .  a    - shift
1330e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1331e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1332316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1333316643e7SJed Brown 
1334316643e7SJed Brown    Notes:
1335e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1336316643e7SJed Brown 
1337895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1338895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1339895c21f2SBarry Smith 
1340a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1341b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1342a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1343a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1344a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1345a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1346a4f0a591SBarry Smith 
13476cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
13486cd88445SBarry Smith 
13496cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1350ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1351ca5f011dSBarry Smith 
1352316643e7SJed Brown    Level: beginner
1353316643e7SJed Brown 
1354316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1355316643e7SJed Brown 
1356ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1357316643e7SJed Brown 
1358316643e7SJed Brown @*/
1359e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1360316643e7SJed Brown {
1361316643e7SJed Brown   PetscErrorCode ierr;
1362089b2837SJed Brown   SNES           snes;
136324989b8cSPeter Brune   DM             dm;
1364316643e7SJed Brown 
1365316643e7SJed Brown   PetscFunctionBegin;
13660700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1367e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1368e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1369e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1370e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
137124989b8cSPeter Brune 
137224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
137324989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
137424989b8cSPeter Brune 
1375089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1376e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1377316643e7SJed Brown   PetscFunctionReturn(0);
1378316643e7SJed Brown }
1379316643e7SJed Brown 
13804a2ae208SSatish Balay #undef __FUNCT__
1381e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1382e1244c69SJed Brown /*@
1383e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1384e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1385e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1386e1244c69SJed Brown    not been changed by the TS.
1387e1244c69SJed Brown 
1388e1244c69SJed Brown    Logically Collective
1389e1244c69SJed Brown 
1390e1244c69SJed Brown    Input Arguments:
1391e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1392e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1393e1244c69SJed Brown 
1394e1244c69SJed Brown    Level: intermediate
1395e1244c69SJed Brown 
1396e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1397e1244c69SJed Brown @*/
1398e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1399e1244c69SJed Brown {
1400e1244c69SJed Brown   PetscFunctionBegin;
1401e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1402e1244c69SJed Brown   PetscFunctionReturn(0);
1403e1244c69SJed Brown }
1404e1244c69SJed Brown 
1405e1244c69SJed Brown #undef __FUNCT__
1406efe9872eSLisandro Dalcin #define __FUNCT__ "TSSetI2Function"
1407efe9872eSLisandro Dalcin /*@C
1408efe9872eSLisandro Dalcin    TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1409efe9872eSLisandro Dalcin 
1410efe9872eSLisandro Dalcin    Logically Collective on TS
1411efe9872eSLisandro Dalcin 
1412efe9872eSLisandro Dalcin    Input Parameters:
1413efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1414efe9872eSLisandro Dalcin .  F   - vector to hold the residual (or NULL to have it created internally)
1415efe9872eSLisandro Dalcin .  fun - the function evaluation routine
1416efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1417efe9872eSLisandro Dalcin 
1418efe9872eSLisandro Dalcin    Calling sequence of fun:
1419efe9872eSLisandro Dalcin $  fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx);
1420efe9872eSLisandro Dalcin 
1421efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1422efe9872eSLisandro Dalcin .  U    - state vector
1423efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1424efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1425efe9872eSLisandro Dalcin .  F    - function vector
1426efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine (may be NULL)
1427efe9872eSLisandro Dalcin 
1428efe9872eSLisandro Dalcin    Level: beginner
1429efe9872eSLisandro Dalcin 
1430efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function
1431efe9872eSLisandro Dalcin 
1432efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian()
1433efe9872eSLisandro Dalcin @*/
1434efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx)
1435efe9872eSLisandro Dalcin {
1436efe9872eSLisandro Dalcin   DM             dm;
1437efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1438efe9872eSLisandro Dalcin 
1439efe9872eSLisandro Dalcin   PetscFunctionBegin;
1440efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1441efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2);
1442efe9872eSLisandro Dalcin   ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr);
1443efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1444efe9872eSLisandro Dalcin   ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1445efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1446efe9872eSLisandro Dalcin }
1447efe9872eSLisandro Dalcin 
1448efe9872eSLisandro Dalcin #undef __FUNCT__
1449efe9872eSLisandro Dalcin #define __FUNCT__ "TSGetI2Function"
1450efe9872eSLisandro Dalcin /*@C
1451efe9872eSLisandro Dalcin   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1452efe9872eSLisandro Dalcin 
1453efe9872eSLisandro Dalcin   Not Collective
1454efe9872eSLisandro Dalcin 
1455efe9872eSLisandro Dalcin   Input Parameter:
1456efe9872eSLisandro Dalcin . ts - the TS context
1457efe9872eSLisandro Dalcin 
1458efe9872eSLisandro Dalcin   Output Parameter:
1459efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL)
1460efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL)
1461efe9872eSLisandro Dalcin - ctx - the function context (or NULL)
1462efe9872eSLisandro Dalcin 
1463efe9872eSLisandro Dalcin   Level: advanced
1464efe9872eSLisandro Dalcin 
1465efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function
1466efe9872eSLisandro Dalcin 
1467efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction()
1468efe9872eSLisandro Dalcin @*/
1469efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1470efe9872eSLisandro Dalcin {
1471efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1472efe9872eSLisandro Dalcin   SNES           snes;
1473efe9872eSLisandro Dalcin   DM             dm;
1474efe9872eSLisandro Dalcin 
1475efe9872eSLisandro Dalcin   PetscFunctionBegin;
1476efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1477efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1478efe9872eSLisandro Dalcin   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1479efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1480efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1481efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1482efe9872eSLisandro Dalcin }
1483efe9872eSLisandro Dalcin 
1484efe9872eSLisandro Dalcin #undef __FUNCT__
1485efe9872eSLisandro Dalcin #define __FUNCT__ "TSSetI2Jacobian"
1486efe9872eSLisandro Dalcin /*@C
1487bc77d74cSLisandro Dalcin    TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1488efe9872eSLisandro Dalcin         where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1489efe9872eSLisandro Dalcin 
1490efe9872eSLisandro Dalcin    Logically Collective on TS
1491efe9872eSLisandro Dalcin 
1492efe9872eSLisandro Dalcin    Input Parameters:
1493efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1494efe9872eSLisandro Dalcin .  J   - Jacobian matrix
1495efe9872eSLisandro Dalcin .  P   - preconditioning matrix for J (may be same as J)
1496efe9872eSLisandro Dalcin .  jac - the Jacobian evaluation routine
1497efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1498efe9872eSLisandro Dalcin 
1499efe9872eSLisandro Dalcin    Calling sequence of jac:
1500bc77d74cSLisandro Dalcin $  jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx);
1501efe9872eSLisandro Dalcin 
1502efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1503efe9872eSLisandro Dalcin .  U    - state vector
1504efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1505efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1506efe9872eSLisandro Dalcin .  v    - shift for U_t
1507efe9872eSLisandro Dalcin .  a    - shift for U_tt
1508efe9872eSLisandro Dalcin .  J    - Jacobian of G(U) = F(t,U,W+v*U,W'+a*U), equivalent to dF/dU + v*dF/dU_t  + a*dF/dU_tt
1509efe9872eSLisandro Dalcin .  P    - preconditioning matrix for J, may be same as J
1510efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine
1511efe9872eSLisandro Dalcin 
1512efe9872eSLisandro Dalcin    Notes:
1513efe9872eSLisandro Dalcin    The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1514efe9872eSLisandro Dalcin 
1515efe9872eSLisandro Dalcin    The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1516efe9872eSLisandro Dalcin    the Jacobian of G(U) = F(t,U,W+v*U,W'+a*U) where F(t,U,U_t,U_tt) = 0 is the DAE to be solved.
1517efe9872eSLisandro Dalcin    The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1518bc77d74cSLisandro Dalcin    parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1519efe9872eSLisandro Dalcin 
1520efe9872eSLisandro Dalcin    Level: beginner
1521efe9872eSLisandro Dalcin 
1522efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian
1523efe9872eSLisandro Dalcin 
1524efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1525efe9872eSLisandro Dalcin @*/
1526efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1527efe9872eSLisandro Dalcin {
1528efe9872eSLisandro Dalcin   DM             dm;
1529efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1530efe9872eSLisandro Dalcin 
1531efe9872eSLisandro Dalcin   PetscFunctionBegin;
1532efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1533efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2);
1534efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3);
1535efe9872eSLisandro Dalcin   ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr);
1536efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1537efe9872eSLisandro Dalcin   ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1538efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1539efe9872eSLisandro Dalcin }
1540efe9872eSLisandro Dalcin 
1541efe9872eSLisandro Dalcin #undef __FUNCT__
1542efe9872eSLisandro Dalcin #define __FUNCT__ "TSGetI2Jacobian"
1543efe9872eSLisandro Dalcin /*@C
1544efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1545efe9872eSLisandro Dalcin 
1546efe9872eSLisandro Dalcin   Not Collective, but parallel objects are returned if TS is parallel
1547efe9872eSLisandro Dalcin 
1548efe9872eSLisandro Dalcin   Input Parameter:
1549efe9872eSLisandro Dalcin . ts  - The TS context obtained from TSCreate()
1550efe9872eSLisandro Dalcin 
1551efe9872eSLisandro Dalcin   Output Parameters:
1552efe9872eSLisandro Dalcin + J  - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1553efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J
1554efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1555efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1556efe9872eSLisandro Dalcin 
1557efe9872eSLisandro Dalcin   Notes: You can pass in NULL for any return argument you do not need.
1558efe9872eSLisandro Dalcin 
1559efe9872eSLisandro Dalcin   Level: advanced
1560efe9872eSLisandro Dalcin 
1561efe9872eSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
1562efe9872eSLisandro Dalcin 
1563efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian
1564efe9872eSLisandro Dalcin @*/
1565efe9872eSLisandro Dalcin PetscErrorCode  TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1566efe9872eSLisandro Dalcin {
1567efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1568efe9872eSLisandro Dalcin   SNES           snes;
1569efe9872eSLisandro Dalcin   DM             dm;
1570efe9872eSLisandro Dalcin 
1571efe9872eSLisandro Dalcin   PetscFunctionBegin;
1572efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1573efe9872eSLisandro Dalcin   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
1574efe9872eSLisandro Dalcin   ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr);
1575efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1576efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1577efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1578efe9872eSLisandro Dalcin }
1579efe9872eSLisandro Dalcin 
1580efe9872eSLisandro Dalcin #undef __FUNCT__
1581efe9872eSLisandro Dalcin #define __FUNCT__ "TSComputeI2Function"
1582efe9872eSLisandro Dalcin /*@
1583efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1584efe9872eSLisandro Dalcin 
1585efe9872eSLisandro Dalcin   Collective on TS and Vec
1586efe9872eSLisandro Dalcin 
1587efe9872eSLisandro Dalcin   Input Parameters:
1588efe9872eSLisandro Dalcin + ts - the TS context
1589efe9872eSLisandro Dalcin . t - current time
1590efe9872eSLisandro Dalcin . U - state vector
1591efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t)
1592efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt)
1593efe9872eSLisandro Dalcin 
1594efe9872eSLisandro Dalcin   Output Parameter:
1595efe9872eSLisandro Dalcin . F - the residual vector
1596efe9872eSLisandro Dalcin 
1597efe9872eSLisandro Dalcin   Note:
1598efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1599efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1600efe9872eSLisandro Dalcin 
1601efe9872eSLisandro Dalcin   Level: developer
1602efe9872eSLisandro Dalcin 
1603efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector
1604efe9872eSLisandro Dalcin 
1605efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1606efe9872eSLisandro Dalcin @*/
1607efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1608efe9872eSLisandro Dalcin {
1609efe9872eSLisandro Dalcin   DM             dm;
1610efe9872eSLisandro Dalcin   TSI2Function   I2Function;
1611efe9872eSLisandro Dalcin   void           *ctx;
1612efe9872eSLisandro Dalcin   TSRHSFunction  rhsfunction;
1613efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1614efe9872eSLisandro Dalcin 
1615efe9872eSLisandro Dalcin   PetscFunctionBegin;
1616efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1617efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1618efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1619efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1620efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F,VEC_CLASSID,6);
1621efe9872eSLisandro Dalcin 
1622efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1623efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr);
1624efe9872eSLisandro Dalcin   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
1625efe9872eSLisandro Dalcin 
1626efe9872eSLisandro Dalcin   if (!I2Function) {
1627efe9872eSLisandro Dalcin     ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr);
1628efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1629efe9872eSLisandro Dalcin   }
1630efe9872eSLisandro Dalcin 
1631efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1632efe9872eSLisandro Dalcin 
1633efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit function");
1634efe9872eSLisandro Dalcin   ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr);
1635efe9872eSLisandro Dalcin   PetscStackPop;
1636efe9872eSLisandro Dalcin 
1637efe9872eSLisandro Dalcin   if (rhsfunction) {
1638efe9872eSLisandro Dalcin     Vec Frhs;
1639efe9872eSLisandro Dalcin     ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
1640efe9872eSLisandro Dalcin     ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
1641efe9872eSLisandro Dalcin     ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr);
1642efe9872eSLisandro Dalcin   }
1643efe9872eSLisandro Dalcin 
1644efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1645efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1646efe9872eSLisandro Dalcin }
1647efe9872eSLisandro Dalcin 
1648efe9872eSLisandro Dalcin #undef __FUNCT__
1649efe9872eSLisandro Dalcin #define __FUNCT__ "TSComputeI2Jacobian"
1650efe9872eSLisandro Dalcin /*@
1651efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1652efe9872eSLisandro Dalcin 
1653efe9872eSLisandro Dalcin   Collective on TS and Vec
1654efe9872eSLisandro Dalcin 
1655efe9872eSLisandro Dalcin   Input Parameters:
1656efe9872eSLisandro Dalcin + ts - the TS context
1657efe9872eSLisandro Dalcin . t - current timestep
1658efe9872eSLisandro Dalcin . U - state vector
1659efe9872eSLisandro Dalcin . V - time derivative of state vector
1660efe9872eSLisandro Dalcin . A - second time derivative of state vector
1661efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1662efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1663efe9872eSLisandro Dalcin 
1664efe9872eSLisandro Dalcin   Output Parameters:
1665efe9872eSLisandro Dalcin + J - Jacobian matrix
1666efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1667efe9872eSLisandro Dalcin 
1668efe9872eSLisandro Dalcin   Notes:
1669efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1670efe9872eSLisandro Dalcin 
1671efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1672efe9872eSLisandro Dalcin 
1673efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1674efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1675efe9872eSLisandro Dalcin 
1676efe9872eSLisandro Dalcin   Level: developer
1677efe9872eSLisandro Dalcin 
1678efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix
1679efe9872eSLisandro Dalcin 
1680efe9872eSLisandro Dalcin .seealso:  TSSetI2Jacobian()
1681efe9872eSLisandro Dalcin @*/
1682efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1683efe9872eSLisandro Dalcin {
1684efe9872eSLisandro Dalcin   DM             dm;
1685efe9872eSLisandro Dalcin   TSI2Jacobian   I2Jacobian;
1686efe9872eSLisandro Dalcin   void           *ctx;
1687efe9872eSLisandro Dalcin   TSRHSJacobian  rhsjacobian;
1688efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1689efe9872eSLisandro Dalcin 
1690efe9872eSLisandro Dalcin   PetscFunctionBegin;
1691efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1692efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1693efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1694efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1695efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J,MAT_CLASSID,8);
1696efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P,MAT_CLASSID,9);
1697efe9872eSLisandro Dalcin 
1698efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1699efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr);
1700efe9872eSLisandro Dalcin   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
1701efe9872eSLisandro Dalcin 
1702efe9872eSLisandro Dalcin   if (!I2Jacobian) {
1703efe9872eSLisandro Dalcin     ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr);
1704efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1705efe9872eSLisandro Dalcin   }
1706efe9872eSLisandro Dalcin 
1707efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1708efe9872eSLisandro Dalcin 
1709efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit Jacobian");
1710efe9872eSLisandro Dalcin   ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr);
1711efe9872eSLisandro Dalcin   PetscStackPop;
1712efe9872eSLisandro Dalcin 
1713efe9872eSLisandro Dalcin   if (rhsjacobian) {
1714efe9872eSLisandro Dalcin     Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1715efe9872eSLisandro Dalcin     ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr);
1716efe9872eSLisandro Dalcin     ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr);
1717efe9872eSLisandro Dalcin     ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr);
1718efe9872eSLisandro Dalcin     if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);}
1719efe9872eSLisandro Dalcin   }
1720efe9872eSLisandro Dalcin 
1721efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1722efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1723efe9872eSLisandro Dalcin }
1724efe9872eSLisandro Dalcin 
1725efe9872eSLisandro Dalcin #undef __FUNCT__
1726efe9872eSLisandro Dalcin #define __FUNCT__ "TS2SetSolution"
1727efe9872eSLisandro Dalcin /*@
1728efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1729efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1730efe9872eSLisandro Dalcin 
1731efe9872eSLisandro Dalcin    Logically Collective on TS and Vec
1732efe9872eSLisandro Dalcin 
1733efe9872eSLisandro Dalcin    Input Parameters:
1734efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1735efe9872eSLisandro Dalcin .  u - the solution vector
1736efe9872eSLisandro Dalcin -  v - the time derivative vector
1737efe9872eSLisandro Dalcin 
1738efe9872eSLisandro Dalcin    Level: beginner
1739efe9872eSLisandro Dalcin 
1740efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions
1741efe9872eSLisandro Dalcin @*/
1742efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1743efe9872eSLisandro Dalcin {
1744efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1745efe9872eSLisandro Dalcin 
1746efe9872eSLisandro Dalcin   PetscFunctionBegin;
1747efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1748efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1749efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1750efe9872eSLisandro Dalcin   ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
1751efe9872eSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr);
1752efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
1753efe9872eSLisandro Dalcin   ts->vec_dot = v;
1754efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1755efe9872eSLisandro Dalcin }
1756efe9872eSLisandro Dalcin 
1757efe9872eSLisandro Dalcin #undef __FUNCT__
1758efe9872eSLisandro Dalcin #define __FUNCT__ "TS2GetSolution"
1759efe9872eSLisandro Dalcin /*@
1760efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1761efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1762efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1763efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1764efe9872eSLisandro Dalcin 
1765efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1766efe9872eSLisandro Dalcin 
1767efe9872eSLisandro Dalcin    Input Parameter:
1768efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1769efe9872eSLisandro Dalcin 
1770efe9872eSLisandro Dalcin    Output Parameter:
1771efe9872eSLisandro Dalcin +  u - the vector containing the solution
1772efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1773efe9872eSLisandro Dalcin 
1774efe9872eSLisandro Dalcin    Level: intermediate
1775efe9872eSLisandro Dalcin 
1776efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1777efe9872eSLisandro Dalcin 
1778efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution
1779efe9872eSLisandro Dalcin @*/
1780efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1781efe9872eSLisandro Dalcin {
1782efe9872eSLisandro Dalcin   PetscFunctionBegin;
1783efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1784efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1785efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1786efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1787efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1788efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1789efe9872eSLisandro Dalcin }
1790efe9872eSLisandro Dalcin 
1791efe9872eSLisandro Dalcin #undef __FUNCT__
179255849f57SBarry Smith #define __FUNCT__ "TSLoad"
179355849f57SBarry Smith /*@C
179455849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
179555849f57SBarry Smith 
179655849f57SBarry Smith   Collective on PetscViewer
179755849f57SBarry Smith 
179855849f57SBarry Smith   Input Parameters:
179955849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
180055849f57SBarry Smith            some related function before a call to TSLoad().
180155849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
180255849f57SBarry Smith 
180355849f57SBarry Smith    Level: intermediate
180455849f57SBarry Smith 
180555849f57SBarry Smith   Notes:
180655849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
180755849f57SBarry Smith 
180855849f57SBarry Smith   Notes for advanced users:
180955849f57SBarry Smith   Most users should not need to know the details of the binary storage
181055849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
181155849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
181255849f57SBarry Smith   format is
181355849f57SBarry Smith .vb
181455849f57SBarry Smith      has not yet been determined
181555849f57SBarry Smith .ve
181655849f57SBarry Smith 
181755849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
181855849f57SBarry Smith @*/
1819f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
182055849f57SBarry Smith {
182155849f57SBarry Smith   PetscErrorCode ierr;
182255849f57SBarry Smith   PetscBool      isbinary;
182355849f57SBarry Smith   PetscInt       classid;
182455849f57SBarry Smith   char           type[256];
18252d53ad75SBarry Smith   DMTS           sdm;
1826ad6bc421SBarry Smith   DM             dm;
182755849f57SBarry Smith 
182855849f57SBarry Smith   PetscFunctionBegin;
1829f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
183055849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
183155849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
183255849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
183355849f57SBarry Smith 
1834060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1835ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1836060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1837f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1838f2c2a1b9SBarry Smith   if (ts->ops->load) {
1839f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1840f2c2a1b9SBarry Smith   }
1841ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1842ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1843ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1844f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1845f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
18462d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
18472d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
184855849f57SBarry Smith   PetscFunctionReturn(0);
184955849f57SBarry Smith }
185055849f57SBarry Smith 
18519804daf3SBarry Smith #include <petscdraw.h>
1852e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1853e04113cfSBarry Smith #include <petscviewersaws.h>
1854f05ece33SBarry Smith #endif
185555849f57SBarry Smith #undef __FUNCT__
18564a2ae208SSatish Balay #define __FUNCT__ "TSView"
18577e2c5f70SBarry Smith /*@C
1858d763cef2SBarry Smith     TSView - Prints the TS data structure.
1859d763cef2SBarry Smith 
18604c49b128SBarry Smith     Collective on TS
1861d763cef2SBarry Smith 
1862d763cef2SBarry Smith     Input Parameters:
1863d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1864d763cef2SBarry Smith -   viewer - visualization context
1865d763cef2SBarry Smith 
1866d763cef2SBarry Smith     Options Database Key:
1867d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1868d763cef2SBarry Smith 
1869d763cef2SBarry Smith     Notes:
1870d763cef2SBarry Smith     The available visualization contexts include
1871b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1872b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1873d763cef2SBarry Smith          output where only the first processor opens
1874d763cef2SBarry Smith          the file.  All other processors send their
1875d763cef2SBarry Smith          data to the first processor to print.
1876d763cef2SBarry Smith 
1877d763cef2SBarry Smith     The user can open an alternative visualization context with
1878b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1879d763cef2SBarry Smith 
1880d763cef2SBarry Smith     Level: beginner
1881d763cef2SBarry Smith 
1882d763cef2SBarry Smith .keywords: TS, timestep, view
1883d763cef2SBarry Smith 
1884b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1885d763cef2SBarry Smith @*/
18867087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1887d763cef2SBarry Smith {
1888dfbe8321SBarry Smith   PetscErrorCode ierr;
188919fd82e9SBarry Smith   TSType         type;
18902b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
18912d53ad75SBarry Smith   DMTS           sdm;
1892e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1893536b137fSBarry Smith   PetscBool      issaws;
1894f05ece33SBarry Smith #endif
1895d763cef2SBarry Smith 
1896d763cef2SBarry Smith   PetscFunctionBegin;
18970700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
18983050cee2SBarry Smith   if (!viewer) {
1899ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
19003050cee2SBarry Smith   }
19010700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1902c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1903fd16b177SBarry Smith 
1904251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1905251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
190655849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
19072b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1908e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1909536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1910f05ece33SBarry Smith #endif
191132077d6dSBarry Smith   if (iascii) {
1912dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
191377431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
19147c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1915d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
19165ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1917c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1918d763cef2SBarry Smith     }
19195ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1920193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
1921a0af407cSBarry Smith     if (ts->vrtol) {
1922a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of relative error tolerances, ");CHKERRQ(ierr);
1923a0af407cSBarry Smith     } else {
1924a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr);
1925a0af407cSBarry Smith     }
1926a0af407cSBarry Smith     if (ts->vatol) {
1927a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of absolute error tolerances\n");CHKERRQ(ierr);
1928a0af407cSBarry Smith     } else {
1929a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr);
1930a0af407cSBarry Smith     }
19312d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19322d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1933d52bd9f3SBarry Smith     if (ts->ops->view) {
1934d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1935d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1936d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1937d52bd9f3SBarry Smith     }
19380f5bd95cSBarry Smith   } else if (isstring) {
1939a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1940b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
194155849f57SBarry Smith   } else if (isbinary) {
194255849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
194355849f57SBarry Smith     MPI_Comm    comm;
194455849f57SBarry Smith     PetscMPIInt rank;
194555849f57SBarry Smith     char        type[256];
194655849f57SBarry Smith 
194755849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
194855849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
194955849f57SBarry Smith     if (!rank) {
195055849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
195155849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
195255849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
195355849f57SBarry Smith     }
195455849f57SBarry Smith     if (ts->ops->view) {
195555849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
195655849f57SBarry Smith     }
1957f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1958f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
19592d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19602d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
19612b0a91c0SBarry Smith   } else if (isdraw) {
19622b0a91c0SBarry Smith     PetscDraw draw;
19632b0a91c0SBarry Smith     char      str[36];
196489fd9fafSBarry Smith     PetscReal x,y,bottom,h;
19652b0a91c0SBarry Smith 
19662b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
19672b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
19682b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
19692b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
197051fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
197189fd9fafSBarry Smith     bottom = y - h;
19722b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
19732b0a91c0SBarry Smith     if (ts->ops->view) {
19742b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
19752b0a91c0SBarry Smith     }
19762b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1977e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1978536b137fSBarry Smith   } else if (issaws) {
1979d45a07a7SBarry Smith     PetscMPIInt rank;
19802657e9d9SBarry Smith     const char  *name;
19812657e9d9SBarry Smith 
19822657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1983d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1984d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1985d45a07a7SBarry Smith       char       dir[1024];
1986d45a07a7SBarry Smith 
1987e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1988a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
19892657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
19902657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
19912657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1992d763cef2SBarry Smith     }
19930acecf5bSBarry Smith     if (ts->ops->view) {
19940acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
19950acecf5bSBarry Smith     }
1996f05ece33SBarry Smith #endif
1997f05ece33SBarry Smith   }
1998f05ece33SBarry Smith 
1999b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2000251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
2001b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2002d763cef2SBarry Smith   PetscFunctionReturn(0);
2003d763cef2SBarry Smith }
2004d763cef2SBarry Smith 
2005d763cef2SBarry Smith 
20064a2ae208SSatish Balay #undef __FUNCT__
20074a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
2008b07ff414SBarry Smith /*@
2009d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2010d763cef2SBarry Smith    the timesteppers.
2011d763cef2SBarry Smith 
20123f9fe445SBarry Smith    Logically Collective on TS
2013d763cef2SBarry Smith 
2014d763cef2SBarry Smith    Input Parameters:
2015d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2016d763cef2SBarry Smith -  usrP - optional user context
2017d763cef2SBarry Smith 
2018daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2019daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2020daf670e6SBarry Smith 
2021d763cef2SBarry Smith    Level: intermediate
2022d763cef2SBarry Smith 
2023d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
2024d763cef2SBarry Smith 
2025d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2026d763cef2SBarry Smith @*/
20277087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2028d763cef2SBarry Smith {
2029d763cef2SBarry Smith   PetscFunctionBegin;
20300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2031d763cef2SBarry Smith   ts->user = usrP;
2032d763cef2SBarry Smith   PetscFunctionReturn(0);
2033d763cef2SBarry Smith }
2034d763cef2SBarry Smith 
20354a2ae208SSatish Balay #undef __FUNCT__
20364a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
2037b07ff414SBarry Smith /*@
2038d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2039d763cef2SBarry Smith     timestepper.
2040d763cef2SBarry Smith 
2041d763cef2SBarry Smith     Not Collective
2042d763cef2SBarry Smith 
2043d763cef2SBarry Smith     Input Parameter:
2044d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2045d763cef2SBarry Smith 
2046d763cef2SBarry Smith     Output Parameter:
2047d763cef2SBarry Smith .   usrP - user context
2048d763cef2SBarry Smith 
2049daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2050daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2051daf670e6SBarry Smith 
2052d763cef2SBarry Smith     Level: intermediate
2053d763cef2SBarry Smith 
2054d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
2055d763cef2SBarry Smith 
2056d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2057d763cef2SBarry Smith @*/
2058e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2059d763cef2SBarry Smith {
2060d763cef2SBarry Smith   PetscFunctionBegin;
20610700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2062e71120c6SJed Brown   *(void**)usrP = ts->user;
2063d763cef2SBarry Smith   PetscFunctionReturn(0);
2064d763cef2SBarry Smith }
2065d763cef2SBarry Smith 
20664a2ae208SSatish Balay #undef __FUNCT__
20674a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
2068d763cef2SBarry Smith /*@
2069b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
2070d763cef2SBarry Smith 
2071d763cef2SBarry Smith    Not Collective
2072d763cef2SBarry Smith 
2073d763cef2SBarry Smith    Input Parameter:
2074d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2075d763cef2SBarry Smith 
2076d763cef2SBarry Smith    Output Parameter:
2077b8123daeSJed Brown .  iter - number of steps completed so far
2078d763cef2SBarry Smith 
2079d763cef2SBarry Smith    Level: intermediate
2080d763cef2SBarry Smith 
2081d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
20829be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2083d763cef2SBarry Smith @*/
20847087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
2085d763cef2SBarry Smith {
2086d763cef2SBarry Smith   PetscFunctionBegin;
20870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20884482741eSBarry Smith   PetscValidIntPointer(iter,2);
2089d763cef2SBarry Smith   *iter = ts->steps;
2090d763cef2SBarry Smith   PetscFunctionReturn(0);
2091d763cef2SBarry Smith }
2092d763cef2SBarry Smith 
20934a2ae208SSatish Balay #undef __FUNCT__
20944a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
2095d763cef2SBarry Smith /*@
2096d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
2097d763cef2SBarry Smith    as well as the initial time.
2098d763cef2SBarry Smith 
20993f9fe445SBarry Smith    Logically Collective on TS
2100d763cef2SBarry Smith 
2101d763cef2SBarry Smith    Input Parameters:
2102d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2103d763cef2SBarry Smith .  initial_time - the initial time
2104d763cef2SBarry Smith -  time_step - the size of the timestep
2105d763cef2SBarry Smith 
2106d763cef2SBarry Smith    Level: intermediate
2107d763cef2SBarry Smith 
2108d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
2109d763cef2SBarry Smith 
2110d763cef2SBarry Smith .keywords: TS, set, initial, timestep
2111d763cef2SBarry Smith @*/
21127087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
2113d763cef2SBarry Smith {
2114e144a568SJed Brown   PetscErrorCode ierr;
2115e144a568SJed Brown 
2116d763cef2SBarry Smith   PetscFunctionBegin;
21170700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2118e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
2119d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
2120d763cef2SBarry Smith   PetscFunctionReturn(0);
2121d763cef2SBarry Smith }
2122d763cef2SBarry Smith 
21234a2ae208SSatish Balay #undef __FUNCT__
21244a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
2125d763cef2SBarry Smith /*@
2126d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2127d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2128d763cef2SBarry Smith 
21293f9fe445SBarry Smith    Logically Collective on TS
2130d763cef2SBarry Smith 
2131d763cef2SBarry Smith    Input Parameters:
2132d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2133d763cef2SBarry Smith -  time_step - the size of the timestep
2134d763cef2SBarry Smith 
2135d763cef2SBarry Smith    Level: intermediate
2136d763cef2SBarry Smith 
2137d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2138d763cef2SBarry Smith 
2139d763cef2SBarry Smith .keywords: TS, set, timestep
2140d763cef2SBarry Smith @*/
21417087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2142d763cef2SBarry Smith {
2143d763cef2SBarry Smith   PetscFunctionBegin;
21440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2145c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2146d763cef2SBarry Smith   ts->time_step = time_step;
2147d763cef2SBarry Smith   PetscFunctionReturn(0);
2148d763cef2SBarry Smith }
2149d763cef2SBarry Smith 
21504a2ae208SSatish Balay #undef __FUNCT__
2151a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
2152a43b19c4SJed Brown /*@
215349354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
215449354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
215549354f04SShri Abhyankar      or just return at the final time TS computed.
2156a43b19c4SJed Brown 
2157a43b19c4SJed Brown   Logically Collective on TS
2158a43b19c4SJed Brown 
2159a43b19c4SJed Brown    Input Parameter:
2160a43b19c4SJed Brown +   ts - the time-step context
216149354f04SShri Abhyankar -   eftopt - exact final time option
2162a43b19c4SJed Brown 
2163feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2164feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2165feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2166feed9e9dSBarry Smith 
2167feed9e9dSBarry Smith    Options Database:
2168feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2169feed9e9dSBarry Smith 
2170ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2171ee346746SBarry Smith     then the final time you selected.
2172ee346746SBarry Smith 
2173a43b19c4SJed Brown    Level: beginner
2174a43b19c4SJed Brown 
2175a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
2176a43b19c4SJed Brown @*/
217749354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2178a43b19c4SJed Brown {
2179a43b19c4SJed Brown   PetscFunctionBegin;
2180a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
218149354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
218249354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2183a43b19c4SJed Brown   PetscFunctionReturn(0);
2184a43b19c4SJed Brown }
2185a43b19c4SJed Brown 
2186a43b19c4SJed Brown #undef __FUNCT__
21874a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
2188d763cef2SBarry Smith /*@
2189d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2190d763cef2SBarry Smith 
2191d763cef2SBarry Smith    Not Collective
2192d763cef2SBarry Smith 
2193d763cef2SBarry Smith    Input Parameter:
2194d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2195d763cef2SBarry Smith 
2196d763cef2SBarry Smith    Output Parameter:
2197d763cef2SBarry Smith .  dt - the current timestep size
2198d763cef2SBarry Smith 
2199d763cef2SBarry Smith    Level: intermediate
2200d763cef2SBarry Smith 
2201d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2202d763cef2SBarry Smith 
2203d763cef2SBarry Smith .keywords: TS, get, timestep
2204d763cef2SBarry Smith @*/
22057087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2206d763cef2SBarry Smith {
2207d763cef2SBarry Smith   PetscFunctionBegin;
22080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2209f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2210d763cef2SBarry Smith   *dt = ts->time_step;
2211d763cef2SBarry Smith   PetscFunctionReturn(0);
2212d763cef2SBarry Smith }
2213d763cef2SBarry Smith 
22144a2ae208SSatish Balay #undef __FUNCT__
22154a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
2216d8e5e3e6SSatish Balay /*@
2217d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2218d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2219d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2220d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2221d763cef2SBarry Smith 
2222d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2223d763cef2SBarry Smith 
2224d763cef2SBarry Smith    Input Parameter:
2225d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2226d763cef2SBarry Smith 
2227d763cef2SBarry Smith    Output Parameter:
2228d763cef2SBarry Smith .  v - the vector containing the solution
2229d763cef2SBarry Smith 
223063e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
223163e21af5SBarry Smith    final time. It returns the solution at the next timestep.
223263e21af5SBarry Smith 
2233d763cef2SBarry Smith    Level: intermediate
2234d763cef2SBarry Smith 
223503fe5f5eSDebojyoti Ghosh .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetAuxSolution()
2236d763cef2SBarry Smith 
2237d763cef2SBarry Smith .keywords: TS, timestep, get, solution
2238d763cef2SBarry Smith @*/
22397087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2240d763cef2SBarry Smith {
2241d763cef2SBarry Smith   PetscFunctionBegin;
22420700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22434482741eSBarry Smith   PetscValidPointer(v,2);
22448737fe31SLisandro Dalcin   *v = ts->vec_sol;
2245d763cef2SBarry Smith   PetscFunctionReturn(0);
2246d763cef2SBarry Smith }
2247d763cef2SBarry Smith 
2248c235aa8dSHong Zhang #undef __FUNCT__
224903fe5f5eSDebojyoti Ghosh #define __FUNCT__ "TSGetAuxSolution"
225003fe5f5eSDebojyoti Ghosh /*@
225103fe5f5eSDebojyoti Ghosh    TSGetAuxSolution - Returns any auxiliary solutions at the present
225203fe5f5eSDebojyoti Ghosh    timestep, if available for the time integration method being used.
225303fe5f5eSDebojyoti Ghosh    Auxiliary solutions are quantities that share the same size and
225403fe5f5eSDebojyoti Ghosh    structure as the solution vector.
225503fe5f5eSDebojyoti Ghosh 
225603fe5f5eSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
225703fe5f5eSDebojyoti Ghosh 
225803fe5f5eSDebojyoti Ghosh    Parameters :
225903fe5f5eSDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
226003fe5f5eSDebojyoti Ghosh .  n - If v is PETSC_NULL, then the number of auxiliary solutions is
226103fe5f5eSDebojyoti Ghosh        returned through n, else the n-th auxiliary solution is
226203fe5f5eSDebojyoti Ghosh        returned in v.
226303fe5f5eSDebojyoti Ghosh .  v - the vector containing the n-th auxiliary solution
226403fe5f5eSDebojyoti Ghosh        (may be PETSC_NULL to use this function to find out
226503fe5f5eSDebojyoti Ghosh         the number of auxiliary solutions).
226603fe5f5eSDebojyoti Ghosh 
226703fe5f5eSDebojyoti Ghosh    Level: intermediate
226803fe5f5eSDebojyoti Ghosh 
226903fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution()
227003fe5f5eSDebojyoti Ghosh 
227103fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution
227203fe5f5eSDebojyoti Ghosh @*/
227303fe5f5eSDebojyoti Ghosh PetscErrorCode  TSGetAuxSolution(TS ts,PetscInt *n,Vec *v)
227403fe5f5eSDebojyoti Ghosh {
227503fe5f5eSDebojyoti Ghosh   PetscErrorCode ierr;
227603fe5f5eSDebojyoti Ghosh 
227703fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
227803fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
227903fe5f5eSDebojyoti Ghosh   if (!ts->ops->getauxsolution) *n = 0;
228003fe5f5eSDebojyoti Ghosh   else {
228103fe5f5eSDebojyoti Ghosh     ierr = (*ts->ops->getauxsolution)(ts,n,v);CHKERRQ(ierr);
228203fe5f5eSDebojyoti Ghosh   }
228303fe5f5eSDebojyoti Ghosh   PetscFunctionReturn(0);
228403fe5f5eSDebojyoti Ghosh }
228503fe5f5eSDebojyoti Ghosh 
228603fe5f5eSDebojyoti Ghosh #undef __FUNCT__
2287dfb21088SHong Zhang #define __FUNCT__ "TSGetCostGradients"
2288c235aa8dSHong Zhang /*@
2289dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
2290c235aa8dSHong Zhang 
2291c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
2292c235aa8dSHong Zhang 
2293c235aa8dSHong Zhang    Input Parameter:
2294c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
2295c235aa8dSHong Zhang 
2296c235aa8dSHong Zhang    Output Parameter:
2297abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
2298abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
2299c235aa8dSHong Zhang 
2300c235aa8dSHong Zhang    Level: intermediate
2301c235aa8dSHong Zhang 
2302c235aa8dSHong Zhang .seealso: TSGetTimeStep()
2303c235aa8dSHong Zhang 
2304c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
2305c235aa8dSHong Zhang @*/
2306dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
2307c235aa8dSHong Zhang {
2308c235aa8dSHong Zhang   PetscFunctionBegin;
2309c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2310abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
2311abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
2312abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
2313c235aa8dSHong Zhang   PetscFunctionReturn(0);
2314c235aa8dSHong Zhang }
2315c235aa8dSHong Zhang 
2316bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
23174a2ae208SSatish Balay #undef __FUNCT__
2318bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
2319d8e5e3e6SSatish Balay /*@
2320bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2321d763cef2SBarry Smith 
2322bdad233fSMatthew Knepley   Not collective
2323d763cef2SBarry Smith 
2324bdad233fSMatthew Knepley   Input Parameters:
2325bdad233fSMatthew Knepley + ts   - The TS
2326bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2327d763cef2SBarry Smith .vb
23280910c330SBarry Smith          U_t - A U = 0      (linear)
23290910c330SBarry Smith          U_t - A(t) U = 0   (linear)
23300910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2331d763cef2SBarry Smith .ve
2332d763cef2SBarry Smith 
2333d763cef2SBarry Smith    Level: beginner
2334d763cef2SBarry Smith 
2335bdad233fSMatthew Knepley .keywords: TS, problem type
2336bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2337d763cef2SBarry Smith @*/
23387087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2339a7cc72afSBarry Smith {
23409e2a6581SJed Brown   PetscErrorCode ierr;
23419e2a6581SJed Brown 
2342d763cef2SBarry Smith   PetscFunctionBegin;
23430700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2344bdad233fSMatthew Knepley   ts->problem_type = type;
23459e2a6581SJed Brown   if (type == TS_LINEAR) {
23469e2a6581SJed Brown     SNES snes;
23479e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
23489e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
23499e2a6581SJed Brown   }
2350d763cef2SBarry Smith   PetscFunctionReturn(0);
2351d763cef2SBarry Smith }
2352d763cef2SBarry Smith 
2353bdad233fSMatthew Knepley #undef __FUNCT__
2354bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
2355bdad233fSMatthew Knepley /*@C
2356bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2357bdad233fSMatthew Knepley 
2358bdad233fSMatthew Knepley   Not collective
2359bdad233fSMatthew Knepley 
2360bdad233fSMatthew Knepley   Input Parameter:
2361bdad233fSMatthew Knepley . ts   - The TS
2362bdad233fSMatthew Knepley 
2363bdad233fSMatthew Knepley   Output Parameter:
2364bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2365bdad233fSMatthew Knepley .vb
2366089b2837SJed Brown          M U_t = A U
2367089b2837SJed Brown          M(t) U_t = A(t) U
2368b5abc632SBarry Smith          F(t,U,U_t)
2369bdad233fSMatthew Knepley .ve
2370bdad233fSMatthew Knepley 
2371bdad233fSMatthew Knepley    Level: beginner
2372bdad233fSMatthew Knepley 
2373bdad233fSMatthew Knepley .keywords: TS, problem type
2374bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2375bdad233fSMatthew Knepley @*/
23767087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2377a7cc72afSBarry Smith {
2378bdad233fSMatthew Knepley   PetscFunctionBegin;
23790700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
23804482741eSBarry Smith   PetscValidIntPointer(type,2);
2381bdad233fSMatthew Knepley   *type = ts->problem_type;
2382bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2383bdad233fSMatthew Knepley }
2384d763cef2SBarry Smith 
23854a2ae208SSatish Balay #undef __FUNCT__
23864a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
2387d763cef2SBarry Smith /*@
2388d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
2389d763cef2SBarry Smith    of a timestepper.
2390d763cef2SBarry Smith 
2391d763cef2SBarry Smith    Collective on TS
2392d763cef2SBarry Smith 
2393d763cef2SBarry Smith    Input Parameter:
2394d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2395d763cef2SBarry Smith 
2396d763cef2SBarry Smith    Notes:
2397d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2398d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2399d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
2400d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2401d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
2402d763cef2SBarry Smith 
2403d763cef2SBarry Smith    Level: advanced
2404d763cef2SBarry Smith 
2405d763cef2SBarry Smith .keywords: TS, timestep, setup
2406d763cef2SBarry Smith 
2407d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
2408d763cef2SBarry Smith @*/
24097087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2410d763cef2SBarry Smith {
2411dfbe8321SBarry Smith   PetscErrorCode ierr;
24126c6b9e74SPeter Brune   DM             dm;
24136c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2414d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2415cd11d68dSLisandro Dalcin   TSIFunction    ifun;
24166c6b9e74SPeter Brune   TSIJacobian    ijac;
2417efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
24186c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
2419d763cef2SBarry Smith 
2420d763cef2SBarry Smith   PetscFunctionBegin;
24210700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2422277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2423277b19d0SLisandro Dalcin 
24242c18e0fdSBarry Smith   ts->total_steps = 0;
24257adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2426cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
2427cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
2428d763cef2SBarry Smith   }
2429277b19d0SLisandro Dalcin 
2430277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
2431277b19d0SLisandro Dalcin 
2432e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
2433e1244c69SJed Brown     Mat Amat,Pmat;
2434e1244c69SJed Brown     SNES snes;
2435e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2436e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2437e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2438e1244c69SJed Brown      * have displaced the RHS matrix */
2439e1244c69SJed Brown     if (Amat == ts->Arhs) {
2440e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2441e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2442e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2443e1244c69SJed Brown     }
2444e1244c69SJed Brown     if (Pmat == ts->Brhs) {
2445e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2446e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2447e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2448e1244c69SJed Brown     }
2449e1244c69SJed Brown   }
2450277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2451000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2452277b19d0SLisandro Dalcin   }
2453277b19d0SLisandro Dalcin 
2454a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
24556c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
24566c6b9e74SPeter Brune    */
24576c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
24580298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
24596c6b9e74SPeter Brune   if (!func) {
24606c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
24616c6b9e74SPeter Brune   }
2462a6772fa2SLisandro Dalcin   /* If the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it.
24636c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
24646c6b9e74SPeter Brune    */
24650298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
24660298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
2467efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr);
24680298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
2469efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
24706c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
24716c6b9e74SPeter Brune   }
2472*c0517034SDebojyoti Ghosh 
2473*c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2474*c0517034SDebojyoti Ghosh   if (ts->ops->startingmethod) {
2475*c0517034SDebojyoti Ghosh     ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr);
2476*c0517034SDebojyoti Ghosh   }
2477*c0517034SDebojyoti Ghosh 
2478277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2479277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2480277b19d0SLisandro Dalcin }
2481277b19d0SLisandro Dalcin 
2482277b19d0SLisandro Dalcin #undef __FUNCT__
2483f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp"
2484f6a906c0SBarry Smith /*@
2485f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
2486f6a906c0SBarry Smith    of an adjoint solver
2487f6a906c0SBarry Smith 
2488f6a906c0SBarry Smith    Collective on TS
2489f6a906c0SBarry Smith 
2490f6a906c0SBarry Smith    Input Parameter:
2491f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
2492f6a906c0SBarry Smith 
2493f6a906c0SBarry Smith    Level: advanced
2494f6a906c0SBarry Smith 
2495f6a906c0SBarry Smith .keywords: TS, timestep, setup
2496f6a906c0SBarry Smith 
2497947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
2498f6a906c0SBarry Smith @*/
2499f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
2500f6a906c0SBarry Smith {
2501f6a906c0SBarry Smith   PetscErrorCode ierr;
2502f6a906c0SBarry Smith 
2503f6a906c0SBarry Smith   PetscFunctionBegin;
2504f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2505f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
2506dfb21088SHong Zhang   if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
2507d8151eeaSBarry Smith 
2508947abb85SHong Zhang   if (ts->vec_costintegral) { /* if there is integral in the cost function*/
2509d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2510d8151eeaSBarry Smith     if (ts->vecs_sensip){
2511d8151eeaSBarry Smith       ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2512d8151eeaSBarry Smith     }
2513947abb85SHong Zhang   }
2514d8151eeaSBarry Smith 
251542f2b339SBarry Smith   if (ts->ops->adjointsetup) {
251642f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
2517f6a906c0SBarry Smith   }
2518f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
2519f6a906c0SBarry Smith   PetscFunctionReturn(0);
2520f6a906c0SBarry Smith }
2521f6a906c0SBarry Smith 
2522f6a906c0SBarry Smith #undef __FUNCT__
2523277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
2524277b19d0SLisandro Dalcin /*@
2525277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2526277b19d0SLisandro Dalcin 
2527277b19d0SLisandro Dalcin    Collective on TS
2528277b19d0SLisandro Dalcin 
2529277b19d0SLisandro Dalcin    Input Parameter:
2530277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2531277b19d0SLisandro Dalcin 
2532277b19d0SLisandro Dalcin    Level: beginner
2533277b19d0SLisandro Dalcin 
2534277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2535277b19d0SLisandro Dalcin 
2536277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2537277b19d0SLisandro Dalcin @*/
2538277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2539277b19d0SLisandro Dalcin {
2540277b19d0SLisandro Dalcin   PetscErrorCode ierr;
2541277b19d0SLisandro Dalcin 
2542277b19d0SLisandro Dalcin   PetscFunctionBegin;
2543277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2544b18ea86cSHong Zhang 
2545277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2546277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2547277b19d0SLisandro Dalcin   }
2548277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2549e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2550bbd56ea5SKarl Rupp 
25514e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
25524e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2553214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
25546bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2555efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
2556e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2557e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
255838637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2559bbd56ea5SKarl Rupp 
2560947abb85SHong Zhang  if (ts->vec_costintegral) {
2561d8151eeaSBarry Smith     ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2562d8151eeaSBarry Smith     if (ts->vecs_drdp){
2563d8151eeaSBarry Smith       ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2564d8151eeaSBarry Smith     }
2565947abb85SHong Zhang   }
2566d8151eeaSBarry Smith   ts->vecs_sensi  = NULL;
2567d8151eeaSBarry Smith   ts->vecs_sensip = NULL;
2568ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
25692c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
257036eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2571277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2572d763cef2SBarry Smith   PetscFunctionReturn(0);
2573d763cef2SBarry Smith }
2574d763cef2SBarry Smith 
25754a2ae208SSatish Balay #undef __FUNCT__
25764a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
2577d8e5e3e6SSatish Balay /*@
2578d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2579d763cef2SBarry Smith    with TSCreate().
2580d763cef2SBarry Smith 
2581d763cef2SBarry Smith    Collective on TS
2582d763cef2SBarry Smith 
2583d763cef2SBarry Smith    Input Parameter:
2584d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2585d763cef2SBarry Smith 
2586d763cef2SBarry Smith    Level: beginner
2587d763cef2SBarry Smith 
2588d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2589d763cef2SBarry Smith 
2590d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2591d763cef2SBarry Smith @*/
25926bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2593d763cef2SBarry Smith {
25946849ba73SBarry Smith   PetscErrorCode ierr;
2595d763cef2SBarry Smith 
2596d763cef2SBarry Smith   PetscFunctionBegin;
25976bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
25986bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
25996bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2600d763cef2SBarry Smith 
26016bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2602277b19d0SLisandro Dalcin 
2603e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2604e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
26056bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
26066d4c513bSLisandro Dalcin 
2607bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2608bc952696SBarry Smith 
260984df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
26106427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
26116427ac75SLisandro Dalcin 
26126bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
26136bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
26146bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
26150dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
26166d4c513bSLisandro Dalcin 
2617a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2618d763cef2SBarry Smith   PetscFunctionReturn(0);
2619d763cef2SBarry Smith }
2620d763cef2SBarry Smith 
26214a2ae208SSatish Balay #undef __FUNCT__
26224a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2623d8e5e3e6SSatish Balay /*@
2624d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2625d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2626d763cef2SBarry Smith 
2627d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2628d763cef2SBarry Smith 
2629d763cef2SBarry Smith    Input Parameter:
2630d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2631d763cef2SBarry Smith 
2632d763cef2SBarry Smith    Output Parameter:
2633d763cef2SBarry Smith .  snes - the nonlinear solver context
2634d763cef2SBarry Smith 
2635d763cef2SBarry Smith    Notes:
2636d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2637d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
263894b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2639d763cef2SBarry Smith 
2640d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
26410298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2642d763cef2SBarry Smith 
2643d763cef2SBarry Smith    Level: beginner
2644d763cef2SBarry Smith 
2645d763cef2SBarry Smith .keywords: timestep, get, SNES
2646d763cef2SBarry Smith @*/
26477087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2648d763cef2SBarry Smith {
2649d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2650d372ba47SLisandro Dalcin 
2651d763cef2SBarry Smith   PetscFunctionBegin;
26520700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
26534482741eSBarry Smith   PetscValidPointer(snes,2);
2654d372ba47SLisandro Dalcin   if (!ts->snes) {
2655ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
26560298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
26573bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2658d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2659496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
26609e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
26619e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
26629e2a6581SJed Brown     }
2663d372ba47SLisandro Dalcin   }
2664d763cef2SBarry Smith   *snes = ts->snes;
2665d763cef2SBarry Smith   PetscFunctionReturn(0);
2666d763cef2SBarry Smith }
2667d763cef2SBarry Smith 
26684a2ae208SSatish Balay #undef __FUNCT__
2669deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2670deb2cd25SJed Brown /*@
2671deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2672deb2cd25SJed Brown 
2673deb2cd25SJed Brown    Collective
2674deb2cd25SJed Brown 
2675deb2cd25SJed Brown    Input Parameter:
2676deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2677deb2cd25SJed Brown -  snes - the nonlinear solver context
2678deb2cd25SJed Brown 
2679deb2cd25SJed Brown    Notes:
2680deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2681deb2cd25SJed Brown 
2682deb2cd25SJed Brown    Level: developer
2683deb2cd25SJed Brown 
2684deb2cd25SJed Brown .keywords: timestep, set, SNES
2685deb2cd25SJed Brown @*/
2686deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2687deb2cd25SJed Brown {
2688deb2cd25SJed Brown   PetscErrorCode ierr;
2689d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2690deb2cd25SJed Brown 
2691deb2cd25SJed Brown   PetscFunctionBegin;
2692deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2693deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2694deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2695deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2696bbd56ea5SKarl Rupp 
2697deb2cd25SJed Brown   ts->snes = snes;
2698bbd56ea5SKarl Rupp 
26990298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
27000298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2701740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
27020298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2703740132f1SEmil Constantinescu   }
2704deb2cd25SJed Brown   PetscFunctionReturn(0);
2705deb2cd25SJed Brown }
2706deb2cd25SJed Brown 
2707deb2cd25SJed Brown #undef __FUNCT__
270894b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2709d8e5e3e6SSatish Balay /*@
271094b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2711d763cef2SBarry Smith    a TS (timestepper) context.
2712d763cef2SBarry Smith 
271394b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2714d763cef2SBarry Smith 
2715d763cef2SBarry Smith    Input Parameter:
2716d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2717d763cef2SBarry Smith 
2718d763cef2SBarry Smith    Output Parameter:
271994b7f48cSBarry Smith .  ksp - the nonlinear solver context
2720d763cef2SBarry Smith 
2721d763cef2SBarry Smith    Notes:
272294b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2723d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2724d763cef2SBarry Smith    KSP and PC contexts as well.
2725d763cef2SBarry Smith 
272694b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
27270298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2728d763cef2SBarry Smith 
2729d763cef2SBarry Smith    Level: beginner
2730d763cef2SBarry Smith 
273194b7f48cSBarry Smith .keywords: timestep, get, KSP
2732d763cef2SBarry Smith @*/
27337087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2734d763cef2SBarry Smith {
2735d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2736089b2837SJed Brown   SNES           snes;
2737d372ba47SLisandro Dalcin 
2738d763cef2SBarry Smith   PetscFunctionBegin;
27390700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27404482741eSBarry Smith   PetscValidPointer(ksp,2);
274117186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2742e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2743089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2744089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2745d763cef2SBarry Smith   PetscFunctionReturn(0);
2746d763cef2SBarry Smith }
2747d763cef2SBarry Smith 
2748d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2749d763cef2SBarry Smith 
27504a2ae208SSatish Balay #undef __FUNCT__
2751adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2752adb62b0dSMatthew Knepley /*@
2753adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2754adb62b0dSMatthew Knepley    maximum time for iteration.
2755adb62b0dSMatthew Knepley 
27563f9fe445SBarry Smith    Not Collective
2757adb62b0dSMatthew Knepley 
2758adb62b0dSMatthew Knepley    Input Parameters:
2759adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
27600298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
27610298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2762adb62b0dSMatthew Knepley 
2763adb62b0dSMatthew Knepley    Level: intermediate
2764adb62b0dSMatthew Knepley 
2765adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2766adb62b0dSMatthew Knepley @*/
27677087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2768adb62b0dSMatthew Knepley {
2769adb62b0dSMatthew Knepley   PetscFunctionBegin;
27700700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2771abc0a331SBarry Smith   if (maxsteps) {
27724482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2773adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2774adb62b0dSMatthew Knepley   }
2775abc0a331SBarry Smith   if (maxtime) {
27764482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2777adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2778adb62b0dSMatthew Knepley   }
2779adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2780adb62b0dSMatthew Knepley }
2781adb62b0dSMatthew Knepley 
2782adb62b0dSMatthew Knepley #undef __FUNCT__
27834a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2784d763cef2SBarry Smith /*@
2785d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2786d763cef2SBarry Smith    maximum time for iteration.
2787d763cef2SBarry Smith 
27883f9fe445SBarry Smith    Logically Collective on TS
2789d763cef2SBarry Smith 
2790d763cef2SBarry Smith    Input Parameters:
2791d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2792d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2793d763cef2SBarry Smith -  maxtime - final time to iterate to
2794d763cef2SBarry Smith 
2795d763cef2SBarry Smith    Options Database Keys:
2796d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
27973bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2798d763cef2SBarry Smith 
2799d763cef2SBarry Smith    Notes:
2800d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2801d763cef2SBarry Smith 
2802d763cef2SBarry Smith    Level: intermediate
2803d763cef2SBarry Smith 
2804d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2805a43b19c4SJed Brown 
2806a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2807d763cef2SBarry Smith @*/
28087087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2809d763cef2SBarry Smith {
2810d763cef2SBarry Smith   PetscFunctionBegin;
28110700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2812c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2813c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
281439b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
281539b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2816d763cef2SBarry Smith   PetscFunctionReturn(0);
2817d763cef2SBarry Smith }
2818d763cef2SBarry Smith 
28194a2ae208SSatish Balay #undef __FUNCT__
28204a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2821d763cef2SBarry Smith /*@
2822d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2823d763cef2SBarry Smith    for use by the TS routines.
2824d763cef2SBarry Smith 
28253f9fe445SBarry Smith    Logically Collective on TS and Vec
2826d763cef2SBarry Smith 
2827d763cef2SBarry Smith    Input Parameters:
2828d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
28290910c330SBarry Smith -  u - the solution vector
2830d763cef2SBarry Smith 
2831d763cef2SBarry Smith    Level: beginner
2832d763cef2SBarry Smith 
2833d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2834d763cef2SBarry Smith @*/
28350910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2836d763cef2SBarry Smith {
28378737fe31SLisandro Dalcin   PetscErrorCode ierr;
2838496e6a7aSJed Brown   DM             dm;
28398737fe31SLisandro Dalcin 
2840d763cef2SBarry Smith   PetscFunctionBegin;
28410700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28420910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
28430910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
28446bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
28450910c330SBarry Smith   ts->vec_sol = u;
2846bbd56ea5SKarl Rupp 
2847496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
28480910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2849d763cef2SBarry Smith   PetscFunctionReturn(0);
2850d763cef2SBarry Smith }
2851d763cef2SBarry Smith 
2852e74ef692SMatthew Knepley #undef __FUNCT__
285373b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps"
285473b18844SBarry Smith /*@
285573b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
285673b18844SBarry Smith 
285773b18844SBarry Smith    Logically Collective on TS
285873b18844SBarry Smith 
285973b18844SBarry Smith    Input Parameters:
286073b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
286173b18844SBarry Smith .  steps - number of steps to use
286273b18844SBarry Smith 
286373b18844SBarry Smith    Level: intermediate
286473b18844SBarry Smith 
286573b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
286673b18844SBarry Smith           so as to integrate back to less than the original timestep
286773b18844SBarry Smith 
286873b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
286973b18844SBarry Smith 
287073b18844SBarry Smith .seealso: TSSetExactFinalTime()
287173b18844SBarry Smith @*/
287273b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
287373b18844SBarry Smith {
287473b18844SBarry Smith   PetscFunctionBegin;
287573b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
287673b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
287773b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
287873b18844SBarry Smith   if (steps > ts->total_steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps");
287973b18844SBarry Smith   ts->adjoint_max_steps = steps;
288073b18844SBarry Smith   PetscFunctionReturn(0);
288173b18844SBarry Smith }
288273b18844SBarry Smith 
288373b18844SBarry Smith #undef __FUNCT__
2884dfb21088SHong Zhang #define __FUNCT__ "TSSetCostGradients"
2885c235aa8dSHong Zhang /*@
2886dfb21088SHong Zhang    TSSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial conditions and w.r.t. the problem parameters
28870cf82b59SBarry Smith       for use by the TSAdjoint routines.
2888c235aa8dSHong Zhang 
2889c235aa8dSHong Zhang    Logically Collective on TS and Vec
2890c235aa8dSHong Zhang 
2891c235aa8dSHong Zhang    Input Parameters:
2892c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2893abc2977eSBarry Smith .  lambda - gradients with respect to the initial condition variables, the dimension and parallel layout of these vectors is the same as the ODE solution vector
2894abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2895c235aa8dSHong Zhang 
2896c235aa8dSHong Zhang    Level: beginner
2897c235aa8dSHong Zhang 
2898abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
28990cf82b59SBarry Smith 
2900c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2901c235aa8dSHong Zhang @*/
2902dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
2903c235aa8dSHong Zhang {
2904c235aa8dSHong Zhang   PetscFunctionBegin;
2905c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2906abc2977eSBarry Smith   PetscValidPointer(lambda,2);
2907abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
2908abc2977eSBarry Smith   ts->vecs_sensip = mu;
2909dfb21088SHong Zhang   if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostIntegrand");
2910abc2977eSBarry Smith   ts->numcost  = numcost;
2911ad8e2604SHong Zhang   PetscFunctionReturn(0);
2912ad8e2604SHong Zhang }
2913ad8e2604SHong Zhang 
2914ad8e2604SHong Zhang #undef __FUNCT__
29155bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian"
2916ad8e2604SHong Zhang /*@C
29170cf82b59SBarry Smith   TSAdjointSetRHSJacobian - Sets the function that computes the Jacobian of G w.r.t. the parameters p where y_t = G(y,p,t), as well as the location to store the matrix.
2918ad8e2604SHong Zhang 
2919ad8e2604SHong Zhang   Logically Collective on TS
2920ad8e2604SHong Zhang 
2921ad8e2604SHong Zhang   Input Parameters:
2922ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2923ad8e2604SHong Zhang - func - The function
2924ad8e2604SHong Zhang 
2925ad8e2604SHong Zhang   Calling sequence of func:
29260cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
292705755b9cSHong Zhang +   t - current timestep
29280cf82b59SBarry Smith .   y - input vector (current ODE solution)
292905755b9cSHong Zhang .   A - output matrix
293005755b9cSHong Zhang -   ctx - [optional] user-defined function context
2931ad8e2604SHong Zhang 
2932ad8e2604SHong Zhang   Level: intermediate
2933ad8e2604SHong Zhang 
29340cf82b59SBarry Smith   Notes: Amat has the same number of rows and the same row parallel layout as u, Amat has the same number of columns and parallel layout as p
29350cf82b59SBarry Smith 
2936ad8e2604SHong Zhang .keywords: TS, sensitivity
2937ad8e2604SHong Zhang .seealso:
2938ad8e2604SHong Zhang @*/
29395bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2940ad8e2604SHong Zhang {
2941ad8e2604SHong Zhang   PetscErrorCode ierr;
2942ad8e2604SHong Zhang 
2943ad8e2604SHong Zhang   PetscFunctionBegin;
2944ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2945ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2946ad8e2604SHong Zhang 
2947ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2948ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2949ad8e2604SHong Zhang   if(Amat) {
2950ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2951ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2952ad8e2604SHong Zhang     ts->Jacp = Amat;
2953ad8e2604SHong Zhang   }
2954ad8e2604SHong Zhang   PetscFunctionReturn(0);
2955ad8e2604SHong Zhang }
2956ad8e2604SHong Zhang 
2957ad8e2604SHong Zhang #undef __FUNCT__
29585bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian"
29590cf82b59SBarry Smith /*@C
29605bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2961ad8e2604SHong Zhang 
2962ad8e2604SHong Zhang   Collective on TS
2963ad8e2604SHong Zhang 
2964ad8e2604SHong Zhang   Input Parameters:
2965ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2966ad8e2604SHong Zhang 
2967ad8e2604SHong Zhang   Level: developer
2968ad8e2604SHong Zhang 
2969ad8e2604SHong Zhang .keywords: TS, sensitivity
29705bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
2971ad8e2604SHong Zhang @*/
29725bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2973ad8e2604SHong Zhang {
2974ad8e2604SHong Zhang   PetscErrorCode ierr;
2975ad8e2604SHong Zhang 
2976ad8e2604SHong Zhang   PetscFunctionBegin;
2977ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2978ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2979ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2980ad8e2604SHong Zhang 
2981ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2982ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2983ad8e2604SHong Zhang   PetscStackPop;
2984c235aa8dSHong Zhang   PetscFunctionReturn(0);
2985c235aa8dSHong Zhang }
2986c235aa8dSHong Zhang 
2987c235aa8dSHong Zhang #undef __FUNCT__
2988dfb21088SHong Zhang #define __FUNCT__ "TSSetCostIntegrand"
29896fd0887fSHong Zhang /*@C
2990dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
29916fd0887fSHong Zhang 
29926fd0887fSHong Zhang     Logically Collective on TS
29936fd0887fSHong Zhang 
29946fd0887fSHong Zhang     Input Parameters:
29956fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
2996abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
29970cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
2998b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2999b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
3000feaa1ddbSSatish Balay .   fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run
3001b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
30026fd0887fSHong Zhang 
30030cf82b59SBarry Smith     Calling sequence of rf:
30040cf82b59SBarry Smith $     rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
30056fd0887fSHong Zhang 
30066fd0887fSHong Zhang +   t - current timestep
30070cf82b59SBarry Smith .   y - input vector
30080cf82b59SBarry Smith .   f - function result; one vector entry for each cost function
30096fd0887fSHong Zhang -   ctx - [optional] user-defined function context
30106fd0887fSHong Zhang 
3011b612ec54SBarry Smith    Calling sequence of drdyf:
30120cf82b59SBarry Smith $    PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
3013b612ec54SBarry Smith 
3014b612ec54SBarry Smith    Calling sequence of drdpf:
30150cf82b59SBarry Smith $    PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
3016b612ec54SBarry Smith 
3017b612ec54SBarry Smith     Level: intermediate
30186fd0887fSHong Zhang 
3019abc2977eSBarry Smith     Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions
30200cf82b59SBarry Smith 
30216fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
30226fd0887fSHong Zhang 
3023dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
30246fd0887fSHong Zhang @*/
3025dfb21088SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
3026d8151eeaSBarry Smith                                                           PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
3027b1cb36f3SHong Zhang                                                           PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),
3028b1cb36f3SHong Zhang                                                           PetscBool fwd,void *ctx)
30296fd0887fSHong Zhang {
30306fd0887fSHong Zhang   PetscErrorCode ierr;
30316fd0887fSHong Zhang 
30326fd0887fSHong Zhang   PetscFunctionBegin;
30336fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3034dfb21088SHong Zhang   if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostGradients()");
3035c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
30366fd0887fSHong Zhang 
3037b1cb36f3SHong Zhang   ts->costintegralfwd  = fwd; /* Evaluate the cost integral in forward run if fwd is true */
3038abc2977eSBarry Smith   ierr                 = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
30392c39e106SBarry Smith   ierr                 = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
30400cf82b59SBarry Smith   ts->costintegrand    = rf;
304105755b9cSHong Zhang   ts->costintegrandctx = ctx;
3042b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
3043b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
30446fd0887fSHong Zhang   PetscFunctionReturn(0);
30456fd0887fSHong Zhang }
30466fd0887fSHong Zhang 
30476fd0887fSHong Zhang #undef __FUNCT__
3048dfb21088SHong Zhang #define __FUNCT__ "TSGetCostIntegral"
304936eaed60SHong Zhang /*@
3050dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
305136eaed60SHong Zhang    It is valid to call the routine after a backward run.
305236eaed60SHong Zhang 
305336eaed60SHong Zhang    Not Collective
305436eaed60SHong Zhang 
305536eaed60SHong Zhang    Input Parameter:
305636eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
305736eaed60SHong Zhang 
305836eaed60SHong Zhang    Output Parameter:
30592c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
306036eaed60SHong Zhang 
306136eaed60SHong Zhang    Level: intermediate
306236eaed60SHong Zhang 
3063dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
306436eaed60SHong Zhang 
306536eaed60SHong Zhang .keywords: TS, sensitivity analysis
306636eaed60SHong Zhang @*/
3067dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
306836eaed60SHong Zhang {
306936eaed60SHong Zhang   PetscFunctionBegin;
307036eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
307136eaed60SHong Zhang   PetscValidPointer(v,2);
30722c39e106SBarry Smith   *v = ts->vec_costintegral;
307336eaed60SHong Zhang   PetscFunctionReturn(0);
307436eaed60SHong Zhang }
307536eaed60SHong Zhang 
307636eaed60SHong Zhang #undef __FUNCT__
3077d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand"
30786fd0887fSHong Zhang /*@
30792c39e106SBarry Smith    TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
30806fd0887fSHong Zhang 
30816fd0887fSHong Zhang    Input Parameters:
30826fd0887fSHong Zhang +  ts - the TS context
30836fd0887fSHong Zhang .  t - current time
30840cf82b59SBarry Smith -  y - state vector, i.e. current solution
30856fd0887fSHong Zhang 
30866fd0887fSHong Zhang    Output Parameter:
3087abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
30886fd0887fSHong Zhang 
30896fd0887fSHong Zhang    Note:
30906fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
30916fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
30926fd0887fSHong Zhang 
30936fd0887fSHong Zhang    Level: developer
30946fd0887fSHong Zhang 
30956fd0887fSHong Zhang .keywords: TS, compute
30966fd0887fSHong Zhang 
3097dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
30986fd0887fSHong Zhang @*/
30990cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
31006fd0887fSHong Zhang {
31016fd0887fSHong Zhang   PetscErrorCode ierr;
31026fd0887fSHong Zhang 
31036fd0887fSHong Zhang   PetscFunctionBegin;
31046fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31050cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
31066fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
31076fd0887fSHong Zhang 
31080cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
3109e4680132SHong Zhang   if (ts->costintegrand) {
3110e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
31110cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
31126fd0887fSHong Zhang     PetscStackPop;
31136fd0887fSHong Zhang   } else {
31146fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
31156fd0887fSHong Zhang   }
31166fd0887fSHong Zhang 
31170cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
31186fd0887fSHong Zhang   PetscFunctionReturn(0);
31196fd0887fSHong Zhang }
31206fd0887fSHong Zhang 
31216fd0887fSHong Zhang #undef __FUNCT__
3122d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction"
312305755b9cSHong Zhang /*@
3124d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
312505755b9cSHong Zhang 
312605755b9cSHong Zhang   Collective on TS
312705755b9cSHong Zhang 
312805755b9cSHong Zhang   Input Parameters:
312905755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
313005755b9cSHong Zhang 
313105755b9cSHong Zhang   Notes:
3132d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
313305755b9cSHong Zhang   so most users would not generally call this routine themselves.
313405755b9cSHong Zhang 
313505755b9cSHong Zhang   Level: developer
313605755b9cSHong Zhang 
313705755b9cSHong Zhang .keywords: TS, sensitivity
3138d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
313905755b9cSHong Zhang @*/
31400cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
314105755b9cSHong Zhang {
314205755b9cSHong Zhang   PetscErrorCode ierr;
314305755b9cSHong Zhang 
314405755b9cSHong Zhang   PetscFunctionBegin;
314505755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31460cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
314705755b9cSHong Zhang 
314805755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
31490cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
315005755b9cSHong Zhang   PetscStackPop;
315105755b9cSHong Zhang   PetscFunctionReturn(0);
315205755b9cSHong Zhang }
315305755b9cSHong Zhang 
315405755b9cSHong Zhang #undef __FUNCT__
3155d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction"
315605755b9cSHong Zhang /*@
3157d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
315805755b9cSHong Zhang 
315905755b9cSHong Zhang   Collective on TS
316005755b9cSHong Zhang 
316105755b9cSHong Zhang   Input Parameters:
316205755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
316305755b9cSHong Zhang 
316405755b9cSHong Zhang   Notes:
316505755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
316605755b9cSHong Zhang   so most users would not generally call this routine themselves.
316705755b9cSHong Zhang 
316805755b9cSHong Zhang   Level: developer
316905755b9cSHong Zhang 
317005755b9cSHong Zhang .keywords: TS, sensitivity
3171d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
317205755b9cSHong Zhang @*/
31730cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
317405755b9cSHong Zhang {
317505755b9cSHong Zhang   PetscErrorCode ierr;
317605755b9cSHong Zhang 
317705755b9cSHong Zhang   PetscFunctionBegin;
317805755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31790cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
318005755b9cSHong Zhang 
318105755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
31820cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
318305755b9cSHong Zhang   PetscStackPop;
318405755b9cSHong Zhang   PetscFunctionReturn(0);
318505755b9cSHong Zhang }
318605755b9cSHong Zhang 
318705755b9cSHong Zhang #undef __FUNCT__
3188e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
3189ac226902SBarry Smith /*@C
3190000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
31913f2090d5SJed Brown   called once at the beginning of each time step.
3192000e7ae3SMatthew Knepley 
31933f9fe445SBarry Smith   Logically Collective on TS
3194000e7ae3SMatthew Knepley 
3195000e7ae3SMatthew Knepley   Input Parameters:
3196000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3197000e7ae3SMatthew Knepley - func - The function
3198000e7ae3SMatthew Knepley 
3199000e7ae3SMatthew Knepley   Calling sequence of func:
3200000e7ae3SMatthew Knepley . func (TS ts);
3201000e7ae3SMatthew Knepley 
3202000e7ae3SMatthew Knepley   Level: intermediate
3203000e7ae3SMatthew Knepley 
3204b8123daeSJed Brown   Note:
3205b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
3206b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
3207b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
3208b8123daeSJed Brown 
3209000e7ae3SMatthew Knepley .keywords: TS, timestep
32109be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
3211000e7ae3SMatthew Knepley @*/
32127087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3213000e7ae3SMatthew Knepley {
3214000e7ae3SMatthew Knepley   PetscFunctionBegin;
32150700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3216ae60f76fSBarry Smith   ts->prestep = func;
3217000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3218000e7ae3SMatthew Knepley }
3219000e7ae3SMatthew Knepley 
3220e74ef692SMatthew Knepley #undef __FUNCT__
32213f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
322209ee8438SJed Brown /*@
32233f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
32243f2090d5SJed Brown 
32253f2090d5SJed Brown   Collective on TS
32263f2090d5SJed Brown 
32273f2090d5SJed Brown   Input Parameters:
32283f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
32293f2090d5SJed Brown 
32303f2090d5SJed Brown   Notes:
32313f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
32323f2090d5SJed Brown   so most users would not generally call this routine themselves.
32333f2090d5SJed Brown 
32343f2090d5SJed Brown   Level: developer
32353f2090d5SJed Brown 
32363f2090d5SJed Brown .keywords: TS, timestep
32379be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
32383f2090d5SJed Brown @*/
32397087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
32403f2090d5SJed Brown {
32413f2090d5SJed Brown   PetscErrorCode ierr;
32423f2090d5SJed Brown 
32433f2090d5SJed Brown   PetscFunctionBegin;
32440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3245ae60f76fSBarry Smith   if (ts->prestep) {
3246ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
3247312ce896SJed Brown   }
32483f2090d5SJed Brown   PetscFunctionReturn(0);
32493f2090d5SJed Brown }
32503f2090d5SJed Brown 
32513f2090d5SJed Brown #undef __FUNCT__
3252b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
3253b8123daeSJed Brown /*@C
3254b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3255b8123daeSJed Brown   called once at the beginning of each stage.
3256b8123daeSJed Brown 
3257b8123daeSJed Brown   Logically Collective on TS
3258b8123daeSJed Brown 
3259b8123daeSJed Brown   Input Parameters:
3260b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3261b8123daeSJed Brown - func - The function
3262b8123daeSJed Brown 
3263b8123daeSJed Brown   Calling sequence of func:
3264b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
3265b8123daeSJed Brown 
3266b8123daeSJed Brown   Level: intermediate
3267b8123daeSJed Brown 
3268b8123daeSJed Brown   Note:
3269b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
3270b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
3271b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3272b8123daeSJed Brown 
3273b8123daeSJed Brown .keywords: TS, timestep
32749be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3275b8123daeSJed Brown @*/
3276b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3277b8123daeSJed Brown {
3278b8123daeSJed Brown   PetscFunctionBegin;
3279b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3280ae60f76fSBarry Smith   ts->prestage = func;
3281b8123daeSJed Brown   PetscFunctionReturn(0);
3282b8123daeSJed Brown }
3283b8123daeSJed Brown 
3284b8123daeSJed Brown #undef __FUNCT__
32859be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
32869be3e283SDebojyoti Ghosh /*@C
32879be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
32889be3e283SDebojyoti Ghosh   called once at the end of each stage.
32899be3e283SDebojyoti Ghosh 
32909be3e283SDebojyoti Ghosh   Logically Collective on TS
32919be3e283SDebojyoti Ghosh 
32929be3e283SDebojyoti Ghosh   Input Parameters:
32939be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
32949be3e283SDebojyoti Ghosh - func - The function
32959be3e283SDebojyoti Ghosh 
32969be3e283SDebojyoti Ghosh   Calling sequence of func:
32979be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
32989be3e283SDebojyoti Ghosh 
32999be3e283SDebojyoti Ghosh   Level: intermediate
33009be3e283SDebojyoti Ghosh 
33019be3e283SDebojyoti Ghosh   Note:
33029be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
33039be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
33049be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
33059be3e283SDebojyoti Ghosh 
33069be3e283SDebojyoti Ghosh .keywords: TS, timestep
33079be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
33089be3e283SDebojyoti Ghosh @*/
33099be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
33109be3e283SDebojyoti Ghosh {
33119be3e283SDebojyoti Ghosh   PetscFunctionBegin;
33129be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
33139be3e283SDebojyoti Ghosh   ts->poststage = func;
33149be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
33159be3e283SDebojyoti Ghosh }
33169be3e283SDebojyoti Ghosh 
33179be3e283SDebojyoti Ghosh #undef __FUNCT__
3318c688d042SShri Abhyankar #define __FUNCT__ "TSSetPostEvaluate"
3319c688d042SShri Abhyankar /*@C
3320c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3321c688d042SShri Abhyankar   called once at the end of each step evaluation.
3322c688d042SShri Abhyankar 
3323c688d042SShri Abhyankar   Logically Collective on TS
3324c688d042SShri Abhyankar 
3325c688d042SShri Abhyankar   Input Parameters:
3326c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3327c688d042SShri Abhyankar - func - The function
3328c688d042SShri Abhyankar 
3329c688d042SShri Abhyankar   Calling sequence of func:
3330c688d042SShri Abhyankar . PetscErrorCode func(TS ts);
3331c688d042SShri Abhyankar 
3332c688d042SShri Abhyankar   Level: intermediate
3333c688d042SShri Abhyankar 
3334c688d042SShri Abhyankar   Note:
33351785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
33361785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3337e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3338e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3339e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3340c688d042SShri Abhyankar 
3341c688d042SShri Abhyankar .keywords: TS, timestep
3342c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3343c688d042SShri Abhyankar @*/
3344c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3345c688d042SShri Abhyankar {
3346c688d042SShri Abhyankar   PetscFunctionBegin;
3347c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3348c688d042SShri Abhyankar   ts->postevaluate = func;
3349c688d042SShri Abhyankar   PetscFunctionReturn(0);
3350c688d042SShri Abhyankar }
3351c688d042SShri Abhyankar 
3352c688d042SShri Abhyankar #undef __FUNCT__
3353b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
3354b8123daeSJed Brown /*@
3355b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3356b8123daeSJed Brown 
3357b8123daeSJed Brown   Collective on TS
3358b8123daeSJed Brown 
3359b8123daeSJed Brown   Input Parameters:
3360b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
33619be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3362b8123daeSJed Brown 
3363b8123daeSJed Brown   Notes:
3364b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3365b8123daeSJed Brown   most users would not generally call this routine themselves.
3366b8123daeSJed Brown 
3367b8123daeSJed Brown   Level: developer
3368b8123daeSJed Brown 
3369b8123daeSJed Brown .keywords: TS, timestep
33709be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3371b8123daeSJed Brown @*/
3372b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3373b8123daeSJed Brown {
3374b8123daeSJed Brown   PetscErrorCode ierr;
3375b8123daeSJed Brown 
3376b8123daeSJed Brown   PetscFunctionBegin;
3377b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3378ae60f76fSBarry Smith   if (ts->prestage) {
3379ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3380b8123daeSJed Brown   }
3381b8123daeSJed Brown   PetscFunctionReturn(0);
3382b8123daeSJed Brown }
3383b8123daeSJed Brown 
3384b8123daeSJed Brown #undef __FUNCT__
33859be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
33869be3e283SDebojyoti Ghosh /*@
33879be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
33889be3e283SDebojyoti Ghosh 
33899be3e283SDebojyoti Ghosh   Collective on TS
33909be3e283SDebojyoti Ghosh 
33919be3e283SDebojyoti Ghosh   Input Parameters:
33929be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
33939be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
33949be3e283SDebojyoti Ghosh   stageindex  - Stage number
33959be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
33969be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
33979be3e283SDebojyoti Ghosh 
33989be3e283SDebojyoti Ghosh   Notes:
33999be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
34009be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
34019be3e283SDebojyoti Ghosh 
34029be3e283SDebojyoti Ghosh   Level: developer
34039be3e283SDebojyoti Ghosh 
34049be3e283SDebojyoti Ghosh .keywords: TS, timestep
34059be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
34069be3e283SDebojyoti Ghosh @*/
34079be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
34089be3e283SDebojyoti Ghosh {
34099be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
34109be3e283SDebojyoti Ghosh 
34119be3e283SDebojyoti Ghosh   PetscFunctionBegin;
34129be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34134beae5d8SLisandro Dalcin   if (ts->poststage) {
34149be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
34159be3e283SDebojyoti Ghosh   }
34169be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
34179be3e283SDebojyoti Ghosh }
34189be3e283SDebojyoti Ghosh 
34199be3e283SDebojyoti Ghosh #undef __FUNCT__
3420c688d042SShri Abhyankar #define __FUNCT__ "TSPostEvaluate"
3421c688d042SShri Abhyankar /*@
3422c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3423c688d042SShri Abhyankar 
3424c688d042SShri Abhyankar   Collective on TS
3425c688d042SShri Abhyankar 
3426c688d042SShri Abhyankar   Input Parameters:
3427c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3428c688d042SShri Abhyankar 
3429c688d042SShri Abhyankar   Notes:
3430c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3431c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3432c688d042SShri Abhyankar 
3433c688d042SShri Abhyankar   Level: developer
3434c688d042SShri Abhyankar 
3435c688d042SShri Abhyankar .keywords: TS, timestep
3436c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3437c688d042SShri Abhyankar @*/
3438c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3439c688d042SShri Abhyankar {
3440c688d042SShri Abhyankar   PetscErrorCode ierr;
3441c688d042SShri Abhyankar 
3442c688d042SShri Abhyankar   PetscFunctionBegin;
3443c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3444c688d042SShri Abhyankar   if (ts->postevaluate) {
3445c688d042SShri Abhyankar     PetscStackCallStandard((*ts->postevaluate),(ts));
3446c688d042SShri Abhyankar   }
3447c688d042SShri Abhyankar   PetscFunctionReturn(0);
3448c688d042SShri Abhyankar }
3449c688d042SShri Abhyankar 
3450c688d042SShri Abhyankar #undef __FUNCT__
3451e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
3452ac226902SBarry Smith /*@C
3453000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
34543f2090d5SJed Brown   called once at the end of each time step.
3455000e7ae3SMatthew Knepley 
34563f9fe445SBarry Smith   Logically Collective on TS
3457000e7ae3SMatthew Knepley 
3458000e7ae3SMatthew Knepley   Input Parameters:
3459000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3460000e7ae3SMatthew Knepley - func - The function
3461000e7ae3SMatthew Knepley 
3462000e7ae3SMatthew Knepley   Calling sequence of func:
3463b8123daeSJed Brown $ func (TS ts);
3464000e7ae3SMatthew Knepley 
34651785ff2aSShri Abhyankar   Notes:
34661785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
34671785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
34681785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
34691785ff2aSShri Abhyankar 
3470000e7ae3SMatthew Knepley   Level: intermediate
3471000e7ae3SMatthew Knepley 
3472000e7ae3SMatthew Knepley .keywords: TS, timestep
34731785ff2aSShri Abhyankar .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
3474000e7ae3SMatthew Knepley @*/
34757087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3476000e7ae3SMatthew Knepley {
3477000e7ae3SMatthew Knepley   PetscFunctionBegin;
34780700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3479ae60f76fSBarry Smith   ts->poststep = func;
3480000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3481000e7ae3SMatthew Knepley }
3482000e7ae3SMatthew Knepley 
3483e74ef692SMatthew Knepley #undef __FUNCT__
34843f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
348509ee8438SJed Brown /*@
34863f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
34873f2090d5SJed Brown 
34883f2090d5SJed Brown   Collective on TS
34893f2090d5SJed Brown 
34903f2090d5SJed Brown   Input Parameters:
34913f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
34923f2090d5SJed Brown 
34933f2090d5SJed Brown   Notes:
34943f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
34953f2090d5SJed Brown   so most users would not generally call this routine themselves.
34963f2090d5SJed Brown 
34973f2090d5SJed Brown   Level: developer
34983f2090d5SJed Brown 
34993f2090d5SJed Brown .keywords: TS, timestep
35003f2090d5SJed Brown @*/
35017087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
35023f2090d5SJed Brown {
35033f2090d5SJed Brown   PetscErrorCode ierr;
35043f2090d5SJed Brown 
35053f2090d5SJed Brown   PetscFunctionBegin;
35060700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3507ae60f76fSBarry Smith   if (ts->poststep) {
3508ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
350972ac3e02SJed Brown   }
35103f2090d5SJed Brown   PetscFunctionReturn(0);
35113f2090d5SJed Brown }
35123f2090d5SJed Brown 
3513d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3514d763cef2SBarry Smith 
35154a2ae208SSatish Balay #undef __FUNCT__
3516a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
3517d763cef2SBarry Smith /*@C
3518a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3519d763cef2SBarry Smith    timestep to display the iteration's  progress.
3520d763cef2SBarry Smith 
35213f9fe445SBarry Smith    Logically Collective on TS
3522d763cef2SBarry Smith 
3523d763cef2SBarry Smith    Input Parameters:
3524d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3525e213d8f1SJed Brown .  monitor - monitoring routine
3526329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
35270298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3528b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
35290298fd71SBarry Smith           (may be NULL)
3530d763cef2SBarry Smith 
3531e213d8f1SJed Brown    Calling sequence of monitor:
35320910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3533d763cef2SBarry Smith 
3534d763cef2SBarry Smith +    ts - the TS context
353563e21af5SBarry Smith .    steps - iteration number (after the final time step the monitor routine may be called with a step of -1, this indicates the solution has been interpolated to this time)
35361f06c33eSBarry Smith .    time - current time
35370910c330SBarry Smith .    u - current iterate
3538d763cef2SBarry Smith -    mctx - [optional] monitoring context
3539d763cef2SBarry Smith 
3540d763cef2SBarry Smith    Notes:
3541d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3542d763cef2SBarry Smith    already has been loaded.
3543d763cef2SBarry Smith 
3544025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
3545025f1a04SBarry Smith 
3546d763cef2SBarry Smith    Level: intermediate
3547d763cef2SBarry Smith 
3548d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3549d763cef2SBarry Smith 
3550a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3551d763cef2SBarry Smith @*/
3552c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3553d763cef2SBarry Smith {
355478064530SBarry Smith   PetscErrorCode ierr;
355578064530SBarry Smith   PetscInt       i;
355678064530SBarry Smith   PetscBool      identical;
355778064530SBarry Smith 
3558d763cef2SBarry Smith   PetscFunctionBegin;
35590700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
356078064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
356178064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
356278064530SBarry Smith     if (identical) PetscFunctionReturn(0);
356378064530SBarry Smith   }
356417186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3565d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
35668704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3567d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3568d763cef2SBarry Smith   PetscFunctionReturn(0);
3569d763cef2SBarry Smith }
3570d763cef2SBarry Smith 
35714a2ae208SSatish Balay #undef __FUNCT__
3572a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
3573d763cef2SBarry Smith /*@C
3574a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3575d763cef2SBarry Smith 
35763f9fe445SBarry Smith    Logically Collective on TS
3577d763cef2SBarry Smith 
3578d763cef2SBarry Smith    Input Parameters:
3579d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3580d763cef2SBarry Smith 
3581d763cef2SBarry Smith    Notes:
3582d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3583d763cef2SBarry Smith 
3584d763cef2SBarry Smith    Level: intermediate
3585d763cef2SBarry Smith 
3586d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3587d763cef2SBarry Smith 
3588a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3589d763cef2SBarry Smith @*/
35907087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3591d763cef2SBarry Smith {
3592d952e501SBarry Smith   PetscErrorCode ierr;
3593d952e501SBarry Smith   PetscInt       i;
3594d952e501SBarry Smith 
3595d763cef2SBarry Smith   PetscFunctionBegin;
35960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3597d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
35988704b422SBarry Smith     if (ts->monitordestroy[i]) {
35998704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3600d952e501SBarry Smith     }
3601d952e501SBarry Smith   }
3602d763cef2SBarry Smith   ts->numbermonitors = 0;
3603d763cef2SBarry Smith   PetscFunctionReturn(0);
3604d763cef2SBarry Smith }
3605d763cef2SBarry Smith 
36064a2ae208SSatish Balay #undef __FUNCT__
3607a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
3608721cd6eeSBarry Smith /*@C
3609721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
36105516499fSSatish Balay 
36115516499fSSatish Balay    Level: intermediate
361241251cbbSSatish Balay 
36135516499fSSatish Balay .keywords: TS, set, monitor
36145516499fSSatish Balay 
361563e21af5SBarry Smith .seealso:  TSMonitorSet()
361641251cbbSSatish Balay @*/
3617721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3618d763cef2SBarry Smith {
3619dfbe8321SBarry Smith   PetscErrorCode ierr;
3620721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
362141aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3622d132466eSBarry Smith 
3623d763cef2SBarry Smith   PetscFunctionBegin;
36244d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
362541aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
362641aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3627721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
362841aca3d6SBarry Smith   if (iascii) {
3629649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
363063e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
363163e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
363263e21af5SBarry Smith     } else {
36338392e04aSShri Abhyankar       ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr);
363463e21af5SBarry Smith     }
3635649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
363641aca3d6SBarry Smith   } else if (ibinary) {
363741aca3d6SBarry Smith     PetscMPIInt rank;
363841aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
363941aca3d6SBarry Smith     if (!rank) {
3640450a797fSBarry Smith       PetscBool skipHeader;
3641450a797fSBarry Smith       PetscInt  classid = REAL_FILE_CLASSID;
3642450a797fSBarry Smith 
3643450a797fSBarry Smith       ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr);
3644450a797fSBarry Smith       if (!skipHeader) {
3645450a797fSBarry Smith          ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
3646450a797fSBarry Smith        }
364741aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
364841aca3d6SBarry Smith     } else {
364941aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
365041aca3d6SBarry Smith     }
365141aca3d6SBarry Smith   }
3652721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3653d763cef2SBarry Smith   PetscFunctionReturn(0);
3654d763cef2SBarry Smith }
3655d763cef2SBarry Smith 
36564a2ae208SSatish Balay #undef __FUNCT__
36579110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorSet"
36589110b2e7SHong Zhang /*@C
36599110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
36609110b2e7SHong Zhang    timestep to display the iteration's  progress.
36619110b2e7SHong Zhang 
36629110b2e7SHong Zhang    Logically Collective on TS
36639110b2e7SHong Zhang 
36649110b2e7SHong Zhang    Input Parameters:
36659110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
36669110b2e7SHong Zhang .  adjointmonitor - monitoring routine
36679110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
36689110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
36699110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
36709110b2e7SHong Zhang           (may be NULL)
36719110b2e7SHong Zhang 
36729110b2e7SHong Zhang    Calling sequence of monitor:
36739110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
36749110b2e7SHong Zhang 
36759110b2e7SHong Zhang +    ts - the TS context
36769110b2e7SHong Zhang .    steps - iteration number (after the final time step the monitor routine is called with a step of -1, this is at the final time which may have
36779110b2e7SHong Zhang                                been interpolated to)
36789110b2e7SHong Zhang .    time - current time
36799110b2e7SHong Zhang .    u - current iterate
36809110b2e7SHong Zhang .    numcost - number of cost functionos
36819110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
36829110b2e7SHong Zhang .    mu - sensitivities to parameters
36839110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
36849110b2e7SHong Zhang 
36859110b2e7SHong Zhang    Notes:
36869110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
36879110b2e7SHong Zhang    already has been loaded.
36889110b2e7SHong Zhang 
36899110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
36909110b2e7SHong Zhang 
36919110b2e7SHong Zhang    Level: intermediate
36929110b2e7SHong Zhang 
36939110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
36949110b2e7SHong Zhang 
36959110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
36969110b2e7SHong Zhang @*/
36979110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
36989110b2e7SHong Zhang {
369978064530SBarry Smith   PetscErrorCode ierr;
370078064530SBarry Smith   PetscInt       i;
370178064530SBarry Smith   PetscBool      identical;
370278064530SBarry Smith 
37039110b2e7SHong Zhang   PetscFunctionBegin;
37049110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
370578064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
370678064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr);
370778064530SBarry Smith     if (identical) PetscFunctionReturn(0);
370878064530SBarry Smith   }
37099110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
37109110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
37119110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
37129110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
37139110b2e7SHong Zhang   PetscFunctionReturn(0);
37149110b2e7SHong Zhang }
37159110b2e7SHong Zhang 
37169110b2e7SHong Zhang #undef __FUNCT__
37179110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorCancel"
37189110b2e7SHong Zhang /*@C
37199110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
37209110b2e7SHong Zhang 
37219110b2e7SHong Zhang    Logically Collective on TS
37229110b2e7SHong Zhang 
37239110b2e7SHong Zhang    Input Parameters:
37249110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
37259110b2e7SHong Zhang 
37269110b2e7SHong Zhang    Notes:
37279110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
37289110b2e7SHong Zhang 
37299110b2e7SHong Zhang    Level: intermediate
37309110b2e7SHong Zhang 
37319110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
37329110b2e7SHong Zhang 
37339110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
37349110b2e7SHong Zhang @*/
37359110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
37369110b2e7SHong Zhang {
37379110b2e7SHong Zhang   PetscErrorCode ierr;
37389110b2e7SHong Zhang   PetscInt       i;
37399110b2e7SHong Zhang 
37409110b2e7SHong Zhang   PetscFunctionBegin;
37419110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
37429110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
37439110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
37449110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
37459110b2e7SHong Zhang     }
37469110b2e7SHong Zhang   }
37479110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
37489110b2e7SHong Zhang   PetscFunctionReturn(0);
37499110b2e7SHong Zhang }
37509110b2e7SHong Zhang 
37519110b2e7SHong Zhang #undef __FUNCT__
3752110eb670SHong Zhang #define __FUNCT__ "TSAdjointMonitorDefault"
3753721cd6eeSBarry Smith /*@C
3754721cd6eeSBarry Smith    TSAdjointMonitorDefault - the default monitor of adjoint computations
3755110eb670SHong Zhang 
3756110eb670SHong Zhang    Level: intermediate
3757110eb670SHong Zhang 
3758110eb670SHong Zhang .keywords: TS, set, monitor
3759110eb670SHong Zhang 
3760110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
3761110eb670SHong Zhang @*/
3762721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
3763110eb670SHong Zhang {
3764110eb670SHong Zhang   PetscErrorCode ierr;
3765721cd6eeSBarry Smith   PetscViewer    viewer = vf->viewer;
3766110eb670SHong Zhang 
3767110eb670SHong Zhang   PetscFunctionBegin;
3768110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3769721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
3770110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3771110eb670SHong Zhang   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr);
3772110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3773721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3774110eb670SHong Zhang   PetscFunctionReturn(0);
3775110eb670SHong Zhang }
3776110eb670SHong Zhang 
3777110eb670SHong Zhang #undef __FUNCT__
3778cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
3779cd652676SJed Brown /*@
3780cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3781cd652676SJed Brown 
3782cd652676SJed Brown    Collective on TS
3783cd652676SJed Brown 
3784cd652676SJed Brown    Input Argument:
3785cd652676SJed Brown +  ts - time stepping context
3786cd652676SJed Brown -  t - time to interpolate to
3787cd652676SJed Brown 
3788cd652676SJed Brown    Output Argument:
37890910c330SBarry Smith .  U - state at given time
3790cd652676SJed Brown 
3791cd652676SJed Brown    Level: intermediate
3792cd652676SJed Brown 
3793cd652676SJed Brown    Developer Notes:
3794cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3795cd652676SJed Brown 
3796cd652676SJed Brown .keywords: TS, set
3797cd652676SJed Brown 
3798874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
3799cd652676SJed Brown @*/
38000910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3801cd652676SJed Brown {
3802cd652676SJed Brown   PetscErrorCode ierr;
3803cd652676SJed Brown 
3804cd652676SJed Brown   PetscFunctionBegin;
3805cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3806b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3807be5899b3SLisandro Dalcin   if (t < ts->ptime_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)ts->ptime_prev,(double)ts->ptime);
3808ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
38090910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3810cd652676SJed Brown   PetscFunctionReturn(0);
3811cd652676SJed Brown }
3812cd652676SJed Brown 
3813cd652676SJed Brown #undef __FUNCT__
38144a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3815d763cef2SBarry Smith /*@
38166d9e5789SSean Farley    TSStep - Steps one time step
3817d763cef2SBarry Smith 
3818d763cef2SBarry Smith    Collective on TS
3819d763cef2SBarry Smith 
3820d763cef2SBarry Smith    Input Parameter:
3821d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3822d763cef2SBarry Smith 
382327829d71SBarry Smith    Level: developer
3824d763cef2SBarry Smith 
3825b8123daeSJed Brown    Notes:
382627829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
382727829d71SBarry Smith 
3828b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3829b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3830b8123daeSJed Brown 
383125cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
383225cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
383325cb2221SBarry Smith 
3834d763cef2SBarry Smith .keywords: TS, timestep, solve
3835d763cef2SBarry Smith 
38369be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3837d763cef2SBarry Smith @*/
3838193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3839d763cef2SBarry Smith {
3840dfbe8321SBarry Smith   PetscErrorCode   ierr;
3841fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3842be5899b3SLisandro Dalcin   PetscReal        ptime;
3843d763cef2SBarry Smith 
3844d763cef2SBarry Smith   PetscFunctionBegin;
38450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3846fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3847fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3848fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3849fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3850fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3851fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3852302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
3853fffbeea8SBarry Smith 
3854d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
385568bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3856d405a339SMatthew Knepley 
3857a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSStep()");
3858be5899b3SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
3859a6772fa2SLisandro Dalcin 
3860be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
3861362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3862be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
3863e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3864d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3865193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3866d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3867be5899b3SLisandro Dalcin   ts->ptime_prev = ptime;
3868be5899b3SLisandro Dalcin   ts->steps++; ts->total_steps++;
3869be5899b3SLisandro Dalcin   ts->steprollback = PETSC_FALSE;
387028d5b5d6SLisandro Dalcin   ts->steprestart  = PETSC_FALSE;
3871362cd11cSLisandro Dalcin 
3872362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3873cef5090cSJed Brown     if (ts->errorifstepfailed) {
387408c7845fSBarry Smith       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
387508c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3876d2daff3dSHong Zhang     }
387708c7845fSBarry Smith   } else if (!ts->reason) {
387808c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
387908c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
388008c7845fSBarry Smith   }
388108c7845fSBarry Smith   PetscFunctionReturn(0);
388208c7845fSBarry Smith }
388308c7845fSBarry Smith 
388408c7845fSBarry Smith #undef __FUNCT__
388508c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep"
388608c7845fSBarry Smith /*@
3887b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
388808c7845fSBarry Smith 
388908c7845fSBarry Smith    Collective on TS
389008c7845fSBarry Smith 
389108c7845fSBarry Smith    Input Parameter:
389208c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
389308c7845fSBarry Smith 
38946a4d4014SLisandro Dalcin    Level: intermediate
38956a4d4014SLisandro Dalcin 
3896b957a604SHong Zhang .keywords: TS, adjoint, step
38976a4d4014SLisandro Dalcin 
3898b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
38996a4d4014SLisandro Dalcin @*/
390008c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
39016a4d4014SLisandro Dalcin {
390208c7845fSBarry Smith   DM               dm;
39036a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
39046a4d4014SLisandro Dalcin 
39056a4d4014SLisandro Dalcin   PetscFunctionBegin;
39064a2ae208SSatish Balay   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
390708c7845fSBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
390808c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3909d763cef2SBarry Smith 
3910685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr);
3911d763cef2SBarry Smith 
3912be5899b3SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3913be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime;
391442f2b339SBarry Smith   if (!ts->ops->adjointstep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed because the adjoint of  %s has not been implemented, try other time stepping methods for adjoint sensitivity analysis",((PetscObject)ts)->type_name);
3915be5899b3SLisandro Dalcin   ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
391642f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
39178d0ad7a8SHong Zhang   ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
3918be5899b3SLisandro Dalcin   ts->steps++; ts->total_steps--;
3919362cd11cSLisandro Dalcin 
3920362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3921cef5090cSJed Brown     if (ts->errorifstepfailed) {
39226c4ed002SBarry Smith       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
39236c4ed002SBarry Smith       else if (ts->reason == TS_DIVERGED_STEP_REJECTED) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_reject or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
39246c4ed002SBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3925cef5090cSJed Brown     }
3926362cd11cSLisandro Dalcin   } else if (!ts->reason) {
392773b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
3928362cd11cSLisandro Dalcin   }
3929d763cef2SBarry Smith   PetscFunctionReturn(0);
3930d763cef2SBarry Smith }
3931d763cef2SBarry Smith 
3932d763cef2SBarry Smith #undef __FUNCT__
39337cbde773SLisandro Dalcin #define __FUNCT__ "TSEvaluateWLTE"
39347cbde773SLisandro Dalcin /*@
39357cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
39367cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
39377cbde773SLisandro Dalcin 
39387cbde773SLisandro Dalcin    Collective on TS
39397cbde773SLisandro Dalcin 
39407cbde773SLisandro Dalcin    Input Arguments:
39417cbde773SLisandro Dalcin +  ts - time stepping context
39427cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
39437cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
39447cbde773SLisandro Dalcin 
39457cbde773SLisandro Dalcin    Output Arguments:
39467cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
39477cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
39487cbde773SLisandro Dalcin 
39497cbde773SLisandro Dalcin    Level: advanced
39507cbde773SLisandro Dalcin 
39517cbde773SLisandro Dalcin    Notes:
39527cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
39537cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
39547cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
39557cbde773SLisandro Dalcin 
39567cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
39577cbde773SLisandro Dalcin @*/
39587cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
39597cbde773SLisandro Dalcin {
39607cbde773SLisandro Dalcin   PetscErrorCode ierr;
39617cbde773SLisandro Dalcin 
39627cbde773SLisandro Dalcin   PetscFunctionBegin;
39637cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
39647cbde773SLisandro Dalcin   PetscValidType(ts,1);
39657cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
39667cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
39677cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
39687cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
39697cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
39707cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
39717cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
39727cbde773SLisandro Dalcin   PetscFunctionReturn(0);
39737cbde773SLisandro Dalcin }
39747cbde773SLisandro Dalcin 
39757cbde773SLisandro Dalcin #undef __FUNCT__
397605175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
397705175c85SJed Brown /*@
397805175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
397905175c85SJed Brown 
39801c3436cfSJed Brown    Collective on TS
398105175c85SJed Brown 
398205175c85SJed Brown    Input Arguments:
39831c3436cfSJed Brown +  ts - time stepping context
39841c3436cfSJed Brown .  order - desired order of accuracy
39850298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
398605175c85SJed Brown 
398705175c85SJed Brown    Output Arguments:
39880910c330SBarry Smith .  U - state at the end of the current step
398905175c85SJed Brown 
399005175c85SJed Brown    Level: advanced
399105175c85SJed Brown 
3992108c343cSJed Brown    Notes:
3993108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3994108c343cSJed Brown    It is normally called by adaptive controllers before a step has been accepted and may also be called by the user after TSStep() has returned.
3995108c343cSJed Brown 
39961c3436cfSJed Brown .seealso: TSStep(), TSAdapt
399705175c85SJed Brown @*/
39980910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
399905175c85SJed Brown {
400005175c85SJed Brown   PetscErrorCode ierr;
400105175c85SJed Brown 
400205175c85SJed Brown   PetscFunctionBegin;
400305175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
400405175c85SJed Brown   PetscValidType(ts,1);
40050910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4006ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
40070910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
400805175c85SJed Brown   PetscFunctionReturn(0);
400905175c85SJed Brown }
401005175c85SJed Brown 
4011b1cb36f3SHong Zhang #undef __FUNCT__
4012b1cb36f3SHong Zhang #define __FUNCT__ "TSForwardCostIntegral"
4013b1cb36f3SHong Zhang /*@
4014b1cb36f3SHong Zhang  TSForwardCostIntegral - Evaluate the cost integral in the forward run.
4015b1cb36f3SHong Zhang 
4016b1cb36f3SHong Zhang  Collective on TS
4017b1cb36f3SHong Zhang 
4018b1cb36f3SHong Zhang  Input Arguments:
4019b1cb36f3SHong Zhang  .  ts - time stepping context
4020b1cb36f3SHong Zhang 
4021b1cb36f3SHong Zhang  Level: advanced
4022b1cb36f3SHong Zhang 
4023b1cb36f3SHong Zhang  Notes:
4024b1cb36f3SHong Zhang  This function cannot be called until TSStep() has been completed.
4025b1cb36f3SHong Zhang 
4026b1cb36f3SHong Zhang  .seealso: TSSolve(), TSAdjointCostIntegral()
4027b1cb36f3SHong Zhang  @*/
4028b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts)
4029b1cb36f3SHong Zhang {
4030b1cb36f3SHong Zhang     PetscErrorCode ierr;
4031b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4032b1cb36f3SHong Zhang     if (!ts->ops->forwardintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the forward run",((PetscObject)ts)->type_name);
4033b1cb36f3SHong Zhang     ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr);
4034b1cb36f3SHong Zhang     PetscFunctionReturn(0);
4035b1cb36f3SHong Zhang }
4036d67e68b7SBarry Smith 
403705175c85SJed Brown #undef __FUNCT__
4038d763cef2SBarry Smith #define __FUNCT__ "TSSolve"
4039d763cef2SBarry Smith /*@
4040d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
4041d763cef2SBarry Smith 
4042d763cef2SBarry Smith    Collective on TS
4043d763cef2SBarry Smith 
4044d763cef2SBarry Smith    Input Parameter:
4045d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
404663e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
404763e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
40485a3a76d0SJed Brown 
4049d763cef2SBarry Smith    Level: beginner
4050d763cef2SBarry Smith 
40515a3a76d0SJed Brown    Notes:
40525a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
40535a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
40545a3a76d0SJed Brown    stepped over the final time.
40555a3a76d0SJed Brown 
4056d763cef2SBarry Smith .keywords: TS, timestep, solve
4057d763cef2SBarry Smith 
405863e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
4059d763cef2SBarry Smith @*/
4060cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
4061d763cef2SBarry Smith {
4062b06615a5SLisandro Dalcin   Vec               solution;
4063d763cef2SBarry Smith   PetscErrorCode    ierr;
4064d763cef2SBarry Smith 
4065d763cef2SBarry Smith   PetscFunctionBegin;
4066d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4067f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
4068feed9e9dSBarry Smith 
406949354f04SShri Abhyankar   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 */
4070b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
40710910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
4072b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
4073b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
4074b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
40755a3a76d0SJed Brown     }
40760910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
4077bbd56ea5SKarl Rupp   } else if (u) {
40780910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
40795a3a76d0SJed Brown   }
4080b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
408168bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4082a6772fa2SLisandro Dalcin 
4083a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSSolve()");
4084a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
4085a6772fa2SLisandro Dalcin 
4086d763cef2SBarry Smith   /* reset time step and iteration counters */
4087193ac0bcSJed Brown   ts->steps             = 0;
40885ef26d82SJed Brown   ts->ksp_its           = 0;
40895ef26d82SJed Brown   ts->snes_its          = 0;
4090c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
4091c610991cSLisandro Dalcin   ts->reject            = 0;
4092193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
4093193ac0bcSJed Brown 
4094ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
4095f05ece33SBarry Smith 
4096193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
4097193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
4098a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4099cc708dedSBarry Smith     ts->solvetime = ts->ptime;
4100a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
4101be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
4102db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
4103db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
4104cdf0de3dSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41056427ac75SLisandro Dalcin     ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
410628d5b5d6SLisandro Dalcin     ts->steprollback = PETSC_FALSE;
410728d5b5d6SLisandro Dalcin     ts->steprestart  = PETSC_TRUE;
41086427ac75SLisandro Dalcin 
4109e1a7a14fSJed Brown     while (!ts->reason) {
4110193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41119687d888SLisandro Dalcin       if (!ts->steprollback) {
41129687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
41139687d888SLisandro Dalcin       }
4114193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
4115e783b05fSHong Zhang       if (ts->vec_costintegral && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */
4116b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
4117b1cb36f3SHong Zhang       }
4118e783b05fSHong Zhang       ierr = TSEventHandler(ts);CHKERRQ(ierr); /* The right-hand side may be changed due to event. Be careful with Any computation using the RHS information after this point. */
4119e783b05fSHong Zhang       if (!ts->steprollback) {
4120cdf0de3dSShri Abhyankar         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41211eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
4122aeb4809dSShri Abhyankar       }
4123193ac0bcSJed Brown     }
412463e21af5SBarry Smith     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41256427ac75SLisandro Dalcin 
412649354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
41270910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
4128cc708dedSBarry Smith       ts->solvetime = ts->max_time;
4129b06615a5SLisandro Dalcin       solution = u;
413063e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
41310574a7fbSJed Brown     } else {
4132ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4133cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4134b06615a5SLisandro Dalcin       solution = ts->vec_sol;
41350574a7fbSJed Brown     }
4136193ac0bcSJed Brown   }
4137d2daff3dSHong Zhang 
4138ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
413963e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
414056f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
4141ef222394SBarry Smith   if (ts->adjoint_solve) {
4142ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
41432b0a91c0SBarry Smith   }
4144d763cef2SBarry Smith   PetscFunctionReturn(0);
4145d763cef2SBarry Smith }
4146d763cef2SBarry Smith 
4147d763cef2SBarry Smith #undef __FUNCT__
4148b1cb36f3SHong Zhang #define __FUNCT__ "TSAdjointCostIntegral"
4149b1cb36f3SHong Zhang /*@
4150b1cb36f3SHong Zhang  TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run.
4151b1cb36f3SHong Zhang 
4152b1cb36f3SHong Zhang  Collective on TS
4153b1cb36f3SHong Zhang 
4154b1cb36f3SHong Zhang  Input Arguments:
4155b1cb36f3SHong Zhang  .  ts - time stepping context
4156b1cb36f3SHong Zhang 
4157b1cb36f3SHong Zhang  Level: advanced
4158b1cb36f3SHong Zhang 
4159b1cb36f3SHong Zhang  Notes:
4160b1cb36f3SHong Zhang  This function cannot be called until TSAdjointStep() has been completed.
4161b1cb36f3SHong Zhang 
4162b1cb36f3SHong Zhang  .seealso: TSAdjointSolve(), TSAdjointStep
4163b1cb36f3SHong Zhang  @*/
4164b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts)
4165b1cb36f3SHong Zhang {
4166b1cb36f3SHong Zhang     PetscErrorCode ierr;
4167b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4168b1cb36f3SHong Zhang     if (!ts->ops->adjointintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the adjoint run",((PetscObject)ts)->type_name);
4169b1cb36f3SHong Zhang     ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr);
4170b1cb36f3SHong Zhang     PetscFunctionReturn(0);
4171b1cb36f3SHong Zhang }
4172b1cb36f3SHong Zhang 
4173b1cb36f3SHong Zhang #undef __FUNCT__
4174c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve"
4175c88f2d44SBarry Smith /*@
4176c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
4177c88f2d44SBarry Smith 
4178c88f2d44SBarry Smith    Collective on TS
4179c88f2d44SBarry Smith 
4180c88f2d44SBarry Smith    Input Parameter:
41812c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
4182c88f2d44SBarry Smith 
4183e87fd094SBarry Smith    Options Database:
4184e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions
4185e87fd094SBarry Smith 
4186c88f2d44SBarry Smith    Level: intermediate
4187c88f2d44SBarry Smith 
4188c88f2d44SBarry Smith    Notes:
4189c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
4190c88f2d44SBarry Smith 
419173b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
419273b18844SBarry Smith 
4193c88f2d44SBarry Smith .keywords: TS, timestep, solve
4194c88f2d44SBarry Smith 
4195b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
4196c88f2d44SBarry Smith @*/
41972c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
4198c88f2d44SBarry Smith {
4199c88f2d44SBarry Smith   PetscErrorCode    ierr;
4200c88f2d44SBarry Smith 
4201c88f2d44SBarry Smith   PetscFunctionBegin;
4202c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4203c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
420468bece0bSHong Zhang 
4205c88f2d44SBarry Smith   /* reset time step and iteration counters */
4206c88f2d44SBarry Smith   ts->steps             = 0;
4207c88f2d44SBarry Smith   ts->ksp_its           = 0;
4208c88f2d44SBarry Smith   ts->snes_its          = 0;
4209c88f2d44SBarry Smith   ts->num_snes_failures = 0;
4210c88f2d44SBarry Smith   ts->reject            = 0;
4211c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
4212c88f2d44SBarry Smith 
421373b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
4214c88f2d44SBarry Smith 
421573b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
4216c88f2d44SBarry Smith   while (!ts->reason) {
421755c52731SHong Zhang     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
42189110b2e7SHong Zhang     ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
42196427ac75SLisandro Dalcin     ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr);
4220616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
4221b1cb36f3SHong Zhang     if (ts->vec_costintegral && !ts->costintegralfwd) {
4222b1cb36f3SHong Zhang       ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr);
4223b1cb36f3SHong Zhang     }
4224c88f2d44SBarry Smith   }
422526656371SHong Zhang   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
422626656371SHong Zhang   ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
4227c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
4228e210cd0eSHong Zhang   ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr);
4229685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
4230c88f2d44SBarry Smith   PetscFunctionReturn(0);
4231c88f2d44SBarry Smith }
4232c88f2d44SBarry Smith 
4233c88f2d44SBarry Smith #undef __FUNCT__
4234d763cef2SBarry Smith #define __FUNCT__ "TSMonitor"
42357db568b7SBarry Smith /*@C
4236228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4237228d79bcSJed Brown 
4238228d79bcSJed Brown    Collective on TS
4239228d79bcSJed Brown 
4240228d79bcSJed Brown    Input Parameters:
4241228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
4242228d79bcSJed Brown .  step - step number that has just completed
4243228d79bcSJed Brown .  ptime - model time of the state
42440910c330SBarry Smith -  u - state at the current model time
4245228d79bcSJed Brown 
4246228d79bcSJed Brown    Notes:
42477db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
42487db568b7SBarry Smith    Users would almost never call this routine directly.
4249228d79bcSJed Brown 
425063e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
425163e21af5SBarry Smith 
42527db568b7SBarry Smith    Level: developer
4253228d79bcSJed Brown 
4254228d79bcSJed Brown .keywords: TS, timestep
4255228d79bcSJed Brown @*/
42560910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4257d763cef2SBarry Smith {
4258d6152f81SLisandro Dalcin   DM             dm;
4259a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
4260d6152f81SLisandro Dalcin   PetscErrorCode ierr;
4261d763cef2SBarry Smith 
4262d763cef2SBarry Smith   PetscFunctionBegin;
4263b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4264b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4265d6152f81SLisandro Dalcin 
4266d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
4267d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
4268d6152f81SLisandro Dalcin 
42695edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
4270d763cef2SBarry Smith   for (i=0; i<n; i++) {
42710910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
4272d763cef2SBarry Smith   }
42735edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
4274d763cef2SBarry Smith   PetscFunctionReturn(0);
4275d763cef2SBarry Smith }
4276d763cef2SBarry Smith 
42779110b2e7SHong Zhang #undef __FUNCT__
42789110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitor"
42797db568b7SBarry Smith /*@C
42809110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
42819110b2e7SHong Zhang 
42829110b2e7SHong Zhang    Collective on TS
42839110b2e7SHong Zhang 
42849110b2e7SHong Zhang    Input Parameters:
42859110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
42869110b2e7SHong Zhang .  step - step number that has just completed
42879110b2e7SHong Zhang .  ptime - model time of the state
42889110b2e7SHong Zhang .  u - state at the current model time
42899110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
42909110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
42919110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
42929110b2e7SHong Zhang 
42939110b2e7SHong Zhang    Notes:
42947db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
42957db568b7SBarry Smith    Users would almost never call this routine directly.
42969110b2e7SHong Zhang 
42977db568b7SBarry Smith    Level: developer
42989110b2e7SHong Zhang 
42999110b2e7SHong Zhang .keywords: TS, timestep
43009110b2e7SHong Zhang @*/
43019110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
43029110b2e7SHong Zhang {
43039110b2e7SHong Zhang   PetscErrorCode ierr;
43049110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
43059110b2e7SHong Zhang 
43069110b2e7SHong Zhang   PetscFunctionBegin;
43079110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
43089110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
43099110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
43109110b2e7SHong Zhang   for (i=0; i<n; i++) {
43119110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
43129110b2e7SHong Zhang   }
43139110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
43149110b2e7SHong Zhang   PetscFunctionReturn(0);
43159110b2e7SHong Zhang }
43169110b2e7SHong Zhang 
4317d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
43184a2ae208SSatish Balay #undef __FUNCT__
4319a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
4320d763cef2SBarry Smith /*@C
43217db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4322a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
4323d763cef2SBarry Smith 
4324d763cef2SBarry Smith    Collective on TS
4325d763cef2SBarry Smith 
4326d763cef2SBarry Smith    Input Parameters:
4327d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
4328d763cef2SBarry Smith .  label - the title to put in the title bar
43297c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
4330a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
4331a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4332d763cef2SBarry Smith 
4333d763cef2SBarry Smith    Output Parameter:
43340b039ecaSBarry Smith .  ctx - the context
4335d763cef2SBarry Smith 
4336d763cef2SBarry Smith    Options Database Key:
43374f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
43387db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
43397db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
43407db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
43417db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4342b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4343d763cef2SBarry Smith 
4344d763cef2SBarry Smith    Notes:
4345a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
4346d763cef2SBarry Smith 
43477db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
43487db568b7SBarry Smith 
43497db568b7SBarry Smith    Many of the functions that control the monitoring have two forms: TSMonitorLGSet/GetXXXX() and TSMonitorLGCtxSet/GetXXXX() the first take a TS object as the
43507db568b7SBarry Smith    first argument (if that TS object does not have a TSMonitorLGCtx associated with it the function call is ignored) and the second takes a TSMonitorLGCtx object
43517db568b7SBarry Smith    as the first argument.
43527db568b7SBarry Smith 
43537db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
43547db568b7SBarry Smith 
43557db568b7SBarry Smith 
4356d763cef2SBarry Smith    Level: intermediate
4357d763cef2SBarry Smith 
43587db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
4359d763cef2SBarry Smith 
43607db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
43617db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
43627db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
43637db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
43647db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
43657c922b88SBarry Smith 
4366d763cef2SBarry Smith @*/
4367a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4368d763cef2SBarry Smith {
43697f52daa2SLisandro Dalcin   PetscDraw      draw;
4370dfbe8321SBarry Smith   PetscErrorCode ierr;
4371d763cef2SBarry Smith 
4372d763cef2SBarry Smith   PetscFunctionBegin;
4373b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
43747f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
43757f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
43767f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
4377287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
43787f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
4379a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
4380d763cef2SBarry Smith   PetscFunctionReturn(0);
4381d763cef2SBarry Smith }
4382d763cef2SBarry Smith 
43834a2ae208SSatish Balay #undef __FUNCT__
43844f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
4385b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4386d763cef2SBarry Smith {
43870b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4388c32365f1SBarry Smith   PetscReal      x   = ptime,y;
4389dfbe8321SBarry Smith   PetscErrorCode ierr;
4390d763cef2SBarry Smith 
4391d763cef2SBarry Smith   PetscFunctionBegin;
439263e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
4393b06615a5SLisandro Dalcin   if (!step) {
4394a9f9c1f6SBarry Smith     PetscDrawAxis axis;
4395a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
43966934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr);
4397a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4398a9f9c1f6SBarry Smith   }
4399c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
44000b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
4401b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
44020b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
44036934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
44043923b477SBarry Smith   }
4405d763cef2SBarry Smith   PetscFunctionReturn(0);
4406d763cef2SBarry Smith }
4407d763cef2SBarry Smith 
44084a2ae208SSatish Balay #undef __FUNCT__
4409a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
4410d763cef2SBarry Smith /*@C
4411a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4412a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
4413d763cef2SBarry Smith 
44140b039ecaSBarry Smith    Collective on TSMonitorLGCtx
4415d763cef2SBarry Smith 
4416d763cef2SBarry Smith    Input Parameter:
44170b039ecaSBarry Smith .  ctx - the monitor context
4418d763cef2SBarry Smith 
4419d763cef2SBarry Smith    Level: intermediate
4420d763cef2SBarry Smith 
4421d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
4422d763cef2SBarry Smith 
44234f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
4424d763cef2SBarry Smith @*/
4425a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4426d763cef2SBarry Smith {
4427dfbe8321SBarry Smith   PetscErrorCode ierr;
4428d763cef2SBarry Smith 
4429d763cef2SBarry Smith   PetscFunctionBegin;
44307684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
44317684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
44327684fa3eSBarry Smith   }
44330b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
443431152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
4435387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
4436387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
4437387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
44380b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
4439d763cef2SBarry Smith   PetscFunctionReturn(0);
4440d763cef2SBarry Smith }
4441d763cef2SBarry Smith 
44424a2ae208SSatish Balay #undef __FUNCT__
44434a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
4444d763cef2SBarry Smith /*@
4445b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4446d763cef2SBarry Smith 
4447d763cef2SBarry Smith    Not Collective
4448d763cef2SBarry Smith 
4449d763cef2SBarry Smith    Input Parameter:
4450d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4451d763cef2SBarry Smith 
4452d763cef2SBarry Smith    Output Parameter:
445363e21af5SBarry Smith .  t  - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime().
4454d763cef2SBarry Smith 
4455d763cef2SBarry Smith    Level: beginner
4456d763cef2SBarry Smith 
4457b8123daeSJed Brown    Note:
4458b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
44599be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4460b8123daeSJed Brown 
446163e21af5SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime()
4462d763cef2SBarry Smith 
4463d763cef2SBarry Smith .keywords: TS, get, time
4464d763cef2SBarry Smith @*/
44657087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4466d763cef2SBarry Smith {
4467d763cef2SBarry Smith   PetscFunctionBegin;
44680700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4469f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4470d763cef2SBarry Smith   *t = ts->ptime;
4471d763cef2SBarry Smith   PetscFunctionReturn(0);
4472d763cef2SBarry Smith }
4473d763cef2SBarry Smith 
44744a2ae208SSatish Balay #undef __FUNCT__
4475e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
4476e5e524a1SHong Zhang /*@
4477e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4478e5e524a1SHong Zhang 
4479e5e524a1SHong Zhang    Not Collective
4480e5e524a1SHong Zhang 
4481e5e524a1SHong Zhang    Input Parameter:
4482e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4483e5e524a1SHong Zhang 
4484e5e524a1SHong Zhang    Output Parameter:
4485e5e524a1SHong Zhang .  t  - the previous time
4486e5e524a1SHong Zhang 
4487e5e524a1SHong Zhang    Level: beginner
4488e5e524a1SHong Zhang 
4489e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
4490e5e524a1SHong Zhang 
4491e5e524a1SHong Zhang .keywords: TS, get, time
4492e5e524a1SHong Zhang @*/
4493e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4494e5e524a1SHong Zhang {
4495e5e524a1SHong Zhang   PetscFunctionBegin;
4496e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4497e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4498e5e524a1SHong Zhang   *t = ts->ptime_prev;
4499e5e524a1SHong Zhang   PetscFunctionReturn(0);
4500e5e524a1SHong Zhang }
4501e5e524a1SHong Zhang 
4502e5e524a1SHong Zhang #undef __FUNCT__
45036a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
45046a4d4014SLisandro Dalcin /*@
45056a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
45066a4d4014SLisandro Dalcin 
45073f9fe445SBarry Smith    Logically Collective on TS
45086a4d4014SLisandro Dalcin 
45096a4d4014SLisandro Dalcin    Input Parameters:
45106a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
45116a4d4014SLisandro Dalcin -  time - the time
45126a4d4014SLisandro Dalcin 
45136a4d4014SLisandro Dalcin    Level: intermediate
45146a4d4014SLisandro Dalcin 
45156a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
45166a4d4014SLisandro Dalcin 
45176a4d4014SLisandro Dalcin .keywords: TS, set, time
45186a4d4014SLisandro Dalcin @*/
45197087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
45206a4d4014SLisandro Dalcin {
45216a4d4014SLisandro Dalcin   PetscFunctionBegin;
45220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4523c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
45246a4d4014SLisandro Dalcin   ts->ptime = t;
45256a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
45266a4d4014SLisandro Dalcin }
45276a4d4014SLisandro Dalcin 
45286a4d4014SLisandro Dalcin #undef __FUNCT__
45294a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
4530d763cef2SBarry Smith /*@C
4531d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4532d763cef2SBarry Smith    TS options in the database.
4533d763cef2SBarry Smith 
45343f9fe445SBarry Smith    Logically Collective on TS
4535d763cef2SBarry Smith 
4536d763cef2SBarry Smith    Input Parameter:
4537d763cef2SBarry Smith +  ts     - The TS context
4538d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4539d763cef2SBarry Smith 
4540d763cef2SBarry Smith    Notes:
4541d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4542d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4543d763cef2SBarry Smith    hyphen.
4544d763cef2SBarry Smith 
4545d763cef2SBarry Smith    Level: advanced
4546d763cef2SBarry Smith 
4547d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
4548d763cef2SBarry Smith 
4549d763cef2SBarry Smith .seealso: TSSetFromOptions()
4550d763cef2SBarry Smith 
4551d763cef2SBarry Smith @*/
45527087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4553d763cef2SBarry Smith {
4554dfbe8321SBarry Smith   PetscErrorCode ierr;
4555089b2837SJed Brown   SNES           snes;
4556d763cef2SBarry Smith 
4557d763cef2SBarry Smith   PetscFunctionBegin;
45580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4559d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4560089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4561089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4562d763cef2SBarry Smith   PetscFunctionReturn(0);
4563d763cef2SBarry Smith }
4564d763cef2SBarry Smith 
4565d763cef2SBarry Smith 
45664a2ae208SSatish Balay #undef __FUNCT__
45674a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
4568d763cef2SBarry Smith /*@C
4569d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4570d763cef2SBarry Smith    TS options in the database.
4571d763cef2SBarry Smith 
45723f9fe445SBarry Smith    Logically Collective on TS
4573d763cef2SBarry Smith 
4574d763cef2SBarry Smith    Input Parameter:
4575d763cef2SBarry Smith +  ts     - The TS context
4576d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4577d763cef2SBarry Smith 
4578d763cef2SBarry Smith    Notes:
4579d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4580d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4581d763cef2SBarry Smith    hyphen.
4582d763cef2SBarry Smith 
4583d763cef2SBarry Smith    Level: advanced
4584d763cef2SBarry Smith 
4585d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
4586d763cef2SBarry Smith 
4587d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4588d763cef2SBarry Smith 
4589d763cef2SBarry Smith @*/
45907087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4591d763cef2SBarry Smith {
4592dfbe8321SBarry Smith   PetscErrorCode ierr;
4593089b2837SJed Brown   SNES           snes;
4594d763cef2SBarry Smith 
4595d763cef2SBarry Smith   PetscFunctionBegin;
45960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4597d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4598089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4599089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4600d763cef2SBarry Smith   PetscFunctionReturn(0);
4601d763cef2SBarry Smith }
4602d763cef2SBarry Smith 
46034a2ae208SSatish Balay #undef __FUNCT__
46044a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
4605d763cef2SBarry Smith /*@C
4606d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4607d763cef2SBarry Smith    TS options in the database.
4608d763cef2SBarry Smith 
4609d763cef2SBarry Smith    Not Collective
4610d763cef2SBarry Smith 
4611d763cef2SBarry Smith    Input Parameter:
4612d763cef2SBarry Smith .  ts - The TS context
4613d763cef2SBarry Smith 
4614d763cef2SBarry Smith    Output Parameter:
4615d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4616d763cef2SBarry Smith 
4617d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
4618d763cef2SBarry Smith    sufficient length to hold the prefix.
4619d763cef2SBarry Smith 
4620d763cef2SBarry Smith    Level: intermediate
4621d763cef2SBarry Smith 
4622d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
4623d763cef2SBarry Smith 
4624d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4625d763cef2SBarry Smith @*/
46267087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4627d763cef2SBarry Smith {
4628dfbe8321SBarry Smith   PetscErrorCode ierr;
4629d763cef2SBarry Smith 
4630d763cef2SBarry Smith   PetscFunctionBegin;
46310700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
46324482741eSBarry Smith   PetscValidPointer(prefix,2);
4633d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4634d763cef2SBarry Smith   PetscFunctionReturn(0);
4635d763cef2SBarry Smith }
4636d763cef2SBarry Smith 
46374a2ae208SSatish Balay #undef __FUNCT__
46384a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
4639d763cef2SBarry Smith /*@C
4640d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4641d763cef2SBarry Smith 
4642d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4643d763cef2SBarry Smith 
4644d763cef2SBarry Smith    Input Parameter:
4645d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4646d763cef2SBarry Smith 
4647d763cef2SBarry Smith    Output Parameters:
4648e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4649e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4650e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4651e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4652d763cef2SBarry Smith 
46530298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
4654d763cef2SBarry Smith 
4655d763cef2SBarry Smith    Level: intermediate
4656d763cef2SBarry Smith 
465726d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
4658d763cef2SBarry Smith 
4659d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
4660d763cef2SBarry Smith @*/
4661e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4662d763cef2SBarry Smith {
4663089b2837SJed Brown   PetscErrorCode ierr;
4664089b2837SJed Brown   SNES           snes;
466524989b8cSPeter Brune   DM             dm;
4666089b2837SJed Brown 
4667d763cef2SBarry Smith   PetscFunctionBegin;
4668089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4669e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
467024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
467124989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4672d763cef2SBarry Smith   PetscFunctionReturn(0);
4673d763cef2SBarry Smith }
4674d763cef2SBarry Smith 
46751713a123SBarry Smith #undef __FUNCT__
46762eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
46772eca1d9cSJed Brown /*@C
46782eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
46792eca1d9cSJed Brown 
46802eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
46812eca1d9cSJed Brown 
46822eca1d9cSJed Brown    Input Parameter:
46832eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
46842eca1d9cSJed Brown 
46852eca1d9cSJed Brown    Output Parameters:
4686e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4687e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
46882eca1d9cSJed Brown .  f   - The function to compute the matrices
46892eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
46902eca1d9cSJed Brown 
46910298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
46922eca1d9cSJed Brown 
46932eca1d9cSJed Brown    Level: advanced
46942eca1d9cSJed Brown 
46952eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
46962eca1d9cSJed Brown 
46972eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
46982eca1d9cSJed Brown @*/
4699e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
47002eca1d9cSJed Brown {
4701089b2837SJed Brown   PetscErrorCode ierr;
4702089b2837SJed Brown   SNES           snes;
470324989b8cSPeter Brune   DM             dm;
47040910c330SBarry Smith 
47052eca1d9cSJed Brown   PetscFunctionBegin;
4706089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4707f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4708e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
470924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
471024989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
47112eca1d9cSJed Brown   PetscFunctionReturn(0);
47122eca1d9cSJed Brown }
47132eca1d9cSJed Brown 
47146083293cSBarry Smith 
47152eca1d9cSJed Brown #undef __FUNCT__
471683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
47171713a123SBarry Smith /*@C
471883a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
47191713a123SBarry Smith    VecView() for the solution at each timestep
47201713a123SBarry Smith 
47211713a123SBarry Smith    Collective on TS
47221713a123SBarry Smith 
47231713a123SBarry Smith    Input Parameters:
47241713a123SBarry Smith +  ts - the TS context
47251713a123SBarry Smith .  step - current time-step
4726142b95e3SSatish Balay .  ptime - current time
47270298fd71SBarry Smith -  dummy - either a viewer or NULL
47281713a123SBarry Smith 
472999fdda47SBarry Smith    Options Database:
473099fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
473199fdda47SBarry Smith 
4732387f4636SBarry Smith    Notes: the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
473399fdda47SBarry Smith        will look bad
473499fdda47SBarry Smith 
47351713a123SBarry Smith    Level: intermediate
47361713a123SBarry Smith 
47371713a123SBarry Smith .keywords: TS,  vector, monitor, view
47381713a123SBarry Smith 
4739a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
47401713a123SBarry Smith @*/
47410910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
47421713a123SBarry Smith {
4743dfbe8321SBarry Smith   PetscErrorCode   ierr;
474483a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4745473a3ab2SBarry Smith   PetscDraw        draw;
47461713a123SBarry Smith 
47471713a123SBarry Smith   PetscFunctionBegin;
47486083293cSBarry Smith   if (!step && ictx->showinitial) {
47496083293cSBarry Smith     if (!ictx->initialsolution) {
47500910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
47511713a123SBarry Smith     }
47520910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
47536083293cSBarry Smith   }
4754b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
47550dcf80beSBarry Smith 
47566083293cSBarry Smith   if (ictx->showinitial) {
47576083293cSBarry Smith     PetscReal pause;
47586083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
47596083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
47606083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
47616083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
47626083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
47636083293cSBarry Smith   }
47640910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4765473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
476651fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4767473a3ab2SBarry Smith     char      time[32];
4768473a3ab2SBarry Smith 
4769473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
477085b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4771473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4772473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
477351fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4774473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4775473a3ab2SBarry Smith   }
4776473a3ab2SBarry Smith 
47776083293cSBarry Smith   if (ictx->showinitial) {
47786083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
47796083293cSBarry Smith   }
47801713a123SBarry Smith   PetscFunctionReturn(0);
47811713a123SBarry Smith }
47821713a123SBarry Smith 
47832d5ee99bSBarry Smith #undef __FUNCT__
47849110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorDrawSensi"
47859110b2e7SHong Zhang /*@C
47869110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
47879110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
47889110b2e7SHong Zhang 
47899110b2e7SHong Zhang    Collective on TS
47909110b2e7SHong Zhang 
47919110b2e7SHong Zhang    Input Parameters:
47929110b2e7SHong Zhang +  ts - the TS context
47939110b2e7SHong Zhang .  step - current time-step
47949110b2e7SHong Zhang .  ptime - current time
47959110b2e7SHong Zhang .  u - current state
47969110b2e7SHong Zhang .  numcost - number of cost functions
47979110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
47989110b2e7SHong Zhang .  mu - sensitivities to parameters
47999110b2e7SHong Zhang -  dummy - either a viewer or NULL
48009110b2e7SHong Zhang 
48019110b2e7SHong Zhang    Level: intermediate
48029110b2e7SHong Zhang 
48039110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
48049110b2e7SHong Zhang 
48059110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
48069110b2e7SHong Zhang @*/
48079110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
48089110b2e7SHong Zhang {
48099110b2e7SHong Zhang   PetscErrorCode   ierr;
48109110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
48119110b2e7SHong Zhang   PetscDraw        draw;
4812a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
4813a0046e2cSSatish Balay   char             time[32];
48149110b2e7SHong Zhang 
48159110b2e7SHong Zhang   PetscFunctionBegin;
48169110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
48179110b2e7SHong Zhang 
48189110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
48199110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
48209110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
48219110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
48229110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
48239110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
48249110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
48259110b2e7SHong Zhang   PetscFunctionReturn(0);
48269110b2e7SHong Zhang }
48279110b2e7SHong Zhang 
48289110b2e7SHong Zhang #undef __FUNCT__
48292d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
48302d5ee99bSBarry Smith /*@C
48312d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
48322d5ee99bSBarry Smith 
48332d5ee99bSBarry Smith    Collective on TS
48342d5ee99bSBarry Smith 
48352d5ee99bSBarry Smith    Input Parameters:
48362d5ee99bSBarry Smith +  ts - the TS context
48372d5ee99bSBarry Smith .  step - current time-step
48382d5ee99bSBarry Smith .  ptime - current time
48392d5ee99bSBarry Smith -  dummy - either a viewer or NULL
48402d5ee99bSBarry Smith 
48412d5ee99bSBarry Smith    Level: intermediate
48422d5ee99bSBarry Smith 
48432d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
48442d5ee99bSBarry Smith 
48452d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
48462d5ee99bSBarry Smith @*/
48472d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
48482d5ee99bSBarry Smith {
48492d5ee99bSBarry Smith   PetscErrorCode    ierr;
48502d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
48512d5ee99bSBarry Smith   PetscDraw         draw;
48526934998bSLisandro Dalcin   PetscDrawAxis     axis;
48532d5ee99bSBarry Smith   PetscInt          n;
48542d5ee99bSBarry Smith   PetscMPIInt       size;
48556934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
48562d5ee99bSBarry Smith   char              time[32];
48572d5ee99bSBarry Smith   const PetscScalar *U;
48582d5ee99bSBarry Smith 
48592d5ee99bSBarry Smith   PetscFunctionBegin;
48606934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
48616934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
48622d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
48636934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
48642d5ee99bSBarry Smith 
48652d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
48666934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
48676934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
48686934998bSLisandro Dalcin   if (!step) {
48696934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
48706934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
48716934998bSLisandro Dalcin   }
48722d5ee99bSBarry Smith 
48732d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
48746934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
48756934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
4876a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
48776934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
48782d5ee99bSBarry Smith 
48796934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
48806934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
48812d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
48824b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
488385b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
48842d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
488551fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
48862d5ee99bSBarry Smith   }
48876934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
48882d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
48896934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
48902d5ee99bSBarry Smith   PetscFunctionReturn(0);
48912d5ee99bSBarry Smith }
48922d5ee99bSBarry Smith 
48931713a123SBarry Smith 
48946c699258SBarry Smith #undef __FUNCT__
489583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
48966083293cSBarry Smith /*@C
489783a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
48986083293cSBarry Smith 
48996083293cSBarry Smith    Collective on TS
49006083293cSBarry Smith 
49016083293cSBarry Smith    Input Parameters:
49026083293cSBarry Smith .    ctx - the monitor context
49036083293cSBarry Smith 
49046083293cSBarry Smith    Level: intermediate
49056083293cSBarry Smith 
49066083293cSBarry Smith .keywords: TS,  vector, monitor, view
49076083293cSBarry Smith 
490883a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
49096083293cSBarry Smith @*/
491083a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
49116083293cSBarry Smith {
49126083293cSBarry Smith   PetscErrorCode ierr;
49136083293cSBarry Smith 
49146083293cSBarry Smith   PetscFunctionBegin;
491583a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
491683a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
491783a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
49186083293cSBarry Smith   PetscFunctionReturn(0);
49196083293cSBarry Smith }
49206083293cSBarry Smith 
49216083293cSBarry Smith #undef __FUNCT__
492283a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
49236083293cSBarry Smith /*@C
492483a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
49256083293cSBarry Smith 
49266083293cSBarry Smith    Collective on TS
49276083293cSBarry Smith 
49286083293cSBarry Smith    Input Parameter:
49296083293cSBarry Smith .    ts - time-step context
49306083293cSBarry Smith 
49316083293cSBarry Smith    Output Patameter:
49326083293cSBarry Smith .    ctx - the monitor context
49336083293cSBarry Smith 
493499fdda47SBarry Smith    Options Database:
493599fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
493699fdda47SBarry Smith 
49376083293cSBarry Smith    Level: intermediate
49386083293cSBarry Smith 
49396083293cSBarry Smith .keywords: TS,  vector, monitor, view
49406083293cSBarry Smith 
494183a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
49426083293cSBarry Smith @*/
494383a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
49446083293cSBarry Smith {
49456083293cSBarry Smith   PetscErrorCode   ierr;
49466083293cSBarry Smith 
49476083293cSBarry Smith   PetscFunctionBegin;
4948b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
494983a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4950e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4951bbd56ea5SKarl Rupp 
495283a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4953473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
4954c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4955473a3ab2SBarry Smith 
4956473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
4957c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
49586083293cSBarry Smith   PetscFunctionReturn(0);
49596083293cSBarry Smith }
49606083293cSBarry Smith 
49616083293cSBarry Smith #undef __FUNCT__
496283a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
49633a471f94SBarry Smith /*@C
496483a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
49653a471f94SBarry Smith    VecView() for the error at each timestep
49663a471f94SBarry Smith 
49673a471f94SBarry Smith    Collective on TS
49683a471f94SBarry Smith 
49693a471f94SBarry Smith    Input Parameters:
49703a471f94SBarry Smith +  ts - the TS context
49713a471f94SBarry Smith .  step - current time-step
49723a471f94SBarry Smith .  ptime - current time
49730298fd71SBarry Smith -  dummy - either a viewer or NULL
49743a471f94SBarry Smith 
49753a471f94SBarry Smith    Level: intermediate
49763a471f94SBarry Smith 
49773a471f94SBarry Smith .keywords: TS,  vector, monitor, view
49783a471f94SBarry Smith 
49793a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
49803a471f94SBarry Smith @*/
49810910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
49823a471f94SBarry Smith {
49833a471f94SBarry Smith   PetscErrorCode   ierr;
498483a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
498583a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
49863a471f94SBarry Smith   Vec              work;
49873a471f94SBarry Smith 
49883a471f94SBarry Smith   PetscFunctionBegin;
4989b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
49900910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
49913a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
49920910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
49933a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
49943a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
49953a471f94SBarry Smith   PetscFunctionReturn(0);
49963a471f94SBarry Smith }
49973a471f94SBarry Smith 
4998af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
49993a471f94SBarry Smith #undef __FUNCT__
50006c699258SBarry Smith #define __FUNCT__ "TSSetDM"
50016c699258SBarry Smith /*@
50022a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
50036c699258SBarry Smith 
50043f9fe445SBarry Smith    Logically Collective on TS and DM
50056c699258SBarry Smith 
50066c699258SBarry Smith    Input Parameters:
50072a808120SBarry Smith +  ts - the ODE integrator object
50082a808120SBarry Smith -  dm - the dm, cannot be NULL
50096c699258SBarry Smith 
50106c699258SBarry Smith    Level: intermediate
50116c699258SBarry Smith 
50126c699258SBarry Smith 
50136c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
50146c699258SBarry Smith @*/
50157087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
50166c699258SBarry Smith {
50176c699258SBarry Smith   PetscErrorCode ierr;
5018089b2837SJed Brown   SNES           snes;
5019942e3340SBarry Smith   DMTS           tsdm;
50206c699258SBarry Smith 
50216c699258SBarry Smith   PetscFunctionBegin;
50220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
50232a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
502470663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
5025942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
50262a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
5027942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
5028942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
502924989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
503024989b8cSPeter Brune         tsdm->originaldm = dm;
503124989b8cSPeter Brune       }
503224989b8cSPeter Brune     }
50336bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
503424989b8cSPeter Brune   }
50356c699258SBarry Smith   ts->dm = dm;
5036bbd56ea5SKarl Rupp 
5037089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5038089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
50396c699258SBarry Smith   PetscFunctionReturn(0);
50406c699258SBarry Smith }
50416c699258SBarry Smith 
50426c699258SBarry Smith #undef __FUNCT__
50436c699258SBarry Smith #define __FUNCT__ "TSGetDM"
50446c699258SBarry Smith /*@
50456c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
50466c699258SBarry Smith 
50473f9fe445SBarry Smith    Not Collective
50486c699258SBarry Smith 
50496c699258SBarry Smith    Input Parameter:
50506c699258SBarry Smith . ts - the preconditioner context
50516c699258SBarry Smith 
50526c699258SBarry Smith    Output Parameter:
50536c699258SBarry Smith .  dm - the dm
50546c699258SBarry Smith 
50556c699258SBarry Smith    Level: intermediate
50566c699258SBarry Smith 
50576c699258SBarry Smith 
50586c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
50596c699258SBarry Smith @*/
50607087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
50616c699258SBarry Smith {
5062496e6a7aSJed Brown   PetscErrorCode ierr;
5063496e6a7aSJed Brown 
50646c699258SBarry Smith   PetscFunctionBegin;
50650700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5066496e6a7aSJed Brown   if (!ts->dm) {
5067ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
5068496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
5069496e6a7aSJed Brown   }
50706c699258SBarry Smith   *dm = ts->dm;
50716c699258SBarry Smith   PetscFunctionReturn(0);
50726c699258SBarry Smith }
50731713a123SBarry Smith 
50740f5c6efeSJed Brown #undef __FUNCT__
50750f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
50760f5c6efeSJed Brown /*@
50770f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
50780f5c6efeSJed Brown 
50793f9fe445SBarry Smith    Logically Collective on SNES
50800f5c6efeSJed Brown 
50810f5c6efeSJed Brown    Input Parameter:
5082d42a1c89SJed Brown + snes - nonlinear solver
50830910c330SBarry Smith . U - the current state at which to evaluate the residual
5084d42a1c89SJed Brown - ctx - user context, must be a TS
50850f5c6efeSJed Brown 
50860f5c6efeSJed Brown    Output Parameter:
50870f5c6efeSJed Brown . F - the nonlinear residual
50880f5c6efeSJed Brown 
50890f5c6efeSJed Brown    Notes:
50900f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
50910f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
50920f5c6efeSJed Brown 
50930f5c6efeSJed Brown    Level: advanced
50940f5c6efeSJed Brown 
50950f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
50960f5c6efeSJed Brown @*/
50970910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
50980f5c6efeSJed Brown {
50990f5c6efeSJed Brown   TS             ts = (TS)ctx;
51000f5c6efeSJed Brown   PetscErrorCode ierr;
51010f5c6efeSJed Brown 
51020f5c6efeSJed Brown   PetscFunctionBegin;
51030f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
51040910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
51050f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
51060f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
51070910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
51080f5c6efeSJed Brown   PetscFunctionReturn(0);
51090f5c6efeSJed Brown }
51100f5c6efeSJed Brown 
51110f5c6efeSJed Brown #undef __FUNCT__
51120f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
51130f5c6efeSJed Brown /*@
51140f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
51150f5c6efeSJed Brown 
51160f5c6efeSJed Brown    Collective on SNES
51170f5c6efeSJed Brown 
51180f5c6efeSJed Brown    Input Parameter:
51190f5c6efeSJed Brown + snes - nonlinear solver
51200910c330SBarry Smith . U - the current state at which to evaluate the residual
51210f5c6efeSJed Brown - ctx - user context, must be a TS
51220f5c6efeSJed Brown 
51230f5c6efeSJed Brown    Output Parameter:
51240f5c6efeSJed Brown + A - the Jacobian
51250f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
51260f5c6efeSJed Brown - flag - indicates any structure change in the matrix
51270f5c6efeSJed Brown 
51280f5c6efeSJed Brown    Notes:
51290f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
51300f5c6efeSJed Brown 
51310f5c6efeSJed Brown    Level: developer
51320f5c6efeSJed Brown 
51330f5c6efeSJed Brown .seealso: SNESSetJacobian()
51340f5c6efeSJed Brown @*/
5135d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
51360f5c6efeSJed Brown {
51370f5c6efeSJed Brown   TS             ts = (TS)ctx;
51380f5c6efeSJed Brown   PetscErrorCode ierr;
51390f5c6efeSJed Brown 
51400f5c6efeSJed Brown   PetscFunctionBegin;
51410f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
51420910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
51430f5c6efeSJed Brown   PetscValidPointer(A,3);
514494ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
51450f5c6efeSJed Brown   PetscValidPointer(B,4);
514694ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
51470f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
5148d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
51490f5c6efeSJed Brown   PetscFunctionReturn(0);
51500f5c6efeSJed Brown }
5151325fc9f4SBarry Smith 
51520e4ef248SJed Brown #undef __FUNCT__
51530e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
51540e4ef248SJed Brown /*@C
51559ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
51560e4ef248SJed Brown 
51570e4ef248SJed Brown    Collective on TS
51580e4ef248SJed Brown 
51590e4ef248SJed Brown    Input Arguments:
51600e4ef248SJed Brown +  ts - time stepping context
51610e4ef248SJed Brown .  t - time at which to evaluate
51620910c330SBarry Smith .  U - state at which to evaluate
51630e4ef248SJed Brown -  ctx - context
51640e4ef248SJed Brown 
51650e4ef248SJed Brown    Output Arguments:
51660e4ef248SJed Brown .  F - right hand side
51670e4ef248SJed Brown 
51680e4ef248SJed Brown    Level: intermediate
51690e4ef248SJed Brown 
51700e4ef248SJed Brown    Notes:
51710e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
51720e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
51730e4ef248SJed Brown 
51740e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
51750e4ef248SJed Brown @*/
51760910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
51770e4ef248SJed Brown {
51780e4ef248SJed Brown   PetscErrorCode ierr;
51790e4ef248SJed Brown   Mat            Arhs,Brhs;
51800e4ef248SJed Brown 
51810e4ef248SJed Brown   PetscFunctionBegin;
51820e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
5183d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
51840910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
51850e4ef248SJed Brown   PetscFunctionReturn(0);
51860e4ef248SJed Brown }
51870e4ef248SJed Brown 
51880e4ef248SJed Brown #undef __FUNCT__
51890e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
51900e4ef248SJed Brown /*@C
51910e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
51920e4ef248SJed Brown 
51930e4ef248SJed Brown    Collective on TS
51940e4ef248SJed Brown 
51950e4ef248SJed Brown    Input Arguments:
51960e4ef248SJed Brown +  ts - time stepping context
51970e4ef248SJed Brown .  t - time at which to evaluate
51980910c330SBarry Smith .  U - state at which to evaluate
51990e4ef248SJed Brown -  ctx - context
52000e4ef248SJed Brown 
52010e4ef248SJed Brown    Output Arguments:
52020e4ef248SJed Brown +  A - pointer to operator
52030e4ef248SJed Brown .  B - pointer to preconditioning matrix
52040e4ef248SJed Brown -  flg - matrix structure flag
52050e4ef248SJed Brown 
52060e4ef248SJed Brown    Level: intermediate
52070e4ef248SJed Brown 
52080e4ef248SJed Brown    Notes:
52090e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
52100e4ef248SJed Brown 
52110e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
52120e4ef248SJed Brown @*/
5213d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
52140e4ef248SJed Brown {
52150e4ef248SJed Brown   PetscFunctionBegin;
52160e4ef248SJed Brown   PetscFunctionReturn(0);
52170e4ef248SJed Brown }
52180e4ef248SJed Brown 
52190026cea9SSean Farley #undef __FUNCT__
52200026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
52210026cea9SSean Farley /*@C
52220026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
52230026cea9SSean Farley 
52240026cea9SSean Farley    Collective on TS
52250026cea9SSean Farley 
52260026cea9SSean Farley    Input Arguments:
52270026cea9SSean Farley +  ts - time stepping context
52280026cea9SSean Farley .  t - time at which to evaluate
52290910c330SBarry Smith .  U - state at which to evaluate
52300910c330SBarry Smith .  Udot - time derivative of state vector
52310026cea9SSean Farley -  ctx - context
52320026cea9SSean Farley 
52330026cea9SSean Farley    Output Arguments:
52340026cea9SSean Farley .  F - left hand side
52350026cea9SSean Farley 
52360026cea9SSean Farley    Level: intermediate
52370026cea9SSean Farley 
52380026cea9SSean Farley    Notes:
52390910c330SBarry Smith    The assumption here is that the left hand side is of the form A*Udot (and not A*Udot + B*U). For other cases, the
52400026cea9SSean Farley    user is required to write their own TSComputeIFunction.
52410026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
52420026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
52430026cea9SSean Farley 
52449ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
52459ae8fd06SBarry Smith 
52469ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
52470026cea9SSean Farley @*/
52480910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
52490026cea9SSean Farley {
52500026cea9SSean Farley   PetscErrorCode ierr;
52510026cea9SSean Farley   Mat            A,B;
52520026cea9SSean Farley 
52530026cea9SSean Farley   PetscFunctionBegin;
52540298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
5255d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
52560910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
52570026cea9SSean Farley   PetscFunctionReturn(0);
52580026cea9SSean Farley }
52590026cea9SSean Farley 
52600026cea9SSean Farley #undef __FUNCT__
52610026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
52620026cea9SSean Farley /*@C
5263b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
52640026cea9SSean Farley 
52650026cea9SSean Farley    Collective on TS
52660026cea9SSean Farley 
52670026cea9SSean Farley    Input Arguments:
52680026cea9SSean Farley +  ts - time stepping context
52690026cea9SSean Farley .  t - time at which to evaluate
52700910c330SBarry Smith .  U - state at which to evaluate
52710910c330SBarry Smith .  Udot - time derivative of state vector
52720026cea9SSean Farley .  shift - shift to apply
52730026cea9SSean Farley -  ctx - context
52740026cea9SSean Farley 
52750026cea9SSean Farley    Output Arguments:
52760026cea9SSean Farley +  A - pointer to operator
52770026cea9SSean Farley .  B - pointer to preconditioning matrix
52780026cea9SSean Farley -  flg - matrix structure flag
52790026cea9SSean Farley 
5280b41af12eSJed Brown    Level: advanced
52810026cea9SSean Farley 
52820026cea9SSean Farley    Notes:
52830026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
52840026cea9SSean Farley 
5285b41af12eSJed Brown    It is only appropriate for problems of the form
5286b41af12eSJed Brown 
5287b41af12eSJed Brown $     M Udot = F(U,t)
5288b41af12eSJed Brown 
5289b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
5290b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5291b41af12eSJed Brown   an implicit operator of the form
5292b41af12eSJed Brown 
5293b41af12eSJed Brown $    shift*M + J
5294b41af12eSJed Brown 
5295b41af12eSJed Brown   where J is the Jacobian of -F(U).  Support may be added in a future version of PETSc, but for now, the user must store
5296b41af12eSJed Brown   a copy of M or reassemble it when requested.
5297b41af12eSJed Brown 
52980026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
52990026cea9SSean Farley @*/
5300d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
53010026cea9SSean Farley {
5302b41af12eSJed Brown   PetscErrorCode ierr;
5303b41af12eSJed Brown 
53040026cea9SSean Farley   PetscFunctionBegin;
530594ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
5306b41af12eSJed Brown   ts->ijacobian.shift = shift;
53070026cea9SSean Farley   PetscFunctionReturn(0);
53080026cea9SSean Farley }
5309b41af12eSJed Brown 
5310e817cc15SEmil Constantinescu #undef __FUNCT__
5311e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
5312e817cc15SEmil Constantinescu /*@
5313e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
5314e817cc15SEmil Constantinescu 
5315e817cc15SEmil Constantinescu    Not Collective
5316e817cc15SEmil Constantinescu 
5317e817cc15SEmil Constantinescu    Input Parameter:
5318e817cc15SEmil Constantinescu .  ts - the TS context
5319e817cc15SEmil Constantinescu 
5320e817cc15SEmil Constantinescu    Output Parameter:
53214e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
5322e817cc15SEmil Constantinescu 
5323e817cc15SEmil Constantinescu    Level: beginner
5324e817cc15SEmil Constantinescu 
5325e817cc15SEmil Constantinescu .keywords: TS, equation type
5326e817cc15SEmil Constantinescu 
5327e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
5328e817cc15SEmil Constantinescu @*/
5329e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
5330e817cc15SEmil Constantinescu {
5331e817cc15SEmil Constantinescu   PetscFunctionBegin;
5332e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5333e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
5334e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
5335e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5336e817cc15SEmil Constantinescu }
5337e817cc15SEmil Constantinescu 
5338e817cc15SEmil Constantinescu #undef __FUNCT__
5339e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
5340e817cc15SEmil Constantinescu /*@
5341e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
5342e817cc15SEmil Constantinescu 
5343e817cc15SEmil Constantinescu    Not Collective
5344e817cc15SEmil Constantinescu 
5345e817cc15SEmil Constantinescu    Input Parameter:
5346e817cc15SEmil Constantinescu +  ts - the TS context
53471297b224SEmil Constantinescu -  equation_type - see TSEquationType
5348e817cc15SEmil Constantinescu 
5349e817cc15SEmil Constantinescu    Level: advanced
5350e817cc15SEmil Constantinescu 
5351e817cc15SEmil Constantinescu .keywords: TS, equation type
5352e817cc15SEmil Constantinescu 
5353e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
5354e817cc15SEmil Constantinescu @*/
5355e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
5356e817cc15SEmil Constantinescu {
5357e817cc15SEmil Constantinescu   PetscFunctionBegin;
5358e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5359e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
5360e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5361e817cc15SEmil Constantinescu }
53620026cea9SSean Farley 
53634af1b03aSJed Brown #undef __FUNCT__
53644af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
53654af1b03aSJed Brown /*@
53664af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
53674af1b03aSJed Brown 
53684af1b03aSJed Brown    Not Collective
53694af1b03aSJed Brown 
53704af1b03aSJed Brown    Input Parameter:
53714af1b03aSJed Brown .  ts - the TS context
53724af1b03aSJed Brown 
53734af1b03aSJed Brown    Output Parameter:
53744af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
53754af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
53764af1b03aSJed Brown 
5377487e0bb9SJed Brown    Level: beginner
53784af1b03aSJed Brown 
5379cd652676SJed Brown    Notes:
5380cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
53814af1b03aSJed Brown 
53824af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
53834af1b03aSJed Brown 
53844af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
53854af1b03aSJed Brown @*/
53864af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
53874af1b03aSJed Brown {
53884af1b03aSJed Brown   PetscFunctionBegin;
53894af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53904af1b03aSJed Brown   PetscValidPointer(reason,2);
53914af1b03aSJed Brown   *reason = ts->reason;
53924af1b03aSJed Brown   PetscFunctionReturn(0);
53934af1b03aSJed Brown }
53944af1b03aSJed Brown 
5395fb1732b5SBarry Smith #undef __FUNCT__
5396d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
5397d6ad946cSShri Abhyankar /*@
5398d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5399d6ad946cSShri Abhyankar 
5400d6ad946cSShri Abhyankar    Not Collective
5401d6ad946cSShri Abhyankar 
5402d6ad946cSShri Abhyankar    Input Parameter:
5403d6ad946cSShri Abhyankar +  ts - the TS context
5404d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5405d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
5406d6ad946cSShri Abhyankar 
5407f5abba47SShri Abhyankar    Level: advanced
5408d6ad946cSShri Abhyankar 
5409d6ad946cSShri Abhyankar    Notes:
5410d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
5411d6ad946cSShri Abhyankar 
5412d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
5413d6ad946cSShri Abhyankar 
5414d6ad946cSShri Abhyankar .seealso: TSConvergedReason
5415d6ad946cSShri Abhyankar @*/
5416d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
5417d6ad946cSShri Abhyankar {
5418d6ad946cSShri Abhyankar   PetscFunctionBegin;
5419d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5420d6ad946cSShri Abhyankar   ts->reason = reason;
5421d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
5422d6ad946cSShri Abhyankar }
5423d6ad946cSShri Abhyankar 
5424d6ad946cSShri Abhyankar #undef __FUNCT__
5425cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
5426cc708dedSBarry Smith /*@
5427cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
5428cc708dedSBarry Smith 
5429cc708dedSBarry Smith    Not Collective
5430cc708dedSBarry Smith 
5431cc708dedSBarry Smith    Input Parameter:
5432cc708dedSBarry Smith .  ts - the TS context
5433cc708dedSBarry Smith 
5434cc708dedSBarry Smith    Output Parameter:
543563e21af5SBarry Smith .  ftime - the final time. This time corresponds to the final time set with TSSetDuration()
5436cc708dedSBarry Smith 
5437487e0bb9SJed Brown    Level: beginner
5438cc708dedSBarry Smith 
5439cc708dedSBarry Smith    Notes:
5440cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
5441cc708dedSBarry Smith 
5442cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
5443cc708dedSBarry Smith 
5444cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
5445cc708dedSBarry Smith @*/
5446cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
5447cc708dedSBarry Smith {
5448cc708dedSBarry Smith   PetscFunctionBegin;
5449cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5450cc708dedSBarry Smith   PetscValidPointer(ftime,2);
5451cc708dedSBarry Smith   *ftime = ts->solvetime;
5452cc708dedSBarry Smith   PetscFunctionReturn(0);
5453cc708dedSBarry Smith }
5454cc708dedSBarry Smith 
5455cc708dedSBarry Smith #undef __FUNCT__
54562c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps"
54572c18e0fdSBarry Smith /*@
54582c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
54592c18e0fdSBarry Smith 
54602c18e0fdSBarry Smith    Not Collective
54612c18e0fdSBarry Smith 
54622c18e0fdSBarry Smith    Input Parameter:
54632c18e0fdSBarry Smith .  ts - the TS context
54642c18e0fdSBarry Smith 
54652c18e0fdSBarry Smith    Output Parameter:
54662c18e0fdSBarry Smith .  steps - the number of steps
54672c18e0fdSBarry Smith 
54682c18e0fdSBarry Smith    Level: beginner
54692c18e0fdSBarry Smith 
54702c18e0fdSBarry Smith    Notes:
54712c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
54722c18e0fdSBarry Smith 
54732c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
54742c18e0fdSBarry Smith 
54752c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
54762c18e0fdSBarry Smith @*/
54772c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
54782c18e0fdSBarry Smith {
54792c18e0fdSBarry Smith   PetscFunctionBegin;
54802c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
54812c18e0fdSBarry Smith   PetscValidPointer(steps,2);
54822c18e0fdSBarry Smith   *steps = ts->total_steps;
54832c18e0fdSBarry Smith   PetscFunctionReturn(0);
54842c18e0fdSBarry Smith }
54852c18e0fdSBarry Smith 
54862c18e0fdSBarry Smith #undef __FUNCT__
54875ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
54889f67acb7SJed Brown /*@
54895ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
54909f67acb7SJed Brown    used by the time integrator.
54919f67acb7SJed Brown 
54929f67acb7SJed Brown    Not Collective
54939f67acb7SJed Brown 
54949f67acb7SJed Brown    Input Parameter:
54959f67acb7SJed Brown .  ts - TS context
54969f67acb7SJed Brown 
54979f67acb7SJed Brown    Output Parameter:
54989f67acb7SJed Brown .  nits - number of nonlinear iterations
54999f67acb7SJed Brown 
55009f67acb7SJed Brown    Notes:
55019f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
55029f67acb7SJed Brown 
55039f67acb7SJed Brown    Level: intermediate
55049f67acb7SJed Brown 
55059f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
55069f67acb7SJed Brown 
55075ef26d82SJed Brown .seealso:  TSGetKSPIterations()
55089f67acb7SJed Brown @*/
55095ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
55109f67acb7SJed Brown {
55119f67acb7SJed Brown   PetscFunctionBegin;
55129f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
55139f67acb7SJed Brown   PetscValidIntPointer(nits,2);
55145ef26d82SJed Brown   *nits = ts->snes_its;
55159f67acb7SJed Brown   PetscFunctionReturn(0);
55169f67acb7SJed Brown }
55179f67acb7SJed Brown 
55189f67acb7SJed Brown #undef __FUNCT__
55195ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
55209f67acb7SJed Brown /*@
55215ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
55229f67acb7SJed Brown    used by the time integrator.
55239f67acb7SJed Brown 
55249f67acb7SJed Brown    Not Collective
55259f67acb7SJed Brown 
55269f67acb7SJed Brown    Input Parameter:
55279f67acb7SJed Brown .  ts - TS context
55289f67acb7SJed Brown 
55299f67acb7SJed Brown    Output Parameter:
55309f67acb7SJed Brown .  lits - number of linear iterations
55319f67acb7SJed Brown 
55329f67acb7SJed Brown    Notes:
55339f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
55349f67acb7SJed Brown 
55359f67acb7SJed Brown    Level: intermediate
55369f67acb7SJed Brown 
55379f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
55389f67acb7SJed Brown 
55395ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
55409f67acb7SJed Brown @*/
55415ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
55429f67acb7SJed Brown {
55439f67acb7SJed Brown   PetscFunctionBegin;
55449f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
55459f67acb7SJed Brown   PetscValidIntPointer(lits,2);
55465ef26d82SJed Brown   *lits = ts->ksp_its;
55479f67acb7SJed Brown   PetscFunctionReturn(0);
55489f67acb7SJed Brown }
55499f67acb7SJed Brown 
55509f67acb7SJed Brown #undef __FUNCT__
5551cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
5552cef5090cSJed Brown /*@
5553cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5554cef5090cSJed Brown 
5555cef5090cSJed Brown    Not Collective
5556cef5090cSJed Brown 
5557cef5090cSJed Brown    Input Parameter:
5558cef5090cSJed Brown .  ts - TS context
5559cef5090cSJed Brown 
5560cef5090cSJed Brown    Output Parameter:
5561cef5090cSJed Brown .  rejects - number of steps rejected
5562cef5090cSJed Brown 
5563cef5090cSJed Brown    Notes:
5564cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5565cef5090cSJed Brown 
5566cef5090cSJed Brown    Level: intermediate
5567cef5090cSJed Brown 
5568cef5090cSJed Brown .keywords: TS, get, number
5569cef5090cSJed Brown 
55705ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5571cef5090cSJed Brown @*/
5572cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5573cef5090cSJed Brown {
5574cef5090cSJed Brown   PetscFunctionBegin;
5575cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5576cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5577cef5090cSJed Brown   *rejects = ts->reject;
5578cef5090cSJed Brown   PetscFunctionReturn(0);
5579cef5090cSJed Brown }
5580cef5090cSJed Brown 
5581cef5090cSJed Brown #undef __FUNCT__
5582cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
5583cef5090cSJed Brown /*@
5584cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5585cef5090cSJed Brown 
5586cef5090cSJed Brown    Not Collective
5587cef5090cSJed Brown 
5588cef5090cSJed Brown    Input Parameter:
5589cef5090cSJed Brown .  ts - TS context
5590cef5090cSJed Brown 
5591cef5090cSJed Brown    Output Parameter:
5592cef5090cSJed Brown .  fails - number of failed nonlinear solves
5593cef5090cSJed Brown 
5594cef5090cSJed Brown    Notes:
5595cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5596cef5090cSJed Brown 
5597cef5090cSJed Brown    Level: intermediate
5598cef5090cSJed Brown 
5599cef5090cSJed Brown .keywords: TS, get, number
5600cef5090cSJed Brown 
56015ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5602cef5090cSJed Brown @*/
5603cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5604cef5090cSJed Brown {
5605cef5090cSJed Brown   PetscFunctionBegin;
5606cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5607cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5608cef5090cSJed Brown   *fails = ts->num_snes_failures;
5609cef5090cSJed Brown   PetscFunctionReturn(0);
5610cef5090cSJed Brown }
5611cef5090cSJed Brown 
5612cef5090cSJed Brown #undef __FUNCT__
5613cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
5614cef5090cSJed Brown /*@
5615cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5616cef5090cSJed Brown 
5617cef5090cSJed Brown    Not Collective
5618cef5090cSJed Brown 
5619cef5090cSJed Brown    Input Parameter:
5620cef5090cSJed Brown +  ts - TS context
5621cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5622cef5090cSJed Brown 
5623cef5090cSJed Brown    Notes:
5624cef5090cSJed Brown    The counter is reset to zero for each step
5625cef5090cSJed Brown 
5626cef5090cSJed Brown    Options Database Key:
5627cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5628cef5090cSJed Brown 
5629cef5090cSJed Brown    Level: intermediate
5630cef5090cSJed Brown 
5631cef5090cSJed Brown .keywords: TS, set, maximum, number
5632cef5090cSJed Brown 
56335ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5634cef5090cSJed Brown @*/
5635cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5636cef5090cSJed Brown {
5637cef5090cSJed Brown   PetscFunctionBegin;
5638cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5639cef5090cSJed Brown   ts->max_reject = rejects;
5640cef5090cSJed Brown   PetscFunctionReturn(0);
5641cef5090cSJed Brown }
5642cef5090cSJed Brown 
5643cef5090cSJed Brown #undef __FUNCT__
5644cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
5645cef5090cSJed Brown /*@
5646cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5647cef5090cSJed Brown 
5648cef5090cSJed Brown    Not Collective
5649cef5090cSJed Brown 
5650cef5090cSJed Brown    Input Parameter:
5651cef5090cSJed Brown +  ts - TS context
5652cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5653cef5090cSJed Brown 
5654cef5090cSJed Brown    Notes:
5655cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5656cef5090cSJed Brown 
5657cef5090cSJed Brown    Options Database Key:
5658cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5659cef5090cSJed Brown 
5660cef5090cSJed Brown    Level: intermediate
5661cef5090cSJed Brown 
5662cef5090cSJed Brown .keywords: TS, set, maximum, number
5663cef5090cSJed Brown 
56645ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5665cef5090cSJed Brown @*/
5666cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5667cef5090cSJed Brown {
5668cef5090cSJed Brown   PetscFunctionBegin;
5669cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5670cef5090cSJed Brown   ts->max_snes_failures = fails;
5671cef5090cSJed Brown   PetscFunctionReturn(0);
5672cef5090cSJed Brown }
5673cef5090cSJed Brown 
5674cef5090cSJed Brown #undef __FUNCT__
56754e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
5676cef5090cSJed Brown /*@
5677cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5678cef5090cSJed Brown 
5679cef5090cSJed Brown    Not Collective
5680cef5090cSJed Brown 
5681cef5090cSJed Brown    Input Parameter:
5682cef5090cSJed Brown +  ts - TS context
5683cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5684cef5090cSJed Brown 
5685cef5090cSJed Brown    Options Database Key:
5686cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5687cef5090cSJed Brown 
5688cef5090cSJed Brown    Level: intermediate
5689cef5090cSJed Brown 
5690cef5090cSJed Brown .keywords: TS, set, error
5691cef5090cSJed Brown 
56925ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5693cef5090cSJed Brown @*/
5694cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5695cef5090cSJed Brown {
5696cef5090cSJed Brown   PetscFunctionBegin;
5697cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5698cef5090cSJed Brown   ts->errorifstepfailed = err;
5699cef5090cSJed Brown   PetscFunctionReturn(0);
5700cef5090cSJed Brown }
5701cef5090cSJed Brown 
5702cef5090cSJed Brown #undef __FUNCT__
5703fde5950dSBarry Smith #define __FUNCT__ "TSMonitorSolution"
5704fb1732b5SBarry Smith /*@C
5705fde5950dSBarry Smith    TSMonitorSolution - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file or a PetscDraw object
5706fb1732b5SBarry Smith 
5707fb1732b5SBarry Smith    Collective on TS
5708fb1732b5SBarry Smith 
5709fb1732b5SBarry Smith    Input Parameters:
5710fb1732b5SBarry Smith +  ts - the TS context
5711fb1732b5SBarry Smith .  step - current time-step
5712fb1732b5SBarry Smith .  ptime - current time
57130910c330SBarry Smith .  u - current state
5714721cd6eeSBarry Smith -  vf - viewer and its format
5715fb1732b5SBarry Smith 
5716fb1732b5SBarry Smith    Level: intermediate
5717fb1732b5SBarry Smith 
5718fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
5719fb1732b5SBarry Smith 
5720fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5721fb1732b5SBarry Smith @*/
5722721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5723fb1732b5SBarry Smith {
5724fb1732b5SBarry Smith   PetscErrorCode ierr;
5725fb1732b5SBarry Smith 
5726fb1732b5SBarry Smith   PetscFunctionBegin;
5727721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5728721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5729721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5730ed81e22dSJed Brown   PetscFunctionReturn(0);
5731ed81e22dSJed Brown }
5732ed81e22dSJed Brown 
5733ed81e22dSJed Brown #undef __FUNCT__
5734ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
5735ed81e22dSJed Brown /*@C
5736ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5737ed81e22dSJed Brown 
5738ed81e22dSJed Brown    Collective on TS
5739ed81e22dSJed Brown 
5740ed81e22dSJed Brown    Input Parameters:
5741ed81e22dSJed Brown +  ts - the TS context
5742ed81e22dSJed Brown .  step - current time-step
5743ed81e22dSJed Brown .  ptime - current time
57440910c330SBarry Smith .  u - current state
5745ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5746ed81e22dSJed Brown 
5747ed81e22dSJed Brown    Level: intermediate
5748ed81e22dSJed Brown 
5749ed81e22dSJed Brown    Notes:
5750ed81e22dSJed Brown    The VTK format does not allow writing multiple time steps in the same file, therefore a different file will be written for each time step.
5751ed81e22dSJed Brown    These are named according to the file name template.
5752ed81e22dSJed Brown 
5753ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5754ed81e22dSJed Brown 
5755ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5756ed81e22dSJed Brown 
5757ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5758ed81e22dSJed Brown @*/
57590910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5760ed81e22dSJed Brown {
5761ed81e22dSJed Brown   PetscErrorCode ierr;
5762ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5763ed81e22dSJed Brown   PetscViewer    viewer;
5764ed81e22dSJed Brown 
5765ed81e22dSJed Brown   PetscFunctionBegin;
576663e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
57678caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5768ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
57690910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5770ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5771ed81e22dSJed Brown   PetscFunctionReturn(0);
5772ed81e22dSJed Brown }
5773ed81e22dSJed Brown 
5774ed81e22dSJed Brown #undef __FUNCT__
5775ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
5776ed81e22dSJed Brown /*@C
5777ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5778ed81e22dSJed Brown 
5779ed81e22dSJed Brown    Collective on TS
5780ed81e22dSJed Brown 
5781ed81e22dSJed Brown    Input Parameters:
5782ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5783ed81e22dSJed Brown 
5784ed81e22dSJed Brown    Level: intermediate
5785ed81e22dSJed Brown 
5786ed81e22dSJed Brown    Note:
5787ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5788ed81e22dSJed Brown 
5789ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5790ed81e22dSJed Brown 
5791ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5792ed81e22dSJed Brown @*/
5793ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5794ed81e22dSJed Brown {
5795ed81e22dSJed Brown   PetscErrorCode ierr;
5796ed81e22dSJed Brown 
5797ed81e22dSJed Brown   PetscFunctionBegin;
5798ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5799fb1732b5SBarry Smith   PetscFunctionReturn(0);
5800fb1732b5SBarry Smith }
5801fb1732b5SBarry Smith 
580284df9cb4SJed Brown #undef __FUNCT__
5803552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
580484df9cb4SJed Brown /*@
5805552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
580684df9cb4SJed Brown 
5807ed81e22dSJed Brown    Collective on TS if controller has not been created yet
580884df9cb4SJed Brown 
580984df9cb4SJed Brown    Input Arguments:
5810ed81e22dSJed Brown .  ts - time stepping context
581184df9cb4SJed Brown 
581284df9cb4SJed Brown    Output Arguments:
5813ed81e22dSJed Brown .  adapt - adaptive controller
581484df9cb4SJed Brown 
581584df9cb4SJed Brown    Level: intermediate
581684df9cb4SJed Brown 
5817ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
581884df9cb4SJed Brown @*/
5819552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
582084df9cb4SJed Brown {
582184df9cb4SJed Brown   PetscErrorCode ierr;
582284df9cb4SJed Brown 
582384df9cb4SJed Brown   PetscFunctionBegin;
582484df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5825bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
582684df9cb4SJed Brown   if (!ts->adapt) {
5827ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
58283bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
58291c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
583084df9cb4SJed Brown   }
5831bec58848SLisandro Dalcin   *adapt = ts->adapt;
583284df9cb4SJed Brown   PetscFunctionReturn(0);
583384df9cb4SJed Brown }
5834d6ebe24aSShri Abhyankar 
5835d6ebe24aSShri Abhyankar #undef __FUNCT__
58361c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
58371c3436cfSJed Brown /*@
58381c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
58391c3436cfSJed Brown 
58401c3436cfSJed Brown    Logically Collective
58411c3436cfSJed Brown 
58421c3436cfSJed Brown    Input Arguments:
58431c3436cfSJed Brown +  ts - time integration context
58441c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
58450298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
58461c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
58470298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
58481c3436cfSJed Brown 
5849a3cdaa26SBarry Smith    Options Database keys:
5850a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5851a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5852a3cdaa26SBarry Smith 
58533ff766beSShri Abhyankar    Notes:
58543ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
58553ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
58563ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
58573ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
58583ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
58593ff766beSShri Abhyankar    differential variables.
58603ff766beSShri Abhyankar 
58611c3436cfSJed Brown    Level: beginner
58621c3436cfSJed Brown 
5863c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
58641c3436cfSJed Brown @*/
58651c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
58661c3436cfSJed Brown {
58671c3436cfSJed Brown   PetscErrorCode ierr;
58681c3436cfSJed Brown 
58691c3436cfSJed Brown   PetscFunctionBegin;
5870c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
58711c3436cfSJed Brown   if (vatol) {
58721c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
58731c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
58741c3436cfSJed Brown     ts->vatol = vatol;
58751c3436cfSJed Brown   }
5876c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
58771c3436cfSJed Brown   if (vrtol) {
58781c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
58791c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
58801c3436cfSJed Brown     ts->vrtol = vrtol;
58811c3436cfSJed Brown   }
58821c3436cfSJed Brown   PetscFunctionReturn(0);
58831c3436cfSJed Brown }
58841c3436cfSJed Brown 
58851c3436cfSJed Brown #undef __FUNCT__
5886c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
5887c5033834SJed Brown /*@
5888c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5889c5033834SJed Brown 
5890c5033834SJed Brown    Logically Collective
5891c5033834SJed Brown 
5892c5033834SJed Brown    Input Arguments:
5893c5033834SJed Brown .  ts - time integration context
5894c5033834SJed Brown 
5895c5033834SJed Brown    Output Arguments:
58960298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
58970298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
58980298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
58990298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5900c5033834SJed Brown 
5901c5033834SJed Brown    Level: beginner
5902c5033834SJed Brown 
5903c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5904c5033834SJed Brown @*/
5905c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5906c5033834SJed Brown {
5907c5033834SJed Brown   PetscFunctionBegin;
5908c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5909c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5910c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5911c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5912c5033834SJed Brown   PetscFunctionReturn(0);
5913c5033834SJed Brown }
5914c5033834SJed Brown 
5915c5033834SJed Brown #undef __FUNCT__
59169c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNorm2"
59179c6b16b5SShri Abhyankar /*@
5918a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
59199c6b16b5SShri Abhyankar 
59209c6b16b5SShri Abhyankar    Collective on TS
59219c6b16b5SShri Abhyankar 
59229c6b16b5SShri Abhyankar    Input Arguments:
59239c6b16b5SShri Abhyankar +  ts - time stepping context
5924a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5925a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
59269c6b16b5SShri Abhyankar 
59279c6b16b5SShri Abhyankar    Output Arguments:
59289c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
59299c6b16b5SShri Abhyankar 
59309c6b16b5SShri Abhyankar    Level: developer
59319c6b16b5SShri Abhyankar 
5932deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
59339c6b16b5SShri Abhyankar @*/
5934a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm)
59359c6b16b5SShri Abhyankar {
59369c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
59379c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
59389c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
59399c6b16b5SShri Abhyankar   PetscReal         sum,gsum;
59409c6b16b5SShri Abhyankar   PetscReal         tol;
59419c6b16b5SShri Abhyankar 
59429c6b16b5SShri Abhyankar   PetscFunctionBegin;
59439c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5944a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5945a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5946a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5947a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5948a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5949a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5950a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
59519c6b16b5SShri Abhyankar 
59529c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
59539c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
59549c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
59559c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
59569c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
59579c6b16b5SShri Abhyankar   sum  = 0.;
59589c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
59599c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
59609c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59619c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59629c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
59639c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59649c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
59659c6b16b5SShri Abhyankar     }
59669c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59679c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59689c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
59699c6b16b5SShri Abhyankar     const PetscScalar *atol;
59709c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59719c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
59729c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59739c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
59749c6b16b5SShri Abhyankar     }
59759c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59769c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
59779c6b16b5SShri Abhyankar     const PetscScalar *rtol;
59789c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59799c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
59809c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59819c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
59829c6b16b5SShri Abhyankar     }
59839c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59849c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
59859c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
59869c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59879c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
59889c6b16b5SShri Abhyankar     }
59899c6b16b5SShri Abhyankar   }
59909c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
59919c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
59929c6b16b5SShri Abhyankar 
5993b2566f29SBarry Smith   ierr  = MPIU_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
59949c6b16b5SShri Abhyankar   *norm = PetscSqrtReal(gsum / N);
59959c6b16b5SShri Abhyankar 
59969c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
59979c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
59989c6b16b5SShri Abhyankar }
59999c6b16b5SShri Abhyankar 
60009c6b16b5SShri Abhyankar #undef __FUNCT__
60019c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNormInfinity"
60029c6b16b5SShri Abhyankar /*@
6003a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
60049c6b16b5SShri Abhyankar 
60059c6b16b5SShri Abhyankar    Collective on TS
60069c6b16b5SShri Abhyankar 
60079c6b16b5SShri Abhyankar    Input Arguments:
60089c6b16b5SShri Abhyankar +  ts - time stepping context
6009a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6010a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
60119c6b16b5SShri Abhyankar 
60129c6b16b5SShri Abhyankar    Output Arguments:
60139c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
60149c6b16b5SShri Abhyankar 
60159c6b16b5SShri Abhyankar    Level: developer
60169c6b16b5SShri Abhyankar 
6017deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
60189c6b16b5SShri Abhyankar @*/
6019a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm)
60209c6b16b5SShri Abhyankar {
60219c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
60229c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart,k;
60239c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
60249c6b16b5SShri Abhyankar   PetscReal         max,gmax;
60259c6b16b5SShri Abhyankar   PetscReal         tol;
60269c6b16b5SShri Abhyankar 
60279c6b16b5SShri Abhyankar   PetscFunctionBegin;
60289c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6029a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
6030a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
6031a4868fbcSLisandro Dalcin   PetscValidType(U,2);
6032a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
6033a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
6034a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
6035a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
60369c6b16b5SShri Abhyankar 
60379c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
60389c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
60399c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
60409c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
60419c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
60429c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
60439c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
60449c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60459c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60469c6b16b5SShri Abhyankar     k = 0;
60479c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
60489c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
60499c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
60509c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60519c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
60529c6b16b5SShri Abhyankar     }
60539c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60549c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60559c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
60569c6b16b5SShri Abhyankar     const PetscScalar *atol;
60579c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60589c6b16b5SShri Abhyankar     k = 0;
60599c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
60609c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
60619c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
60629c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60639c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
60649c6b16b5SShri Abhyankar     }
60659c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60669c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
60679c6b16b5SShri Abhyankar     const PetscScalar *rtol;
60689c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60699c6b16b5SShri Abhyankar     k = 0;
60709c6b16b5SShri Abhyankar     tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
60719c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
60729c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
60739c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60749c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
60759c6b16b5SShri Abhyankar     }
60769c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60779c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
60789c6b16b5SShri Abhyankar     k = 0;
60799c6b16b5SShri Abhyankar     tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
60809c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
60819c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
60829c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60839c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
60849c6b16b5SShri Abhyankar     }
60859c6b16b5SShri Abhyankar   }
60869c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
60879c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
60889c6b16b5SShri Abhyankar 
6089b2566f29SBarry Smith   ierr  = MPIU_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
60909c6b16b5SShri Abhyankar   *norm = gmax;
60919c6b16b5SShri Abhyankar 
60929c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
60939c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
60949c6b16b5SShri Abhyankar }
60959c6b16b5SShri Abhyankar 
60969c6b16b5SShri Abhyankar #undef __FUNCT__
60977619abb3SShri #define __FUNCT__ "TSErrorWeightedNorm"
60981c3436cfSJed Brown /*@
6099a4868fbcSLisandro Dalcin    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors
61001c3436cfSJed Brown 
61011c3436cfSJed Brown    Collective on TS
61021c3436cfSJed Brown 
61031c3436cfSJed Brown    Input Arguments:
61041c3436cfSJed Brown +  ts - time stepping context
6105a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6106a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
6107a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
61087619abb3SShri 
61091c3436cfSJed Brown    Output Arguments:
61101c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
61111c3436cfSJed Brown 
6112a4868fbcSLisandro Dalcin 
6113a4868fbcSLisandro Dalcin    Options Database Keys:
6114a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
6115a4868fbcSLisandro Dalcin 
61161c3436cfSJed Brown    Level: developer
61171c3436cfSJed Brown 
6118deea92deSShri .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
61191c3436cfSJed Brown @*/
6120a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm)
61211c3436cfSJed Brown {
61228beabaa1SBarry Smith   PetscErrorCode ierr;
61231c3436cfSJed Brown 
61241c3436cfSJed Brown   PetscFunctionBegin;
6125a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
6126a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNorm2(ts,U,Y,norm);CHKERRQ(ierr);
6127a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
6128a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm);CHKERRQ(ierr);
6129a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
61301c3436cfSJed Brown   PetscFunctionReturn(0);
61311c3436cfSJed Brown }
61321c3436cfSJed Brown 
61331c3436cfSJed Brown #undef __FUNCT__
61348d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
61358d59e960SJed Brown /*@
61368d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
61378d59e960SJed Brown 
61388d59e960SJed Brown    Logically Collective on TS
61398d59e960SJed Brown 
61408d59e960SJed Brown    Input Arguments:
61418d59e960SJed Brown +  ts - time stepping context
61428d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
61438d59e960SJed Brown 
61448d59e960SJed Brown    Note:
61458d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
61468d59e960SJed Brown 
61478d59e960SJed Brown    Level: intermediate
61488d59e960SJed Brown 
61498d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
61508d59e960SJed Brown @*/
61518d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
61528d59e960SJed Brown {
61538d59e960SJed Brown   PetscFunctionBegin;
61548d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
61558d59e960SJed Brown   ts->cfltime_local = cfltime;
61568d59e960SJed Brown   ts->cfltime       = -1.;
61578d59e960SJed Brown   PetscFunctionReturn(0);
61588d59e960SJed Brown }
61598d59e960SJed Brown 
61608d59e960SJed Brown #undef __FUNCT__
61618d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
61628d59e960SJed Brown /*@
61638d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
61648d59e960SJed Brown 
61658d59e960SJed Brown    Collective on TS
61668d59e960SJed Brown 
61678d59e960SJed Brown    Input Arguments:
61688d59e960SJed Brown .  ts - time stepping context
61698d59e960SJed Brown 
61708d59e960SJed Brown    Output Arguments:
61718d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
61728d59e960SJed Brown 
61738d59e960SJed Brown    Level: advanced
61748d59e960SJed Brown 
61758d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
61768d59e960SJed Brown @*/
61778d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
61788d59e960SJed Brown {
61798d59e960SJed Brown   PetscErrorCode ierr;
61808d59e960SJed Brown 
61818d59e960SJed Brown   PetscFunctionBegin;
61828d59e960SJed Brown   if (ts->cfltime < 0) {
6183b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
61848d59e960SJed Brown   }
61858d59e960SJed Brown   *cfltime = ts->cfltime;
61868d59e960SJed Brown   PetscFunctionReturn(0);
61878d59e960SJed Brown }
61888d59e960SJed Brown 
61898d59e960SJed Brown #undef __FUNCT__
6190d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
6191d6ebe24aSShri Abhyankar /*@
6192d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6193d6ebe24aSShri Abhyankar 
6194d6ebe24aSShri Abhyankar    Input Parameters:
6195d6ebe24aSShri Abhyankar .  ts   - the TS context.
6196d6ebe24aSShri Abhyankar .  xl   - lower bound.
6197d6ebe24aSShri Abhyankar .  xu   - upper bound.
6198d6ebe24aSShri Abhyankar 
6199d6ebe24aSShri Abhyankar    Notes:
6200d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6201e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6202d6ebe24aSShri Abhyankar 
62032bd2b0e6SSatish Balay    Level: advanced
62042bd2b0e6SSatish Balay 
6205d6ebe24aSShri Abhyankar @*/
6206d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6207d6ebe24aSShri Abhyankar {
6208d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6209d6ebe24aSShri Abhyankar   SNES           snes;
6210d6ebe24aSShri Abhyankar 
6211d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6212d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6213d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6214d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6215d6ebe24aSShri Abhyankar }
6216d6ebe24aSShri Abhyankar 
6217325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
6218c6db04a5SJed Brown #include <mex.h>
6219325fc9f4SBarry Smith 
6220325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
6221325fc9f4SBarry Smith 
6222325fc9f4SBarry Smith #undef __FUNCT__
6223325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
6224325fc9f4SBarry Smith /*
6225325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
6226325fc9f4SBarry Smith                          TSSetFunctionMatlab().
6227325fc9f4SBarry Smith 
6228325fc9f4SBarry Smith    Collective on TS
6229325fc9f4SBarry Smith 
6230325fc9f4SBarry Smith    Input Parameters:
6231325fc9f4SBarry Smith +  snes - the TS context
62320910c330SBarry Smith -  u - input vector
6233325fc9f4SBarry Smith 
6234325fc9f4SBarry Smith    Output Parameter:
6235325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
6236325fc9f4SBarry Smith 
6237325fc9f4SBarry Smith    Notes:
6238325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
6239325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
6240325fc9f4SBarry Smith    themselves.
6241325fc9f4SBarry Smith 
6242325fc9f4SBarry Smith    Level: developer
6243325fc9f4SBarry Smith 
6244325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6245325fc9f4SBarry Smith 
6246325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6247325fc9f4SBarry Smith */
62480910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
6249325fc9f4SBarry Smith {
6250325fc9f4SBarry Smith   PetscErrorCode  ierr;
6251325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6252325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
6253325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
6254325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
6255325fc9f4SBarry Smith 
6256325fc9f4SBarry Smith   PetscFunctionBegin;
6257325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
62580910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
62590910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
6260325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
62610910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
6262325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
6263325fc9f4SBarry Smith 
6264325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
62650910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
62660910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
62670910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
6268bbd56ea5SKarl Rupp 
6269325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6270325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
6271325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6272325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6273325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
6274325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
6275325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
6276325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
6277325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6278325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6279325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6280325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6281325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6282325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6283325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6284325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6285325fc9f4SBarry Smith   PetscFunctionReturn(0);
6286325fc9f4SBarry Smith }
6287325fc9f4SBarry Smith 
6288325fc9f4SBarry Smith 
6289325fc9f4SBarry Smith #undef __FUNCT__
6290325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
6291325fc9f4SBarry Smith /*
6292325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
6293325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
6294e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
6295325fc9f4SBarry Smith 
6296325fc9f4SBarry Smith    Logically Collective on TS
6297325fc9f4SBarry Smith 
6298325fc9f4SBarry Smith    Input Parameters:
6299325fc9f4SBarry Smith +  ts - the TS context
6300325fc9f4SBarry Smith -  func - function evaluation routine
6301325fc9f4SBarry Smith 
6302325fc9f4SBarry Smith    Calling sequence of func:
63030910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
6304325fc9f4SBarry Smith 
6305325fc9f4SBarry Smith    Level: beginner
6306325fc9f4SBarry Smith 
6307325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
6308325fc9f4SBarry Smith 
6309325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6310325fc9f4SBarry Smith */
6311cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
6312325fc9f4SBarry Smith {
6313325fc9f4SBarry Smith   PetscErrorCode  ierr;
6314325fc9f4SBarry Smith   TSMatlabContext *sctx;
6315325fc9f4SBarry Smith 
6316325fc9f4SBarry Smith   PetscFunctionBegin;
6317325fc9f4SBarry Smith   /* currently sctx is memory bleed */
631895dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
6319325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6320325fc9f4SBarry Smith   /*
6321325fc9f4SBarry Smith      This should work, but it doesn't
6322325fc9f4SBarry Smith   sctx->ctx = ctx;
6323325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6324325fc9f4SBarry Smith   */
6325325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6326bbd56ea5SKarl Rupp 
63270298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
6328325fc9f4SBarry Smith   PetscFunctionReturn(0);
6329325fc9f4SBarry Smith }
6330325fc9f4SBarry Smith 
6331325fc9f4SBarry Smith #undef __FUNCT__
6332325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
6333325fc9f4SBarry Smith /*
6334325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
6335325fc9f4SBarry Smith                          TSSetJacobianMatlab().
6336325fc9f4SBarry Smith 
6337325fc9f4SBarry Smith    Collective on TS
6338325fc9f4SBarry Smith 
6339325fc9f4SBarry Smith    Input Parameters:
6340cdcf91faSSean Farley +  ts - the TS context
63410910c330SBarry Smith .  u - input vector
6342325fc9f4SBarry Smith .  A, B - the matrices
6343325fc9f4SBarry Smith -  ctx - user context
6344325fc9f4SBarry Smith 
6345325fc9f4SBarry Smith    Level: developer
6346325fc9f4SBarry Smith 
6347325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6348325fc9f4SBarry Smith 
6349325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6350325fc9f4SBarry Smith @*/
6351f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
6352325fc9f4SBarry Smith {
6353325fc9f4SBarry Smith   PetscErrorCode  ierr;
6354325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6355325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
6356325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
6357325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
6358325fc9f4SBarry Smith 
6359325fc9f4SBarry Smith   PetscFunctionBegin;
6360cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
63610910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
6362325fc9f4SBarry Smith 
63630910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
6364325fc9f4SBarry Smith 
6365cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
63660910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
63670910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
63680910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
63690910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
6370bbd56ea5SKarl Rupp 
6371325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6372325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
6373325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6374325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6375325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
6376325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
6377325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
6378325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
6379325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
6380325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
6381325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6382325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6383325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6384325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6385325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6386325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6387325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6388325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
6389325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
6390325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6391325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
6392325fc9f4SBarry Smith   PetscFunctionReturn(0);
6393325fc9f4SBarry Smith }
6394325fc9f4SBarry Smith 
6395325fc9f4SBarry Smith 
6396325fc9f4SBarry Smith #undef __FUNCT__
6397325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
6398325fc9f4SBarry Smith /*
6399325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
6400e3c5b3baSBarry Smith    vector for use by the TS routines in solving ODEs from MATLAB. Here the function is a string containing the name of a MATLAB function
6401325fc9f4SBarry Smith 
6402325fc9f4SBarry Smith    Logically Collective on TS
6403325fc9f4SBarry Smith 
6404325fc9f4SBarry Smith    Input Parameters:
6405cdcf91faSSean Farley +  ts - the TS context
6406325fc9f4SBarry Smith .  A,B - Jacobian matrices
6407325fc9f4SBarry Smith .  func - function evaluation routine
6408325fc9f4SBarry Smith -  ctx - user context
6409325fc9f4SBarry Smith 
6410325fc9f4SBarry Smith    Calling sequence of func:
64110910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
6412325fc9f4SBarry Smith 
6413325fc9f4SBarry Smith 
6414325fc9f4SBarry Smith    Level: developer
6415325fc9f4SBarry Smith 
6416325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
6417325fc9f4SBarry Smith 
6418325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6419325fc9f4SBarry Smith */
6420cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
6421325fc9f4SBarry Smith {
6422325fc9f4SBarry Smith   PetscErrorCode  ierr;
6423325fc9f4SBarry Smith   TSMatlabContext *sctx;
6424325fc9f4SBarry Smith 
6425325fc9f4SBarry Smith   PetscFunctionBegin;
6426325fc9f4SBarry Smith   /* currently sctx is memory bleed */
642795dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
6428325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6429325fc9f4SBarry Smith   /*
6430325fc9f4SBarry Smith      This should work, but it doesn't
6431325fc9f4SBarry Smith   sctx->ctx = ctx;
6432325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6433325fc9f4SBarry Smith   */
6434325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6435bbd56ea5SKarl Rupp 
6436cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
6437325fc9f4SBarry Smith   PetscFunctionReturn(0);
6438325fc9f4SBarry Smith }
6439325fc9f4SBarry Smith 
6440b5b1a830SBarry Smith #undef __FUNCT__
6441b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
6442b5b1a830SBarry Smith /*
6443b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
6444b5b1a830SBarry Smith 
6445b5b1a830SBarry Smith    Collective on TS
6446b5b1a830SBarry Smith 
6447b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6448b5b1a830SBarry Smith @*/
64490910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
6450b5b1a830SBarry Smith {
6451b5b1a830SBarry Smith   PetscErrorCode  ierr;
6452b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6453a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
6454b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
6455b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
6456b5b1a830SBarry Smith 
6457b5b1a830SBarry Smith   PetscFunctionBegin;
6458cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
64590910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
6460b5b1a830SBarry Smith 
6461cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
64620910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
6463bbd56ea5SKarl Rupp 
6464b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6465b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
6466b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
6467b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
6468b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
6469b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
6470b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
6471b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6472b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
6473b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
6474b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
6475b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
6476b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
6477b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
6478b5b1a830SBarry Smith   PetscFunctionReturn(0);
6479b5b1a830SBarry Smith }
6480b5b1a830SBarry Smith 
6481b5b1a830SBarry Smith 
6482b5b1a830SBarry Smith #undef __FUNCT__
6483b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
6484b5b1a830SBarry Smith /*
6485b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
6486b5b1a830SBarry Smith 
6487b5b1a830SBarry Smith    Level: developer
6488b5b1a830SBarry Smith 
6489b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
6490b5b1a830SBarry Smith 
6491b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6492b5b1a830SBarry Smith */
6493cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
6494b5b1a830SBarry Smith {
6495b5b1a830SBarry Smith   PetscErrorCode  ierr;
6496b5b1a830SBarry Smith   TSMatlabContext *sctx;
6497b5b1a830SBarry Smith 
6498b5b1a830SBarry Smith   PetscFunctionBegin;
6499b5b1a830SBarry Smith   /* currently sctx is memory bleed */
650095dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
6501b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6502b5b1a830SBarry Smith   /*
6503b5b1a830SBarry Smith      This should work, but it doesn't
6504b5b1a830SBarry Smith   sctx->ctx = ctx;
6505b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6506b5b1a830SBarry Smith   */
6507b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6508bbd56ea5SKarl Rupp 
65090298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
6510b5b1a830SBarry Smith   PetscFunctionReturn(0);
6511b5b1a830SBarry Smith }
6512325fc9f4SBarry Smith #endif
6513b3603a34SBarry Smith 
6514b3603a34SBarry Smith #undef __FUNCT__
65154f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
6516b3603a34SBarry Smith /*@C
65174f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
6518b3603a34SBarry Smith        in a time based line graph
6519b3603a34SBarry Smith 
6520b3603a34SBarry Smith    Collective on TS
6521b3603a34SBarry Smith 
6522b3603a34SBarry Smith    Input Parameters:
6523b3603a34SBarry Smith +  ts - the TS context
6524b3603a34SBarry Smith .  step - current time-step
6525b3603a34SBarry Smith .  ptime - current time
65267db568b7SBarry Smith .  u - current solution
65277db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
6528b3603a34SBarry Smith 
6529b3d3934dSBarry Smith    Options Database:
65309ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
6531b3d3934dSBarry Smith 
6532b3603a34SBarry Smith    Level: intermediate
6533b3603a34SBarry Smith 
65346934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component solutions in a separate window
6535b3603a34SBarry Smith 
6536b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
6537b3603a34SBarry Smith 
65387db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
65397db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
65407db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
65417db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
6542b3603a34SBarry Smith @*/
65437db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6544b3603a34SBarry Smith {
6545b3603a34SBarry Smith   PetscErrorCode    ierr;
65467db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
6547b3603a34SBarry Smith   const PetscScalar *yy;
654880666b62SBarry Smith   Vec               v;
6549b3603a34SBarry Smith 
6550b3603a34SBarry Smith   PetscFunctionBegin;
655163e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
655258ff32f7SBarry Smith   if (!step) {
6553a9f9c1f6SBarry Smith     PetscDrawAxis axis;
65546934998bSLisandro Dalcin     PetscInt      dim;
6555a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6556a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
6557bab0a581SBarry Smith     if (!ctx->names) {
6558bab0a581SBarry Smith       PetscBool flg;
6559bab0a581SBarry Smith       /* user provides names of variables to plot but no names has been set so assume names are integer values */
6560bab0a581SBarry Smith       ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr);
6561bab0a581SBarry Smith       if (flg) {
6562bab0a581SBarry Smith         PetscInt i,n;
6563bab0a581SBarry Smith         char     **names;
6564bab0a581SBarry Smith         ierr = VecGetSize(u,&n);CHKERRQ(ierr);
6565bab0a581SBarry Smith         ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr);
6566bab0a581SBarry Smith         for (i=0; i<n; i++) {
6567bab0a581SBarry Smith           ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr);
6568bab0a581SBarry Smith           ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr);
6569bab0a581SBarry Smith         }
6570bab0a581SBarry Smith         names[n] = NULL;
6571bab0a581SBarry Smith         ctx->names = names;
6572bab0a581SBarry Smith       }
6573bab0a581SBarry Smith     }
6574387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
6575387f4636SBarry Smith       char      **displaynames;
6576387f4636SBarry Smith       PetscBool flg;
6577387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
657895dccacaSBarry Smith       ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr);
6579387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
6580c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
6581387f4636SBarry Smith       if (flg) {
6582a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
6583387f4636SBarry Smith       }
6584387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
6585387f4636SBarry Smith     }
6586387f4636SBarry Smith     if (ctx->displaynames) {
6587387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
6588387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
6589387f4636SBarry Smith     } else if (ctx->names) {
65900910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
65910b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6592387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
6593b0bc92c6SBarry Smith     } else {
6594b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6595b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6596387f4636SBarry Smith     }
65970b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
659858ff32f7SBarry Smith   }
65996934998bSLisandro Dalcin 
66006934998bSLisandro Dalcin   if (!ctx->transform) v = u;
66016934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
660280666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
66036934998bSLisandro Dalcin   if (ctx->displaynames) {
66046934998bSLisandro Dalcin     PetscInt i;
66056934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
66066934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
66076934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
66086934998bSLisandro Dalcin   } else {
6609e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6610e3efe391SJed Brown     PetscInt  i,n;
66116934998bSLisandro Dalcin     PetscReal *yreal;
661280666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
6613785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6614e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
66150b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6616e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6617e3efe391SJed Brown #else
66180b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6619e3efe391SJed Brown #endif
662080666b62SBarry Smith   }
66216934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
66226934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
66236934998bSLisandro Dalcin 
6624b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
66250b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
66266934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
66273923b477SBarry Smith   }
6628b3603a34SBarry Smith   PetscFunctionReturn(0);
6629b3603a34SBarry Smith }
6630b3603a34SBarry Smith 
6631387f4636SBarry Smith 
6632b3603a34SBarry Smith #undef __FUNCT__
663331152f8aSBarry Smith #define __FUNCT__ "TSMonitorLGSetVariableNames"
6634b037adc7SBarry Smith /*@C
663531152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6636b037adc7SBarry Smith 
6637b037adc7SBarry Smith    Collective on TS
6638b037adc7SBarry Smith 
6639b037adc7SBarry Smith    Input Parameters:
6640b037adc7SBarry Smith +  ts - the TS context
6641b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
6642b037adc7SBarry Smith 
6643b037adc7SBarry Smith    Level: intermediate
6644b037adc7SBarry Smith 
66457db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66467db568b7SBarry Smith 
6647b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
6648b037adc7SBarry Smith 
6649a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
6650b037adc7SBarry Smith @*/
665131152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
6652b037adc7SBarry Smith {
6653b037adc7SBarry Smith   PetscErrorCode    ierr;
6654b037adc7SBarry Smith   PetscInt          i;
6655b037adc7SBarry Smith 
6656b037adc7SBarry Smith   PetscFunctionBegin;
6657b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6658b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
66595537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
6660b3d3934dSBarry Smith       break;
6661b3d3934dSBarry Smith     }
6662b3d3934dSBarry Smith   }
6663b3d3934dSBarry Smith   PetscFunctionReturn(0);
6664b3d3934dSBarry Smith }
6665b3d3934dSBarry Smith 
6666b3d3934dSBarry Smith #undef __FUNCT__
6667e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetVariableNames"
6668e673d494SBarry Smith /*@C
6669e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6670e673d494SBarry Smith 
6671e673d494SBarry Smith    Collective on TS
6672e673d494SBarry Smith 
6673e673d494SBarry Smith    Input Parameters:
6674e673d494SBarry Smith +  ts - the TS context
6675e673d494SBarry Smith -  names - the names of the components, final string must be NULL
6676e673d494SBarry Smith 
6677e673d494SBarry Smith    Level: intermediate
6678e673d494SBarry Smith 
6679e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6680e673d494SBarry Smith 
6681a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
6682e673d494SBarry Smith @*/
6683e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
6684e673d494SBarry Smith {
6685e673d494SBarry Smith   PetscErrorCode    ierr;
6686e673d494SBarry Smith 
6687e673d494SBarry Smith   PetscFunctionBegin;
6688e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
6689e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
6690e673d494SBarry Smith   PetscFunctionReturn(0);
6691e673d494SBarry Smith }
6692e673d494SBarry Smith 
6693e673d494SBarry Smith #undef __FUNCT__
6694b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorLGGetVariableNames"
6695b3d3934dSBarry Smith /*@C
6696b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
6697b3d3934dSBarry Smith 
6698b3d3934dSBarry Smith    Collective on TS
6699b3d3934dSBarry Smith 
6700b3d3934dSBarry Smith    Input Parameter:
6701b3d3934dSBarry Smith .  ts - the TS context
6702b3d3934dSBarry Smith 
6703b3d3934dSBarry Smith    Output Parameter:
6704b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
6705b3d3934dSBarry Smith 
6706b3d3934dSBarry Smith    Level: intermediate
6707b3d3934dSBarry Smith 
67087db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
67097db568b7SBarry Smith 
6710b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6711b3d3934dSBarry Smith 
6712b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6713b3d3934dSBarry Smith @*/
6714b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
6715b3d3934dSBarry Smith {
6716b3d3934dSBarry Smith   PetscInt       i;
6717b3d3934dSBarry Smith 
6718b3d3934dSBarry Smith   PetscFunctionBegin;
6719b3d3934dSBarry Smith   *names = NULL;
6720b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6721b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
67225537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
6723b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
6724b3d3934dSBarry Smith       break;
6725387f4636SBarry Smith     }
6726387f4636SBarry Smith   }
6727387f4636SBarry Smith   PetscFunctionReturn(0);
6728387f4636SBarry Smith }
6729387f4636SBarry Smith 
6730387f4636SBarry Smith #undef __FUNCT__
6731a66092f1SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables"
6732a66092f1SBarry Smith /*@C
6733a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
6734a66092f1SBarry Smith 
6735a66092f1SBarry Smith    Collective on TS
6736a66092f1SBarry Smith 
6737a66092f1SBarry Smith    Input Parameters:
6738a66092f1SBarry Smith +  ctx - the TSMonitorLG context
6739a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
6740a66092f1SBarry Smith 
6741a66092f1SBarry Smith    Level: intermediate
6742a66092f1SBarry Smith 
6743a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
6744a66092f1SBarry Smith 
6745a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6746a66092f1SBarry Smith @*/
6747a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6748a66092f1SBarry Smith {
6749a66092f1SBarry Smith   PetscInt          j = 0,k;
6750a66092f1SBarry Smith   PetscErrorCode    ierr;
6751a66092f1SBarry Smith 
6752a66092f1SBarry Smith   PetscFunctionBegin;
6753a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6754a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6755a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6756a66092f1SBarry Smith   while (displaynames[j]) j++;
6757a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6758a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6759a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6760a66092f1SBarry Smith   j = 0;
6761a66092f1SBarry Smith   while (displaynames[j]) {
6762a66092f1SBarry Smith     k = 0;
6763a66092f1SBarry Smith     while (ctx->names[k]) {
6764a66092f1SBarry Smith       PetscBool flg;
6765a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6766a66092f1SBarry Smith       if (flg) {
6767a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6768a66092f1SBarry Smith         break;
6769a66092f1SBarry Smith       }
6770a66092f1SBarry Smith       k++;
6771a66092f1SBarry Smith     }
6772a66092f1SBarry Smith     j++;
6773a66092f1SBarry Smith   }
6774a66092f1SBarry Smith   PetscFunctionReturn(0);
6775a66092f1SBarry Smith }
6776a66092f1SBarry Smith 
6777a66092f1SBarry Smith 
6778a66092f1SBarry Smith #undef __FUNCT__
6779387f4636SBarry Smith #define __FUNCT__ "TSMonitorLGSetDisplayVariables"
6780387f4636SBarry Smith /*@C
6781387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6782387f4636SBarry Smith 
6783387f4636SBarry Smith    Collective on TS
6784387f4636SBarry Smith 
6785387f4636SBarry Smith    Input Parameters:
6786387f4636SBarry Smith +  ts - the TS context
6787387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
6788387f4636SBarry Smith 
67897db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
67907db568b7SBarry Smith 
6791387f4636SBarry Smith    Level: intermediate
6792387f4636SBarry Smith 
6793387f4636SBarry Smith .keywords: TS,  vector, monitor, view
6794387f4636SBarry Smith 
6795387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6796387f4636SBarry Smith @*/
6797387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6798387f4636SBarry Smith {
6799a66092f1SBarry Smith   PetscInt          i;
6800387f4636SBarry Smith   PetscErrorCode    ierr;
6801387f4636SBarry Smith 
6802387f4636SBarry Smith   PetscFunctionBegin;
6803387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6804387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
68055537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6806b3d3934dSBarry Smith       break;
6807b037adc7SBarry Smith     }
6808b037adc7SBarry Smith   }
6809b037adc7SBarry Smith   PetscFunctionReturn(0);
6810b037adc7SBarry Smith }
6811b037adc7SBarry Smith 
6812b037adc7SBarry Smith #undef __FUNCT__
681380666b62SBarry Smith #define __FUNCT__ "TSMonitorLGSetTransform"
681480666b62SBarry Smith /*@C
681580666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
681680666b62SBarry Smith 
681780666b62SBarry Smith    Collective on TS
681880666b62SBarry Smith 
681980666b62SBarry Smith    Input Parameters:
682080666b62SBarry Smith +  ts - the TS context
682180666b62SBarry Smith .  transform - the transform function
68227684fa3eSBarry Smith .  destroy - function to destroy the optional context
682380666b62SBarry Smith -  ctx - optional context used by transform function
682480666b62SBarry Smith 
68257db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
68267db568b7SBarry Smith 
682780666b62SBarry Smith    Level: intermediate
682880666b62SBarry Smith 
682980666b62SBarry Smith .keywords: TS,  vector, monitor, view
683080666b62SBarry Smith 
6831a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
683280666b62SBarry Smith @*/
68337684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
683480666b62SBarry Smith {
683580666b62SBarry Smith   PetscInt          i;
6836a66092f1SBarry Smith   PetscErrorCode    ierr;
683780666b62SBarry Smith 
683880666b62SBarry Smith   PetscFunctionBegin;
683980666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
684080666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
68415537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
684280666b62SBarry Smith     }
684380666b62SBarry Smith   }
684480666b62SBarry Smith   PetscFunctionReturn(0);
684580666b62SBarry Smith }
684680666b62SBarry Smith 
684780666b62SBarry Smith #undef __FUNCT__
6848e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetTransform"
6849e673d494SBarry Smith /*@C
6850e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6851e673d494SBarry Smith 
6852e673d494SBarry Smith    Collective on TSLGCtx
6853e673d494SBarry Smith 
6854e673d494SBarry Smith    Input Parameters:
6855e673d494SBarry Smith +  ts - the TS context
6856e673d494SBarry Smith .  transform - the transform function
68577684fa3eSBarry Smith .  destroy - function to destroy the optional context
6858e673d494SBarry Smith -  ctx - optional context used by transform function
6859e673d494SBarry Smith 
6860e673d494SBarry Smith    Level: intermediate
6861e673d494SBarry Smith 
6862e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6863e673d494SBarry Smith 
6864a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6865e673d494SBarry Smith @*/
68667684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6867e673d494SBarry Smith {
6868e673d494SBarry Smith   PetscFunctionBegin;
6869e673d494SBarry Smith   ctx->transform    = transform;
68707684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6871e673d494SBarry Smith   ctx->transformctx = tctx;
6872e673d494SBarry Smith   PetscFunctionReturn(0);
6873e673d494SBarry Smith }
6874e673d494SBarry Smith 
6875b3603a34SBarry Smith #undef __FUNCT__
68764f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
6877ef20d060SBarry Smith /*@C
68784f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
6879ef20d060SBarry Smith        in a time based line graph
6880ef20d060SBarry Smith 
6881ef20d060SBarry Smith    Collective on TS
6882ef20d060SBarry Smith 
6883ef20d060SBarry Smith    Input Parameters:
6884ef20d060SBarry Smith +  ts - the TS context
6885ef20d060SBarry Smith .  step - current time-step
6886ef20d060SBarry Smith .  ptime - current time
68877db568b7SBarry Smith .  u - current solution
68887db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6889ef20d060SBarry Smith 
6890ef20d060SBarry Smith    Level: intermediate
6891ef20d060SBarry Smith 
68926934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component errors in a separate window
6893abd5a294SJed Brown 
6894abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6895abd5a294SJed Brown 
6896abd5a294SJed Brown    Options Database Keys:
68974f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6898ef20d060SBarry Smith 
6899ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
6900ef20d060SBarry Smith 
6901abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6902ef20d060SBarry Smith @*/
69030910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6904ef20d060SBarry Smith {
6905ef20d060SBarry Smith   PetscErrorCode    ierr;
69060b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6907ef20d060SBarry Smith   const PetscScalar *yy;
6908ef20d060SBarry Smith   Vec               y;
6909ef20d060SBarry Smith 
6910ef20d060SBarry Smith   PetscFunctionBegin;
6911a9f9c1f6SBarry Smith   if (!step) {
6912a9f9c1f6SBarry Smith     PetscDrawAxis axis;
69136934998bSLisandro Dalcin     PetscInt      dim;
6914a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
69151ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
69160910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6917a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6918a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6919a9f9c1f6SBarry Smith   }
69200910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6921ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
69220910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6923ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6924e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6925e3efe391SJed Brown   {
6926e3efe391SJed Brown     PetscReal *yreal;
6927e3efe391SJed Brown     PetscInt  i,n;
6928e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6929785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6930e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
69310b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6932e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6933e3efe391SJed Brown   }
6934e3efe391SJed Brown #else
69350b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6936e3efe391SJed Brown #endif
6937ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6938ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6939b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
69400b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
69416934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
69423923b477SBarry Smith   }
6943ef20d060SBarry Smith   PetscFunctionReturn(0);
6944ef20d060SBarry Smith }
6945ef20d060SBarry Smith 
6946201da799SBarry Smith #undef __FUNCT__
6947201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
6948201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6949201da799SBarry Smith {
6950201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6951201da799SBarry Smith   PetscReal      x   = ptime,y;
6952201da799SBarry Smith   PetscErrorCode ierr;
6953201da799SBarry Smith   PetscInt       its;
6954201da799SBarry Smith 
6955201da799SBarry Smith   PetscFunctionBegin;
695663e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
6957201da799SBarry Smith   if (!n) {
6958201da799SBarry Smith     PetscDrawAxis axis;
6959201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6960201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
6961201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6962201da799SBarry Smith     ctx->snes_its = 0;
6963201da799SBarry Smith   }
6964201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
6965201da799SBarry Smith   y    = its - ctx->snes_its;
6966201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
69673fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6968201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
69696934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
6970201da799SBarry Smith   }
6971201da799SBarry Smith   ctx->snes_its = its;
6972201da799SBarry Smith   PetscFunctionReturn(0);
6973201da799SBarry Smith }
6974201da799SBarry Smith 
6975201da799SBarry Smith #undef __FUNCT__
6976201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
6977201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6978201da799SBarry Smith {
6979201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6980201da799SBarry Smith   PetscReal      x   = ptime,y;
6981201da799SBarry Smith   PetscErrorCode ierr;
6982201da799SBarry Smith   PetscInt       its;
6983201da799SBarry Smith 
6984201da799SBarry Smith   PetscFunctionBegin;
698563e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
6986201da799SBarry Smith   if (!n) {
6987201da799SBarry Smith     PetscDrawAxis axis;
6988201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6989201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
6990201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6991201da799SBarry Smith     ctx->ksp_its = 0;
6992201da799SBarry Smith   }
6993201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
6994201da799SBarry Smith   y    = its - ctx->ksp_its;
6995201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
699699fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6997201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
69986934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
6999201da799SBarry Smith   }
7000201da799SBarry Smith   ctx->ksp_its = its;
7001201da799SBarry Smith   PetscFunctionReturn(0);
7002201da799SBarry Smith }
7003f9c1d6abSBarry Smith 
7004f9c1d6abSBarry Smith #undef __FUNCT__
7005f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
7006f9c1d6abSBarry Smith /*@
7007f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
7008f9c1d6abSBarry Smith 
7009f9c1d6abSBarry Smith    Collective on TS and Vec
7010f9c1d6abSBarry Smith 
7011f9c1d6abSBarry Smith    Input Parameters:
7012f9c1d6abSBarry Smith +  ts - the TS context
7013f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
7014f9c1d6abSBarry Smith 
7015f9c1d6abSBarry Smith    Output Parameters:
7016f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
7017f9c1d6abSBarry Smith 
7018f9c1d6abSBarry Smith    Level: developer
7019f9c1d6abSBarry Smith 
7020f9c1d6abSBarry Smith .keywords: TS, compute
7021f9c1d6abSBarry Smith 
7022f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
7023f9c1d6abSBarry Smith @*/
7024f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
7025f9c1d6abSBarry Smith {
7026f9c1d6abSBarry Smith   PetscErrorCode ierr;
7027f9c1d6abSBarry Smith 
7028f9c1d6abSBarry Smith   PetscFunctionBegin;
7029f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7030ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
7031f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
7032f9c1d6abSBarry Smith   PetscFunctionReturn(0);
7033f9c1d6abSBarry Smith }
703424655328SShri 
7035b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
7036b3d3934dSBarry Smith #undef __FUNCT__
7037b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxCreate"
7038b3d3934dSBarry Smith /*@C
7039b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
7040b3d3934dSBarry Smith 
7041b3d3934dSBarry Smith    Collective on TS
7042b3d3934dSBarry Smith 
7043b3d3934dSBarry Smith    Input Parameters:
7044b3d3934dSBarry Smith .  ts  - the ODE solver object
7045b3d3934dSBarry Smith 
7046b3d3934dSBarry Smith    Output Parameter:
7047b3d3934dSBarry Smith .  ctx - the context
7048b3d3934dSBarry Smith 
7049b3d3934dSBarry Smith    Level: intermediate
7050b3d3934dSBarry Smith 
7051b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
7052b3d3934dSBarry Smith 
7053b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
7054b3d3934dSBarry Smith 
7055b3d3934dSBarry Smith @*/
7056b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
7057b3d3934dSBarry Smith {
7058b3d3934dSBarry Smith   PetscErrorCode ierr;
7059b3d3934dSBarry Smith 
7060b3d3934dSBarry Smith   PetscFunctionBegin;
7061a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
7062b3d3934dSBarry Smith   PetscFunctionReturn(0);
7063b3d3934dSBarry Smith }
7064b3d3934dSBarry Smith 
7065b3d3934dSBarry Smith #undef __FUNCT__
7066b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelope"
7067b3d3934dSBarry Smith /*@C
7068b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
7069b3d3934dSBarry Smith 
7070b3d3934dSBarry Smith    Collective on TS
7071b3d3934dSBarry Smith 
7072b3d3934dSBarry Smith    Input Parameters:
7073b3d3934dSBarry Smith +  ts - the TS context
7074b3d3934dSBarry Smith .  step - current time-step
7075b3d3934dSBarry Smith .  ptime - current time
70767db568b7SBarry Smith .  u  - current solution
70777db568b7SBarry Smith -  dctx - the envelope context
7078b3d3934dSBarry Smith 
7079b3d3934dSBarry Smith    Options Database:
7080b3d3934dSBarry Smith .  -ts_monitor_envelope
7081b3d3934dSBarry Smith 
7082b3d3934dSBarry Smith    Level: intermediate
7083b3d3934dSBarry Smith 
7084b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
7085b3d3934dSBarry Smith 
7086b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7087b3d3934dSBarry Smith 
70887db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
7089b3d3934dSBarry Smith @*/
70907db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7091b3d3934dSBarry Smith {
7092b3d3934dSBarry Smith   PetscErrorCode       ierr;
70937db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
7094b3d3934dSBarry Smith 
7095b3d3934dSBarry Smith   PetscFunctionBegin;
7096b3d3934dSBarry Smith   if (!ctx->max) {
7097b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
7098b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
7099b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
7100b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
7101b3d3934dSBarry Smith   } else {
7102b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
7103b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
7104b3d3934dSBarry Smith   }
7105b3d3934dSBarry Smith   PetscFunctionReturn(0);
7106b3d3934dSBarry Smith }
7107b3d3934dSBarry Smith 
7108b3d3934dSBarry Smith 
7109b3d3934dSBarry Smith #undef __FUNCT__
7110b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeGetBounds"
7111b3d3934dSBarry Smith /*@C
7112b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
7113b3d3934dSBarry Smith 
7114b3d3934dSBarry Smith    Collective on TS
7115b3d3934dSBarry Smith 
7116b3d3934dSBarry Smith    Input Parameter:
7117b3d3934dSBarry Smith .  ts - the TS context
7118b3d3934dSBarry Smith 
7119b3d3934dSBarry Smith    Output Parameter:
7120b3d3934dSBarry Smith +  max - the maximum values
7121b3d3934dSBarry Smith -  min - the minimum values
7122b3d3934dSBarry Smith 
71237db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
71247db568b7SBarry Smith 
7125b3d3934dSBarry Smith    Level: intermediate
7126b3d3934dSBarry Smith 
7127b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7128b3d3934dSBarry Smith 
7129b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7130b3d3934dSBarry Smith @*/
7131b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
7132b3d3934dSBarry Smith {
7133b3d3934dSBarry Smith   PetscInt i;
7134b3d3934dSBarry Smith 
7135b3d3934dSBarry Smith   PetscFunctionBegin;
7136b3d3934dSBarry Smith   if (max) *max = NULL;
7137b3d3934dSBarry Smith   if (min) *min = NULL;
7138b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7139b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
71405537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7141b3d3934dSBarry Smith       if (max) *max = ctx->max;
7142b3d3934dSBarry Smith       if (min) *min = ctx->min;
7143b3d3934dSBarry Smith       break;
7144b3d3934dSBarry Smith     }
7145b3d3934dSBarry Smith   }
7146b3d3934dSBarry Smith   PetscFunctionReturn(0);
7147b3d3934dSBarry Smith }
7148b3d3934dSBarry Smith 
7149b3d3934dSBarry Smith #undef __FUNCT__
7150b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy"
7151b3d3934dSBarry Smith /*@C
7152b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7153b3d3934dSBarry Smith 
7154b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7155b3d3934dSBarry Smith 
7156b3d3934dSBarry Smith    Input Parameter:
7157b3d3934dSBarry Smith .  ctx - the monitor context
7158b3d3934dSBarry Smith 
7159b3d3934dSBarry Smith    Level: intermediate
7160b3d3934dSBarry Smith 
7161b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
7162b3d3934dSBarry Smith 
71637db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7164b3d3934dSBarry Smith @*/
7165b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7166b3d3934dSBarry Smith {
7167b3d3934dSBarry Smith   PetscErrorCode ierr;
7168b3d3934dSBarry Smith 
7169b3d3934dSBarry Smith   PetscFunctionBegin;
7170b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7171b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7172b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7173b3d3934dSBarry Smith   PetscFunctionReturn(0);
7174b3d3934dSBarry Smith }
7175f2dee214SBarry Smith 
717624655328SShri #undef __FUNCT__
717724655328SShri #define __FUNCT__ "TSRollBack"
717824655328SShri /*@
717924655328SShri    TSRollBack - Rolls back one time step
718024655328SShri 
718124655328SShri    Collective on TS
718224655328SShri 
718324655328SShri    Input Parameter:
718424655328SShri .  ts - the TS context obtained from TSCreate()
718524655328SShri 
718624655328SShri    Level: advanced
718724655328SShri 
718824655328SShri .keywords: TS, timestep, rollback
718924655328SShri 
719024655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
719124655328SShri @*/
719224655328SShri PetscErrorCode  TSRollBack(TS ts)
719324655328SShri {
719424655328SShri   PetscErrorCode ierr;
719524655328SShri 
719624655328SShri   PetscFunctionBegin;
719724655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7198b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
719924655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
720024655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
720124655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
720224655328SShri   ts->ptime = ts->ptime_prev;
7203be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
7204be5899b3SLisandro Dalcin   ts->steps--; ts->total_steps--;
7205b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
720624655328SShri   PetscFunctionReturn(0);
720724655328SShri }
7208aeb4809dSShri Abhyankar 
7209ff22ae23SHong Zhang #undef __FUNCT__
7210ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
7211ff22ae23SHong Zhang /*@
7212ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7213ff22ae23SHong Zhang 
7214ff22ae23SHong Zhang    Input Parameter:
7215ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7216ff22ae23SHong Zhang 
7217ff22ae23SHong Zhang    Level: advanced
7218ff22ae23SHong Zhang 
7219ff22ae23SHong Zhang .keywords: TS, getstages
7220ff22ae23SHong Zhang 
7221ff22ae23SHong Zhang .seealso: TSCreate()
7222ff22ae23SHong Zhang @*/
7223ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7224ff22ae23SHong Zhang {
7225ff22ae23SHong Zhang   PetscErrorCode ierr;
7226ff22ae23SHong Zhang 
7227ff22ae23SHong Zhang   PetscFunctionBegin;
7228ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7229ff22ae23SHong Zhang   PetscValidPointer(ns,2);
7230ff22ae23SHong Zhang 
7231ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
7232ff22ae23SHong Zhang   else {
7233ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7234ff22ae23SHong Zhang   }
7235ff22ae23SHong Zhang   PetscFunctionReturn(0);
7236ff22ae23SHong Zhang }
7237ff22ae23SHong Zhang 
7238847ff0e1SMatthew G. Knepley #undef __FUNCT__
7239847ff0e1SMatthew G. Knepley #define __FUNCT__ "TSComputeIJacobianDefaultColor"
7240847ff0e1SMatthew G. Knepley /*@C
7241847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7242847ff0e1SMatthew G. Knepley 
7243847ff0e1SMatthew G. Knepley   Collective on SNES
7244847ff0e1SMatthew G. Knepley 
7245847ff0e1SMatthew G. Knepley   Input Parameters:
7246847ff0e1SMatthew G. Knepley + ts - the TS context
7247847ff0e1SMatthew G. Knepley . t - current timestep
7248847ff0e1SMatthew G. Knepley . U - state vector
7249847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7250847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7251847ff0e1SMatthew G. Knepley - ctx - an optional user context
7252847ff0e1SMatthew G. Knepley 
7253847ff0e1SMatthew G. Knepley   Output Parameters:
7254847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7255847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7256847ff0e1SMatthew G. Knepley 
7257847ff0e1SMatthew G. Knepley   Level: intermediate
7258847ff0e1SMatthew G. Knepley 
7259847ff0e1SMatthew G. Knepley   Notes:
7260847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7261847ff0e1SMatthew G. Knepley 
7262847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7263847ff0e1SMatthew G. Knepley 
7264847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7265847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7266847ff0e1SMatthew G. Knepley 
7267847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7268847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7269847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7270847ff0e1SMatthew G. Knepley 
7271847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
7272847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7273847ff0e1SMatthew G. Knepley @*/
7274847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7275847ff0e1SMatthew G. Knepley {
7276847ff0e1SMatthew G. Knepley   SNES           snes;
7277847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7278847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7279847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
7280847ff0e1SMatthew G. Knepley 
7281847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
7282c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
7283847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
7284847ff0e1SMatthew G. Knepley   if (!color) {
7285847ff0e1SMatthew G. Knepley     DM         dm;
7286847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
7287847ff0e1SMatthew G. Knepley 
7288847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
7289847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
7290847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
7291847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
7292847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7293847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7294847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7295847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7296847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7297847ff0e1SMatthew G. Knepley     } else {
7298847ff0e1SMatthew G. Knepley       MatColoring mc;
7299847ff0e1SMatthew G. Knepley 
7300847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
7301847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
7302847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
7303847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
7304847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
7305847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
7306847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7307847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7308847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7309847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7310847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7311847ff0e1SMatthew G. Knepley     }
7312847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
7313847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
7314847ff0e1SMatthew G. Knepley   }
7315847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
7316847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
7317847ff0e1SMatthew G. Knepley   if (J != B) {
7318847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7319847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7320847ff0e1SMatthew G. Knepley   }
7321847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
7322847ff0e1SMatthew G. Knepley }
732393b34091SDebojyoti Ghosh 
732493b34091SDebojyoti Ghosh #undef __FUNCT__
7325cb9d8021SPierre Barbier de Reuille #define __FUNCT__ "TSSetFunctionDomainError"
7326cb9d8021SPierre Barbier de Reuille /*@
7327cb9d8021SPierre Barbier de Reuille     TSSetFunctionDomainError - Set the function testing if the current state vector is valid
7328cb9d8021SPierre Barbier de Reuille 
7329cb9d8021SPierre Barbier de Reuille     Input Parameters:
7330cb9d8021SPierre Barbier de Reuille     ts - the TS context
7331cb9d8021SPierre Barbier de Reuille     func - function called within TSFunctionDomainError
7332cb9d8021SPierre Barbier de Reuille 
7333cb9d8021SPierre Barbier de Reuille     Level: intermediate
7334cb9d8021SPierre Barbier de Reuille 
7335cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain
7336cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
7337cb9d8021SPierre Barbier de Reuille @*/
7338cb9d8021SPierre Barbier de Reuille 
7339d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
7340cb9d8021SPierre Barbier de Reuille {
7341cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7342cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7343cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
7344cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7345cb9d8021SPierre Barbier de Reuille }
7346cb9d8021SPierre Barbier de Reuille 
7347cb9d8021SPierre Barbier de Reuille #undef __FUNCT__
7348cb9d8021SPierre Barbier de Reuille #define __FUNCT__ "TSFunctionDomainError"
7349cb9d8021SPierre Barbier de Reuille /*@
7350cb9d8021SPierre Barbier de Reuille     TSFunctionDomainError - Check if the current state is valid
7351cb9d8021SPierre Barbier de Reuille 
7352cb9d8021SPierre Barbier de Reuille     Input Parameters:
7353cb9d8021SPierre Barbier de Reuille     ts - the TS context
7354cb9d8021SPierre Barbier de Reuille     stagetime - time of the simulation
7355d183316bSPierre Barbier de Reuille     Y - state vector to check.
7356cb9d8021SPierre Barbier de Reuille 
7357cb9d8021SPierre Barbier de Reuille     Output Parameter:
7358cb9d8021SPierre Barbier de Reuille     accept - Set to PETSC_FALSE if the current state vector is valid.
7359cb9d8021SPierre Barbier de Reuille 
7360cb9d8021SPierre Barbier de Reuille     Note:
7361cb9d8021SPierre Barbier de Reuille     This function should be used to ensure the state is in a valid part of the space.
7362cb9d8021SPierre Barbier de Reuille     For example, one can ensure here all values are positive.
736396a0c994SBarry Smith 
736496a0c994SBarry Smith     Level: advanced
7365cb9d8021SPierre Barbier de Reuille @*/
7366d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
7367cb9d8021SPierre Barbier de Reuille {
7368cb9d8021SPierre Barbier de Reuille   PetscErrorCode ierr;
7369cb9d8021SPierre Barbier de Reuille 
7370cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7371cb9d8021SPierre Barbier de Reuille 
7372cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7373cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
7374cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
7375d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
7376cb9d8021SPierre Barbier de Reuille   }
7377cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7378cb9d8021SPierre Barbier de Reuille }
73791ceb14c0SBarry Smith 
73801ceb14c0SBarry Smith #undef  __FUNCT__
7381e5168f73SEmil Constantinescu #define __FUNCT__ "TSClone"
738293b34091SDebojyoti Ghosh /*@C
7383e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
738493b34091SDebojyoti Ghosh 
738593b34091SDebojyoti Ghosh   Collective on MPI_Comm
738693b34091SDebojyoti Ghosh 
738793b34091SDebojyoti Ghosh   Input Parameter:
738893b34091SDebojyoti Ghosh . tsin    - The input TS
738993b34091SDebojyoti Ghosh 
739093b34091SDebojyoti Ghosh   Output Parameter:
7391e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
739293b34091SDebojyoti Ghosh 
73935eca1a21SEmil Constantinescu   Notes:
73945eca1a21SEmil Constantinescu   This function is used to create a clone of a TS object. It is used in ARKIMEX for initializing the slope for first stage explicit methods. It will likely be replaced in the future with a mechanism of switching methods on the fly.
73955eca1a21SEmil Constantinescu 
7396baa10174SEmil Constantinescu   When using TSDestroy() on a clone the user has to first reset the correct TS reference in the embedded SNES object: e.g.: by running SNES snes_dup=NULL; TSGetSNES(ts,&snes_dup); ierr = TSSetSNES(ts,snes_dup);
73975eca1a21SEmil Constantinescu 
73985eca1a21SEmil Constantinescu   Level: developer
739993b34091SDebojyoti Ghosh 
7400e5168f73SEmil Constantinescu .keywords: TS, clone
7401e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
740293b34091SDebojyoti Ghosh @*/
7403baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
740493b34091SDebojyoti Ghosh {
740593b34091SDebojyoti Ghosh   TS             t;
740693b34091SDebojyoti Ghosh   PetscErrorCode ierr;
7407dc846ba4SSatish Balay   SNES           snes_start;
7408dc846ba4SSatish Balay   DM             dm;
7409dc846ba4SSatish Balay   TSType         type;
741093b34091SDebojyoti Ghosh 
741193b34091SDebojyoti Ghosh   PetscFunctionBegin;
741293b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
741393b34091SDebojyoti Ghosh   *tsout = NULL;
741493b34091SDebojyoti Ghosh 
74157a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
741693b34091SDebojyoti Ghosh 
741793b34091SDebojyoti Ghosh   /* General TS description */
741893b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
741993b34091SDebojyoti Ghosh   t->setupcalled       = 0;
742093b34091SDebojyoti Ghosh   t->ksp_its           = 0;
742193b34091SDebojyoti Ghosh   t->snes_its          = 0;
742293b34091SDebojyoti Ghosh   t->nwork             = 0;
742393b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
742493b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
742593b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
742693b34091SDebojyoti Ghosh 
742734561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
742834561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
7429d15a3a53SEmil Constantinescu 
743093b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
743193b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
743293b34091SDebojyoti Ghosh 
743393b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
743451699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
743593b34091SDebojyoti Ghosh 
743693b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
743793b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
743893b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
743993b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
744093b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
744193b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
744293b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
744393b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
744493b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
744593b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
744693b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
744793b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
744893b34091SDebojyoti Ghosh 
744993b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
745093b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
745193b34091SDebojyoti Ghosh 
745293b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
745393b34091SDebojyoti Ghosh 
745493b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
745593b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
745693b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
745793b34091SDebojyoti Ghosh 
745893b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
745993b34091SDebojyoti Ghosh 
74600d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
74610d4fed19SBarry Smith     PetscInt i;
74620d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
74630d4fed19SBarry Smith     for (i=0; i<10; i++) {
74640d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
74650d4fed19SBarry Smith     }
74660d4fed19SBarry Smith   }
746793b34091SDebojyoti Ghosh   *tsout = t;
746893b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
746993b34091SDebojyoti Ghosh }
7470