xref: /petsc/src/ts/interface/ts.c (revision 721cd6eefd76982cc0021e06e1ca85d9e68e1b93)
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 @*/
47*721cd6eeSBarry 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) {
57*721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
58*721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
59*721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
60fde5950dSBarry Smith     if (monitorsetup) {
61*721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
62fde5950dSBarry Smith     }
63*721cd6eeSBarry 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 @*/
93*721cd6eeSBarry 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) {
103*721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
104*721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
105*721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
106fde5950dSBarry Smith     if (monitorsetup) {
107*721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
108fde5950dSBarry Smith     }
109*721cd6eeSBarry 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:
1254d91e141SJed Brown +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP
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];
167089b2837SJed Brown   SNES                   snes;
16831748224SBarry Smith   PetscReal              time_step;
16949354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
170d1212d36SBarry Smith   char                   dir[16];
1716991f827SBarry Smith   const char             *defaultType;
1726991f827SBarry Smith   char                   typeName[256];
173bdad233fSMatthew Knepley 
174bdad233fSMatthew Knepley   PetscFunctionBegin;
1750700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1763194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
1776991f827SBarry Smith   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
1786991f827SBarry Smith   else defaultType = TSEULER;
1796991f827SBarry Smith 
1806991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
1816991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr);
1826991f827SBarry Smith   if (opt) {
1836991f827SBarry Smith     ierr = TSSetType(ts, typeName);CHKERRQ(ierr);
1846991f827SBarry Smith   } else {
1856991f827SBarry Smith     ierr = TSSetType(ts, defaultType);CHKERRQ(ierr);
1866991f827SBarry Smith   }
187bdad233fSMatthew Knepley 
188bdad233fSMatthew Knepley   /* Handle generic TS options */
1890298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1900298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
1910298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
19231748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
19331748224SBarry Smith   if (flg) {
19431748224SBarry Smith     ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
19531748224SBarry Smith   }
19649354f04SShri 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);
19749354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
1980298fd71SBarry 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);
1990298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
2000298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
2010298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
2020298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
203bdad233fSMatthew Knepley 
20456f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
20556f85f32SBarry Smith   {
20656f85f32SBarry Smith   PetscBool set;
20756f85f32SBarry Smith   flg  = PETSC_FALSE;
20856f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
20956f85f32SBarry Smith   if (set) {
21056f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
21156f85f32SBarry Smith   }
21256f85f32SBarry Smith   }
21356f85f32SBarry Smith #endif
21456f85f32SBarry Smith 
215bdad233fSMatthew Knepley   /* Monitor options */
216fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr);
217fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr);
218fde5950dSBarry Smith   ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);CHKERRQ(ierr);
219fde5950dSBarry Smith 
2205180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
2215180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
2225180491cSLisandro Dalcin 
2234f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
224b3603a34SBarry Smith   if (opt) {
2250b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2263923b477SBarry Smith     PetscInt       howoften = 1;
227b3603a34SBarry Smith 
2280298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
22922d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
2304f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
231bdad233fSMatthew Knepley   }
2324f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
233ef20d060SBarry Smith   if (opt) {
2340b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2353923b477SBarry Smith     PetscInt       howoften = 1;
236ef20d060SBarry Smith 
2370298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
23822d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
2394f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
240ef20d060SBarry Smith   }
2416934998bSLisandro Dalcin 
2426934998bSLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2436934998bSLisandro Dalcin   if (opt) {
2446934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
2456934998bSLisandro Dalcin     PetscInt       howoften = 1;
2466934998bSLisandro Dalcin 
2476934998bSLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2486934998bSLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2496934998bSLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2506934998bSLisandro Dalcin   }
251201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
252201da799SBarry Smith   if (opt) {
253201da799SBarry Smith     TSMonitorLGCtx ctx;
254201da799SBarry Smith     PetscInt       howoften = 1;
255201da799SBarry Smith 
2560298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2577f52daa2SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
258201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
259201da799SBarry Smith   }
260201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
261201da799SBarry Smith   if (opt) {
262201da799SBarry Smith     TSMonitorLGCtx ctx;
263201da799SBarry Smith     PetscInt       howoften = 1;
264201da799SBarry Smith 
2650298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2667f52daa2SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
267201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
268201da799SBarry Smith   }
2698189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
2708189c53fSBarry Smith   if (opt) {
2718189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2728189c53fSBarry Smith     PetscInt          howoften = 1;
2738189c53fSBarry Smith 
2740298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
2756934998bSLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2768189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
2778189c53fSBarry Smith   }
278ef20d060SBarry Smith   opt  = PETSC_FALSE;
2790dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
280a7cc72afSBarry Smith   if (opt) {
28183a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
28283a4ac43SBarry Smith     PetscInt         howoften = 1;
283a80ad3e0SBarry Smith 
2840298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
2856934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
28683a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
287bdad233fSMatthew Knepley   }
288fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2899110b2e7SHong Zhang   ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr);
2909110b2e7SHong Zhang   if (opt) {
2919110b2e7SHong Zhang     TSMonitorDrawCtx ctx;
2929110b2e7SHong Zhang     PetscInt         howoften = 1;
2939110b2e7SHong Zhang 
2949110b2e7SHong Zhang     ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr);
2956934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2969110b2e7SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2979110b2e7SHong Zhang   }
2989110b2e7SHong Zhang   opt  = PETSC_FALSE;
2992d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
3002d5ee99bSBarry Smith   if (opt) {
3012d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
3022d5ee99bSBarry Smith     PetscReal        bounds[4];
3032d5ee99bSBarry Smith     PetscInt         n = 4;
3042d5ee99bSBarry Smith     PetscDraw        draw;
3056934998bSLisandro Dalcin     PetscDrawAxis    axis;
3062d5ee99bSBarry Smith 
3072d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
3082d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
3096934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr);
3102d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
3116934998bSLisandro Dalcin     ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr);
3126934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
3136934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
3142d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3152d5ee99bSBarry Smith   }
3162d5ee99bSBarry Smith   opt  = PETSC_FALSE;
3170dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
3183a471f94SBarry Smith   if (opt) {
31983a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
32083a4ac43SBarry Smith     PetscInt         howoften = 1;
3213a471f94SBarry Smith 
3220298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
3236934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
32483a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3253a471f94SBarry Smith   }
326fde5950dSBarry Smith 
327ed81e22dSJed Brown   opt  = PETSC_FALSE;
32891b97e58SBarry 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);
329ed81e22dSJed Brown   if (flg) {
330ed81e22dSJed Brown     const char *ptr,*ptr2;
331ed81e22dSJed Brown     char       *filetemplate;
332ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
333ed81e22dSJed Brown     /* Do some cursory validation of the input. */
334ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
335ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
336ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
337ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
338ce94432eSBarry 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");
339ed81e22dSJed Brown       if (ptr2) break;
340ed81e22dSJed Brown     }
341ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
342ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
343ed81e22dSJed Brown   }
344bdad233fSMatthew Knepley 
345d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
346d1212d36SBarry Smith   if (flg) {
347d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
348d1212d36SBarry Smith     int                  ray = 0;
349d1212d36SBarry Smith     DMDADirection        ddir;
350d1212d36SBarry Smith     DM                   da;
351d1212d36SBarry Smith     PetscMPIInt          rank;
352d1212d36SBarry Smith 
353ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
354d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
355d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
356ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
357d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
358d1212d36SBarry Smith 
359d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
360b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
361d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
362d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
363ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
364d1212d36SBarry Smith     if (!rank) {
365d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
366d1212d36SBarry Smith     }
36751b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
368d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
369d1212d36SBarry Smith   }
37051b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
37151b4a12fSMatthew G. Knepley   if (flg) {
37251b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
37351b4a12fSMatthew G. Knepley     int                 ray = 0;
37451b4a12fSMatthew G. Knepley     DMDADirection       ddir;
37551b4a12fSMatthew G. Knepley     DM                  da;
37651b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
377d1212d36SBarry Smith 
37851b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
37951b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
38051b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
38151b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
38251b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3831c3436cfSJed Brown 
38451b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
385b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
38651b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
38751b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
38851b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
38951b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
39051b4a12fSMatthew G. Knepley   }
391a7a1495cSBarry Smith 
392b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
393b3d3934dSBarry Smith   if (opt) {
394b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
395b3d3934dSBarry Smith 
396b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
397b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
398b3d3934dSBarry Smith   }
399b3d3934dSBarry Smith 
400847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
401847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
402847ff0e1SMatthew G. Knepley   if (flg) {
403847ff0e1SMatthew G. Knepley     DM   dm;
404847ff0e1SMatthew G. Knepley     DMTS tdm;
405847ff0e1SMatthew G. Knepley 
406847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
407847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
408847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
409847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
410847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
411847ff0e1SMatthew G. Knepley   }
412847ff0e1SMatthew G. Knepley 
413ee346746SBarry Smith   if (ts->adapt) {
414ee346746SBarry Smith     ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr);
415ee346746SBarry Smith   }
416d763cef2SBarry Smith 
417d763cef2SBarry Smith   /* Handle specific TS options */
418d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
4196991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
420d763cef2SBarry Smith   }
421fbc52257SHong Zhang 
42268bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
42368bece0bSHong Zhang   if (ts->trajectory) tflg = PETSC_TRUE;
42468bece0bSHong Zhang   else tflg = PETSC_FALSE;
42568bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
42668bece0bSHong Zhang   if (tflg) {
42768bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
42868bece0bSHong Zhang   }
42968bece0bSHong Zhang   if (ts->adjoint_solve) tflg = PETSC_TRUE;
43068bece0bSHong Zhang   else tflg = PETSC_FALSE;
43168bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
43268bece0bSHong Zhang   if (flg) {
43368bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
43468bece0bSHong Zhang     ts->adjoint_solve = tflg;
43568bece0bSHong Zhang   }
43668bece0bSHong Zhang   if (ts->trajectory) {
43768bece0bSHong Zhang     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
43868bece0bSHong Zhang   }
439d763cef2SBarry Smith 
440d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
4410633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
442fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
443d763cef2SBarry Smith 
4446991f827SBarry Smith   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4456991f827SBarry Smith   if (snes) {
4466991f827SBarry Smith     if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
44749c41c37SLisandro Dalcin     ierr = SNESSetFromOptions(snes);CHKERRQ(ierr);
448d763cef2SBarry Smith   }
44968bece0bSHong Zhang 
450d763cef2SBarry Smith   PetscFunctionReturn(0);
451d763cef2SBarry Smith }
452d763cef2SBarry Smith 
453d763cef2SBarry Smith #undef __FUNCT__
454bc952696SBarry Smith #define __FUNCT__ "TSSetSaveTrajectory"
455d2daff3dSHong Zhang /*@
456bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
457d2daff3dSHong Zhang 
458d2daff3dSHong Zhang    Collective on TS
459d2daff3dSHong Zhang 
460d2daff3dSHong Zhang    Input Parameters:
461bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
462bc952696SBarry Smith 
46368bece0bSHong Zhang Note: This routine should be called after all TS options have been set
464d2daff3dSHong Zhang 
465d2daff3dSHong Zhang    Level: intermediate
466d2daff3dSHong Zhang 
467bc952696SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve()
468d2daff3dSHong Zhang 
469bc952696SBarry Smith .keywords: TS, set, checkpoint,
470d2daff3dSHong Zhang @*/
471bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
472d2daff3dSHong Zhang {
473bc952696SBarry Smith   PetscErrorCode ierr;
474bc952696SBarry Smith 
475d2daff3dSHong Zhang   PetscFunctionBegin;
476d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
477bc952696SBarry Smith   if (!ts->trajectory) {
478bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
479972caf09SHong Zhang     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
480bc952696SBarry Smith   }
481d2daff3dSHong Zhang   PetscFunctionReturn(0);
482d2daff3dSHong Zhang }
483d2daff3dSHong Zhang 
484a7a1495cSBarry Smith #undef __FUNCT__
485a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
486a7a1495cSBarry Smith /*@
487a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
488a7a1495cSBarry Smith       set with TSSetRHSJacobian().
489a7a1495cSBarry Smith 
490a7a1495cSBarry Smith    Collective on TS and Vec
491a7a1495cSBarry Smith 
492a7a1495cSBarry Smith    Input Parameters:
493316643e7SJed Brown +  ts - the TS context
494a7a1495cSBarry Smith .  t - current timestep
4950910c330SBarry Smith -  U - input vector
496a7a1495cSBarry Smith 
497a7a1495cSBarry Smith    Output Parameters:
498a7a1495cSBarry Smith +  A - Jacobian matrix
499a7a1495cSBarry Smith .  B - optional preconditioning matrix
500a7a1495cSBarry Smith -  flag - flag indicating matrix structure
501a7a1495cSBarry Smith 
502a7a1495cSBarry Smith    Notes:
503a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
504a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
505a7a1495cSBarry Smith 
50694b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
507a7a1495cSBarry Smith    flag parameter.
508a7a1495cSBarry Smith 
509a7a1495cSBarry Smith    Level: developer
510a7a1495cSBarry Smith 
511a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
512a7a1495cSBarry Smith 
51394b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
514a7a1495cSBarry Smith @*/
515d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
516a7a1495cSBarry Smith {
517dfbe8321SBarry Smith   PetscErrorCode ierr;
518270bf2e7SJed Brown   PetscObjectState Ustate;
51924989b8cSPeter Brune   DM             dm;
520942e3340SBarry Smith   DMTS           tsdm;
52124989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
52224989b8cSPeter Brune   void           *ctx;
52324989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
524b2df71adSDebojyoti Ghosh   TSRHSFunction  rhsfunction;
525a7a1495cSBarry Smith 
526a7a1495cSBarry Smith   PetscFunctionBegin;
5270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5280910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5290910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
53024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
531942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
53224989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
5330298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
534b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
53559e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
536b2df71adSDebojyoti Ghosh   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
5370e4ef248SJed Brown     PetscFunctionReturn(0);
538f8ede8e7SJed Brown   }
539d90be118SSean Farley 
540ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
541d90be118SSean Farley 
542e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
54394ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
54494ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
54594ab13aaSBarry Smith     if (A != B) {
54694ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
54794ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
548e1244c69SJed Brown     }
549e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
550e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
551e1244c69SJed Brown   }
552e1244c69SJed Brown 
55324989b8cSPeter Brune   if (rhsjacobianfunc) {
5546cd88445SBarry Smith     PetscBool missing;
55594ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
556a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
557d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
558a7a1495cSBarry Smith     PetscStackPop;
55994ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
5606cd88445SBarry Smith     if (A) {
5616cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
5626cd88445SBarry 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");
5636cd88445SBarry Smith     }
5646cd88445SBarry Smith     if (B && B != A) {
5656cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
5666cd88445SBarry 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");
5676cd88445SBarry Smith     }
568ef66eb69SBarry Smith   } else {
56994ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
57094ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
571ef66eb69SBarry Smith   }
5720e4ef248SJed Brown   ts->rhsjacobian.time       = t;
5730910c330SBarry Smith   ts->rhsjacobian.X          = U;
57459e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
575a7a1495cSBarry Smith   PetscFunctionReturn(0);
576a7a1495cSBarry Smith }
577a7a1495cSBarry Smith 
5784a2ae208SSatish Balay #undef __FUNCT__
5794a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
580316643e7SJed Brown /*@
581d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
582d763cef2SBarry Smith 
583316643e7SJed Brown    Collective on TS and Vec
584316643e7SJed Brown 
585316643e7SJed Brown    Input Parameters:
586316643e7SJed Brown +  ts - the TS context
587316643e7SJed Brown .  t - current time
5880910c330SBarry Smith -  U - state vector
589316643e7SJed Brown 
590316643e7SJed Brown    Output Parameter:
591316643e7SJed Brown .  y - right hand side
592316643e7SJed Brown 
593316643e7SJed Brown    Note:
594316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
595316643e7SJed Brown    is used internally within the nonlinear solvers.
596316643e7SJed Brown 
597316643e7SJed Brown    Level: developer
598316643e7SJed Brown 
599316643e7SJed Brown .keywords: TS, compute
600316643e7SJed Brown 
601316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
602316643e7SJed Brown @*/
6030910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
604d763cef2SBarry Smith {
605dfbe8321SBarry Smith   PetscErrorCode ierr;
60624989b8cSPeter Brune   TSRHSFunction  rhsfunction;
60724989b8cSPeter Brune   TSIFunction    ifunction;
60824989b8cSPeter Brune   void           *ctx;
60924989b8cSPeter Brune   DM             dm;
61024989b8cSPeter Brune 
611d763cef2SBarry Smith   PetscFunctionBegin;
6120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6130910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6140700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
61524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
61624989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
6170298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
618d763cef2SBarry Smith 
619ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
620d763cef2SBarry Smith 
6210910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
62224989b8cSPeter Brune   if (rhsfunction) {
623d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
6240910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
625d763cef2SBarry Smith     PetscStackPop;
626214bc6a2SJed Brown   } else {
627214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
628b2cd27e8SJed Brown   }
62944a41b28SSean Farley 
6300910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
631d763cef2SBarry Smith   PetscFunctionReturn(0);
632d763cef2SBarry Smith }
633d763cef2SBarry Smith 
6344a2ae208SSatish Balay #undef __FUNCT__
635ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
636ef20d060SBarry Smith /*@
637ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
638ef20d060SBarry Smith 
639ef20d060SBarry Smith    Collective on TS and Vec
640ef20d060SBarry Smith 
641ef20d060SBarry Smith    Input Parameters:
642ef20d060SBarry Smith +  ts - the TS context
643ef20d060SBarry Smith -  t - current time
644ef20d060SBarry Smith 
645ef20d060SBarry Smith    Output Parameter:
6460910c330SBarry Smith .  U - the solution
647ef20d060SBarry Smith 
648ef20d060SBarry Smith    Note:
649ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
650ef20d060SBarry Smith    is used internally within the nonlinear solvers.
651ef20d060SBarry Smith 
652ef20d060SBarry Smith    Level: developer
653ef20d060SBarry Smith 
654ef20d060SBarry Smith .keywords: TS, compute
655ef20d060SBarry Smith 
656abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
657ef20d060SBarry Smith @*/
6580910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
659ef20d060SBarry Smith {
660ef20d060SBarry Smith   PetscErrorCode     ierr;
661ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
662ef20d060SBarry Smith   void               *ctx;
663ef20d060SBarry Smith   DM                 dm;
664ef20d060SBarry Smith 
665ef20d060SBarry Smith   PetscFunctionBegin;
666ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6670910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
668ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
669ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
670ef20d060SBarry Smith 
671ef20d060SBarry Smith   if (solutionfunction) {
6729b7cd975SBarry Smith     PetscStackPush("TS user solution function");
6730910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
674ef20d060SBarry Smith     PetscStackPop;
675ef20d060SBarry Smith   }
676ef20d060SBarry Smith   PetscFunctionReturn(0);
677ef20d060SBarry Smith }
6789b7cd975SBarry Smith #undef __FUNCT__
6799b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
6809b7cd975SBarry Smith /*@
6819b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
6829b7cd975SBarry Smith 
6839b7cd975SBarry Smith    Collective on TS and Vec
6849b7cd975SBarry Smith 
6859b7cd975SBarry Smith    Input Parameters:
6869b7cd975SBarry Smith +  ts - the TS context
6879b7cd975SBarry Smith -  t - current time
6889b7cd975SBarry Smith 
6899b7cd975SBarry Smith    Output Parameter:
6909b7cd975SBarry Smith .  U - the function value
6919b7cd975SBarry Smith 
6929b7cd975SBarry Smith    Note:
6939b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
6949b7cd975SBarry Smith    is used internally within the nonlinear solvers.
6959b7cd975SBarry Smith 
6969b7cd975SBarry Smith    Level: developer
6979b7cd975SBarry Smith 
6989b7cd975SBarry Smith .keywords: TS, compute
6999b7cd975SBarry Smith 
7009b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7019b7cd975SBarry Smith @*/
7029b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7039b7cd975SBarry Smith {
7049b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7059b7cd975SBarry Smith   void               *ctx;
7069b7cd975SBarry Smith   DM                 dm;
7079b7cd975SBarry Smith 
7089b7cd975SBarry Smith   PetscFunctionBegin;
7099b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7109b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7119b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7129b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7139b7cd975SBarry Smith 
7149b7cd975SBarry Smith   if (forcing) {
7159b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
7169b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
7179b7cd975SBarry Smith     PetscStackPop;
7189b7cd975SBarry Smith   }
7199b7cd975SBarry Smith   PetscFunctionReturn(0);
7209b7cd975SBarry Smith }
721ef20d060SBarry Smith 
722ef20d060SBarry Smith #undef __FUNCT__
723214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
724214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
725214bc6a2SJed Brown {
7262dd45cf8SJed Brown   Vec            F;
727214bc6a2SJed Brown   PetscErrorCode ierr;
728214bc6a2SJed Brown 
729214bc6a2SJed Brown   PetscFunctionBegin;
7300298fd71SBarry Smith   *Frhs = NULL;
7310298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
732214bc6a2SJed Brown   if (!ts->Frhs) {
7332dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
734214bc6a2SJed Brown   }
735214bc6a2SJed Brown   *Frhs = ts->Frhs;
736214bc6a2SJed Brown   PetscFunctionReturn(0);
737214bc6a2SJed Brown }
738214bc6a2SJed Brown 
739214bc6a2SJed Brown #undef __FUNCT__
740214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
741214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
742214bc6a2SJed Brown {
743214bc6a2SJed Brown   Mat            A,B;
7442dd45cf8SJed Brown   PetscErrorCode ierr;
745214bc6a2SJed Brown 
746214bc6a2SJed Brown   PetscFunctionBegin;
747c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
748c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
7490298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
750214bc6a2SJed Brown   if (Arhs) {
751214bc6a2SJed Brown     if (!ts->Arhs) {
752214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
753214bc6a2SJed Brown     }
754214bc6a2SJed Brown     *Arhs = ts->Arhs;
755214bc6a2SJed Brown   }
756214bc6a2SJed Brown   if (Brhs) {
757214bc6a2SJed Brown     if (!ts->Brhs) {
758bdb70873SJed Brown       if (A != B) {
759214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
760bdb70873SJed Brown       } else {
761bdb70873SJed Brown         ts->Brhs = ts->Arhs;
762bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
763bdb70873SJed Brown       }
764214bc6a2SJed Brown     }
765214bc6a2SJed Brown     *Brhs = ts->Brhs;
766214bc6a2SJed Brown   }
767214bc6a2SJed Brown   PetscFunctionReturn(0);
768214bc6a2SJed Brown }
769214bc6a2SJed Brown 
770214bc6a2SJed Brown #undef __FUNCT__
771316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
772316643e7SJed Brown /*@
7730910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
774316643e7SJed Brown 
775316643e7SJed Brown    Collective on TS and Vec
776316643e7SJed Brown 
777316643e7SJed Brown    Input Parameters:
778316643e7SJed Brown +  ts - the TS context
779316643e7SJed Brown .  t - current time
7800910c330SBarry Smith .  U - state vector
7810910c330SBarry Smith .  Udot - time derivative of state vector
782214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
783316643e7SJed Brown 
784316643e7SJed Brown    Output Parameter:
785316643e7SJed Brown .  Y - right hand side
786316643e7SJed Brown 
787316643e7SJed Brown    Note:
788316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
789316643e7SJed Brown    is used internally within the nonlinear solvers.
790316643e7SJed Brown 
791316643e7SJed Brown    If the user did did not write their equations in implicit form, this
792316643e7SJed Brown    function recasts them in implicit form.
793316643e7SJed Brown 
794316643e7SJed Brown    Level: developer
795316643e7SJed Brown 
796316643e7SJed Brown .keywords: TS, compute
797316643e7SJed Brown 
798316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
799316643e7SJed Brown @*/
8000910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
801316643e7SJed Brown {
802316643e7SJed Brown   PetscErrorCode ierr;
80324989b8cSPeter Brune   TSIFunction    ifunction;
80424989b8cSPeter Brune   TSRHSFunction  rhsfunction;
80524989b8cSPeter Brune   void           *ctx;
80624989b8cSPeter Brune   DM             dm;
807316643e7SJed Brown 
808316643e7SJed Brown   PetscFunctionBegin;
8090700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8100910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8110910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
8120700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
813316643e7SJed Brown 
81424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
81524989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
8160298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
81724989b8cSPeter Brune 
818ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
819d90be118SSean Farley 
8200910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
82124989b8cSPeter Brune   if (ifunction) {
822316643e7SJed Brown     PetscStackPush("TS user implicit function");
8230910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
824316643e7SJed Brown     PetscStackPop;
825214bc6a2SJed Brown   }
826214bc6a2SJed Brown   if (imex) {
82724989b8cSPeter Brune     if (!ifunction) {
8280910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
8292dd45cf8SJed Brown     }
83024989b8cSPeter Brune   } else if (rhsfunction) {
83124989b8cSPeter Brune     if (ifunction) {
832214bc6a2SJed Brown       Vec Frhs;
833214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
8340910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
835214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
8362dd45cf8SJed Brown     } else {
8370910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
8380910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
839316643e7SJed Brown     }
8404a6899ffSJed Brown   }
8410910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
842316643e7SJed Brown   PetscFunctionReturn(0);
843316643e7SJed Brown }
844316643e7SJed Brown 
845316643e7SJed Brown #undef __FUNCT__
846316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
847316643e7SJed Brown /*@
848316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
849316643e7SJed Brown 
850316643e7SJed Brown    Collective on TS and Vec
851316643e7SJed Brown 
852316643e7SJed Brown    Input
853316643e7SJed Brown       Input Parameters:
854316643e7SJed Brown +  ts - the TS context
855316643e7SJed Brown .  t - current timestep
8560910c330SBarry Smith .  U - state vector
8570910c330SBarry Smith .  Udot - time derivative of state vector
858214bc6a2SJed Brown .  shift - shift to apply, see note below
859214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
860316643e7SJed Brown 
861316643e7SJed Brown    Output Parameters:
862316643e7SJed Brown +  A - Jacobian matrix
863316643e7SJed Brown .  B - optional preconditioning matrix
864316643e7SJed Brown -  flag - flag indicating matrix structure
865316643e7SJed Brown 
866316643e7SJed Brown    Notes:
8670910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
868316643e7SJed Brown 
8690910c330SBarry Smith    dF/dU + shift*dF/dUdot
870316643e7SJed Brown 
871316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
872316643e7SJed Brown    is used internally within the nonlinear solvers.
873316643e7SJed Brown 
874316643e7SJed Brown    Level: developer
875316643e7SJed Brown 
876316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
877316643e7SJed Brown 
878316643e7SJed Brown .seealso:  TSSetIJacobian()
87963495f91SJed Brown @*/
880d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
881316643e7SJed Brown {
882316643e7SJed Brown   PetscErrorCode ierr;
88324989b8cSPeter Brune   TSIJacobian    ijacobian;
88424989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
88524989b8cSPeter Brune   DM             dm;
88624989b8cSPeter Brune   void           *ctx;
887316643e7SJed Brown 
888316643e7SJed Brown   PetscFunctionBegin;
8890700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8900910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8910910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
892316643e7SJed Brown   PetscValidPointer(A,6);
89394ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
894316643e7SJed Brown   PetscValidPointer(B,7);
89594ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
89624989b8cSPeter Brune 
89724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
89824989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
8990298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
90024989b8cSPeter Brune 
901ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
902316643e7SJed Brown 
90394ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
90424989b8cSPeter Brune   if (ijacobian) {
9056cd88445SBarry Smith     PetscBool missing;
906316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
907d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
908316643e7SJed Brown     PetscStackPop;
9096cd88445SBarry Smith     if (A) {
9106cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
9116cd88445SBarry 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");
9126cd88445SBarry Smith     }
9136cd88445SBarry Smith     if (B && B != A) {
9146cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
9156cd88445SBarry 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");
9166cd88445SBarry Smith     }
9174a6899ffSJed Brown   }
918214bc6a2SJed Brown   if (imex) {
919b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
92094ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
92194ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
92294ab13aaSBarry Smith       if (A != B) {
92394ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
92494ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
925214bc6a2SJed Brown       }
926214bc6a2SJed Brown     }
927214bc6a2SJed Brown   } else {
928e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
929e1244c69SJed Brown     if (rhsjacobian) {
930bd373395SBarry Smith       if (ijacobian) {
931214bc6a2SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
932bd373395SBarry Smith       } else {
933bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
934214bc6a2SJed Brown       }
935d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
936e1244c69SJed Brown     }
93794ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
938e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
939e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
94094ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
94194ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
94294ab13aaSBarry Smith       if (A != B) {
94394ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
94494ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
945316643e7SJed Brown       }
946e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
947e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
948e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
94994ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
95094ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
95194ab13aaSBarry Smith         if (A != B) {
95294ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
95394ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
954214bc6a2SJed Brown         }
955316643e7SJed Brown       }
95694ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
95794ab13aaSBarry Smith       if (A != B) {
95894ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
959316643e7SJed Brown       }
960316643e7SJed Brown     }
961316643e7SJed Brown   }
96294ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
963316643e7SJed Brown   PetscFunctionReturn(0);
964316643e7SJed Brown }
965316643e7SJed Brown 
966316643e7SJed Brown #undef __FUNCT__
9674a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
968d763cef2SBarry Smith /*@C
969d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
970b5abc632SBarry Smith     where U_t = G(t,u).
971d763cef2SBarry Smith 
9723f9fe445SBarry Smith     Logically Collective on TS
973d763cef2SBarry Smith 
974d763cef2SBarry Smith     Input Parameters:
975d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
9760298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
977d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
978d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
9790298fd71SBarry Smith           function evaluation routine (may be NULL)
980d763cef2SBarry Smith 
981d763cef2SBarry Smith     Calling sequence of func:
98287828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
983d763cef2SBarry Smith 
984d763cef2SBarry Smith +   t - current timestep
985d763cef2SBarry Smith .   u - input vector
986d763cef2SBarry Smith .   F - function vector
987d763cef2SBarry Smith -   ctx - [optional] user-defined function context
988d763cef2SBarry Smith 
989d763cef2SBarry Smith     Level: beginner
990d763cef2SBarry Smith 
9912bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
9922bbac0d3SBarry Smith 
993d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
994d763cef2SBarry Smith 
995ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
996d763cef2SBarry Smith @*/
997089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
998d763cef2SBarry Smith {
999089b2837SJed Brown   PetscErrorCode ierr;
1000089b2837SJed Brown   SNES           snes;
10010298fd71SBarry Smith   Vec            ralloc = NULL;
100224989b8cSPeter Brune   DM             dm;
1003d763cef2SBarry Smith 
1004089b2837SJed Brown   PetscFunctionBegin;
10050700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1006ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
100724989b8cSPeter Brune 
100824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
100924989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1010089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1011e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1012e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1013e856ceecSJed Brown     r    = ralloc;
1014e856ceecSJed Brown   }
1015089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1016e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1017d763cef2SBarry Smith   PetscFunctionReturn(0);
1018d763cef2SBarry Smith }
1019d763cef2SBarry Smith 
10204a2ae208SSatish Balay #undef __FUNCT__
1021ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
1022ef20d060SBarry Smith /*@C
1023abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1024ef20d060SBarry Smith 
1025ef20d060SBarry Smith     Logically Collective on TS
1026ef20d060SBarry Smith 
1027ef20d060SBarry Smith     Input Parameters:
1028ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1029ef20d060SBarry Smith .   f - routine for evaluating the solution
1030ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
10310298fd71SBarry Smith           function evaluation routine (may be NULL)
1032ef20d060SBarry Smith 
1033ef20d060SBarry Smith     Calling sequence of func:
1034ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
1035ef20d060SBarry Smith 
1036ef20d060SBarry Smith +   t - current timestep
1037ef20d060SBarry Smith .   u - output vector
1038ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1039ef20d060SBarry Smith 
1040abd5a294SJed Brown     Notes:
1041abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1042abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1043abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1044abd5a294SJed Brown 
10454f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1046abd5a294SJed Brown 
1047ef20d060SBarry Smith     Level: beginner
1048ef20d060SBarry Smith 
1049ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1050ef20d060SBarry Smith 
10519b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
1052ef20d060SBarry Smith @*/
1053ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1054ef20d060SBarry Smith {
1055ef20d060SBarry Smith   PetscErrorCode ierr;
1056ef20d060SBarry Smith   DM             dm;
1057ef20d060SBarry Smith 
1058ef20d060SBarry Smith   PetscFunctionBegin;
1059ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1060ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1061ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1062ef20d060SBarry Smith   PetscFunctionReturn(0);
1063ef20d060SBarry Smith }
1064ef20d060SBarry Smith 
1065ef20d060SBarry Smith #undef __FUNCT__
10669b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
10679b7cd975SBarry Smith /*@C
10689b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
10699b7cd975SBarry Smith 
10709b7cd975SBarry Smith     Logically Collective on TS
10719b7cd975SBarry Smith 
10729b7cd975SBarry Smith     Input Parameters:
10739b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
10749b7cd975SBarry Smith .   f - routine for evaluating the forcing function
10759b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
10760298fd71SBarry Smith           function evaluation routine (may be NULL)
10779b7cd975SBarry Smith 
10789b7cd975SBarry Smith     Calling sequence of func:
10799b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
10809b7cd975SBarry Smith 
10819b7cd975SBarry Smith +   t - current timestep
10829b7cd975SBarry Smith .   u - output vector
10839b7cd975SBarry Smith -   ctx - [optional] user-defined function context
10849b7cd975SBarry Smith 
10859b7cd975SBarry Smith     Notes:
10869b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
10879b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
10889b7cd975SBarry Smith 
10899b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
10909b7cd975SBarry Smith 
10919b7cd975SBarry Smith     Level: beginner
10929b7cd975SBarry Smith 
10939b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
10949b7cd975SBarry Smith 
10959b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
10969b7cd975SBarry Smith @*/
10979b7cd975SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
10989b7cd975SBarry Smith {
10999b7cd975SBarry Smith   PetscErrorCode ierr;
11009b7cd975SBarry Smith   DM             dm;
11019b7cd975SBarry Smith 
11029b7cd975SBarry Smith   PetscFunctionBegin;
11039b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
11049b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
11059b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
11069b7cd975SBarry Smith   PetscFunctionReturn(0);
11079b7cd975SBarry Smith }
11089b7cd975SBarry Smith 
11099b7cd975SBarry Smith #undef __FUNCT__
11104a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
1111d763cef2SBarry Smith /*@C
1112f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1113b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1114d763cef2SBarry Smith 
11153f9fe445SBarry Smith    Logically Collective on TS
1116d763cef2SBarry Smith 
1117d763cef2SBarry Smith    Input Parameters:
1118d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1119e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1120e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1121d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1122d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
11230298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1124d763cef2SBarry Smith 
1125f7ab8db6SBarry Smith    Calling sequence of f:
1126ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1127d763cef2SBarry Smith 
1128d763cef2SBarry Smith +  t - current timestep
1129d763cef2SBarry Smith .  u - input vector
1130e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1131e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1132d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1133d763cef2SBarry Smith 
11346cd88445SBarry Smith    Notes:
11356cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
11366cd88445SBarry Smith 
11376cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1138ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1139d763cef2SBarry Smith 
1140d763cef2SBarry Smith    Level: beginner
1141d763cef2SBarry Smith 
1142d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1143d763cef2SBarry Smith 
1144ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1145d763cef2SBarry Smith 
1146d763cef2SBarry Smith @*/
1147e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1148d763cef2SBarry Smith {
1149277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1150089b2837SJed Brown   SNES           snes;
115124989b8cSPeter Brune   DM             dm;
115224989b8cSPeter Brune   TSIJacobian    ijacobian;
1153277b19d0SLisandro Dalcin 
1154d763cef2SBarry Smith   PetscFunctionBegin;
11550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1156e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1157e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1158e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1159e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1160d763cef2SBarry Smith 
116124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
116224989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1163e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1164e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1165e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1166e1244c69SJed Brown   }
11670298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1168089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11695f659677SPeter Brune   if (!ijacobian) {
1170e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
11710e4ef248SJed Brown   }
1172e5d3d808SBarry Smith   if (Amat) {
1173e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
11740e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1175bbd56ea5SKarl Rupp 
1176e5d3d808SBarry Smith     ts->Arhs = Amat;
11770e4ef248SJed Brown   }
1178e5d3d808SBarry Smith   if (Pmat) {
1179e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
11800e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1181bbd56ea5SKarl Rupp 
1182e5d3d808SBarry Smith     ts->Brhs = Pmat;
11830e4ef248SJed Brown   }
1184d763cef2SBarry Smith   PetscFunctionReturn(0);
1185d763cef2SBarry Smith }
1186d763cef2SBarry Smith 
1187316643e7SJed Brown 
1188316643e7SJed Brown #undef __FUNCT__
1189316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1190316643e7SJed Brown /*@C
1191b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1192316643e7SJed Brown 
11933f9fe445SBarry Smith    Logically Collective on TS
1194316643e7SJed Brown 
1195316643e7SJed Brown    Input Parameters:
1196316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
11970298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1198316643e7SJed Brown .  f   - the function evaluation routine
11990298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1200316643e7SJed Brown 
1201316643e7SJed Brown    Calling sequence of f:
1202316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1203316643e7SJed Brown 
1204316643e7SJed Brown +  t   - time at step/stage being solved
1205316643e7SJed Brown .  u   - state vector
1206316643e7SJed Brown .  u_t - time derivative of state vector
1207316643e7SJed Brown .  F   - function vector
1208316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1209316643e7SJed Brown 
1210316643e7SJed Brown    Important:
12112bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1212316643e7SJed Brown 
1213316643e7SJed Brown    Level: beginner
1214316643e7SJed Brown 
1215316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1216316643e7SJed Brown 
1217d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1218316643e7SJed Brown @*/
1219089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1220316643e7SJed Brown {
1221089b2837SJed Brown   PetscErrorCode ierr;
1222089b2837SJed Brown   SNES           snes;
12230298fd71SBarry Smith   Vec            resalloc = NULL;
122424989b8cSPeter Brune   DM             dm;
1225316643e7SJed Brown 
1226316643e7SJed Brown   PetscFunctionBegin;
12270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1228ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
122924989b8cSPeter Brune 
123024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
123124989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
123224989b8cSPeter Brune 
1233089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1234e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
1235e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1236e856ceecSJed Brown     res  = resalloc;
1237e856ceecSJed Brown   }
1238089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1239e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1240089b2837SJed Brown   PetscFunctionReturn(0);
1241089b2837SJed Brown }
1242089b2837SJed Brown 
1243089b2837SJed Brown #undef __FUNCT__
1244089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1245089b2837SJed Brown /*@C
1246089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1247089b2837SJed Brown 
1248089b2837SJed Brown    Not Collective
1249089b2837SJed Brown 
1250089b2837SJed Brown    Input Parameter:
1251089b2837SJed Brown .  ts - the TS context
1252089b2837SJed Brown 
1253089b2837SJed Brown    Output Parameter:
12540298fd71SBarry Smith +  r - vector to hold residual (or NULL)
12550298fd71SBarry Smith .  func - the function to compute residual (or NULL)
12560298fd71SBarry Smith -  ctx - the function context (or NULL)
1257089b2837SJed Brown 
1258089b2837SJed Brown    Level: advanced
1259089b2837SJed Brown 
1260089b2837SJed Brown .keywords: TS, nonlinear, get, function
1261089b2837SJed Brown 
1262089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1263089b2837SJed Brown @*/
1264089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1265089b2837SJed Brown {
1266089b2837SJed Brown   PetscErrorCode ierr;
1267089b2837SJed Brown   SNES           snes;
126824989b8cSPeter Brune   DM             dm;
1269089b2837SJed Brown 
1270089b2837SJed Brown   PetscFunctionBegin;
1271089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1272089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12730298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
127424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
127524989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1276089b2837SJed Brown   PetscFunctionReturn(0);
1277089b2837SJed Brown }
1278089b2837SJed Brown 
1279089b2837SJed Brown #undef __FUNCT__
1280089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1281089b2837SJed Brown /*@C
1282089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1283089b2837SJed Brown 
1284089b2837SJed Brown    Not Collective
1285089b2837SJed Brown 
1286089b2837SJed Brown    Input Parameter:
1287089b2837SJed Brown .  ts - the TS context
1288089b2837SJed Brown 
1289089b2837SJed Brown    Output Parameter:
12900298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
12910298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
12920298fd71SBarry Smith -  ctx - the function context (or NULL)
1293089b2837SJed Brown 
1294089b2837SJed Brown    Level: advanced
1295089b2837SJed Brown 
1296089b2837SJed Brown .keywords: TS, nonlinear, get, function
1297089b2837SJed Brown 
12982bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1299089b2837SJed Brown @*/
1300089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1301089b2837SJed Brown {
1302089b2837SJed Brown   PetscErrorCode ierr;
1303089b2837SJed Brown   SNES           snes;
130424989b8cSPeter Brune   DM             dm;
1305089b2837SJed Brown 
1306089b2837SJed Brown   PetscFunctionBegin;
1307089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1308089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13090298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
131024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
131124989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1312316643e7SJed Brown   PetscFunctionReturn(0);
1313316643e7SJed Brown }
1314316643e7SJed Brown 
1315316643e7SJed Brown #undef __FUNCT__
1316316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1317316643e7SJed Brown /*@C
1318a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1319ae8867d6SBarry Smith         provided with TSSetIFunction().
1320316643e7SJed Brown 
13213f9fe445SBarry Smith    Logically Collective on TS
1322316643e7SJed Brown 
1323316643e7SJed Brown    Input Parameters:
1324316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1325e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1326e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1327316643e7SJed Brown .  f   - the Jacobian evaluation routine
13280298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1329316643e7SJed Brown 
1330316643e7SJed Brown    Calling sequence of f:
1331ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1332316643e7SJed Brown 
1333316643e7SJed Brown +  t    - time at step/stage being solved
13341b4a444bSJed Brown .  U    - state vector
13351b4a444bSJed Brown .  U_t  - time derivative of state vector
1336316643e7SJed Brown .  a    - shift
1337e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1338e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1339316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1340316643e7SJed Brown 
1341316643e7SJed Brown    Notes:
1342e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1343316643e7SJed Brown 
1344895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1345895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1346895c21f2SBarry Smith 
1347a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1348b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1349a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1350a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1351a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1352a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1353a4f0a591SBarry Smith 
13546cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
13556cd88445SBarry Smith 
13566cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1357ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1358ca5f011dSBarry Smith 
1359316643e7SJed Brown    Level: beginner
1360316643e7SJed Brown 
1361316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1362316643e7SJed Brown 
1363ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1364316643e7SJed Brown 
1365316643e7SJed Brown @*/
1366e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1367316643e7SJed Brown {
1368316643e7SJed Brown   PetscErrorCode ierr;
1369089b2837SJed Brown   SNES           snes;
137024989b8cSPeter Brune   DM             dm;
1371316643e7SJed Brown 
1372316643e7SJed Brown   PetscFunctionBegin;
13730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1374e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1375e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1376e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1377e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
137824989b8cSPeter Brune 
137924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
138024989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
138124989b8cSPeter Brune 
1382089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1383e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1384316643e7SJed Brown   PetscFunctionReturn(0);
1385316643e7SJed Brown }
1386316643e7SJed Brown 
13874a2ae208SSatish Balay #undef __FUNCT__
1388e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1389e1244c69SJed Brown /*@
1390e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1391e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1392e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1393e1244c69SJed Brown    not been changed by the TS.
1394e1244c69SJed Brown 
1395e1244c69SJed Brown    Logically Collective
1396e1244c69SJed Brown 
1397e1244c69SJed Brown    Input Arguments:
1398e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1399e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1400e1244c69SJed Brown 
1401e1244c69SJed Brown    Level: intermediate
1402e1244c69SJed Brown 
1403e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1404e1244c69SJed Brown @*/
1405e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1406e1244c69SJed Brown {
1407e1244c69SJed Brown   PetscFunctionBegin;
1408e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1409e1244c69SJed Brown   PetscFunctionReturn(0);
1410e1244c69SJed Brown }
1411e1244c69SJed Brown 
1412e1244c69SJed Brown #undef __FUNCT__
141355849f57SBarry Smith #define __FUNCT__ "TSLoad"
141455849f57SBarry Smith /*@C
141555849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
141655849f57SBarry Smith 
141755849f57SBarry Smith   Collective on PetscViewer
141855849f57SBarry Smith 
141955849f57SBarry Smith   Input Parameters:
142055849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
142155849f57SBarry Smith            some related function before a call to TSLoad().
142255849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
142355849f57SBarry Smith 
142455849f57SBarry Smith    Level: intermediate
142555849f57SBarry Smith 
142655849f57SBarry Smith   Notes:
142755849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
142855849f57SBarry Smith 
142955849f57SBarry Smith   Notes for advanced users:
143055849f57SBarry Smith   Most users should not need to know the details of the binary storage
143155849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
143255849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
143355849f57SBarry Smith   format is
143455849f57SBarry Smith .vb
143555849f57SBarry Smith      has not yet been determined
143655849f57SBarry Smith .ve
143755849f57SBarry Smith 
143855849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
143955849f57SBarry Smith @*/
1440f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
144155849f57SBarry Smith {
144255849f57SBarry Smith   PetscErrorCode ierr;
144355849f57SBarry Smith   PetscBool      isbinary;
144455849f57SBarry Smith   PetscInt       classid;
144555849f57SBarry Smith   char           type[256];
14462d53ad75SBarry Smith   DMTS           sdm;
1447ad6bc421SBarry Smith   DM             dm;
144855849f57SBarry Smith 
144955849f57SBarry Smith   PetscFunctionBegin;
1450f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
145155849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
145255849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
145355849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
145455849f57SBarry Smith 
1455060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1456ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1457060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1458f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1459f2c2a1b9SBarry Smith   if (ts->ops->load) {
1460f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1461f2c2a1b9SBarry Smith   }
1462ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1463ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1464ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1465f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1466f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
14672d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14682d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
146955849f57SBarry Smith   PetscFunctionReturn(0);
147055849f57SBarry Smith }
147155849f57SBarry Smith 
14729804daf3SBarry Smith #include <petscdraw.h>
1473e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1474e04113cfSBarry Smith #include <petscviewersaws.h>
1475f05ece33SBarry Smith #endif
147655849f57SBarry Smith #undef __FUNCT__
14774a2ae208SSatish Balay #define __FUNCT__ "TSView"
14787e2c5f70SBarry Smith /*@C
1479d763cef2SBarry Smith     TSView - Prints the TS data structure.
1480d763cef2SBarry Smith 
14814c49b128SBarry Smith     Collective on TS
1482d763cef2SBarry Smith 
1483d763cef2SBarry Smith     Input Parameters:
1484d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1485d763cef2SBarry Smith -   viewer - visualization context
1486d763cef2SBarry Smith 
1487d763cef2SBarry Smith     Options Database Key:
1488d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1489d763cef2SBarry Smith 
1490d763cef2SBarry Smith     Notes:
1491d763cef2SBarry Smith     The available visualization contexts include
1492b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1493b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1494d763cef2SBarry Smith          output where only the first processor opens
1495d763cef2SBarry Smith          the file.  All other processors send their
1496d763cef2SBarry Smith          data to the first processor to print.
1497d763cef2SBarry Smith 
1498d763cef2SBarry Smith     The user can open an alternative visualization context with
1499b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1500d763cef2SBarry Smith 
1501d763cef2SBarry Smith     Level: beginner
1502d763cef2SBarry Smith 
1503d763cef2SBarry Smith .keywords: TS, timestep, view
1504d763cef2SBarry Smith 
1505b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1506d763cef2SBarry Smith @*/
15077087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1508d763cef2SBarry Smith {
1509dfbe8321SBarry Smith   PetscErrorCode ierr;
151019fd82e9SBarry Smith   TSType         type;
15112b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
15122d53ad75SBarry Smith   DMTS           sdm;
1513e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1514536b137fSBarry Smith   PetscBool      issaws;
1515f05ece33SBarry Smith #endif
1516d763cef2SBarry Smith 
1517d763cef2SBarry Smith   PetscFunctionBegin;
15180700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
15193050cee2SBarry Smith   if (!viewer) {
1520ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
15213050cee2SBarry Smith   }
15220700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1523c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1524fd16b177SBarry Smith 
1525251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1526251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
152755849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
15282b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1529e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1530536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1531f05ece33SBarry Smith #endif
153232077d6dSBarry Smith   if (iascii) {
1533dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
153477431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
15357c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1536d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
15375ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1538c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1539d763cef2SBarry Smith     }
15405ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1541193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
15422d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
15432d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1544d52bd9f3SBarry Smith     if (ts->ops->view) {
1545d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1546d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1547d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1548d52bd9f3SBarry Smith     }
15490f5bd95cSBarry Smith   } else if (isstring) {
1550a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1551b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
155255849f57SBarry Smith   } else if (isbinary) {
155355849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
155455849f57SBarry Smith     MPI_Comm    comm;
155555849f57SBarry Smith     PetscMPIInt rank;
155655849f57SBarry Smith     char        type[256];
155755849f57SBarry Smith 
155855849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
155955849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
156055849f57SBarry Smith     if (!rank) {
156155849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
156255849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
156355849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
156455849f57SBarry Smith     }
156555849f57SBarry Smith     if (ts->ops->view) {
156655849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
156755849f57SBarry Smith     }
1568f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1569f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
15702d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
15712d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
15722b0a91c0SBarry Smith   } else if (isdraw) {
15732b0a91c0SBarry Smith     PetscDraw draw;
15742b0a91c0SBarry Smith     char      str[36];
157589fd9fafSBarry Smith     PetscReal x,y,bottom,h;
15762b0a91c0SBarry Smith 
15772b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
15782b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
15792b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
15802b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
158151fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
158289fd9fafSBarry Smith     bottom = y - h;
15832b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
15842b0a91c0SBarry Smith     if (ts->ops->view) {
15852b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
15862b0a91c0SBarry Smith     }
15872b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1588e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1589536b137fSBarry Smith   } else if (issaws) {
1590d45a07a7SBarry Smith     PetscMPIInt rank;
15912657e9d9SBarry Smith     const char  *name;
15922657e9d9SBarry Smith 
15932657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1594d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1595d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1596d45a07a7SBarry Smith       char       dir[1024];
1597d45a07a7SBarry Smith 
1598e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1599a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
16002657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
16012657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
16022657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1603d763cef2SBarry Smith     }
16040acecf5bSBarry Smith     if (ts->ops->view) {
16050acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
16060acecf5bSBarry Smith     }
1607f05ece33SBarry Smith #endif
1608f05ece33SBarry Smith   }
1609f05ece33SBarry Smith 
1610b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1611251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1612b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1613d763cef2SBarry Smith   PetscFunctionReturn(0);
1614d763cef2SBarry Smith }
1615d763cef2SBarry Smith 
1616d763cef2SBarry Smith 
16174a2ae208SSatish Balay #undef __FUNCT__
16184a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1619b07ff414SBarry Smith /*@
1620d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1621d763cef2SBarry Smith    the timesteppers.
1622d763cef2SBarry Smith 
16233f9fe445SBarry Smith    Logically Collective on TS
1624d763cef2SBarry Smith 
1625d763cef2SBarry Smith    Input Parameters:
1626d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1627d763cef2SBarry Smith -  usrP - optional user context
1628d763cef2SBarry Smith 
1629daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
1630daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
1631daf670e6SBarry Smith 
1632d763cef2SBarry Smith    Level: intermediate
1633d763cef2SBarry Smith 
1634d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1635d763cef2SBarry Smith 
1636d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1637d763cef2SBarry Smith @*/
16387087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1639d763cef2SBarry Smith {
1640d763cef2SBarry Smith   PetscFunctionBegin;
16410700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1642d763cef2SBarry Smith   ts->user = usrP;
1643d763cef2SBarry Smith   PetscFunctionReturn(0);
1644d763cef2SBarry Smith }
1645d763cef2SBarry Smith 
16464a2ae208SSatish Balay #undef __FUNCT__
16474a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1648b07ff414SBarry Smith /*@
1649d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1650d763cef2SBarry Smith     timestepper.
1651d763cef2SBarry Smith 
1652d763cef2SBarry Smith     Not Collective
1653d763cef2SBarry Smith 
1654d763cef2SBarry Smith     Input Parameter:
1655d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1656d763cef2SBarry Smith 
1657d763cef2SBarry Smith     Output Parameter:
1658d763cef2SBarry Smith .   usrP - user context
1659d763cef2SBarry Smith 
1660daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
1661daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
1662daf670e6SBarry Smith 
1663d763cef2SBarry Smith     Level: intermediate
1664d763cef2SBarry Smith 
1665d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1666d763cef2SBarry Smith 
1667d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1668d763cef2SBarry Smith @*/
1669e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1670d763cef2SBarry Smith {
1671d763cef2SBarry Smith   PetscFunctionBegin;
16720700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1673e71120c6SJed Brown   *(void**)usrP = ts->user;
1674d763cef2SBarry Smith   PetscFunctionReturn(0);
1675d763cef2SBarry Smith }
1676d763cef2SBarry Smith 
16774a2ae208SSatish Balay #undef __FUNCT__
16784a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1679d763cef2SBarry Smith /*@
1680b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1681d763cef2SBarry Smith 
1682d763cef2SBarry Smith    Not Collective
1683d763cef2SBarry Smith 
1684d763cef2SBarry Smith    Input Parameter:
1685d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1686d763cef2SBarry Smith 
1687d763cef2SBarry Smith    Output Parameter:
1688b8123daeSJed Brown .  iter - number of steps completed so far
1689d763cef2SBarry Smith 
1690d763cef2SBarry Smith    Level: intermediate
1691d763cef2SBarry Smith 
1692d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
16939be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1694d763cef2SBarry Smith @*/
16957087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1696d763cef2SBarry Smith {
1697d763cef2SBarry Smith   PetscFunctionBegin;
16980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
16994482741eSBarry Smith   PetscValidIntPointer(iter,2);
1700d763cef2SBarry Smith   *iter = ts->steps;
1701d763cef2SBarry Smith   PetscFunctionReturn(0);
1702d763cef2SBarry Smith }
1703d763cef2SBarry Smith 
17044a2ae208SSatish Balay #undef __FUNCT__
17054a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1706d763cef2SBarry Smith /*@
1707d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1708d763cef2SBarry Smith    as well as the initial time.
1709d763cef2SBarry Smith 
17103f9fe445SBarry Smith    Logically Collective on TS
1711d763cef2SBarry Smith 
1712d763cef2SBarry Smith    Input Parameters:
1713d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1714d763cef2SBarry Smith .  initial_time - the initial time
1715d763cef2SBarry Smith -  time_step - the size of the timestep
1716d763cef2SBarry Smith 
1717d763cef2SBarry Smith    Level: intermediate
1718d763cef2SBarry Smith 
1719d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1720d763cef2SBarry Smith 
1721d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1722d763cef2SBarry Smith @*/
17237087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1724d763cef2SBarry Smith {
1725e144a568SJed Brown   PetscErrorCode ierr;
1726e144a568SJed Brown 
1727d763cef2SBarry Smith   PetscFunctionBegin;
17280700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1729e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1730d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1731d763cef2SBarry Smith   PetscFunctionReturn(0);
1732d763cef2SBarry Smith }
1733d763cef2SBarry Smith 
17344a2ae208SSatish Balay #undef __FUNCT__
17354a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1736d763cef2SBarry Smith /*@
1737d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1738d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1739d763cef2SBarry Smith 
17403f9fe445SBarry Smith    Logically Collective on TS
1741d763cef2SBarry Smith 
1742d763cef2SBarry Smith    Input Parameters:
1743d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1744d763cef2SBarry Smith -  time_step - the size of the timestep
1745d763cef2SBarry Smith 
1746d763cef2SBarry Smith    Level: intermediate
1747d763cef2SBarry Smith 
1748d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1749d763cef2SBarry Smith 
1750d763cef2SBarry Smith .keywords: TS, set, timestep
1751d763cef2SBarry Smith @*/
17527087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1753d763cef2SBarry Smith {
1754d763cef2SBarry Smith   PetscFunctionBegin;
17550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1756c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1757d763cef2SBarry Smith   ts->time_step      = time_step;
175831748224SBarry Smith   ts->time_step_orig = time_step;
1759d763cef2SBarry Smith   PetscFunctionReturn(0);
1760d763cef2SBarry Smith }
1761d763cef2SBarry Smith 
17624a2ae208SSatish Balay #undef __FUNCT__
1763a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1764a43b19c4SJed Brown /*@
176549354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
176649354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
176749354f04SShri Abhyankar      or just return at the final time TS computed.
1768a43b19c4SJed Brown 
1769a43b19c4SJed Brown   Logically Collective on TS
1770a43b19c4SJed Brown 
1771a43b19c4SJed Brown    Input Parameter:
1772a43b19c4SJed Brown +   ts - the time-step context
177349354f04SShri Abhyankar -   eftopt - exact final time option
1774a43b19c4SJed Brown 
1775feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
1776feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
1777feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
1778feed9e9dSBarry Smith 
1779feed9e9dSBarry Smith    Options Database:
1780feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
1781feed9e9dSBarry Smith 
1782ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
1783ee346746SBarry Smith     then the final time you selected.
1784ee346746SBarry Smith 
1785a43b19c4SJed Brown    Level: beginner
1786a43b19c4SJed Brown 
1787a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1788a43b19c4SJed Brown @*/
178949354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1790a43b19c4SJed Brown {
1791a43b19c4SJed Brown   PetscFunctionBegin;
1792a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
179349354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
179449354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1795a43b19c4SJed Brown   PetscFunctionReturn(0);
1796a43b19c4SJed Brown }
1797a43b19c4SJed Brown 
1798a43b19c4SJed Brown #undef __FUNCT__
17994a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1800d763cef2SBarry Smith /*@
1801d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1802d763cef2SBarry Smith 
1803d763cef2SBarry Smith    Not Collective
1804d763cef2SBarry Smith 
1805d763cef2SBarry Smith    Input Parameter:
1806d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1807d763cef2SBarry Smith 
1808d763cef2SBarry Smith    Output Parameter:
1809d763cef2SBarry Smith .  dt - the current timestep size
1810d763cef2SBarry Smith 
1811d763cef2SBarry Smith    Level: intermediate
1812d763cef2SBarry Smith 
1813d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1814d763cef2SBarry Smith 
1815d763cef2SBarry Smith .keywords: TS, get, timestep
1816d763cef2SBarry Smith @*/
18177087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1818d763cef2SBarry Smith {
1819d763cef2SBarry Smith   PetscFunctionBegin;
18200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1821f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1822d763cef2SBarry Smith   *dt = ts->time_step;
1823d763cef2SBarry Smith   PetscFunctionReturn(0);
1824d763cef2SBarry Smith }
1825d763cef2SBarry Smith 
18264a2ae208SSatish Balay #undef __FUNCT__
18274a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1828d8e5e3e6SSatish Balay /*@
1829d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1830d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1831d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1832d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1833d763cef2SBarry Smith 
1834d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1835d763cef2SBarry Smith 
1836d763cef2SBarry Smith    Input Parameter:
1837d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1838d763cef2SBarry Smith 
1839d763cef2SBarry Smith    Output Parameter:
1840d763cef2SBarry Smith .  v - the vector containing the solution
1841d763cef2SBarry Smith 
1842d763cef2SBarry Smith    Level: intermediate
1843d763cef2SBarry Smith 
1844d763cef2SBarry Smith .seealso: TSGetTimeStep()
1845d763cef2SBarry Smith 
1846d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1847d763cef2SBarry Smith @*/
18487087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1849d763cef2SBarry Smith {
1850d763cef2SBarry Smith   PetscFunctionBegin;
18510700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
18524482741eSBarry Smith   PetscValidPointer(v,2);
18538737fe31SLisandro Dalcin   *v = ts->vec_sol;
1854d763cef2SBarry Smith   PetscFunctionReturn(0);
1855d763cef2SBarry Smith }
1856d763cef2SBarry Smith 
1857c235aa8dSHong Zhang #undef __FUNCT__
1858dfb21088SHong Zhang #define __FUNCT__ "TSGetCostGradients"
1859c235aa8dSHong Zhang /*@
1860dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
1861c235aa8dSHong Zhang 
1862c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
1863c235aa8dSHong Zhang 
1864c235aa8dSHong Zhang    Input Parameter:
1865c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
1866c235aa8dSHong Zhang 
1867c235aa8dSHong Zhang    Output Parameter:
1868abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
1869abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
1870c235aa8dSHong Zhang 
1871c235aa8dSHong Zhang    Level: intermediate
1872c235aa8dSHong Zhang 
1873c235aa8dSHong Zhang .seealso: TSGetTimeStep()
1874c235aa8dSHong Zhang 
1875c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
1876c235aa8dSHong Zhang @*/
1877dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
1878c235aa8dSHong Zhang {
1879c235aa8dSHong Zhang   PetscFunctionBegin;
1880c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1881abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
1882abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
1883abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
1884c235aa8dSHong Zhang   PetscFunctionReturn(0);
1885c235aa8dSHong Zhang }
1886c235aa8dSHong Zhang 
1887bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
18884a2ae208SSatish Balay #undef __FUNCT__
1889bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1890d8e5e3e6SSatish Balay /*@
1891bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1892d763cef2SBarry Smith 
1893bdad233fSMatthew Knepley   Not collective
1894d763cef2SBarry Smith 
1895bdad233fSMatthew Knepley   Input Parameters:
1896bdad233fSMatthew Knepley + ts   - The TS
1897bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1898d763cef2SBarry Smith .vb
18990910c330SBarry Smith          U_t - A U = 0      (linear)
19000910c330SBarry Smith          U_t - A(t) U = 0   (linear)
19010910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1902d763cef2SBarry Smith .ve
1903d763cef2SBarry Smith 
1904d763cef2SBarry Smith    Level: beginner
1905d763cef2SBarry Smith 
1906bdad233fSMatthew Knepley .keywords: TS, problem type
1907bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1908d763cef2SBarry Smith @*/
19097087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1910a7cc72afSBarry Smith {
19119e2a6581SJed Brown   PetscErrorCode ierr;
19129e2a6581SJed Brown 
1913d763cef2SBarry Smith   PetscFunctionBegin;
19140700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1915bdad233fSMatthew Knepley   ts->problem_type = type;
19169e2a6581SJed Brown   if (type == TS_LINEAR) {
19179e2a6581SJed Brown     SNES snes;
19189e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
19199e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
19209e2a6581SJed Brown   }
1921d763cef2SBarry Smith   PetscFunctionReturn(0);
1922d763cef2SBarry Smith }
1923d763cef2SBarry Smith 
1924bdad233fSMatthew Knepley #undef __FUNCT__
1925bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1926bdad233fSMatthew Knepley /*@C
1927bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1928bdad233fSMatthew Knepley 
1929bdad233fSMatthew Knepley   Not collective
1930bdad233fSMatthew Knepley 
1931bdad233fSMatthew Knepley   Input Parameter:
1932bdad233fSMatthew Knepley . ts   - The TS
1933bdad233fSMatthew Knepley 
1934bdad233fSMatthew Knepley   Output Parameter:
1935bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1936bdad233fSMatthew Knepley .vb
1937089b2837SJed Brown          M U_t = A U
1938089b2837SJed Brown          M(t) U_t = A(t) U
1939b5abc632SBarry Smith          F(t,U,U_t)
1940bdad233fSMatthew Knepley .ve
1941bdad233fSMatthew Knepley 
1942bdad233fSMatthew Knepley    Level: beginner
1943bdad233fSMatthew Knepley 
1944bdad233fSMatthew Knepley .keywords: TS, problem type
1945bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1946bdad233fSMatthew Knepley @*/
19477087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1948a7cc72afSBarry Smith {
1949bdad233fSMatthew Knepley   PetscFunctionBegin;
19500700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
19514482741eSBarry Smith   PetscValidIntPointer(type,2);
1952bdad233fSMatthew Knepley   *type = ts->problem_type;
1953bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1954bdad233fSMatthew Knepley }
1955d763cef2SBarry Smith 
19564a2ae208SSatish Balay #undef __FUNCT__
19574a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1958d763cef2SBarry Smith /*@
1959d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1960d763cef2SBarry Smith    of a timestepper.
1961d763cef2SBarry Smith 
1962d763cef2SBarry Smith    Collective on TS
1963d763cef2SBarry Smith 
1964d763cef2SBarry Smith    Input Parameter:
1965d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1966d763cef2SBarry Smith 
1967d763cef2SBarry Smith    Notes:
1968d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1969d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1970d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1971d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1972d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1973d763cef2SBarry Smith 
1974d763cef2SBarry Smith    Level: advanced
1975d763cef2SBarry Smith 
1976d763cef2SBarry Smith .keywords: TS, timestep, setup
1977d763cef2SBarry Smith 
1978d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1979d763cef2SBarry Smith @*/
19807087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1981d763cef2SBarry Smith {
1982dfbe8321SBarry Smith   PetscErrorCode ierr;
19836c6b9e74SPeter Brune   DM             dm;
19846c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1985d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
19866c6b9e74SPeter Brune   TSIJacobian    ijac;
19876c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1988d763cef2SBarry Smith 
1989d763cef2SBarry Smith   PetscFunctionBegin;
19900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1991277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1992277b19d0SLisandro Dalcin 
19932c18e0fdSBarry Smith   ts->total_steps = 0;
19947adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
19959596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1996d763cef2SBarry Smith   }
1997277b19d0SLisandro Dalcin 
1998277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1999277b19d0SLisandro Dalcin 
20001c3436cfSJed Brown 
2001e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
2002e1244c69SJed Brown     Mat Amat,Pmat;
2003e1244c69SJed Brown     SNES snes;
2004e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2005e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2006e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2007e1244c69SJed Brown      * have displaced the RHS matrix */
2008e1244c69SJed Brown     if (Amat == ts->Arhs) {
2009e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2010e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2011e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2012e1244c69SJed Brown     }
2013e1244c69SJed Brown     if (Pmat == ts->Brhs) {
2014e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2015e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2016e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2017e1244c69SJed Brown     }
2018e1244c69SJed Brown   }
2019277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2020000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2021277b19d0SLisandro Dalcin   }
2022277b19d0SLisandro Dalcin 
20236c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
20246c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
20256c6b9e74SPeter Brune    */
20266c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
20270298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
20286c6b9e74SPeter Brune   if (!func) {
20296c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
20306c6b9e74SPeter Brune   }
20316c6b9e74SPeter Brune   /* if the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it.
20326c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
20336c6b9e74SPeter Brune    */
20340298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
20350298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
20360298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
20376c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
20386c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
20396c6b9e74SPeter Brune   }
2040277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2041277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2042277b19d0SLisandro Dalcin }
2043277b19d0SLisandro Dalcin 
2044277b19d0SLisandro Dalcin #undef __FUNCT__
2045f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp"
2046f6a906c0SBarry Smith /*@
2047f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
2048f6a906c0SBarry Smith    of an adjoint solver
2049f6a906c0SBarry Smith 
2050f6a906c0SBarry Smith    Collective on TS
2051f6a906c0SBarry Smith 
2052f6a906c0SBarry Smith    Input Parameter:
2053f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
2054f6a906c0SBarry Smith 
2055f6a906c0SBarry Smith    Level: advanced
2056f6a906c0SBarry Smith 
2057f6a906c0SBarry Smith .keywords: TS, timestep, setup
2058f6a906c0SBarry Smith 
2059947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
2060f6a906c0SBarry Smith @*/
2061f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
2062f6a906c0SBarry Smith {
2063f6a906c0SBarry Smith   PetscErrorCode ierr;
2064f6a906c0SBarry Smith 
2065f6a906c0SBarry Smith   PetscFunctionBegin;
2066f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2067f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
2068dfb21088SHong Zhang   if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
2069d8151eeaSBarry Smith 
2070947abb85SHong Zhang   if (ts->vec_costintegral) { /* if there is integral in the cost function*/
2071d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2072d8151eeaSBarry Smith     if (ts->vecs_sensip){
2073d8151eeaSBarry Smith       ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2074d8151eeaSBarry Smith     }
2075947abb85SHong Zhang   }
2076d8151eeaSBarry Smith 
207742f2b339SBarry Smith   if (ts->ops->adjointsetup) {
207842f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
2079f6a906c0SBarry Smith   }
2080f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
2081f6a906c0SBarry Smith   PetscFunctionReturn(0);
2082f6a906c0SBarry Smith }
2083f6a906c0SBarry Smith 
2084f6a906c0SBarry Smith #undef __FUNCT__
2085277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
2086277b19d0SLisandro Dalcin /*@
2087277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2088277b19d0SLisandro Dalcin 
2089277b19d0SLisandro Dalcin    Collective on TS
2090277b19d0SLisandro Dalcin 
2091277b19d0SLisandro Dalcin    Input Parameter:
2092277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2093277b19d0SLisandro Dalcin 
2094277b19d0SLisandro Dalcin    Level: beginner
2095277b19d0SLisandro Dalcin 
2096277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2097277b19d0SLisandro Dalcin 
2098277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2099277b19d0SLisandro Dalcin @*/
2100277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2101277b19d0SLisandro Dalcin {
2102277b19d0SLisandro Dalcin   PetscErrorCode ierr;
2103277b19d0SLisandro Dalcin 
2104277b19d0SLisandro Dalcin   PetscFunctionBegin;
2105277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2106b18ea86cSHong Zhang 
2107277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2108277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2109277b19d0SLisandro Dalcin   }
2110277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2111e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2112bbd56ea5SKarl Rupp 
21134e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
21144e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2115214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
21166bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2117e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2118e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
211938637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2120bbd56ea5SKarl Rupp 
2121947abb85SHong Zhang  if (ts->vec_costintegral) {
2122d8151eeaSBarry Smith     ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2123d8151eeaSBarry Smith     if (ts->vecs_drdp){
2124d8151eeaSBarry Smith       ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2125d8151eeaSBarry Smith     }
2126947abb85SHong Zhang   }
2127d8151eeaSBarry Smith   ts->vecs_sensi  = NULL;
2128d8151eeaSBarry Smith   ts->vecs_sensip = NULL;
2129ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
21302c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
213136eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2132277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2133d763cef2SBarry Smith   PetscFunctionReturn(0);
2134d763cef2SBarry Smith }
2135d763cef2SBarry Smith 
21364a2ae208SSatish Balay #undef __FUNCT__
21374a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
2138d8e5e3e6SSatish Balay /*@
2139d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2140d763cef2SBarry Smith    with TSCreate().
2141d763cef2SBarry Smith 
2142d763cef2SBarry Smith    Collective on TS
2143d763cef2SBarry Smith 
2144d763cef2SBarry Smith    Input Parameter:
2145d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2146d763cef2SBarry Smith 
2147d763cef2SBarry Smith    Level: beginner
2148d763cef2SBarry Smith 
2149d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2150d763cef2SBarry Smith 
2151d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2152d763cef2SBarry Smith @*/
21536bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2154d763cef2SBarry Smith {
21556849ba73SBarry Smith   PetscErrorCode ierr;
2156d763cef2SBarry Smith 
2157d763cef2SBarry Smith   PetscFunctionBegin;
21586bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
21596bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
21606bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2161d763cef2SBarry Smith 
21626bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2163277b19d0SLisandro Dalcin 
2164e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2165e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
21666bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
21676d4c513bSLisandro Dalcin 
2168bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2169bc952696SBarry Smith 
217084df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
2171aeb4809dSShri Abhyankar   if ((*ts)->event) {
2172aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
2173aeb4809dSShri Abhyankar   }
21746bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
21756bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
21766bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
21770dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
21786d4c513bSLisandro Dalcin 
2179a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2180d763cef2SBarry Smith   PetscFunctionReturn(0);
2181d763cef2SBarry Smith }
2182d763cef2SBarry Smith 
21834a2ae208SSatish Balay #undef __FUNCT__
21844a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2185d8e5e3e6SSatish Balay /*@
2186d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2187d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2188d763cef2SBarry Smith 
2189d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2190d763cef2SBarry Smith 
2191d763cef2SBarry Smith    Input Parameter:
2192d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2193d763cef2SBarry Smith 
2194d763cef2SBarry Smith    Output Parameter:
2195d763cef2SBarry Smith .  snes - the nonlinear solver context
2196d763cef2SBarry Smith 
2197d763cef2SBarry Smith    Notes:
2198d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2199d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
220094b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2201d763cef2SBarry Smith 
2202d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
22030298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2204d763cef2SBarry Smith 
2205d763cef2SBarry Smith    Level: beginner
2206d763cef2SBarry Smith 
2207d763cef2SBarry Smith .keywords: timestep, get, SNES
2208d763cef2SBarry Smith @*/
22097087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2210d763cef2SBarry Smith {
2211d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2212d372ba47SLisandro Dalcin 
2213d763cef2SBarry Smith   PetscFunctionBegin;
22140700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22154482741eSBarry Smith   PetscValidPointer(snes,2);
2216d372ba47SLisandro Dalcin   if (!ts->snes) {
2217ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
22180298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
22193bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2220d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2221496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
22229e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
22239e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
22249e2a6581SJed Brown     }
2225d372ba47SLisandro Dalcin   }
2226d763cef2SBarry Smith   *snes = ts->snes;
2227d763cef2SBarry Smith   PetscFunctionReturn(0);
2228d763cef2SBarry Smith }
2229d763cef2SBarry Smith 
22304a2ae208SSatish Balay #undef __FUNCT__
2231deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2232deb2cd25SJed Brown /*@
2233deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2234deb2cd25SJed Brown 
2235deb2cd25SJed Brown    Collective
2236deb2cd25SJed Brown 
2237deb2cd25SJed Brown    Input Parameter:
2238deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2239deb2cd25SJed Brown -  snes - the nonlinear solver context
2240deb2cd25SJed Brown 
2241deb2cd25SJed Brown    Notes:
2242deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2243deb2cd25SJed Brown 
2244deb2cd25SJed Brown    Level: developer
2245deb2cd25SJed Brown 
2246deb2cd25SJed Brown .keywords: timestep, set, SNES
2247deb2cd25SJed Brown @*/
2248deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2249deb2cd25SJed Brown {
2250deb2cd25SJed Brown   PetscErrorCode ierr;
2251d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2252deb2cd25SJed Brown 
2253deb2cd25SJed Brown   PetscFunctionBegin;
2254deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2255deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2256deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2257deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2258bbd56ea5SKarl Rupp 
2259deb2cd25SJed Brown   ts->snes = snes;
2260bbd56ea5SKarl Rupp 
22610298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
22620298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2263740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
22640298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2265740132f1SEmil Constantinescu   }
2266deb2cd25SJed Brown   PetscFunctionReturn(0);
2267deb2cd25SJed Brown }
2268deb2cd25SJed Brown 
2269deb2cd25SJed Brown #undef __FUNCT__
227094b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2271d8e5e3e6SSatish Balay /*@
227294b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2273d763cef2SBarry Smith    a TS (timestepper) context.
2274d763cef2SBarry Smith 
227594b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2276d763cef2SBarry Smith 
2277d763cef2SBarry Smith    Input Parameter:
2278d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2279d763cef2SBarry Smith 
2280d763cef2SBarry Smith    Output Parameter:
228194b7f48cSBarry Smith .  ksp - the nonlinear solver context
2282d763cef2SBarry Smith 
2283d763cef2SBarry Smith    Notes:
228494b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2285d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2286d763cef2SBarry Smith    KSP and PC contexts as well.
2287d763cef2SBarry Smith 
228894b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
22890298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2290d763cef2SBarry Smith 
2291d763cef2SBarry Smith    Level: beginner
2292d763cef2SBarry Smith 
229394b7f48cSBarry Smith .keywords: timestep, get, KSP
2294d763cef2SBarry Smith @*/
22957087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2296d763cef2SBarry Smith {
2297d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2298089b2837SJed Brown   SNES           snes;
2299d372ba47SLisandro Dalcin 
2300d763cef2SBarry Smith   PetscFunctionBegin;
23010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
23024482741eSBarry Smith   PetscValidPointer(ksp,2);
230317186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2304e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2305089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2306089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2307d763cef2SBarry Smith   PetscFunctionReturn(0);
2308d763cef2SBarry Smith }
2309d763cef2SBarry Smith 
2310d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2311d763cef2SBarry Smith 
23124a2ae208SSatish Balay #undef __FUNCT__
2313adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2314adb62b0dSMatthew Knepley /*@
2315adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2316adb62b0dSMatthew Knepley    maximum time for iteration.
2317adb62b0dSMatthew Knepley 
23183f9fe445SBarry Smith    Not Collective
2319adb62b0dSMatthew Knepley 
2320adb62b0dSMatthew Knepley    Input Parameters:
2321adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
23220298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
23230298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2324adb62b0dSMatthew Knepley 
2325adb62b0dSMatthew Knepley    Level: intermediate
2326adb62b0dSMatthew Knepley 
2327adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2328adb62b0dSMatthew Knepley @*/
23297087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2330adb62b0dSMatthew Knepley {
2331adb62b0dSMatthew Knepley   PetscFunctionBegin;
23320700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2333abc0a331SBarry Smith   if (maxsteps) {
23344482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2335adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2336adb62b0dSMatthew Knepley   }
2337abc0a331SBarry Smith   if (maxtime) {
23384482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2339adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2340adb62b0dSMatthew Knepley   }
2341adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2342adb62b0dSMatthew Knepley }
2343adb62b0dSMatthew Knepley 
2344adb62b0dSMatthew Knepley #undef __FUNCT__
23454a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2346d763cef2SBarry Smith /*@
2347d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2348d763cef2SBarry Smith    maximum time for iteration.
2349d763cef2SBarry Smith 
23503f9fe445SBarry Smith    Logically Collective on TS
2351d763cef2SBarry Smith 
2352d763cef2SBarry Smith    Input Parameters:
2353d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2354d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2355d763cef2SBarry Smith -  maxtime - final time to iterate to
2356d763cef2SBarry Smith 
2357d763cef2SBarry Smith    Options Database Keys:
2358d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
23593bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2360d763cef2SBarry Smith 
2361d763cef2SBarry Smith    Notes:
2362d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2363d763cef2SBarry Smith 
2364d763cef2SBarry Smith    Level: intermediate
2365d763cef2SBarry Smith 
2366d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2367a43b19c4SJed Brown 
2368a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2369d763cef2SBarry Smith @*/
23707087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2371d763cef2SBarry Smith {
2372d763cef2SBarry Smith   PetscFunctionBegin;
23730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2374c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2375c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
237639b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
237739b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2378d763cef2SBarry Smith   PetscFunctionReturn(0);
2379d763cef2SBarry Smith }
2380d763cef2SBarry Smith 
23814a2ae208SSatish Balay #undef __FUNCT__
23824a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2383d763cef2SBarry Smith /*@
2384d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2385d763cef2SBarry Smith    for use by the TS routines.
2386d763cef2SBarry Smith 
23873f9fe445SBarry Smith    Logically Collective on TS and Vec
2388d763cef2SBarry Smith 
2389d763cef2SBarry Smith    Input Parameters:
2390d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
23910910c330SBarry Smith -  u - the solution vector
2392d763cef2SBarry Smith 
2393d763cef2SBarry Smith    Level: beginner
2394d763cef2SBarry Smith 
2395d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2396d763cef2SBarry Smith @*/
23970910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2398d763cef2SBarry Smith {
23998737fe31SLisandro Dalcin   PetscErrorCode ierr;
2400496e6a7aSJed Brown   DM             dm;
24018737fe31SLisandro Dalcin 
2402d763cef2SBarry Smith   PetscFunctionBegin;
24030700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24040910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
24050910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
24066bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2407bbd56ea5SKarl Rupp 
24080910c330SBarry Smith   ts->vec_sol = u;
2409bbd56ea5SKarl Rupp 
2410496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
24110910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2412d763cef2SBarry Smith   PetscFunctionReturn(0);
2413d763cef2SBarry Smith }
2414d763cef2SBarry Smith 
2415e74ef692SMatthew Knepley #undef __FUNCT__
241673b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps"
241773b18844SBarry Smith /*@
241873b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
241973b18844SBarry Smith 
242073b18844SBarry Smith    Logically Collective on TS
242173b18844SBarry Smith 
242273b18844SBarry Smith    Input Parameters:
242373b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
242473b18844SBarry Smith .  steps - number of steps to use
242573b18844SBarry Smith 
242673b18844SBarry Smith    Level: intermediate
242773b18844SBarry Smith 
242873b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
242973b18844SBarry Smith           so as to integrate back to less than the original timestep
243073b18844SBarry Smith 
243173b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
243273b18844SBarry Smith 
243373b18844SBarry Smith .seealso: TSSetExactFinalTime()
243473b18844SBarry Smith @*/
243573b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
243673b18844SBarry Smith {
243773b18844SBarry Smith   PetscFunctionBegin;
243873b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
243973b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
244073b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
244173b18844SBarry 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");
244273b18844SBarry Smith   ts->adjoint_max_steps = steps;
244373b18844SBarry Smith   PetscFunctionReturn(0);
244473b18844SBarry Smith }
244573b18844SBarry Smith 
244673b18844SBarry Smith #undef __FUNCT__
2447dfb21088SHong Zhang #define __FUNCT__ "TSSetCostGradients"
2448c235aa8dSHong Zhang /*@
2449dfb21088SHong 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
24500cf82b59SBarry Smith       for use by the TSAdjoint routines.
2451c235aa8dSHong Zhang 
2452c235aa8dSHong Zhang    Logically Collective on TS and Vec
2453c235aa8dSHong Zhang 
2454c235aa8dSHong Zhang    Input Parameters:
2455c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2456abc2977eSBarry 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
2457abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2458c235aa8dSHong Zhang 
2459c235aa8dSHong Zhang    Level: beginner
2460c235aa8dSHong Zhang 
2461abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
24620cf82b59SBarry Smith 
2463c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2464c235aa8dSHong Zhang @*/
2465dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
2466c235aa8dSHong Zhang {
2467c235aa8dSHong Zhang   PetscFunctionBegin;
2468c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2469abc2977eSBarry Smith   PetscValidPointer(lambda,2);
2470abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
2471abc2977eSBarry Smith   ts->vecs_sensip = mu;
2472dfb21088SHong 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");
2473abc2977eSBarry Smith   ts->numcost  = numcost;
2474ad8e2604SHong Zhang   PetscFunctionReturn(0);
2475ad8e2604SHong Zhang }
2476ad8e2604SHong Zhang 
2477ad8e2604SHong Zhang #undef __FUNCT__
24785bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian"
2479ad8e2604SHong Zhang /*@C
24800cf82b59SBarry 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.
2481ad8e2604SHong Zhang 
2482ad8e2604SHong Zhang   Logically Collective on TS
2483ad8e2604SHong Zhang 
2484ad8e2604SHong Zhang   Input Parameters:
2485ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2486ad8e2604SHong Zhang - func - The function
2487ad8e2604SHong Zhang 
2488ad8e2604SHong Zhang   Calling sequence of func:
24890cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
249005755b9cSHong Zhang +   t - current timestep
24910cf82b59SBarry Smith .   y - input vector (current ODE solution)
249205755b9cSHong Zhang .   A - output matrix
249305755b9cSHong Zhang -   ctx - [optional] user-defined function context
2494ad8e2604SHong Zhang 
2495ad8e2604SHong Zhang   Level: intermediate
2496ad8e2604SHong Zhang 
24970cf82b59SBarry 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
24980cf82b59SBarry Smith 
2499ad8e2604SHong Zhang .keywords: TS, sensitivity
2500ad8e2604SHong Zhang .seealso:
2501ad8e2604SHong Zhang @*/
25025bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2503ad8e2604SHong Zhang {
2504ad8e2604SHong Zhang   PetscErrorCode ierr;
2505ad8e2604SHong Zhang 
2506ad8e2604SHong Zhang   PetscFunctionBegin;
2507ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2508ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2509ad8e2604SHong Zhang 
2510ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2511ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2512ad8e2604SHong Zhang   if(Amat) {
2513ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2514ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2515ad8e2604SHong Zhang     ts->Jacp = Amat;
2516ad8e2604SHong Zhang   }
2517ad8e2604SHong Zhang   PetscFunctionReturn(0);
2518ad8e2604SHong Zhang }
2519ad8e2604SHong Zhang 
2520ad8e2604SHong Zhang #undef __FUNCT__
25215bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian"
25220cf82b59SBarry Smith /*@C
25235bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2524ad8e2604SHong Zhang 
2525ad8e2604SHong Zhang   Collective on TS
2526ad8e2604SHong Zhang 
2527ad8e2604SHong Zhang   Input Parameters:
2528ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2529ad8e2604SHong Zhang 
2530ad8e2604SHong Zhang   Level: developer
2531ad8e2604SHong Zhang 
2532ad8e2604SHong Zhang .keywords: TS, sensitivity
25335bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
2534ad8e2604SHong Zhang @*/
25355bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2536ad8e2604SHong Zhang {
2537ad8e2604SHong Zhang   PetscErrorCode ierr;
2538ad8e2604SHong Zhang 
2539ad8e2604SHong Zhang   PetscFunctionBegin;
2540ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2541ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2542ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2543ad8e2604SHong Zhang 
2544ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2545ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2546ad8e2604SHong Zhang   PetscStackPop;
2547c235aa8dSHong Zhang   PetscFunctionReturn(0);
2548c235aa8dSHong Zhang }
2549c235aa8dSHong Zhang 
2550c235aa8dSHong Zhang #undef __FUNCT__
2551dfb21088SHong Zhang #define __FUNCT__ "TSSetCostIntegrand"
25526fd0887fSHong Zhang /*@C
2553dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
25546fd0887fSHong Zhang 
25556fd0887fSHong Zhang     Logically Collective on TS
25566fd0887fSHong Zhang 
25576fd0887fSHong Zhang     Input Parameters:
25586fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
2559abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
25600cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
2561b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2562b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
2563b1cb36f3SHong Zhang .   fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run
2564b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
25656fd0887fSHong Zhang 
25660cf82b59SBarry Smith     Calling sequence of rf:
25670cf82b59SBarry Smith $     rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
25686fd0887fSHong Zhang 
25696fd0887fSHong Zhang +   t - current timestep
25700cf82b59SBarry Smith .   y - input vector
25710cf82b59SBarry Smith .   f - function result; one vector entry for each cost function
25726fd0887fSHong Zhang -   ctx - [optional] user-defined function context
25736fd0887fSHong Zhang 
2574b612ec54SBarry Smith    Calling sequence of drdyf:
25750cf82b59SBarry Smith $    PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
2576b612ec54SBarry Smith 
2577b612ec54SBarry Smith    Calling sequence of drdpf:
25780cf82b59SBarry Smith $    PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
2579b612ec54SBarry Smith 
2580b612ec54SBarry Smith     Level: intermediate
25816fd0887fSHong Zhang 
2582abc2977eSBarry Smith     Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions
25830cf82b59SBarry Smith 
25846fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
25856fd0887fSHong Zhang 
2586dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
25876fd0887fSHong Zhang @*/
2588dfb21088SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
2589d8151eeaSBarry Smith                                                           PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
2590b1cb36f3SHong Zhang                                                           PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),
2591b1cb36f3SHong Zhang                                                           PetscBool fwd,void *ctx)
25926fd0887fSHong Zhang {
25936fd0887fSHong Zhang   PetscErrorCode ierr;
25946fd0887fSHong Zhang 
25956fd0887fSHong Zhang   PetscFunctionBegin;
25966fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2597dfb21088SHong 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()");
2598c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
25996fd0887fSHong Zhang 
2600b1cb36f3SHong Zhang   ts->costintegralfwd  = fwd; /* Evaluate the cost integral in forward run if fwd is true */
2601abc2977eSBarry Smith   ierr                 = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
26022c39e106SBarry Smith   ierr                 = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
26030cf82b59SBarry Smith   ts->costintegrand    = rf;
260405755b9cSHong Zhang   ts->costintegrandctx = ctx;
2605b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
2606b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
26076fd0887fSHong Zhang   PetscFunctionReturn(0);
26086fd0887fSHong Zhang }
26096fd0887fSHong Zhang 
26106fd0887fSHong Zhang #undef __FUNCT__
2611dfb21088SHong Zhang #define __FUNCT__ "TSGetCostIntegral"
261236eaed60SHong Zhang /*@
2613dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
261436eaed60SHong Zhang    It is valid to call the routine after a backward run.
261536eaed60SHong Zhang 
261636eaed60SHong Zhang    Not Collective
261736eaed60SHong Zhang 
261836eaed60SHong Zhang    Input Parameter:
261936eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
262036eaed60SHong Zhang 
262136eaed60SHong Zhang    Output Parameter:
26222c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
262336eaed60SHong Zhang 
262436eaed60SHong Zhang    Level: intermediate
262536eaed60SHong Zhang 
2626dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
262736eaed60SHong Zhang 
262836eaed60SHong Zhang .keywords: TS, sensitivity analysis
262936eaed60SHong Zhang @*/
2630dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
263136eaed60SHong Zhang {
263236eaed60SHong Zhang   PetscFunctionBegin;
263336eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
263436eaed60SHong Zhang   PetscValidPointer(v,2);
26352c39e106SBarry Smith   *v = ts->vec_costintegral;
263636eaed60SHong Zhang   PetscFunctionReturn(0);
263736eaed60SHong Zhang }
263836eaed60SHong Zhang 
263936eaed60SHong Zhang #undef __FUNCT__
2640d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand"
26416fd0887fSHong Zhang /*@
26422c39e106SBarry Smith    TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
26436fd0887fSHong Zhang 
26446fd0887fSHong Zhang    Input Parameters:
26456fd0887fSHong Zhang +  ts - the TS context
26466fd0887fSHong Zhang .  t - current time
26470cf82b59SBarry Smith -  y - state vector, i.e. current solution
26486fd0887fSHong Zhang 
26496fd0887fSHong Zhang    Output Parameter:
2650abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
26516fd0887fSHong Zhang 
26526fd0887fSHong Zhang    Note:
26536fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
26546fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
26556fd0887fSHong Zhang 
26566fd0887fSHong Zhang    Level: developer
26576fd0887fSHong Zhang 
26586fd0887fSHong Zhang .keywords: TS, compute
26596fd0887fSHong Zhang 
2660dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
26616fd0887fSHong Zhang @*/
26620cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
26636fd0887fSHong Zhang {
26646fd0887fSHong Zhang   PetscErrorCode ierr;
26656fd0887fSHong Zhang 
26666fd0887fSHong Zhang   PetscFunctionBegin;
26676fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
26680cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
26696fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
26706fd0887fSHong Zhang 
26710cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
2672e4680132SHong Zhang   if (ts->costintegrand) {
2673e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
26740cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
26756fd0887fSHong Zhang     PetscStackPop;
26766fd0887fSHong Zhang   } else {
26776fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
26786fd0887fSHong Zhang   }
26796fd0887fSHong Zhang 
26800cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
26816fd0887fSHong Zhang   PetscFunctionReturn(0);
26826fd0887fSHong Zhang }
26836fd0887fSHong Zhang 
26846fd0887fSHong Zhang #undef __FUNCT__
2685d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction"
268605755b9cSHong Zhang /*@
2687d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
268805755b9cSHong Zhang 
268905755b9cSHong Zhang   Collective on TS
269005755b9cSHong Zhang 
269105755b9cSHong Zhang   Input Parameters:
269205755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
269305755b9cSHong Zhang 
269405755b9cSHong Zhang   Notes:
2695d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
269605755b9cSHong Zhang   so most users would not generally call this routine themselves.
269705755b9cSHong Zhang 
269805755b9cSHong Zhang   Level: developer
269905755b9cSHong Zhang 
270005755b9cSHong Zhang .keywords: TS, sensitivity
2701d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
270205755b9cSHong Zhang @*/
27030cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
270405755b9cSHong Zhang {
270505755b9cSHong Zhang   PetscErrorCode ierr;
270605755b9cSHong Zhang 
270705755b9cSHong Zhang   PetscFunctionBegin;
270805755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27090cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
271005755b9cSHong Zhang 
271105755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
27120cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
271305755b9cSHong Zhang   PetscStackPop;
271405755b9cSHong Zhang   PetscFunctionReturn(0);
271505755b9cSHong Zhang }
271605755b9cSHong Zhang 
271705755b9cSHong Zhang #undef __FUNCT__
2718d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction"
271905755b9cSHong Zhang /*@
2720d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
272105755b9cSHong Zhang 
272205755b9cSHong Zhang   Collective on TS
272305755b9cSHong Zhang 
272405755b9cSHong Zhang   Input Parameters:
272505755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
272605755b9cSHong Zhang 
272705755b9cSHong Zhang   Notes:
272805755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
272905755b9cSHong Zhang   so most users would not generally call this routine themselves.
273005755b9cSHong Zhang 
273105755b9cSHong Zhang   Level: developer
273205755b9cSHong Zhang 
273305755b9cSHong Zhang .keywords: TS, sensitivity
2734d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
273505755b9cSHong Zhang @*/
27360cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
273705755b9cSHong Zhang {
273805755b9cSHong Zhang   PetscErrorCode ierr;
273905755b9cSHong Zhang 
274005755b9cSHong Zhang   PetscFunctionBegin;
274105755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27420cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
274305755b9cSHong Zhang 
274405755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
27450cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
274605755b9cSHong Zhang   PetscStackPop;
274705755b9cSHong Zhang   PetscFunctionReturn(0);
274805755b9cSHong Zhang }
274905755b9cSHong Zhang 
275005755b9cSHong Zhang #undef __FUNCT__
2751e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2752ac226902SBarry Smith /*@C
2753000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
27543f2090d5SJed Brown   called once at the beginning of each time step.
2755000e7ae3SMatthew Knepley 
27563f9fe445SBarry Smith   Logically Collective on TS
2757000e7ae3SMatthew Knepley 
2758000e7ae3SMatthew Knepley   Input Parameters:
2759000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2760000e7ae3SMatthew Knepley - func - The function
2761000e7ae3SMatthew Knepley 
2762000e7ae3SMatthew Knepley   Calling sequence of func:
2763000e7ae3SMatthew Knepley . func (TS ts);
2764000e7ae3SMatthew Knepley 
2765000e7ae3SMatthew Knepley   Level: intermediate
2766000e7ae3SMatthew Knepley 
2767b8123daeSJed Brown   Note:
2768b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2769b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2770b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2771b8123daeSJed Brown 
2772000e7ae3SMatthew Knepley .keywords: TS, timestep
27739be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2774000e7ae3SMatthew Knepley @*/
27757087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2776000e7ae3SMatthew Knepley {
2777000e7ae3SMatthew Knepley   PetscFunctionBegin;
27780700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2779ae60f76fSBarry Smith   ts->prestep = func;
2780000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2781000e7ae3SMatthew Knepley }
2782000e7ae3SMatthew Knepley 
2783e74ef692SMatthew Knepley #undef __FUNCT__
27843f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
278509ee8438SJed Brown /*@
27863f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
27873f2090d5SJed Brown 
27883f2090d5SJed Brown   Collective on TS
27893f2090d5SJed Brown 
27903f2090d5SJed Brown   Input Parameters:
27913f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
27923f2090d5SJed Brown 
27933f2090d5SJed Brown   Notes:
27943f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
27953f2090d5SJed Brown   so most users would not generally call this routine themselves.
27963f2090d5SJed Brown 
27973f2090d5SJed Brown   Level: developer
27983f2090d5SJed Brown 
27993f2090d5SJed Brown .keywords: TS, timestep
28009be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
28013f2090d5SJed Brown @*/
28027087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
28033f2090d5SJed Brown {
28043f2090d5SJed Brown   PetscErrorCode ierr;
28053f2090d5SJed Brown 
28063f2090d5SJed Brown   PetscFunctionBegin;
28070700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2808ae60f76fSBarry Smith   if (ts->prestep) {
2809ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2810312ce896SJed Brown   }
28113f2090d5SJed Brown   PetscFunctionReturn(0);
28123f2090d5SJed Brown }
28133f2090d5SJed Brown 
28143f2090d5SJed Brown #undef __FUNCT__
2815b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2816b8123daeSJed Brown /*@C
2817b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2818b8123daeSJed Brown   called once at the beginning of each stage.
2819b8123daeSJed Brown 
2820b8123daeSJed Brown   Logically Collective on TS
2821b8123daeSJed Brown 
2822b8123daeSJed Brown   Input Parameters:
2823b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2824b8123daeSJed Brown - func - The function
2825b8123daeSJed Brown 
2826b8123daeSJed Brown   Calling sequence of func:
2827b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2828b8123daeSJed Brown 
2829b8123daeSJed Brown   Level: intermediate
2830b8123daeSJed Brown 
2831b8123daeSJed Brown   Note:
2832b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2833b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2834b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2835b8123daeSJed Brown 
2836b8123daeSJed Brown .keywords: TS, timestep
28379be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2838b8123daeSJed Brown @*/
2839b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2840b8123daeSJed Brown {
2841b8123daeSJed Brown   PetscFunctionBegin;
2842b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2843ae60f76fSBarry Smith   ts->prestage = func;
2844b8123daeSJed Brown   PetscFunctionReturn(0);
2845b8123daeSJed Brown }
2846b8123daeSJed Brown 
2847b8123daeSJed Brown #undef __FUNCT__
28489be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
28499be3e283SDebojyoti Ghosh /*@C
28509be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
28519be3e283SDebojyoti Ghosh   called once at the end of each stage.
28529be3e283SDebojyoti Ghosh 
28539be3e283SDebojyoti Ghosh   Logically Collective on TS
28549be3e283SDebojyoti Ghosh 
28559be3e283SDebojyoti Ghosh   Input Parameters:
28569be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
28579be3e283SDebojyoti Ghosh - func - The function
28589be3e283SDebojyoti Ghosh 
28599be3e283SDebojyoti Ghosh   Calling sequence of func:
28609be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
28619be3e283SDebojyoti Ghosh 
28629be3e283SDebojyoti Ghosh   Level: intermediate
28639be3e283SDebojyoti Ghosh 
28649be3e283SDebojyoti Ghosh   Note:
28659be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
28669be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
28679be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
28689be3e283SDebojyoti Ghosh 
28699be3e283SDebojyoti Ghosh .keywords: TS, timestep
28709be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
28719be3e283SDebojyoti Ghosh @*/
28729be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
28739be3e283SDebojyoti Ghosh {
28749be3e283SDebojyoti Ghosh   PetscFunctionBegin;
28759be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
28769be3e283SDebojyoti Ghosh   ts->poststage = func;
28779be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
28789be3e283SDebojyoti Ghosh }
28799be3e283SDebojyoti Ghosh 
28809be3e283SDebojyoti Ghosh #undef __FUNCT__
2881b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2882b8123daeSJed Brown /*@
2883b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2884b8123daeSJed Brown 
2885b8123daeSJed Brown   Collective on TS
2886b8123daeSJed Brown 
2887b8123daeSJed Brown   Input Parameters:
2888b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
28899be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2890b8123daeSJed Brown 
2891b8123daeSJed Brown   Notes:
2892b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2893b8123daeSJed Brown   most users would not generally call this routine themselves.
2894b8123daeSJed Brown 
2895b8123daeSJed Brown   Level: developer
2896b8123daeSJed Brown 
2897b8123daeSJed Brown .keywords: TS, timestep
28989be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2899b8123daeSJed Brown @*/
2900b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2901b8123daeSJed Brown {
2902b8123daeSJed Brown   PetscErrorCode ierr;
2903b8123daeSJed Brown 
2904b8123daeSJed Brown   PetscFunctionBegin;
2905b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2906ae60f76fSBarry Smith   if (ts->prestage) {
2907ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2908b8123daeSJed Brown   }
2909b8123daeSJed Brown   PetscFunctionReturn(0);
2910b8123daeSJed Brown }
2911b8123daeSJed Brown 
2912b8123daeSJed Brown #undef __FUNCT__
29139be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
29149be3e283SDebojyoti Ghosh /*@
29159be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
29169be3e283SDebojyoti Ghosh 
29179be3e283SDebojyoti Ghosh   Collective on TS
29189be3e283SDebojyoti Ghosh 
29199be3e283SDebojyoti Ghosh   Input Parameters:
29209be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
29219be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
29229be3e283SDebojyoti Ghosh   stageindex  - Stage number
29239be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
29249be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
29259be3e283SDebojyoti Ghosh 
29269be3e283SDebojyoti Ghosh   Notes:
29279be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
29289be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
29299be3e283SDebojyoti Ghosh 
29309be3e283SDebojyoti Ghosh   Level: developer
29319be3e283SDebojyoti Ghosh 
29329be3e283SDebojyoti Ghosh .keywords: TS, timestep
29339be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
29349be3e283SDebojyoti Ghosh @*/
29359be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
29369be3e283SDebojyoti Ghosh {
29379be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
29389be3e283SDebojyoti Ghosh 
29399be3e283SDebojyoti Ghosh   PetscFunctionBegin;
29409be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29414beae5d8SLisandro Dalcin   if (ts->poststage) {
29429be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
29439be3e283SDebojyoti Ghosh   }
29449be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
29459be3e283SDebojyoti Ghosh }
29469be3e283SDebojyoti Ghosh 
29479be3e283SDebojyoti Ghosh #undef __FUNCT__
2948e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2949ac226902SBarry Smith /*@C
2950000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
29513f2090d5SJed Brown   called once at the end of each time step.
2952000e7ae3SMatthew Knepley 
29533f9fe445SBarry Smith   Logically Collective on TS
2954000e7ae3SMatthew Knepley 
2955000e7ae3SMatthew Knepley   Input Parameters:
2956000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2957000e7ae3SMatthew Knepley - func - The function
2958000e7ae3SMatthew Knepley 
2959000e7ae3SMatthew Knepley   Calling sequence of func:
2960b8123daeSJed Brown $ func (TS ts);
2961000e7ae3SMatthew Knepley 
2962000e7ae3SMatthew Knepley   Level: intermediate
2963000e7ae3SMatthew Knepley 
2964000e7ae3SMatthew Knepley .keywords: TS, timestep
2965b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2966000e7ae3SMatthew Knepley @*/
29677087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2968000e7ae3SMatthew Knepley {
2969000e7ae3SMatthew Knepley   PetscFunctionBegin;
29700700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2971ae60f76fSBarry Smith   ts->poststep = func;
2972000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2973000e7ae3SMatthew Knepley }
2974000e7ae3SMatthew Knepley 
2975e74ef692SMatthew Knepley #undef __FUNCT__
29763f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
297709ee8438SJed Brown /*@
29783f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
29793f2090d5SJed Brown 
29803f2090d5SJed Brown   Collective on TS
29813f2090d5SJed Brown 
29823f2090d5SJed Brown   Input Parameters:
29833f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
29843f2090d5SJed Brown 
29853f2090d5SJed Brown   Notes:
29863f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
29873f2090d5SJed Brown   so most users would not generally call this routine themselves.
29883f2090d5SJed Brown 
29893f2090d5SJed Brown   Level: developer
29903f2090d5SJed Brown 
29913f2090d5SJed Brown .keywords: TS, timestep
29923f2090d5SJed Brown @*/
29937087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
29943f2090d5SJed Brown {
29953f2090d5SJed Brown   PetscErrorCode ierr;
29963f2090d5SJed Brown 
29973f2090d5SJed Brown   PetscFunctionBegin;
29980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2999ae60f76fSBarry Smith   if (ts->poststep) {
3000ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
300172ac3e02SJed Brown   }
30023f2090d5SJed Brown   PetscFunctionReturn(0);
30033f2090d5SJed Brown }
30043f2090d5SJed Brown 
3005d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3006d763cef2SBarry Smith 
30074a2ae208SSatish Balay #undef __FUNCT__
3008a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
3009d763cef2SBarry Smith /*@C
3010a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3011d763cef2SBarry Smith    timestep to display the iteration's  progress.
3012d763cef2SBarry Smith 
30133f9fe445SBarry Smith    Logically Collective on TS
3014d763cef2SBarry Smith 
3015d763cef2SBarry Smith    Input Parameters:
3016d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3017e213d8f1SJed Brown .  monitor - monitoring routine
3018329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
30190298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3020b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
30210298fd71SBarry Smith           (may be NULL)
3022d763cef2SBarry Smith 
3023e213d8f1SJed Brown    Calling sequence of monitor:
30240910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3025d763cef2SBarry Smith 
3026d763cef2SBarry Smith +    ts - the TS context
302788c05cc5SBarry Smith .    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
302888c05cc5SBarry Smith                                been interpolated to)
30291f06c33eSBarry Smith .    time - current time
30300910c330SBarry Smith .    u - current iterate
3031d763cef2SBarry Smith -    mctx - [optional] monitoring context
3032d763cef2SBarry Smith 
3033d763cef2SBarry Smith    Notes:
3034d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3035d763cef2SBarry Smith    already has been loaded.
3036d763cef2SBarry Smith 
3037025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
3038025f1a04SBarry Smith 
3039d763cef2SBarry Smith    Level: intermediate
3040d763cef2SBarry Smith 
3041d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3042d763cef2SBarry Smith 
3043a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3044d763cef2SBarry Smith @*/
3045c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3046d763cef2SBarry Smith {
3047d763cef2SBarry Smith   PetscFunctionBegin;
30480700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
304917186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3050d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
30518704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3052d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3053d763cef2SBarry Smith   PetscFunctionReturn(0);
3054d763cef2SBarry Smith }
3055d763cef2SBarry Smith 
30564a2ae208SSatish Balay #undef __FUNCT__
3057a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
3058d763cef2SBarry Smith /*@C
3059a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3060d763cef2SBarry Smith 
30613f9fe445SBarry Smith    Logically Collective on TS
3062d763cef2SBarry Smith 
3063d763cef2SBarry Smith    Input Parameters:
3064d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3065d763cef2SBarry Smith 
3066d763cef2SBarry Smith    Notes:
3067d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3068d763cef2SBarry Smith 
3069d763cef2SBarry Smith    Level: intermediate
3070d763cef2SBarry Smith 
3071d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3072d763cef2SBarry Smith 
3073a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3074d763cef2SBarry Smith @*/
30757087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3076d763cef2SBarry Smith {
3077d952e501SBarry Smith   PetscErrorCode ierr;
3078d952e501SBarry Smith   PetscInt       i;
3079d952e501SBarry Smith 
3080d763cef2SBarry Smith   PetscFunctionBegin;
30810700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3082d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
30838704b422SBarry Smith     if (ts->monitordestroy[i]) {
30848704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3085d952e501SBarry Smith     }
3086d952e501SBarry Smith   }
3087d763cef2SBarry Smith   ts->numbermonitors = 0;
3088d763cef2SBarry Smith   PetscFunctionReturn(0);
3089d763cef2SBarry Smith }
3090d763cef2SBarry Smith 
30914a2ae208SSatish Balay #undef __FUNCT__
3092a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
3093*721cd6eeSBarry Smith /*@C
3094*721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
30955516499fSSatish Balay 
30965516499fSSatish Balay    Level: intermediate
309741251cbbSSatish Balay 
30985516499fSSatish Balay .keywords: TS, set, monitor
30995516499fSSatish Balay 
310041251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
310141251cbbSSatish Balay @*/
3102*721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3103d763cef2SBarry Smith {
3104dfbe8321SBarry Smith   PetscErrorCode ierr;
3105*721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
310641aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3107d132466eSBarry Smith 
3108d763cef2SBarry Smith   PetscFunctionBegin;
31094d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
311041aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
311141aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3112*721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
311341aca3d6SBarry Smith   if (iascii) {
3114649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
31158392e04aSShri 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);
3116649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
311741aca3d6SBarry Smith   } else if (ibinary) {
311841aca3d6SBarry Smith     PetscMPIInt rank;
311941aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
312041aca3d6SBarry Smith     if (!rank) {
312141aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
312241aca3d6SBarry Smith     } else {
312341aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
312441aca3d6SBarry Smith     }
312541aca3d6SBarry Smith   }
3126*721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3127d763cef2SBarry Smith   PetscFunctionReturn(0);
3128d763cef2SBarry Smith }
3129d763cef2SBarry Smith 
31304a2ae208SSatish Balay #undef __FUNCT__
31319110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorSet"
31329110b2e7SHong Zhang /*@C
31339110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
31349110b2e7SHong Zhang    timestep to display the iteration's  progress.
31359110b2e7SHong Zhang 
31369110b2e7SHong Zhang    Logically Collective on TS
31379110b2e7SHong Zhang 
31389110b2e7SHong Zhang    Input Parameters:
31399110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
31409110b2e7SHong Zhang .  adjointmonitor - monitoring routine
31419110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
31429110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
31439110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
31449110b2e7SHong Zhang           (may be NULL)
31459110b2e7SHong Zhang 
31469110b2e7SHong Zhang    Calling sequence of monitor:
31479110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
31489110b2e7SHong Zhang 
31499110b2e7SHong Zhang +    ts - the TS context
31509110b2e7SHong 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
31519110b2e7SHong Zhang                                been interpolated to)
31529110b2e7SHong Zhang .    time - current time
31539110b2e7SHong Zhang .    u - current iterate
31549110b2e7SHong Zhang .    numcost - number of cost functionos
31559110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
31569110b2e7SHong Zhang .    mu - sensitivities to parameters
31579110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
31589110b2e7SHong Zhang 
31599110b2e7SHong Zhang    Notes:
31609110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
31619110b2e7SHong Zhang    already has been loaded.
31629110b2e7SHong Zhang 
31639110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
31649110b2e7SHong Zhang 
31659110b2e7SHong Zhang    Level: intermediate
31669110b2e7SHong Zhang 
31679110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
31689110b2e7SHong Zhang 
31699110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
31709110b2e7SHong Zhang @*/
31719110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
31729110b2e7SHong Zhang {
31739110b2e7SHong Zhang   PetscFunctionBegin;
31749110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31759110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
31769110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
31779110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
31789110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
31799110b2e7SHong Zhang   PetscFunctionReturn(0);
31809110b2e7SHong Zhang }
31819110b2e7SHong Zhang 
31829110b2e7SHong Zhang #undef __FUNCT__
31839110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorCancel"
31849110b2e7SHong Zhang /*@C
31859110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
31869110b2e7SHong Zhang 
31879110b2e7SHong Zhang    Logically Collective on TS
31889110b2e7SHong Zhang 
31899110b2e7SHong Zhang    Input Parameters:
31909110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
31919110b2e7SHong Zhang 
31929110b2e7SHong Zhang    Notes:
31939110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
31949110b2e7SHong Zhang 
31959110b2e7SHong Zhang    Level: intermediate
31969110b2e7SHong Zhang 
31979110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
31989110b2e7SHong Zhang 
31999110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
32009110b2e7SHong Zhang @*/
32019110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
32029110b2e7SHong Zhang {
32039110b2e7SHong Zhang   PetscErrorCode ierr;
32049110b2e7SHong Zhang   PetscInt       i;
32059110b2e7SHong Zhang 
32069110b2e7SHong Zhang   PetscFunctionBegin;
32079110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
32089110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
32099110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
32109110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
32119110b2e7SHong Zhang     }
32129110b2e7SHong Zhang   }
32139110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
32149110b2e7SHong Zhang   PetscFunctionReturn(0);
32159110b2e7SHong Zhang }
32169110b2e7SHong Zhang 
32179110b2e7SHong Zhang #undef __FUNCT__
3218110eb670SHong Zhang #define __FUNCT__ "TSAdjointMonitorDefault"
3219*721cd6eeSBarry Smith /*@C
3220*721cd6eeSBarry Smith    TSAdjointMonitorDefault - the default monitor of adjoint computations
3221110eb670SHong Zhang 
3222110eb670SHong Zhang    Level: intermediate
3223110eb670SHong Zhang 
3224110eb670SHong Zhang .keywords: TS, set, monitor
3225110eb670SHong Zhang 
3226110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
3227110eb670SHong Zhang @*/
3228*721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
3229110eb670SHong Zhang {
3230110eb670SHong Zhang   PetscErrorCode ierr;
3231*721cd6eeSBarry Smith   PetscViewer    viewer = vf->viewer;
3232110eb670SHong Zhang 
3233110eb670SHong Zhang   PetscFunctionBegin;
3234110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3235*721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
3236110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3237110eb670SHong 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);
3238110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3239*721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3240110eb670SHong Zhang   PetscFunctionReturn(0);
3241110eb670SHong Zhang }
3242110eb670SHong Zhang 
3243110eb670SHong Zhang #undef __FUNCT__
3244cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
3245cd652676SJed Brown /*@
3246cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
3247cd652676SJed Brown 
3248cd652676SJed Brown    Logically Collective on TS
3249cd652676SJed Brown 
3250cd652676SJed Brown    Input Argument:
3251cd652676SJed Brown .  ts - time stepping context
3252cd652676SJed Brown 
3253cd652676SJed Brown    Output Argument:
3254cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
3255cd652676SJed Brown 
3256cd652676SJed Brown    Level: intermediate
3257cd652676SJed Brown 
3258cd652676SJed Brown .keywords: TS, set
3259cd652676SJed Brown 
3260cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
3261cd652676SJed Brown @*/
3262cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
3263cd652676SJed Brown {
3264cd652676SJed Brown   PetscFunctionBegin;
3265cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3266cd652676SJed Brown   ts->retain_stages = flg;
3267cd652676SJed Brown   PetscFunctionReturn(0);
3268cd652676SJed Brown }
3269cd652676SJed Brown 
3270cd652676SJed Brown #undef __FUNCT__
3271cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
3272cd652676SJed Brown /*@
3273cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3274cd652676SJed Brown 
3275cd652676SJed Brown    Collective on TS
3276cd652676SJed Brown 
3277cd652676SJed Brown    Input Argument:
3278cd652676SJed Brown +  ts - time stepping context
3279cd652676SJed Brown -  t - time to interpolate to
3280cd652676SJed Brown 
3281cd652676SJed Brown    Output Argument:
32820910c330SBarry Smith .  U - state at given time
3283cd652676SJed Brown 
3284cd652676SJed Brown    Notes:
3285cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
3286cd652676SJed Brown 
3287cd652676SJed Brown    Level: intermediate
3288cd652676SJed Brown 
3289cd652676SJed Brown    Developer Notes:
3290cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3291cd652676SJed Brown 
3292cd652676SJed Brown .keywords: TS, set
3293cd652676SJed Brown 
3294cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
3295cd652676SJed Brown @*/
32960910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3297cd652676SJed Brown {
3298cd652676SJed Brown   PetscErrorCode ierr;
3299cd652676SJed Brown 
3300cd652676SJed Brown   PetscFunctionBegin;
3301cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3302b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
33036712e2f1SBarry Smith   if (t < ts->ptime - ts->time_step_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)(ts->ptime-ts->time_step_prev),(double)ts->ptime);
3304ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
33050910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3306cd652676SJed Brown   PetscFunctionReturn(0);
3307cd652676SJed Brown }
3308cd652676SJed Brown 
3309cd652676SJed Brown #undef __FUNCT__
33104a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3311d763cef2SBarry Smith /*@
33126d9e5789SSean Farley    TSStep - Steps one time step
3313d763cef2SBarry Smith 
3314d763cef2SBarry Smith    Collective on TS
3315d763cef2SBarry Smith 
3316d763cef2SBarry Smith    Input Parameter:
3317d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3318d763cef2SBarry Smith 
331927829d71SBarry Smith    Level: developer
3320d763cef2SBarry Smith 
3321b8123daeSJed Brown    Notes:
332227829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
332327829d71SBarry Smith 
3324b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3325b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3326b8123daeSJed Brown 
332725cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
332825cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
332925cb2221SBarry Smith 
3330d763cef2SBarry Smith .keywords: TS, timestep, solve
3331d763cef2SBarry Smith 
33329be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3333d763cef2SBarry Smith @*/
3334193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3335d763cef2SBarry Smith {
33362fb8446cSMatthew G. Knepley   DM               dm;
3337dfbe8321SBarry Smith   PetscErrorCode   ierr;
3338fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3339d763cef2SBarry Smith 
3340d763cef2SBarry Smith   PetscFunctionBegin;
33410700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3342feed9e9dSBarry Smith   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()");
3343feed9e9dSBarry Smith 
3344fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3345fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3346fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3347fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3348fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3349fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3350302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
3351fffbeea8SBarry Smith 
33522fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3353d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
335468bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3355d405a339SMatthew Knepley 
3356362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
335724655328SShri   ts->ptime_prev = ts->ptime;
3358cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3359bbd56ea5SKarl Rupp 
3360e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3361d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3362193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3363d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3364bbd56ea5SKarl Rupp 
336524655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3366cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3367362cd11cSLisandro Dalcin 
3368362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3369cef5090cSJed Brown     if (ts->errorifstepfailed) {
337008c7845fSBarry 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]);
337108c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3372d2daff3dSHong Zhang     }
337308c7845fSBarry Smith   } else if (!ts->reason) {
337408c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
337508c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
337608c7845fSBarry Smith   }
33772c18e0fdSBarry Smith   ts->total_steps++;
33788392e04aSShri Abhyankar   ts->steprollback = PETSC_FALSE;
337908c7845fSBarry Smith   PetscFunctionReturn(0);
338008c7845fSBarry Smith }
338108c7845fSBarry Smith 
338208c7845fSBarry Smith #undef __FUNCT__
338308c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep"
338408c7845fSBarry Smith /*@
3385b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
338608c7845fSBarry Smith 
338708c7845fSBarry Smith    Collective on TS
338808c7845fSBarry Smith 
338908c7845fSBarry Smith    Input Parameter:
339008c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
339108c7845fSBarry Smith 
33926a4d4014SLisandro Dalcin    Level: intermediate
33936a4d4014SLisandro Dalcin 
3394b957a604SHong Zhang .keywords: TS, adjoint, step
33956a4d4014SLisandro Dalcin 
3396b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
33976a4d4014SLisandro Dalcin @*/
339808c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
33996a4d4014SLisandro Dalcin {
340008c7845fSBarry Smith   DM               dm;
34016a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
34026a4d4014SLisandro Dalcin 
34036a4d4014SLisandro Dalcin   PetscFunctionBegin;
34044a2ae208SSatish Balay   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
340508c7845fSBarry Smith   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
340608c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3407d763cef2SBarry Smith 
3408d763cef2SBarry Smith   ts->reason = TS_CONVERGED_ITERATING;
340908c7845fSBarry Smith   ts->ptime_prev = ts->ptime;
341008c7845fSBarry Smith   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3411685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts, "-ts_view_solution");CHKERRQ(ierr);
3412d763cef2SBarry Smith 
34138d0ad7a8SHong Zhang   ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
341442f2b339SBarry 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);
341542f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
34168d0ad7a8SHong Zhang   ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
3417d763cef2SBarry Smith 
3418cef5090cSJed Brown   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3419cef5090cSJed Brown   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3420362cd11cSLisandro Dalcin 
3421362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3422cef5090cSJed Brown     if (ts->errorifstepfailed) {
34236c4ed002SBarry 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]);
34246c4ed002SBarry 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]);
34256c4ed002SBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3426cef5090cSJed Brown     }
3427362cd11cSLisandro Dalcin   } else if (!ts->reason) {
342873b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3429362cd11cSLisandro Dalcin   }
34302c18e0fdSBarry Smith   ts->total_steps--;
3431d763cef2SBarry Smith   PetscFunctionReturn(0);
3432d763cef2SBarry Smith }
3433d763cef2SBarry Smith 
3434d763cef2SBarry Smith #undef __FUNCT__
343505175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
343605175c85SJed Brown /*@
343705175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
343805175c85SJed Brown 
34391c3436cfSJed Brown    Collective on TS
344005175c85SJed Brown 
344105175c85SJed Brown    Input Arguments:
34421c3436cfSJed Brown +  ts - time stepping context
34431c3436cfSJed Brown .  order - desired order of accuracy
34440298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
344505175c85SJed Brown 
344605175c85SJed Brown    Output Arguments:
34470910c330SBarry Smith .  U - state at the end of the current step
344805175c85SJed Brown 
344905175c85SJed Brown    Level: advanced
345005175c85SJed Brown 
3451108c343cSJed Brown    Notes:
3452108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3453108c343cSJed 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.
3454108c343cSJed Brown 
34551c3436cfSJed Brown .seealso: TSStep(), TSAdapt
345605175c85SJed Brown @*/
34570910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
345805175c85SJed Brown {
345905175c85SJed Brown   PetscErrorCode ierr;
346005175c85SJed Brown 
346105175c85SJed Brown   PetscFunctionBegin;
346205175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
346305175c85SJed Brown   PetscValidType(ts,1);
34640910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3465ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
34660910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
346705175c85SJed Brown   PetscFunctionReturn(0);
346805175c85SJed Brown }
346905175c85SJed Brown 
3470b1cb36f3SHong Zhang #undef __FUNCT__
3471b1cb36f3SHong Zhang #define __FUNCT__ "TSForwardCostIntegral"
3472b1cb36f3SHong Zhang /*@
3473b1cb36f3SHong Zhang  TSForwardCostIntegral - Evaluate the cost integral in the forward run.
3474b1cb36f3SHong Zhang 
3475b1cb36f3SHong Zhang  Collective on TS
3476b1cb36f3SHong Zhang 
3477b1cb36f3SHong Zhang  Input Arguments:
3478b1cb36f3SHong Zhang  .  ts - time stepping context
3479b1cb36f3SHong Zhang 
3480b1cb36f3SHong Zhang  Level: advanced
3481b1cb36f3SHong Zhang 
3482b1cb36f3SHong Zhang  Notes:
3483b1cb36f3SHong Zhang  This function cannot be called until TSStep() has been completed.
3484b1cb36f3SHong Zhang 
3485b1cb36f3SHong Zhang  .seealso: TSSolve(), TSAdjointCostIntegral()
3486b1cb36f3SHong Zhang  @*/
3487b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts)
3488b1cb36f3SHong Zhang {
3489b1cb36f3SHong Zhang     PetscErrorCode ierr;
3490b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3491b1cb36f3SHong 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);
3492b1cb36f3SHong Zhang     ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr);
3493b1cb36f3SHong Zhang     PetscFunctionReturn(0);
3494b1cb36f3SHong Zhang }
3495d67e68b7SBarry Smith 
349605175c85SJed Brown #undef __FUNCT__
3497d763cef2SBarry Smith #define __FUNCT__ "TSSolve"
3498d763cef2SBarry Smith /*@
3499d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
3500d763cef2SBarry Smith 
3501d763cef2SBarry Smith    Collective on TS
3502d763cef2SBarry Smith 
3503d763cef2SBarry Smith    Input Parameter:
3504d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3505cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
35065a3a76d0SJed Brown 
3507d763cef2SBarry Smith    Level: beginner
3508d763cef2SBarry Smith 
35095a3a76d0SJed Brown    Notes:
35105a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
35115a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
35125a3a76d0SJed Brown    stepped over the final time.
35135a3a76d0SJed Brown 
3514d763cef2SBarry Smith .keywords: TS, timestep, solve
3515d763cef2SBarry Smith 
3516d763cef2SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep()
3517d763cef2SBarry Smith @*/
3518cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
3519d763cef2SBarry Smith {
3520b06615a5SLisandro Dalcin   Vec               solution;
3521d763cef2SBarry Smith   PetscErrorCode    ierr;
3522d763cef2SBarry Smith 
3523d763cef2SBarry Smith   PetscFunctionBegin;
3524d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3525f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3526feed9e9dSBarry Smith   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()");
3527ee346746SBarry Smith   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");
3528feed9e9dSBarry Smith 
352949354f04SShri 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 */
3530b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
35310910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3532b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3533b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3534b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
35355a3a76d0SJed Brown     }
35360910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3537bbd56ea5SKarl Rupp   } else if (u) {
35380910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
35395a3a76d0SJed Brown   }
3540b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
354168bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3542d763cef2SBarry Smith   /* reset time step and iteration counters */
3543193ac0bcSJed Brown   ts->steps             = 0;
35445ef26d82SJed Brown   ts->ksp_its           = 0;
35455ef26d82SJed Brown   ts->snes_its          = 0;
3546c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
3547c610991cSLisandro Dalcin   ts->reject            = 0;
3548193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
3549193ac0bcSJed Brown 
3550ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3551ec8db0baSMatthew G. Knepley   {
3552ec8db0baSMatthew G. Knepley     DM dm;
3553ec8db0baSMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3554ec8db0baSMatthew G. Knepley     ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3555ec8db0baSMatthew G. Knepley   }
3556f05ece33SBarry Smith 
3557193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
3558193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
35590910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
3560cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3561193ac0bcSJed Brown   } else {
3562d763cef2SBarry Smith     /* steps the requested number of timesteps. */
3563db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3564db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3565cdf0de3dSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
35666fea3669SShri Abhyankar     if(ts->event) {
35676fea3669SShri Abhyankar       ierr = TSEventMonitorInitialize(ts);CHKERRQ(ierr);
35686fea3669SShri Abhyankar     }
3569e1a7a14fSJed Brown     while (!ts->reason) {
3570193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3571193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
3572b1cb36f3SHong Zhang       if (!ts->steprollback && ts->vec_costintegral && ts->costintegralfwd) {
3573b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
3574b1cb36f3SHong Zhang       }
3575aeb4809dSShri Abhyankar       if (ts->event) {
3576aeb4809dSShri Abhyankar         ierr = TSEventMonitor(ts);CHKERRQ(ierr);
35771eda64f1SShri Abhyankar       }
35788392e04aSShri Abhyankar       if(!ts->steprollback) {
3579cdf0de3dSShri Abhyankar         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
35801eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
3581aeb4809dSShri Abhyankar       }
3582193ac0bcSJed Brown     }
358349354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
35840910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3585cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3586b06615a5SLisandro Dalcin       solution = u;
35870574a7fbSJed Brown     } else {
3588ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3589cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3590b06615a5SLisandro Dalcin       solution = ts->vec_sol;
35910574a7fbSJed Brown     }
3592b06615a5SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
3593685405a1SBarry Smith     ierr = VecViewFromOptions(solution,(PetscObject) ts,"-ts_view_solution");CHKERRQ(ierr);
3594193ac0bcSJed Brown   }
3595d2daff3dSHong Zhang 
3596ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
3597dc1cb503SEmil Constantinescu   ierr = VecViewFromOptions(ts->vec_sol,NULL,"-ts_view_solution");CHKERRQ(ierr);
359856f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
3599ef222394SBarry Smith   if (ts->adjoint_solve) {
3600ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
36012b0a91c0SBarry Smith   }
3602d763cef2SBarry Smith   PetscFunctionReturn(0);
3603d763cef2SBarry Smith }
3604d763cef2SBarry Smith 
3605d763cef2SBarry Smith #undef __FUNCT__
3606b1cb36f3SHong Zhang #define __FUNCT__ "TSAdjointCostIntegral"
3607b1cb36f3SHong Zhang /*@
3608b1cb36f3SHong Zhang  TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run.
3609b1cb36f3SHong Zhang 
3610b1cb36f3SHong Zhang  Collective on TS
3611b1cb36f3SHong Zhang 
3612b1cb36f3SHong Zhang  Input Arguments:
3613b1cb36f3SHong Zhang  .  ts - time stepping context
3614b1cb36f3SHong Zhang 
3615b1cb36f3SHong Zhang  Level: advanced
3616b1cb36f3SHong Zhang 
3617b1cb36f3SHong Zhang  Notes:
3618b1cb36f3SHong Zhang  This function cannot be called until TSAdjointStep() has been completed.
3619b1cb36f3SHong Zhang 
3620b1cb36f3SHong Zhang  .seealso: TSAdjointSolve(), TSAdjointStep
3621b1cb36f3SHong Zhang  @*/
3622b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts)
3623b1cb36f3SHong Zhang {
3624b1cb36f3SHong Zhang     PetscErrorCode ierr;
3625b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3626b1cb36f3SHong 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);
3627b1cb36f3SHong Zhang     ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr);
3628b1cb36f3SHong Zhang     PetscFunctionReturn(0);
3629b1cb36f3SHong Zhang }
3630b1cb36f3SHong Zhang 
3631b1cb36f3SHong Zhang #undef __FUNCT__
3632c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve"
3633c88f2d44SBarry Smith /*@
3634c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
3635c88f2d44SBarry Smith 
3636c88f2d44SBarry Smith    Collective on TS
3637c88f2d44SBarry Smith 
3638c88f2d44SBarry Smith    Input Parameter:
36392c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
3640c88f2d44SBarry Smith 
3641e87fd094SBarry Smith    Options Database:
3642e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions
3643e87fd094SBarry Smith 
3644c88f2d44SBarry Smith    Level: intermediate
3645c88f2d44SBarry Smith 
3646c88f2d44SBarry Smith    Notes:
3647c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
3648c88f2d44SBarry Smith 
364973b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
365073b18844SBarry Smith 
3651c88f2d44SBarry Smith .keywords: TS, timestep, solve
3652c88f2d44SBarry Smith 
3653b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
3654c88f2d44SBarry Smith @*/
36552c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
3656c88f2d44SBarry Smith {
3657c88f2d44SBarry Smith   PetscErrorCode    ierr;
3658c88f2d44SBarry Smith 
3659c88f2d44SBarry Smith   PetscFunctionBegin;
3660c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3661c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
366268bece0bSHong Zhang 
3663c88f2d44SBarry Smith   /* reset time step and iteration counters */
3664c88f2d44SBarry Smith   ts->steps             = 0;
3665c88f2d44SBarry Smith   ts->ksp_its           = 0;
3666c88f2d44SBarry Smith   ts->snes_its          = 0;
3667c88f2d44SBarry Smith   ts->num_snes_failures = 0;
3668c88f2d44SBarry Smith   ts->reject            = 0;
3669c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
3670c88f2d44SBarry Smith 
367173b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
3672c88f2d44SBarry Smith 
367373b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3674c88f2d44SBarry Smith   while (!ts->reason) {
367555c52731SHong Zhang     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
36769110b2e7SHong Zhang     ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
3677c88f2d44SBarry Smith     if (ts->event) {
3678d0578d90SShri Abhyankar       ierr = TSAdjointEventMonitor(ts);CHKERRQ(ierr);
3679d0578d90SShri Abhyankar     }
3680616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
3681b1cb36f3SHong Zhang     if (ts->vec_costintegral && !ts->costintegralfwd) {
3682b1cb36f3SHong Zhang       ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr);
3683b1cb36f3SHong Zhang     }
3684c88f2d44SBarry Smith   }
368526656371SHong Zhang   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
368626656371SHong Zhang   ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
3687c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
368839c6b90dSHong Zhang   ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-tstrajectory_view");CHKERRQ(ierr);
3689685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
3690c88f2d44SBarry Smith   PetscFunctionReturn(0);
3691c88f2d44SBarry Smith }
3692c88f2d44SBarry Smith 
3693c88f2d44SBarry Smith #undef __FUNCT__
3694d763cef2SBarry Smith #define __FUNCT__ "TSMonitor"
36957db568b7SBarry Smith /*@C
3696228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3697228d79bcSJed Brown 
3698228d79bcSJed Brown    Collective on TS
3699228d79bcSJed Brown 
3700228d79bcSJed Brown    Input Parameters:
3701228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3702228d79bcSJed Brown .  step - step number that has just completed
3703228d79bcSJed Brown .  ptime - model time of the state
37040910c330SBarry Smith -  u - state at the current model time
3705228d79bcSJed Brown 
3706228d79bcSJed Brown    Notes:
37077db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
37087db568b7SBarry Smith    Users would almost never call this routine directly.
3709228d79bcSJed Brown 
37107db568b7SBarry Smith    Level: developer
3711228d79bcSJed Brown 
3712228d79bcSJed Brown .keywords: TS, timestep
3713228d79bcSJed Brown @*/
37140910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3715d763cef2SBarry Smith {
37166849ba73SBarry Smith   PetscErrorCode ierr;
3717a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
3718d763cef2SBarry Smith 
3719d763cef2SBarry Smith   PetscFunctionBegin;
3720b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3721b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
37225edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3723d763cef2SBarry Smith   for (i=0; i<n; i++) {
37240910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3725d763cef2SBarry Smith   }
37265edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3727d763cef2SBarry Smith   PetscFunctionReturn(0);
3728d763cef2SBarry Smith }
3729d763cef2SBarry Smith 
37309110b2e7SHong Zhang #undef __FUNCT__
37319110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitor"
37327db568b7SBarry Smith /*@C
37339110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
37349110b2e7SHong Zhang 
37359110b2e7SHong Zhang    Collective on TS
37369110b2e7SHong Zhang 
37379110b2e7SHong Zhang    Input Parameters:
37389110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
37399110b2e7SHong Zhang .  step - step number that has just completed
37409110b2e7SHong Zhang .  ptime - model time of the state
37419110b2e7SHong Zhang .  u - state at the current model time
37429110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
37439110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
37449110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
37459110b2e7SHong Zhang 
37469110b2e7SHong Zhang    Notes:
37477db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
37487db568b7SBarry Smith    Users would almost never call this routine directly.
37499110b2e7SHong Zhang 
37507db568b7SBarry Smith    Level: developer
37519110b2e7SHong Zhang 
37529110b2e7SHong Zhang .keywords: TS, timestep
37539110b2e7SHong Zhang @*/
37549110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
37559110b2e7SHong Zhang {
37569110b2e7SHong Zhang   PetscErrorCode ierr;
37579110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
37589110b2e7SHong Zhang 
37599110b2e7SHong Zhang   PetscFunctionBegin;
37609110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
37619110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
37629110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
37639110b2e7SHong Zhang   for (i=0; i<n; i++) {
37649110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
37659110b2e7SHong Zhang   }
37669110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
37679110b2e7SHong Zhang   PetscFunctionReturn(0);
37689110b2e7SHong Zhang }
37699110b2e7SHong Zhang 
3770d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
37714a2ae208SSatish Balay #undef __FUNCT__
3772a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
3773d763cef2SBarry Smith /*@C
37747db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
3775a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3776d763cef2SBarry Smith 
3777d763cef2SBarry Smith    Collective on TS
3778d763cef2SBarry Smith 
3779d763cef2SBarry Smith    Input Parameters:
3780d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3781d763cef2SBarry Smith .  label - the title to put in the title bar
37827c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3783a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3784a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3785d763cef2SBarry Smith 
3786d763cef2SBarry Smith    Output Parameter:
37870b039ecaSBarry Smith .  ctx - the context
3788d763cef2SBarry Smith 
3789d763cef2SBarry Smith    Options Database Key:
37904f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
37917db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
37927db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
37937db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
37947db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
3795b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
3796d763cef2SBarry Smith 
3797d763cef2SBarry Smith    Notes:
3798a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3799d763cef2SBarry Smith 
38007db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
38017db568b7SBarry Smith 
38027db568b7SBarry 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
38037db568b7SBarry 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
38047db568b7SBarry Smith    as the first argument.
38057db568b7SBarry Smith 
38067db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
38077db568b7SBarry Smith 
38087db568b7SBarry Smith 
3809d763cef2SBarry Smith    Level: intermediate
3810d763cef2SBarry Smith 
38117db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
3812d763cef2SBarry Smith 
38137db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
38147db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
38157db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
38167db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
38177db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
38187c922b88SBarry Smith 
3819d763cef2SBarry Smith @*/
3820a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3821d763cef2SBarry Smith {
38227f52daa2SLisandro Dalcin   PetscDraw      draw;
3823dfbe8321SBarry Smith   PetscErrorCode ierr;
3824d763cef2SBarry Smith 
3825d763cef2SBarry Smith   PetscFunctionBegin;
3826b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
38277f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
38287f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
38297f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
3830b6fe0379SLisandro Dalcin   ierr = PetscDrawLGSetUseMarkers((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3831287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
38327f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
3833a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3834d763cef2SBarry Smith   PetscFunctionReturn(0);
3835d763cef2SBarry Smith }
3836d763cef2SBarry Smith 
38374a2ae208SSatish Balay #undef __FUNCT__
38384f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3839b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3840d763cef2SBarry Smith {
38410b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3842c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3843dfbe8321SBarry Smith   PetscErrorCode ierr;
3844d763cef2SBarry Smith 
3845d763cef2SBarry Smith   PetscFunctionBegin;
3846b06615a5SLisandro Dalcin   if (!step) {
3847a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3848a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
38496934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr);
3850a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3851a9f9c1f6SBarry Smith   }
3852c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
38530b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3854b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
38550b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
38566934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
38573923b477SBarry Smith   }
3858d763cef2SBarry Smith   PetscFunctionReturn(0);
3859d763cef2SBarry Smith }
3860d763cef2SBarry Smith 
38614a2ae208SSatish Balay #undef __FUNCT__
3862a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3863d763cef2SBarry Smith /*@C
3864a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3865a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3866d763cef2SBarry Smith 
38670b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3868d763cef2SBarry Smith 
3869d763cef2SBarry Smith    Input Parameter:
38700b039ecaSBarry Smith .  ctx - the monitor context
3871d763cef2SBarry Smith 
3872d763cef2SBarry Smith    Level: intermediate
3873d763cef2SBarry Smith 
3874d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3875d763cef2SBarry Smith 
38764f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3877d763cef2SBarry Smith @*/
3878a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3879d763cef2SBarry Smith {
3880dfbe8321SBarry Smith   PetscErrorCode ierr;
3881d763cef2SBarry Smith 
3882d763cef2SBarry Smith   PetscFunctionBegin;
38837684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
38847684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
38857684fa3eSBarry Smith   }
38860b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
388731152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
3888387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
3889387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
3890387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
38910b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3892d763cef2SBarry Smith   PetscFunctionReturn(0);
3893d763cef2SBarry Smith }
3894d763cef2SBarry Smith 
38954a2ae208SSatish Balay #undef __FUNCT__
38964a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3897d763cef2SBarry Smith /*@
3898b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3899d763cef2SBarry Smith 
3900d763cef2SBarry Smith    Not Collective
3901d763cef2SBarry Smith 
3902d763cef2SBarry Smith    Input Parameter:
3903d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3904d763cef2SBarry Smith 
3905d763cef2SBarry Smith    Output Parameter:
3906d763cef2SBarry Smith .  t  - the current time
3907d763cef2SBarry Smith 
3908d763cef2SBarry Smith    Level: beginner
3909d763cef2SBarry Smith 
3910b8123daeSJed Brown    Note:
3911b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
39129be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3913b8123daeSJed Brown 
3914d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3915d763cef2SBarry Smith 
3916d763cef2SBarry Smith .keywords: TS, get, time
3917d763cef2SBarry Smith @*/
39187087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3919d763cef2SBarry Smith {
3920d763cef2SBarry Smith   PetscFunctionBegin;
39210700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3922f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3923d763cef2SBarry Smith   *t = ts->ptime;
3924d763cef2SBarry Smith   PetscFunctionReturn(0);
3925d763cef2SBarry Smith }
3926d763cef2SBarry Smith 
39274a2ae208SSatish Balay #undef __FUNCT__
3928e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3929e5e524a1SHong Zhang /*@
3930e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3931e5e524a1SHong Zhang 
3932e5e524a1SHong Zhang    Not Collective
3933e5e524a1SHong Zhang 
3934e5e524a1SHong Zhang    Input Parameter:
3935e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3936e5e524a1SHong Zhang 
3937e5e524a1SHong Zhang    Output Parameter:
3938e5e524a1SHong Zhang .  t  - the previous time
3939e5e524a1SHong Zhang 
3940e5e524a1SHong Zhang    Level: beginner
3941e5e524a1SHong Zhang 
3942e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3943e5e524a1SHong Zhang 
3944e5e524a1SHong Zhang .keywords: TS, get, time
3945e5e524a1SHong Zhang @*/
3946e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3947e5e524a1SHong Zhang {
3948e5e524a1SHong Zhang   PetscFunctionBegin;
3949e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3950e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3951e5e524a1SHong Zhang   *t = ts->ptime_prev;
3952e5e524a1SHong Zhang   PetscFunctionReturn(0);
3953e5e524a1SHong Zhang }
3954e5e524a1SHong Zhang 
3955e5e524a1SHong Zhang #undef __FUNCT__
39566a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
39576a4d4014SLisandro Dalcin /*@
39586a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
39596a4d4014SLisandro Dalcin 
39603f9fe445SBarry Smith    Logically Collective on TS
39616a4d4014SLisandro Dalcin 
39626a4d4014SLisandro Dalcin    Input Parameters:
39636a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
39646a4d4014SLisandro Dalcin -  time - the time
39656a4d4014SLisandro Dalcin 
39666a4d4014SLisandro Dalcin    Level: intermediate
39676a4d4014SLisandro Dalcin 
39686a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
39696a4d4014SLisandro Dalcin 
39706a4d4014SLisandro Dalcin .keywords: TS, set, time
39716a4d4014SLisandro Dalcin @*/
39727087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
39736a4d4014SLisandro Dalcin {
39746a4d4014SLisandro Dalcin   PetscFunctionBegin;
39750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3976c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
39776a4d4014SLisandro Dalcin   ts->ptime = t;
39786a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
39796a4d4014SLisandro Dalcin }
39806a4d4014SLisandro Dalcin 
39816a4d4014SLisandro Dalcin #undef __FUNCT__
39824a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3983d763cef2SBarry Smith /*@C
3984d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3985d763cef2SBarry Smith    TS options in the database.
3986d763cef2SBarry Smith 
39873f9fe445SBarry Smith    Logically Collective on TS
3988d763cef2SBarry Smith 
3989d763cef2SBarry Smith    Input Parameter:
3990d763cef2SBarry Smith +  ts     - The TS context
3991d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3992d763cef2SBarry Smith 
3993d763cef2SBarry Smith    Notes:
3994d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3995d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3996d763cef2SBarry Smith    hyphen.
3997d763cef2SBarry Smith 
3998d763cef2SBarry Smith    Level: advanced
3999d763cef2SBarry Smith 
4000d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
4001d763cef2SBarry Smith 
4002d763cef2SBarry Smith .seealso: TSSetFromOptions()
4003d763cef2SBarry Smith 
4004d763cef2SBarry Smith @*/
40057087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4006d763cef2SBarry Smith {
4007dfbe8321SBarry Smith   PetscErrorCode ierr;
4008089b2837SJed Brown   SNES           snes;
4009d763cef2SBarry Smith 
4010d763cef2SBarry Smith   PetscFunctionBegin;
40110700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4012d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4013089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4014089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4015d763cef2SBarry Smith   PetscFunctionReturn(0);
4016d763cef2SBarry Smith }
4017d763cef2SBarry Smith 
4018d763cef2SBarry Smith 
40194a2ae208SSatish Balay #undef __FUNCT__
40204a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
4021d763cef2SBarry Smith /*@C
4022d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4023d763cef2SBarry Smith    TS options in the database.
4024d763cef2SBarry Smith 
40253f9fe445SBarry Smith    Logically Collective on TS
4026d763cef2SBarry Smith 
4027d763cef2SBarry Smith    Input Parameter:
4028d763cef2SBarry Smith +  ts     - The TS context
4029d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4030d763cef2SBarry Smith 
4031d763cef2SBarry Smith    Notes:
4032d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4033d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4034d763cef2SBarry Smith    hyphen.
4035d763cef2SBarry Smith 
4036d763cef2SBarry Smith    Level: advanced
4037d763cef2SBarry Smith 
4038d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
4039d763cef2SBarry Smith 
4040d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4041d763cef2SBarry Smith 
4042d763cef2SBarry Smith @*/
40437087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4044d763cef2SBarry Smith {
4045dfbe8321SBarry Smith   PetscErrorCode ierr;
4046089b2837SJed Brown   SNES           snes;
4047d763cef2SBarry Smith 
4048d763cef2SBarry Smith   PetscFunctionBegin;
40490700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4050d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4051089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4052089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4053d763cef2SBarry Smith   PetscFunctionReturn(0);
4054d763cef2SBarry Smith }
4055d763cef2SBarry Smith 
40564a2ae208SSatish Balay #undef __FUNCT__
40574a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
4058d763cef2SBarry Smith /*@C
4059d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4060d763cef2SBarry Smith    TS options in the database.
4061d763cef2SBarry Smith 
4062d763cef2SBarry Smith    Not Collective
4063d763cef2SBarry Smith 
4064d763cef2SBarry Smith    Input Parameter:
4065d763cef2SBarry Smith .  ts - The TS context
4066d763cef2SBarry Smith 
4067d763cef2SBarry Smith    Output Parameter:
4068d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4069d763cef2SBarry Smith 
4070d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
4071d763cef2SBarry Smith    sufficient length to hold the prefix.
4072d763cef2SBarry Smith 
4073d763cef2SBarry Smith    Level: intermediate
4074d763cef2SBarry Smith 
4075d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
4076d763cef2SBarry Smith 
4077d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4078d763cef2SBarry Smith @*/
40797087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4080d763cef2SBarry Smith {
4081dfbe8321SBarry Smith   PetscErrorCode ierr;
4082d763cef2SBarry Smith 
4083d763cef2SBarry Smith   PetscFunctionBegin;
40840700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
40854482741eSBarry Smith   PetscValidPointer(prefix,2);
4086d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4087d763cef2SBarry Smith   PetscFunctionReturn(0);
4088d763cef2SBarry Smith }
4089d763cef2SBarry Smith 
40904a2ae208SSatish Balay #undef __FUNCT__
40914a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
4092d763cef2SBarry Smith /*@C
4093d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4094d763cef2SBarry Smith 
4095d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4096d763cef2SBarry Smith 
4097d763cef2SBarry Smith    Input Parameter:
4098d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4099d763cef2SBarry Smith 
4100d763cef2SBarry Smith    Output Parameters:
4101e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4102e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4103e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4104e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4105d763cef2SBarry Smith 
41060298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
4107d763cef2SBarry Smith 
4108d763cef2SBarry Smith    Level: intermediate
4109d763cef2SBarry Smith 
411026d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
4111d763cef2SBarry Smith 
4112d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
4113d763cef2SBarry Smith @*/
4114e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4115d763cef2SBarry Smith {
4116089b2837SJed Brown   PetscErrorCode ierr;
4117089b2837SJed Brown   SNES           snes;
411824989b8cSPeter Brune   DM             dm;
4119089b2837SJed Brown 
4120d763cef2SBarry Smith   PetscFunctionBegin;
4121089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4122e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
412324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
412424989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4125d763cef2SBarry Smith   PetscFunctionReturn(0);
4126d763cef2SBarry Smith }
4127d763cef2SBarry Smith 
41281713a123SBarry Smith #undef __FUNCT__
41292eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
41302eca1d9cSJed Brown /*@C
41312eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
41322eca1d9cSJed Brown 
41332eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
41342eca1d9cSJed Brown 
41352eca1d9cSJed Brown    Input Parameter:
41362eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
41372eca1d9cSJed Brown 
41382eca1d9cSJed Brown    Output Parameters:
4139e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4140e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
41412eca1d9cSJed Brown .  f   - The function to compute the matrices
41422eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
41432eca1d9cSJed Brown 
41440298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
41452eca1d9cSJed Brown 
41462eca1d9cSJed Brown    Level: advanced
41472eca1d9cSJed Brown 
41482eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
41492eca1d9cSJed Brown 
41502eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
41512eca1d9cSJed Brown @*/
4152e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
41532eca1d9cSJed Brown {
4154089b2837SJed Brown   PetscErrorCode ierr;
4155089b2837SJed Brown   SNES           snes;
415624989b8cSPeter Brune   DM             dm;
41570910c330SBarry Smith 
41582eca1d9cSJed Brown   PetscFunctionBegin;
4159089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4160f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4161e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
416224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
416324989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
41642eca1d9cSJed Brown   PetscFunctionReturn(0);
41652eca1d9cSJed Brown }
41662eca1d9cSJed Brown 
41676083293cSBarry Smith 
41682eca1d9cSJed Brown #undef __FUNCT__
416983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
41701713a123SBarry Smith /*@C
417183a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
41721713a123SBarry Smith    VecView() for the solution at each timestep
41731713a123SBarry Smith 
41741713a123SBarry Smith    Collective on TS
41751713a123SBarry Smith 
41761713a123SBarry Smith    Input Parameters:
41771713a123SBarry Smith +  ts - the TS context
41781713a123SBarry Smith .  step - current time-step
4179142b95e3SSatish Balay .  ptime - current time
41800298fd71SBarry Smith -  dummy - either a viewer or NULL
41811713a123SBarry Smith 
418299fdda47SBarry Smith    Options Database:
418399fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
418499fdda47SBarry Smith 
4185387f4636SBarry 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
418699fdda47SBarry Smith        will look bad
418799fdda47SBarry Smith 
41881713a123SBarry Smith    Level: intermediate
41891713a123SBarry Smith 
41901713a123SBarry Smith .keywords: TS,  vector, monitor, view
41911713a123SBarry Smith 
4192a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
41931713a123SBarry Smith @*/
41940910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
41951713a123SBarry Smith {
4196dfbe8321SBarry Smith   PetscErrorCode   ierr;
419783a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4198473a3ab2SBarry Smith   PetscDraw        draw;
41991713a123SBarry Smith 
42001713a123SBarry Smith   PetscFunctionBegin;
42016083293cSBarry Smith   if (!step && ictx->showinitial) {
42026083293cSBarry Smith     if (!ictx->initialsolution) {
42030910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
42041713a123SBarry Smith     }
42050910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
42066083293cSBarry Smith   }
4207b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
42080dcf80beSBarry Smith 
42096083293cSBarry Smith   if (ictx->showinitial) {
42106083293cSBarry Smith     PetscReal pause;
42116083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
42126083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
42136083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
42146083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
42156083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
42166083293cSBarry Smith   }
42170910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4218473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
421951fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4220473a3ab2SBarry Smith     char      time[32];
4221473a3ab2SBarry Smith 
4222473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
422385b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4224473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4225473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
422651fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4227473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4228473a3ab2SBarry Smith   }
4229473a3ab2SBarry Smith 
42306083293cSBarry Smith   if (ictx->showinitial) {
42316083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
42326083293cSBarry Smith   }
42331713a123SBarry Smith   PetscFunctionReturn(0);
42341713a123SBarry Smith }
42351713a123SBarry Smith 
42362d5ee99bSBarry Smith #undef __FUNCT__
42379110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorDrawSensi"
42389110b2e7SHong Zhang /*@C
42399110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
42409110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
42419110b2e7SHong Zhang 
42429110b2e7SHong Zhang    Collective on TS
42439110b2e7SHong Zhang 
42449110b2e7SHong Zhang    Input Parameters:
42459110b2e7SHong Zhang +  ts - the TS context
42469110b2e7SHong Zhang .  step - current time-step
42479110b2e7SHong Zhang .  ptime - current time
42489110b2e7SHong Zhang .  u - current state
42499110b2e7SHong Zhang .  numcost - number of cost functions
42509110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
42519110b2e7SHong Zhang .  mu - sensitivities to parameters
42529110b2e7SHong Zhang -  dummy - either a viewer or NULL
42539110b2e7SHong Zhang 
42549110b2e7SHong Zhang    Level: intermediate
42559110b2e7SHong Zhang 
42569110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
42579110b2e7SHong Zhang 
42589110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
42599110b2e7SHong Zhang @*/
42609110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
42619110b2e7SHong Zhang {
42629110b2e7SHong Zhang   PetscErrorCode   ierr;
42639110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
42649110b2e7SHong Zhang   PetscDraw        draw;
4265a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
4266a0046e2cSSatish Balay   char             time[32];
42679110b2e7SHong Zhang 
42689110b2e7SHong Zhang   PetscFunctionBegin;
42699110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
42709110b2e7SHong Zhang 
42719110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
42729110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
42739110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
42749110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
42759110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
42769110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
42779110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
42789110b2e7SHong Zhang   PetscFunctionReturn(0);
42799110b2e7SHong Zhang }
42809110b2e7SHong Zhang 
42819110b2e7SHong Zhang #undef __FUNCT__
42822d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
42832d5ee99bSBarry Smith /*@C
42842d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
42852d5ee99bSBarry Smith 
42862d5ee99bSBarry Smith    Collective on TS
42872d5ee99bSBarry Smith 
42882d5ee99bSBarry Smith    Input Parameters:
42892d5ee99bSBarry Smith +  ts - the TS context
42902d5ee99bSBarry Smith .  step - current time-step
42912d5ee99bSBarry Smith .  ptime - current time
42922d5ee99bSBarry Smith -  dummy - either a viewer or NULL
42932d5ee99bSBarry Smith 
42942d5ee99bSBarry Smith    Level: intermediate
42952d5ee99bSBarry Smith 
42962d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
42972d5ee99bSBarry Smith 
42982d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
42992d5ee99bSBarry Smith @*/
43002d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
43012d5ee99bSBarry Smith {
43022d5ee99bSBarry Smith   PetscErrorCode    ierr;
43032d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
43042d5ee99bSBarry Smith   PetscDraw         draw;
43056934998bSLisandro Dalcin   PetscDrawAxis     axis;
43062d5ee99bSBarry Smith   PetscInt          n;
43072d5ee99bSBarry Smith   PetscMPIInt       size;
43086934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
43092d5ee99bSBarry Smith   char              time[32];
43102d5ee99bSBarry Smith   const PetscScalar *U;
43112d5ee99bSBarry Smith 
43122d5ee99bSBarry Smith   PetscFunctionBegin;
43136934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
43146934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
43152d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
43166934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
43172d5ee99bSBarry Smith 
43182d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
43196934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
43206934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
43216934998bSLisandro Dalcin   if (!step) {
43226934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
43236934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
43246934998bSLisandro Dalcin   }
43252d5ee99bSBarry Smith 
43262d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
43276934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
43286934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
4329a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
43306934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
43312d5ee99bSBarry Smith 
43326934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
43336934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
43342d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
43354b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
433685b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
43372d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
433851fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
43392d5ee99bSBarry Smith   }
43406934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
43412d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
43426934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
43432d5ee99bSBarry Smith   PetscFunctionReturn(0);
43442d5ee99bSBarry Smith }
43452d5ee99bSBarry Smith 
43461713a123SBarry Smith 
43476c699258SBarry Smith #undef __FUNCT__
434883a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
43496083293cSBarry Smith /*@C
435083a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
43516083293cSBarry Smith 
43526083293cSBarry Smith    Collective on TS
43536083293cSBarry Smith 
43546083293cSBarry Smith    Input Parameters:
43556083293cSBarry Smith .    ctx - the monitor context
43566083293cSBarry Smith 
43576083293cSBarry Smith    Level: intermediate
43586083293cSBarry Smith 
43596083293cSBarry Smith .keywords: TS,  vector, monitor, view
43606083293cSBarry Smith 
436183a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
43626083293cSBarry Smith @*/
436383a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
43646083293cSBarry Smith {
43656083293cSBarry Smith   PetscErrorCode ierr;
43666083293cSBarry Smith 
43676083293cSBarry Smith   PetscFunctionBegin;
436883a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
436983a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
437083a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
43716083293cSBarry Smith   PetscFunctionReturn(0);
43726083293cSBarry Smith }
43736083293cSBarry Smith 
43746083293cSBarry Smith #undef __FUNCT__
437583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
43766083293cSBarry Smith /*@C
437783a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
43786083293cSBarry Smith 
43796083293cSBarry Smith    Collective on TS
43806083293cSBarry Smith 
43816083293cSBarry Smith    Input Parameter:
43826083293cSBarry Smith .    ts - time-step context
43836083293cSBarry Smith 
43846083293cSBarry Smith    Output Patameter:
43856083293cSBarry Smith .    ctx - the monitor context
43866083293cSBarry Smith 
438799fdda47SBarry Smith    Options Database:
438899fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
438999fdda47SBarry Smith 
43906083293cSBarry Smith    Level: intermediate
43916083293cSBarry Smith 
43926083293cSBarry Smith .keywords: TS,  vector, monitor, view
43936083293cSBarry Smith 
439483a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
43956083293cSBarry Smith @*/
439683a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
43976083293cSBarry Smith {
43986083293cSBarry Smith   PetscErrorCode   ierr;
43996083293cSBarry Smith 
44006083293cSBarry Smith   PetscFunctionBegin;
4401b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
440283a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4403e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4404bbd56ea5SKarl Rupp 
440583a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4406473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
4407c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4408473a3ab2SBarry Smith 
4409473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
4410c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
44116083293cSBarry Smith   PetscFunctionReturn(0);
44126083293cSBarry Smith }
44136083293cSBarry Smith 
44146083293cSBarry Smith #undef __FUNCT__
441583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
44163a471f94SBarry Smith /*@C
441783a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
44183a471f94SBarry Smith    VecView() for the error at each timestep
44193a471f94SBarry Smith 
44203a471f94SBarry Smith    Collective on TS
44213a471f94SBarry Smith 
44223a471f94SBarry Smith    Input Parameters:
44233a471f94SBarry Smith +  ts - the TS context
44243a471f94SBarry Smith .  step - current time-step
44253a471f94SBarry Smith .  ptime - current time
44260298fd71SBarry Smith -  dummy - either a viewer or NULL
44273a471f94SBarry Smith 
44283a471f94SBarry Smith    Level: intermediate
44293a471f94SBarry Smith 
44303a471f94SBarry Smith .keywords: TS,  vector, monitor, view
44313a471f94SBarry Smith 
44323a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
44333a471f94SBarry Smith @*/
44340910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
44353a471f94SBarry Smith {
44363a471f94SBarry Smith   PetscErrorCode   ierr;
443783a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
443883a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
44393a471f94SBarry Smith   Vec              work;
44403a471f94SBarry Smith 
44413a471f94SBarry Smith   PetscFunctionBegin;
4442b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
44430910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
44443a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
44450910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
44463a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
44473a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
44483a471f94SBarry Smith   PetscFunctionReturn(0);
44493a471f94SBarry Smith }
44503a471f94SBarry Smith 
4451af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
44523a471f94SBarry Smith #undef __FUNCT__
44536c699258SBarry Smith #define __FUNCT__ "TSSetDM"
44546c699258SBarry Smith /*@
44556c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
44566c699258SBarry Smith 
44573f9fe445SBarry Smith    Logically Collective on TS and DM
44586c699258SBarry Smith 
44596c699258SBarry Smith    Input Parameters:
44606c699258SBarry Smith +  ts - the preconditioner context
44616c699258SBarry Smith -  dm - the dm
44626c699258SBarry Smith 
44636c699258SBarry Smith    Level: intermediate
44646c699258SBarry Smith 
44656c699258SBarry Smith 
44666c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
44676c699258SBarry Smith @*/
44687087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
44696c699258SBarry Smith {
44706c699258SBarry Smith   PetscErrorCode ierr;
4471089b2837SJed Brown   SNES           snes;
4472942e3340SBarry Smith   DMTS           tsdm;
44736c699258SBarry Smith 
44746c699258SBarry Smith   PetscFunctionBegin;
44750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
447670663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4477942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
44782a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4479942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4480942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
448124989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
448224989b8cSPeter Brune         tsdm->originaldm = dm;
448324989b8cSPeter Brune       }
448424989b8cSPeter Brune     }
44856bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
448624989b8cSPeter Brune   }
44876c699258SBarry Smith   ts->dm = dm;
4488bbd56ea5SKarl Rupp 
4489089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4490089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
44916c699258SBarry Smith   PetscFunctionReturn(0);
44926c699258SBarry Smith }
44936c699258SBarry Smith 
44946c699258SBarry Smith #undef __FUNCT__
44956c699258SBarry Smith #define __FUNCT__ "TSGetDM"
44966c699258SBarry Smith /*@
44976c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
44986c699258SBarry Smith 
44993f9fe445SBarry Smith    Not Collective
45006c699258SBarry Smith 
45016c699258SBarry Smith    Input Parameter:
45026c699258SBarry Smith . ts - the preconditioner context
45036c699258SBarry Smith 
45046c699258SBarry Smith    Output Parameter:
45056c699258SBarry Smith .  dm - the dm
45066c699258SBarry Smith 
45076c699258SBarry Smith    Level: intermediate
45086c699258SBarry Smith 
45096c699258SBarry Smith 
45106c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
45116c699258SBarry Smith @*/
45127087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
45136c699258SBarry Smith {
4514496e6a7aSJed Brown   PetscErrorCode ierr;
4515496e6a7aSJed Brown 
45166c699258SBarry Smith   PetscFunctionBegin;
45170700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4518496e6a7aSJed Brown   if (!ts->dm) {
4519ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4520496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4521496e6a7aSJed Brown   }
45226c699258SBarry Smith   *dm = ts->dm;
45236c699258SBarry Smith   PetscFunctionReturn(0);
45246c699258SBarry Smith }
45251713a123SBarry Smith 
45260f5c6efeSJed Brown #undef __FUNCT__
45270f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
45280f5c6efeSJed Brown /*@
45290f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
45300f5c6efeSJed Brown 
45313f9fe445SBarry Smith    Logically Collective on SNES
45320f5c6efeSJed Brown 
45330f5c6efeSJed Brown    Input Parameter:
4534d42a1c89SJed Brown + snes - nonlinear solver
45350910c330SBarry Smith . U - the current state at which to evaluate the residual
4536d42a1c89SJed Brown - ctx - user context, must be a TS
45370f5c6efeSJed Brown 
45380f5c6efeSJed Brown    Output Parameter:
45390f5c6efeSJed Brown . F - the nonlinear residual
45400f5c6efeSJed Brown 
45410f5c6efeSJed Brown    Notes:
45420f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
45430f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
45440f5c6efeSJed Brown 
45450f5c6efeSJed Brown    Level: advanced
45460f5c6efeSJed Brown 
45470f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
45480f5c6efeSJed Brown @*/
45490910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
45500f5c6efeSJed Brown {
45510f5c6efeSJed Brown   TS             ts = (TS)ctx;
45520f5c6efeSJed Brown   PetscErrorCode ierr;
45530f5c6efeSJed Brown 
45540f5c6efeSJed Brown   PetscFunctionBegin;
45550f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
45560910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
45570f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
45580f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
45590910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
45600f5c6efeSJed Brown   PetscFunctionReturn(0);
45610f5c6efeSJed Brown }
45620f5c6efeSJed Brown 
45630f5c6efeSJed Brown #undef __FUNCT__
45640f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
45650f5c6efeSJed Brown /*@
45660f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
45670f5c6efeSJed Brown 
45680f5c6efeSJed Brown    Collective on SNES
45690f5c6efeSJed Brown 
45700f5c6efeSJed Brown    Input Parameter:
45710f5c6efeSJed Brown + snes - nonlinear solver
45720910c330SBarry Smith . U - the current state at which to evaluate the residual
45730f5c6efeSJed Brown - ctx - user context, must be a TS
45740f5c6efeSJed Brown 
45750f5c6efeSJed Brown    Output Parameter:
45760f5c6efeSJed Brown + A - the Jacobian
45770f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
45780f5c6efeSJed Brown - flag - indicates any structure change in the matrix
45790f5c6efeSJed Brown 
45800f5c6efeSJed Brown    Notes:
45810f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
45820f5c6efeSJed Brown 
45830f5c6efeSJed Brown    Level: developer
45840f5c6efeSJed Brown 
45850f5c6efeSJed Brown .seealso: SNESSetJacobian()
45860f5c6efeSJed Brown @*/
4587d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
45880f5c6efeSJed Brown {
45890f5c6efeSJed Brown   TS             ts = (TS)ctx;
45900f5c6efeSJed Brown   PetscErrorCode ierr;
45910f5c6efeSJed Brown 
45920f5c6efeSJed Brown   PetscFunctionBegin;
45930f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
45940910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
45950f5c6efeSJed Brown   PetscValidPointer(A,3);
459694ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
45970f5c6efeSJed Brown   PetscValidPointer(B,4);
459894ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
45990f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4600d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
46010f5c6efeSJed Brown   PetscFunctionReturn(0);
46020f5c6efeSJed Brown }
4603325fc9f4SBarry Smith 
46040e4ef248SJed Brown #undef __FUNCT__
46050e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
46060e4ef248SJed Brown /*@C
46079ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
46080e4ef248SJed Brown 
46090e4ef248SJed Brown    Collective on TS
46100e4ef248SJed Brown 
46110e4ef248SJed Brown    Input Arguments:
46120e4ef248SJed Brown +  ts - time stepping context
46130e4ef248SJed Brown .  t - time at which to evaluate
46140910c330SBarry Smith .  U - state at which to evaluate
46150e4ef248SJed Brown -  ctx - context
46160e4ef248SJed Brown 
46170e4ef248SJed Brown    Output Arguments:
46180e4ef248SJed Brown .  F - right hand side
46190e4ef248SJed Brown 
46200e4ef248SJed Brown    Level: intermediate
46210e4ef248SJed Brown 
46220e4ef248SJed Brown    Notes:
46230e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
46240e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
46250e4ef248SJed Brown 
46260e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
46270e4ef248SJed Brown @*/
46280910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
46290e4ef248SJed Brown {
46300e4ef248SJed Brown   PetscErrorCode ierr;
46310e4ef248SJed Brown   Mat            Arhs,Brhs;
46320e4ef248SJed Brown 
46330e4ef248SJed Brown   PetscFunctionBegin;
46340e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4635d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
46360910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
46370e4ef248SJed Brown   PetscFunctionReturn(0);
46380e4ef248SJed Brown }
46390e4ef248SJed Brown 
46400e4ef248SJed Brown #undef __FUNCT__
46410e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
46420e4ef248SJed Brown /*@C
46430e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
46440e4ef248SJed Brown 
46450e4ef248SJed Brown    Collective on TS
46460e4ef248SJed Brown 
46470e4ef248SJed Brown    Input Arguments:
46480e4ef248SJed Brown +  ts - time stepping context
46490e4ef248SJed Brown .  t - time at which to evaluate
46500910c330SBarry Smith .  U - state at which to evaluate
46510e4ef248SJed Brown -  ctx - context
46520e4ef248SJed Brown 
46530e4ef248SJed Brown    Output Arguments:
46540e4ef248SJed Brown +  A - pointer to operator
46550e4ef248SJed Brown .  B - pointer to preconditioning matrix
46560e4ef248SJed Brown -  flg - matrix structure flag
46570e4ef248SJed Brown 
46580e4ef248SJed Brown    Level: intermediate
46590e4ef248SJed Brown 
46600e4ef248SJed Brown    Notes:
46610e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
46620e4ef248SJed Brown 
46630e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
46640e4ef248SJed Brown @*/
4665d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
46660e4ef248SJed Brown {
46670e4ef248SJed Brown   PetscFunctionBegin;
46680e4ef248SJed Brown   PetscFunctionReturn(0);
46690e4ef248SJed Brown }
46700e4ef248SJed Brown 
46710026cea9SSean Farley #undef __FUNCT__
46720026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
46730026cea9SSean Farley /*@C
46740026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
46750026cea9SSean Farley 
46760026cea9SSean Farley    Collective on TS
46770026cea9SSean Farley 
46780026cea9SSean Farley    Input Arguments:
46790026cea9SSean Farley +  ts - time stepping context
46800026cea9SSean Farley .  t - time at which to evaluate
46810910c330SBarry Smith .  U - state at which to evaluate
46820910c330SBarry Smith .  Udot - time derivative of state vector
46830026cea9SSean Farley -  ctx - context
46840026cea9SSean Farley 
46850026cea9SSean Farley    Output Arguments:
46860026cea9SSean Farley .  F - left hand side
46870026cea9SSean Farley 
46880026cea9SSean Farley    Level: intermediate
46890026cea9SSean Farley 
46900026cea9SSean Farley    Notes:
46910910c330SBarry 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
46920026cea9SSean Farley    user is required to write their own TSComputeIFunction.
46930026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
46940026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
46950026cea9SSean Farley 
46969ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
46979ae8fd06SBarry Smith 
46989ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
46990026cea9SSean Farley @*/
47000910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
47010026cea9SSean Farley {
47020026cea9SSean Farley   PetscErrorCode ierr;
47030026cea9SSean Farley   Mat            A,B;
47040026cea9SSean Farley 
47050026cea9SSean Farley   PetscFunctionBegin;
47060298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4707d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
47080910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
47090026cea9SSean Farley   PetscFunctionReturn(0);
47100026cea9SSean Farley }
47110026cea9SSean Farley 
47120026cea9SSean Farley #undef __FUNCT__
47130026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
47140026cea9SSean Farley /*@C
4715b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
47160026cea9SSean Farley 
47170026cea9SSean Farley    Collective on TS
47180026cea9SSean Farley 
47190026cea9SSean Farley    Input Arguments:
47200026cea9SSean Farley +  ts - time stepping context
47210026cea9SSean Farley .  t - time at which to evaluate
47220910c330SBarry Smith .  U - state at which to evaluate
47230910c330SBarry Smith .  Udot - time derivative of state vector
47240026cea9SSean Farley .  shift - shift to apply
47250026cea9SSean Farley -  ctx - context
47260026cea9SSean Farley 
47270026cea9SSean Farley    Output Arguments:
47280026cea9SSean Farley +  A - pointer to operator
47290026cea9SSean Farley .  B - pointer to preconditioning matrix
47300026cea9SSean Farley -  flg - matrix structure flag
47310026cea9SSean Farley 
4732b41af12eSJed Brown    Level: advanced
47330026cea9SSean Farley 
47340026cea9SSean Farley    Notes:
47350026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
47360026cea9SSean Farley 
4737b41af12eSJed Brown    It is only appropriate for problems of the form
4738b41af12eSJed Brown 
4739b41af12eSJed Brown $     M Udot = F(U,t)
4740b41af12eSJed Brown 
4741b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4742b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4743b41af12eSJed Brown   an implicit operator of the form
4744b41af12eSJed Brown 
4745b41af12eSJed Brown $    shift*M + J
4746b41af12eSJed Brown 
4747b41af12eSJed 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
4748b41af12eSJed Brown   a copy of M or reassemble it when requested.
4749b41af12eSJed Brown 
47500026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
47510026cea9SSean Farley @*/
4752d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
47530026cea9SSean Farley {
4754b41af12eSJed Brown   PetscErrorCode ierr;
4755b41af12eSJed Brown 
47560026cea9SSean Farley   PetscFunctionBegin;
475794ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4758b41af12eSJed Brown   ts->ijacobian.shift = shift;
47590026cea9SSean Farley   PetscFunctionReturn(0);
47600026cea9SSean Farley }
4761b41af12eSJed Brown 
4762e817cc15SEmil Constantinescu #undef __FUNCT__
4763e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
4764e817cc15SEmil Constantinescu /*@
4765e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4766e817cc15SEmil Constantinescu 
4767e817cc15SEmil Constantinescu    Not Collective
4768e817cc15SEmil Constantinescu 
4769e817cc15SEmil Constantinescu    Input Parameter:
4770e817cc15SEmil Constantinescu .  ts - the TS context
4771e817cc15SEmil Constantinescu 
4772e817cc15SEmil Constantinescu    Output Parameter:
47734e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4774e817cc15SEmil Constantinescu 
4775e817cc15SEmil Constantinescu    Level: beginner
4776e817cc15SEmil Constantinescu 
4777e817cc15SEmil Constantinescu .keywords: TS, equation type
4778e817cc15SEmil Constantinescu 
4779e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4780e817cc15SEmil Constantinescu @*/
4781e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4782e817cc15SEmil Constantinescu {
4783e817cc15SEmil Constantinescu   PetscFunctionBegin;
4784e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4785e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4786e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4787e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4788e817cc15SEmil Constantinescu }
4789e817cc15SEmil Constantinescu 
4790e817cc15SEmil Constantinescu #undef __FUNCT__
4791e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
4792e817cc15SEmil Constantinescu /*@
4793e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4794e817cc15SEmil Constantinescu 
4795e817cc15SEmil Constantinescu    Not Collective
4796e817cc15SEmil Constantinescu 
4797e817cc15SEmil Constantinescu    Input Parameter:
4798e817cc15SEmil Constantinescu +  ts - the TS context
47991297b224SEmil Constantinescu -  equation_type - see TSEquationType
4800e817cc15SEmil Constantinescu 
4801e817cc15SEmil Constantinescu    Level: advanced
4802e817cc15SEmil Constantinescu 
4803e817cc15SEmil Constantinescu .keywords: TS, equation type
4804e817cc15SEmil Constantinescu 
4805e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4806e817cc15SEmil Constantinescu @*/
4807e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4808e817cc15SEmil Constantinescu {
4809e817cc15SEmil Constantinescu   PetscFunctionBegin;
4810e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4811e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4812e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4813e817cc15SEmil Constantinescu }
48140026cea9SSean Farley 
48154af1b03aSJed Brown #undef __FUNCT__
48164af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
48174af1b03aSJed Brown /*@
48184af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
48194af1b03aSJed Brown 
48204af1b03aSJed Brown    Not Collective
48214af1b03aSJed Brown 
48224af1b03aSJed Brown    Input Parameter:
48234af1b03aSJed Brown .  ts - the TS context
48244af1b03aSJed Brown 
48254af1b03aSJed Brown    Output Parameter:
48264af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
48274af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
48284af1b03aSJed Brown 
4829487e0bb9SJed Brown    Level: beginner
48304af1b03aSJed Brown 
4831cd652676SJed Brown    Notes:
4832cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
48334af1b03aSJed Brown 
48344af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
48354af1b03aSJed Brown 
48364af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
48374af1b03aSJed Brown @*/
48384af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
48394af1b03aSJed Brown {
48404af1b03aSJed Brown   PetscFunctionBegin;
48414af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48424af1b03aSJed Brown   PetscValidPointer(reason,2);
48434af1b03aSJed Brown   *reason = ts->reason;
48444af1b03aSJed Brown   PetscFunctionReturn(0);
48454af1b03aSJed Brown }
48464af1b03aSJed Brown 
4847fb1732b5SBarry Smith #undef __FUNCT__
4848d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
4849d6ad946cSShri Abhyankar /*@
4850d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4851d6ad946cSShri Abhyankar 
4852d6ad946cSShri Abhyankar    Not Collective
4853d6ad946cSShri Abhyankar 
4854d6ad946cSShri Abhyankar    Input Parameter:
4855d6ad946cSShri Abhyankar +  ts - the TS context
4856d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4857d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4858d6ad946cSShri Abhyankar 
4859f5abba47SShri Abhyankar    Level: advanced
4860d6ad946cSShri Abhyankar 
4861d6ad946cSShri Abhyankar    Notes:
4862d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4863d6ad946cSShri Abhyankar 
4864d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4865d6ad946cSShri Abhyankar 
4866d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4867d6ad946cSShri Abhyankar @*/
4868d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4869d6ad946cSShri Abhyankar {
4870d6ad946cSShri Abhyankar   PetscFunctionBegin;
4871d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4872d6ad946cSShri Abhyankar   ts->reason = reason;
4873d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4874d6ad946cSShri Abhyankar }
4875d6ad946cSShri Abhyankar 
4876d6ad946cSShri Abhyankar #undef __FUNCT__
4877cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4878cc708dedSBarry Smith /*@
4879cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4880cc708dedSBarry Smith 
4881cc708dedSBarry Smith    Not Collective
4882cc708dedSBarry Smith 
4883cc708dedSBarry Smith    Input Parameter:
4884cc708dedSBarry Smith .  ts - the TS context
4885cc708dedSBarry Smith 
4886cc708dedSBarry Smith    Output Parameter:
4887cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4888cc708dedSBarry Smith 
4889487e0bb9SJed Brown    Level: beginner
4890cc708dedSBarry Smith 
4891cc708dedSBarry Smith    Notes:
4892cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4893cc708dedSBarry Smith 
4894cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4895cc708dedSBarry Smith 
4896cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4897cc708dedSBarry Smith @*/
4898cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4899cc708dedSBarry Smith {
4900cc708dedSBarry Smith   PetscFunctionBegin;
4901cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4902cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4903cc708dedSBarry Smith   *ftime = ts->solvetime;
4904cc708dedSBarry Smith   PetscFunctionReturn(0);
4905cc708dedSBarry Smith }
4906cc708dedSBarry Smith 
4907cc708dedSBarry Smith #undef __FUNCT__
49082c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps"
49092c18e0fdSBarry Smith /*@
49102c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
49112c18e0fdSBarry Smith 
49122c18e0fdSBarry Smith    Not Collective
49132c18e0fdSBarry Smith 
49142c18e0fdSBarry Smith    Input Parameter:
49152c18e0fdSBarry Smith .  ts - the TS context
49162c18e0fdSBarry Smith 
49172c18e0fdSBarry Smith    Output Parameter:
49182c18e0fdSBarry Smith .  steps - the number of steps
49192c18e0fdSBarry Smith 
49202c18e0fdSBarry Smith    Level: beginner
49212c18e0fdSBarry Smith 
49222c18e0fdSBarry Smith    Notes:
49232c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
49242c18e0fdSBarry Smith 
49252c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
49262c18e0fdSBarry Smith 
49272c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
49282c18e0fdSBarry Smith @*/
49292c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
49302c18e0fdSBarry Smith {
49312c18e0fdSBarry Smith   PetscFunctionBegin;
49322c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49332c18e0fdSBarry Smith   PetscValidPointer(steps,2);
49342c18e0fdSBarry Smith   *steps = ts->total_steps;
49352c18e0fdSBarry Smith   PetscFunctionReturn(0);
49362c18e0fdSBarry Smith }
49372c18e0fdSBarry Smith 
49382c18e0fdSBarry Smith #undef __FUNCT__
49395ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
49409f67acb7SJed Brown /*@
49415ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
49429f67acb7SJed Brown    used by the time integrator.
49439f67acb7SJed Brown 
49449f67acb7SJed Brown    Not Collective
49459f67acb7SJed Brown 
49469f67acb7SJed Brown    Input Parameter:
49479f67acb7SJed Brown .  ts - TS context
49489f67acb7SJed Brown 
49499f67acb7SJed Brown    Output Parameter:
49509f67acb7SJed Brown .  nits - number of nonlinear iterations
49519f67acb7SJed Brown 
49529f67acb7SJed Brown    Notes:
49539f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
49549f67acb7SJed Brown 
49559f67acb7SJed Brown    Level: intermediate
49569f67acb7SJed Brown 
49579f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
49589f67acb7SJed Brown 
49595ef26d82SJed Brown .seealso:  TSGetKSPIterations()
49609f67acb7SJed Brown @*/
49615ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
49629f67acb7SJed Brown {
49639f67acb7SJed Brown   PetscFunctionBegin;
49649f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49659f67acb7SJed Brown   PetscValidIntPointer(nits,2);
49665ef26d82SJed Brown   *nits = ts->snes_its;
49679f67acb7SJed Brown   PetscFunctionReturn(0);
49689f67acb7SJed Brown }
49699f67acb7SJed Brown 
49709f67acb7SJed Brown #undef __FUNCT__
49715ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
49729f67acb7SJed Brown /*@
49735ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
49749f67acb7SJed Brown    used by the time integrator.
49759f67acb7SJed Brown 
49769f67acb7SJed Brown    Not Collective
49779f67acb7SJed Brown 
49789f67acb7SJed Brown    Input Parameter:
49799f67acb7SJed Brown .  ts - TS context
49809f67acb7SJed Brown 
49819f67acb7SJed Brown    Output Parameter:
49829f67acb7SJed Brown .  lits - number of linear iterations
49839f67acb7SJed Brown 
49849f67acb7SJed Brown    Notes:
49859f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
49869f67acb7SJed Brown 
49879f67acb7SJed Brown    Level: intermediate
49889f67acb7SJed Brown 
49899f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
49909f67acb7SJed Brown 
49915ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
49929f67acb7SJed Brown @*/
49935ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
49949f67acb7SJed Brown {
49959f67acb7SJed Brown   PetscFunctionBegin;
49969f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49979f67acb7SJed Brown   PetscValidIntPointer(lits,2);
49985ef26d82SJed Brown   *lits = ts->ksp_its;
49999f67acb7SJed Brown   PetscFunctionReturn(0);
50009f67acb7SJed Brown }
50019f67acb7SJed Brown 
50029f67acb7SJed Brown #undef __FUNCT__
5003cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
5004cef5090cSJed Brown /*@
5005cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5006cef5090cSJed Brown 
5007cef5090cSJed Brown    Not Collective
5008cef5090cSJed Brown 
5009cef5090cSJed Brown    Input Parameter:
5010cef5090cSJed Brown .  ts - TS context
5011cef5090cSJed Brown 
5012cef5090cSJed Brown    Output Parameter:
5013cef5090cSJed Brown .  rejects - number of steps rejected
5014cef5090cSJed Brown 
5015cef5090cSJed Brown    Notes:
5016cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5017cef5090cSJed Brown 
5018cef5090cSJed Brown    Level: intermediate
5019cef5090cSJed Brown 
5020cef5090cSJed Brown .keywords: TS, get, number
5021cef5090cSJed Brown 
50225ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5023cef5090cSJed Brown @*/
5024cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5025cef5090cSJed Brown {
5026cef5090cSJed Brown   PetscFunctionBegin;
5027cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5028cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5029cef5090cSJed Brown   *rejects = ts->reject;
5030cef5090cSJed Brown   PetscFunctionReturn(0);
5031cef5090cSJed Brown }
5032cef5090cSJed Brown 
5033cef5090cSJed Brown #undef __FUNCT__
5034cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
5035cef5090cSJed Brown /*@
5036cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5037cef5090cSJed Brown 
5038cef5090cSJed Brown    Not Collective
5039cef5090cSJed Brown 
5040cef5090cSJed Brown    Input Parameter:
5041cef5090cSJed Brown .  ts - TS context
5042cef5090cSJed Brown 
5043cef5090cSJed Brown    Output Parameter:
5044cef5090cSJed Brown .  fails - number of failed nonlinear solves
5045cef5090cSJed Brown 
5046cef5090cSJed Brown    Notes:
5047cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5048cef5090cSJed Brown 
5049cef5090cSJed Brown    Level: intermediate
5050cef5090cSJed Brown 
5051cef5090cSJed Brown .keywords: TS, get, number
5052cef5090cSJed Brown 
50535ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5054cef5090cSJed Brown @*/
5055cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5056cef5090cSJed Brown {
5057cef5090cSJed Brown   PetscFunctionBegin;
5058cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5059cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5060cef5090cSJed Brown   *fails = ts->num_snes_failures;
5061cef5090cSJed Brown   PetscFunctionReturn(0);
5062cef5090cSJed Brown }
5063cef5090cSJed Brown 
5064cef5090cSJed Brown #undef __FUNCT__
5065cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
5066cef5090cSJed Brown /*@
5067cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5068cef5090cSJed Brown 
5069cef5090cSJed Brown    Not Collective
5070cef5090cSJed Brown 
5071cef5090cSJed Brown    Input Parameter:
5072cef5090cSJed Brown +  ts - TS context
5073cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5074cef5090cSJed Brown 
5075cef5090cSJed Brown    Notes:
5076cef5090cSJed Brown    The counter is reset to zero for each step
5077cef5090cSJed Brown 
5078cef5090cSJed Brown    Options Database Key:
5079cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5080cef5090cSJed Brown 
5081cef5090cSJed Brown    Level: intermediate
5082cef5090cSJed Brown 
5083cef5090cSJed Brown .keywords: TS, set, maximum, number
5084cef5090cSJed Brown 
50855ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5086cef5090cSJed Brown @*/
5087cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5088cef5090cSJed Brown {
5089cef5090cSJed Brown   PetscFunctionBegin;
5090cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5091cef5090cSJed Brown   ts->max_reject = rejects;
5092cef5090cSJed Brown   PetscFunctionReturn(0);
5093cef5090cSJed Brown }
5094cef5090cSJed Brown 
5095cef5090cSJed Brown #undef __FUNCT__
5096cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
5097cef5090cSJed Brown /*@
5098cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5099cef5090cSJed Brown 
5100cef5090cSJed Brown    Not Collective
5101cef5090cSJed Brown 
5102cef5090cSJed Brown    Input Parameter:
5103cef5090cSJed Brown +  ts - TS context
5104cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5105cef5090cSJed Brown 
5106cef5090cSJed Brown    Notes:
5107cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5108cef5090cSJed Brown 
5109cef5090cSJed Brown    Options Database Key:
5110cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5111cef5090cSJed Brown 
5112cef5090cSJed Brown    Level: intermediate
5113cef5090cSJed Brown 
5114cef5090cSJed Brown .keywords: TS, set, maximum, number
5115cef5090cSJed Brown 
51165ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5117cef5090cSJed Brown @*/
5118cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5119cef5090cSJed Brown {
5120cef5090cSJed Brown   PetscFunctionBegin;
5121cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5122cef5090cSJed Brown   ts->max_snes_failures = fails;
5123cef5090cSJed Brown   PetscFunctionReturn(0);
5124cef5090cSJed Brown }
5125cef5090cSJed Brown 
5126cef5090cSJed Brown #undef __FUNCT__
51274e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
5128cef5090cSJed Brown /*@
5129cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5130cef5090cSJed Brown 
5131cef5090cSJed Brown    Not Collective
5132cef5090cSJed Brown 
5133cef5090cSJed Brown    Input Parameter:
5134cef5090cSJed Brown +  ts - TS context
5135cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5136cef5090cSJed Brown 
5137cef5090cSJed Brown    Options Database Key:
5138cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5139cef5090cSJed Brown 
5140cef5090cSJed Brown    Level: intermediate
5141cef5090cSJed Brown 
5142cef5090cSJed Brown .keywords: TS, set, error
5143cef5090cSJed Brown 
51445ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5145cef5090cSJed Brown @*/
5146cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5147cef5090cSJed Brown {
5148cef5090cSJed Brown   PetscFunctionBegin;
5149cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5150cef5090cSJed Brown   ts->errorifstepfailed = err;
5151cef5090cSJed Brown   PetscFunctionReturn(0);
5152cef5090cSJed Brown }
5153cef5090cSJed Brown 
5154cef5090cSJed Brown #undef __FUNCT__
5155fde5950dSBarry Smith #define __FUNCT__ "TSMonitorSolution"
5156fb1732b5SBarry Smith /*@C
5157fde5950dSBarry 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
5158fb1732b5SBarry Smith 
5159fb1732b5SBarry Smith    Collective on TS
5160fb1732b5SBarry Smith 
5161fb1732b5SBarry Smith    Input Parameters:
5162fb1732b5SBarry Smith +  ts - the TS context
5163fb1732b5SBarry Smith .  step - current time-step
5164fb1732b5SBarry Smith .  ptime - current time
51650910c330SBarry Smith .  u - current state
5166*721cd6eeSBarry Smith -  vf - viewer and its format
5167fb1732b5SBarry Smith 
5168fb1732b5SBarry Smith    Level: intermediate
5169fb1732b5SBarry Smith 
5170fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
5171fb1732b5SBarry Smith 
5172fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5173fb1732b5SBarry Smith @*/
5174*721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5175fb1732b5SBarry Smith {
5176fb1732b5SBarry Smith   PetscErrorCode ierr;
5177fb1732b5SBarry Smith 
5178fb1732b5SBarry Smith   PetscFunctionBegin;
5179*721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5180*721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5181*721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5182ed81e22dSJed Brown   PetscFunctionReturn(0);
5183ed81e22dSJed Brown }
5184ed81e22dSJed Brown 
5185ed81e22dSJed Brown #undef __FUNCT__
5186ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
5187ed81e22dSJed Brown /*@C
5188ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5189ed81e22dSJed Brown 
5190ed81e22dSJed Brown    Collective on TS
5191ed81e22dSJed Brown 
5192ed81e22dSJed Brown    Input Parameters:
5193ed81e22dSJed Brown +  ts - the TS context
5194ed81e22dSJed Brown .  step - current time-step
5195ed81e22dSJed Brown .  ptime - current time
51960910c330SBarry Smith .  u - current state
5197ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5198ed81e22dSJed Brown 
5199ed81e22dSJed Brown    Level: intermediate
5200ed81e22dSJed Brown 
5201ed81e22dSJed Brown    Notes:
5202ed81e22dSJed 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.
5203ed81e22dSJed Brown    These are named according to the file name template.
5204ed81e22dSJed Brown 
5205ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5206ed81e22dSJed Brown 
5207ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5208ed81e22dSJed Brown 
5209ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5210ed81e22dSJed Brown @*/
52110910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5212ed81e22dSJed Brown {
5213ed81e22dSJed Brown   PetscErrorCode ierr;
5214ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5215ed81e22dSJed Brown   PetscViewer    viewer;
5216ed81e22dSJed Brown 
5217ed81e22dSJed Brown   PetscFunctionBegin;
52188caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5219ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
52200910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5221ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5222ed81e22dSJed Brown   PetscFunctionReturn(0);
5223ed81e22dSJed Brown }
5224ed81e22dSJed Brown 
5225ed81e22dSJed Brown #undef __FUNCT__
5226ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
5227ed81e22dSJed Brown /*@C
5228ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5229ed81e22dSJed Brown 
5230ed81e22dSJed Brown    Collective on TS
5231ed81e22dSJed Brown 
5232ed81e22dSJed Brown    Input Parameters:
5233ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5234ed81e22dSJed Brown 
5235ed81e22dSJed Brown    Level: intermediate
5236ed81e22dSJed Brown 
5237ed81e22dSJed Brown    Note:
5238ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5239ed81e22dSJed Brown 
5240ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5241ed81e22dSJed Brown 
5242ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5243ed81e22dSJed Brown @*/
5244ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5245ed81e22dSJed Brown {
5246ed81e22dSJed Brown   PetscErrorCode ierr;
5247ed81e22dSJed Brown 
5248ed81e22dSJed Brown   PetscFunctionBegin;
5249ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5250fb1732b5SBarry Smith   PetscFunctionReturn(0);
5251fb1732b5SBarry Smith }
5252fb1732b5SBarry Smith 
525384df9cb4SJed Brown #undef __FUNCT__
5254552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
525584df9cb4SJed Brown /*@
5256552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
525784df9cb4SJed Brown 
5258ed81e22dSJed Brown    Collective on TS if controller has not been created yet
525984df9cb4SJed Brown 
526084df9cb4SJed Brown    Input Arguments:
5261ed81e22dSJed Brown .  ts - time stepping context
526284df9cb4SJed Brown 
526384df9cb4SJed Brown    Output Arguments:
5264ed81e22dSJed Brown .  adapt - adaptive controller
526584df9cb4SJed Brown 
526684df9cb4SJed Brown    Level: intermediate
526784df9cb4SJed Brown 
5268ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
526984df9cb4SJed Brown @*/
5270552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
527184df9cb4SJed Brown {
527284df9cb4SJed Brown   PetscErrorCode ierr;
527384df9cb4SJed Brown 
527484df9cb4SJed Brown   PetscFunctionBegin;
527584df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5276ee346746SBarry Smith   if (adapt) PetscValidPointer(adapt,2);
527784df9cb4SJed Brown   if (!ts->adapt) {
5278ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
52793bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
52801c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
528184df9cb4SJed Brown   }
5282ee346746SBarry Smith   if (adapt) *adapt = ts->adapt;
528384df9cb4SJed Brown   PetscFunctionReturn(0);
528484df9cb4SJed Brown }
5285d6ebe24aSShri Abhyankar 
5286d6ebe24aSShri Abhyankar #undef __FUNCT__
52871c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
52881c3436cfSJed Brown /*@
52891c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
52901c3436cfSJed Brown 
52911c3436cfSJed Brown    Logically Collective
52921c3436cfSJed Brown 
52931c3436cfSJed Brown    Input Arguments:
52941c3436cfSJed Brown +  ts - time integration context
52951c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
52960298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
52971c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
52980298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
52991c3436cfSJed Brown 
5300a3cdaa26SBarry Smith    Options Database keys:
5301a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5302a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5303a3cdaa26SBarry Smith 
53043ff766beSShri Abhyankar    Notes:
53053ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
53063ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
53073ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
53083ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
53093ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
53103ff766beSShri Abhyankar    differential variables.
53113ff766beSShri Abhyankar 
53121c3436cfSJed Brown    Level: beginner
53131c3436cfSJed Brown 
5314c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
53151c3436cfSJed Brown @*/
53161c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
53171c3436cfSJed Brown {
53181c3436cfSJed Brown   PetscErrorCode ierr;
53191c3436cfSJed Brown 
53201c3436cfSJed Brown   PetscFunctionBegin;
5321c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
53221c3436cfSJed Brown   if (vatol) {
53231c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
53241c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
5325bbd56ea5SKarl Rupp 
53261c3436cfSJed Brown     ts->vatol = vatol;
53271c3436cfSJed Brown   }
5328c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
53291c3436cfSJed Brown   if (vrtol) {
53301c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
53311c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
5332bbd56ea5SKarl Rupp 
53331c3436cfSJed Brown     ts->vrtol = vrtol;
53341c3436cfSJed Brown   }
53351c3436cfSJed Brown   PetscFunctionReturn(0);
53361c3436cfSJed Brown }
53371c3436cfSJed Brown 
53381c3436cfSJed Brown #undef __FUNCT__
5339c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
5340c5033834SJed Brown /*@
5341c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5342c5033834SJed Brown 
5343c5033834SJed Brown    Logically Collective
5344c5033834SJed Brown 
5345c5033834SJed Brown    Input Arguments:
5346c5033834SJed Brown .  ts - time integration context
5347c5033834SJed Brown 
5348c5033834SJed Brown    Output Arguments:
53490298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
53500298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
53510298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
53520298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5353c5033834SJed Brown 
5354c5033834SJed Brown    Level: beginner
5355c5033834SJed Brown 
5356c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5357c5033834SJed Brown @*/
5358c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5359c5033834SJed Brown {
5360c5033834SJed Brown   PetscFunctionBegin;
5361c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5362c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5363c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5364c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5365c5033834SJed Brown   PetscFunctionReturn(0);
5366c5033834SJed Brown }
5367c5033834SJed Brown 
5368c5033834SJed Brown #undef __FUNCT__
53699c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNorm2"
53709c6b16b5SShri Abhyankar /*@
5371a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
53729c6b16b5SShri Abhyankar 
53739c6b16b5SShri Abhyankar    Collective on TS
53749c6b16b5SShri Abhyankar 
53759c6b16b5SShri Abhyankar    Input Arguments:
53769c6b16b5SShri Abhyankar +  ts - time stepping context
5377a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5378a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
53799c6b16b5SShri Abhyankar 
53809c6b16b5SShri Abhyankar    Output Arguments:
53819c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
53829c6b16b5SShri Abhyankar 
53839c6b16b5SShri Abhyankar    Level: developer
53849c6b16b5SShri Abhyankar 
5385deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
53869c6b16b5SShri Abhyankar @*/
5387a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm)
53889c6b16b5SShri Abhyankar {
53899c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
53909c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
53919c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
53929c6b16b5SShri Abhyankar   PetscReal         sum,gsum;
53939c6b16b5SShri Abhyankar   PetscReal         tol;
53949c6b16b5SShri Abhyankar 
53959c6b16b5SShri Abhyankar   PetscFunctionBegin;
53969c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5397a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5398a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5399a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5400a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5401a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5402a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5403a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
54049c6b16b5SShri Abhyankar 
54059c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
54069c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
54079c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
54089c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
54099c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
54109c6b16b5SShri Abhyankar   sum  = 0.;
54119c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
54129c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
54139c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54149c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54159c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
54169c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54179c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
54189c6b16b5SShri Abhyankar     }
54199c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54209c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54219c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
54229c6b16b5SShri Abhyankar     const PetscScalar *atol;
54239c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54249c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
54259c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54269c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
54279c6b16b5SShri Abhyankar     }
54289c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54299c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
54309c6b16b5SShri Abhyankar     const PetscScalar *rtol;
54319c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54329c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
54339c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54349c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
54359c6b16b5SShri Abhyankar     }
54369c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54379c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
54389c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
54399c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54409c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
54419c6b16b5SShri Abhyankar     }
54429c6b16b5SShri Abhyankar   }
54439c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
54449c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
54459c6b16b5SShri Abhyankar 
5446b2566f29SBarry Smith   ierr  = MPIU_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
54479c6b16b5SShri Abhyankar   *norm = PetscSqrtReal(gsum / N);
54489c6b16b5SShri Abhyankar 
54499c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
54509c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
54519c6b16b5SShri Abhyankar }
54529c6b16b5SShri Abhyankar 
54539c6b16b5SShri Abhyankar #undef __FUNCT__
54549c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNormInfinity"
54559c6b16b5SShri Abhyankar /*@
5456a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
54579c6b16b5SShri Abhyankar 
54589c6b16b5SShri Abhyankar    Collective on TS
54599c6b16b5SShri Abhyankar 
54609c6b16b5SShri Abhyankar    Input Arguments:
54619c6b16b5SShri Abhyankar +  ts - time stepping context
5462a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5463a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
54649c6b16b5SShri Abhyankar 
54659c6b16b5SShri Abhyankar    Output Arguments:
54669c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
54679c6b16b5SShri Abhyankar 
54689c6b16b5SShri Abhyankar    Level: developer
54699c6b16b5SShri Abhyankar 
5470deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
54719c6b16b5SShri Abhyankar @*/
5472a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm)
54739c6b16b5SShri Abhyankar {
54749c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
54759c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart,k;
54769c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
54779c6b16b5SShri Abhyankar   PetscReal         max,gmax;
54789c6b16b5SShri Abhyankar   PetscReal         tol;
54799c6b16b5SShri Abhyankar 
54809c6b16b5SShri Abhyankar   PetscFunctionBegin;
54819c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5482a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5483a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5484a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5485a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5486a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5487a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5488a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
54899c6b16b5SShri Abhyankar 
54909c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
54919c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
54929c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
54939c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
54949c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
54959c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
54969c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
54979c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54989c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54999c6b16b5SShri Abhyankar     k = 0;
55009c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
55019c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
55029c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
55039c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55049c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
55059c6b16b5SShri Abhyankar     }
55069c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
55079c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
55089c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
55099c6b16b5SShri Abhyankar     const PetscScalar *atol;
55109c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
55119c6b16b5SShri Abhyankar     k = 0;
55129c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
55139c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
55149c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
55159c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55169c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
55179c6b16b5SShri Abhyankar     }
55189c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
55199c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
55209c6b16b5SShri Abhyankar     const PetscScalar *rtol;
55219c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
55229c6b16b5SShri Abhyankar     k = 0;
55239c6b16b5SShri Abhyankar     tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
55249c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
55259c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
55269c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55279c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
55289c6b16b5SShri Abhyankar     }
55299c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
55309c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
55319c6b16b5SShri Abhyankar     k = 0;
55329c6b16b5SShri Abhyankar     tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
55339c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
55349c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
55359c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55369c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
55379c6b16b5SShri Abhyankar     }
55389c6b16b5SShri Abhyankar   }
55399c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
55409c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
55419c6b16b5SShri Abhyankar 
5542b2566f29SBarry Smith   ierr  = MPIU_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
55439c6b16b5SShri Abhyankar   *norm = gmax;
55449c6b16b5SShri Abhyankar 
55459c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
55469c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
55479c6b16b5SShri Abhyankar }
55489c6b16b5SShri Abhyankar 
55499c6b16b5SShri Abhyankar #undef __FUNCT__
55507619abb3SShri #define __FUNCT__ "TSErrorWeightedNorm"
55511c3436cfSJed Brown /*@
5552a4868fbcSLisandro Dalcin    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors
55531c3436cfSJed Brown 
55541c3436cfSJed Brown    Collective on TS
55551c3436cfSJed Brown 
55561c3436cfSJed Brown    Input Arguments:
55571c3436cfSJed Brown +  ts - time stepping context
5558a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5559a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
5560a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
55617619abb3SShri 
55621c3436cfSJed Brown    Output Arguments:
55631c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
55641c3436cfSJed Brown 
5565a4868fbcSLisandro Dalcin 
5566a4868fbcSLisandro Dalcin    Options Database Keys:
5567a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5568a4868fbcSLisandro Dalcin 
55691c3436cfSJed Brown    Level: developer
55701c3436cfSJed Brown 
5571deea92deSShri .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
55721c3436cfSJed Brown @*/
5573a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm)
55741c3436cfSJed Brown {
55758beabaa1SBarry Smith   PetscErrorCode ierr;
55761c3436cfSJed Brown 
55771c3436cfSJed Brown   PetscFunctionBegin;
5578a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
5579a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNorm2(ts,U,Y,norm);CHKERRQ(ierr);
5580a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
5581a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm);CHKERRQ(ierr);
5582a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
55831c3436cfSJed Brown   PetscFunctionReturn(0);
55841c3436cfSJed Brown }
55851c3436cfSJed Brown 
55861c3436cfSJed Brown #undef __FUNCT__
55878d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
55888d59e960SJed Brown /*@
55898d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
55908d59e960SJed Brown 
55918d59e960SJed Brown    Logically Collective on TS
55928d59e960SJed Brown 
55938d59e960SJed Brown    Input Arguments:
55948d59e960SJed Brown +  ts - time stepping context
55958d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
55968d59e960SJed Brown 
55978d59e960SJed Brown    Note:
55988d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
55998d59e960SJed Brown 
56008d59e960SJed Brown    Level: intermediate
56018d59e960SJed Brown 
56028d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
56038d59e960SJed Brown @*/
56048d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
56058d59e960SJed Brown {
56068d59e960SJed Brown   PetscFunctionBegin;
56078d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
56088d59e960SJed Brown   ts->cfltime_local = cfltime;
56098d59e960SJed Brown   ts->cfltime       = -1.;
56108d59e960SJed Brown   PetscFunctionReturn(0);
56118d59e960SJed Brown }
56128d59e960SJed Brown 
56138d59e960SJed Brown #undef __FUNCT__
56148d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
56158d59e960SJed Brown /*@
56168d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
56178d59e960SJed Brown 
56188d59e960SJed Brown    Collective on TS
56198d59e960SJed Brown 
56208d59e960SJed Brown    Input Arguments:
56218d59e960SJed Brown .  ts - time stepping context
56228d59e960SJed Brown 
56238d59e960SJed Brown    Output Arguments:
56248d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
56258d59e960SJed Brown 
56268d59e960SJed Brown    Level: advanced
56278d59e960SJed Brown 
56288d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
56298d59e960SJed Brown @*/
56308d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
56318d59e960SJed Brown {
56328d59e960SJed Brown   PetscErrorCode ierr;
56338d59e960SJed Brown 
56348d59e960SJed Brown   PetscFunctionBegin;
56358d59e960SJed Brown   if (ts->cfltime < 0) {
5636b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
56378d59e960SJed Brown   }
56388d59e960SJed Brown   *cfltime = ts->cfltime;
56398d59e960SJed Brown   PetscFunctionReturn(0);
56408d59e960SJed Brown }
56418d59e960SJed Brown 
56428d59e960SJed Brown #undef __FUNCT__
5643d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
5644d6ebe24aSShri Abhyankar /*@
5645d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5646d6ebe24aSShri Abhyankar 
5647d6ebe24aSShri Abhyankar    Input Parameters:
5648d6ebe24aSShri Abhyankar .  ts   - the TS context.
5649d6ebe24aSShri Abhyankar .  xl   - lower bound.
5650d6ebe24aSShri Abhyankar .  xu   - upper bound.
5651d6ebe24aSShri Abhyankar 
5652d6ebe24aSShri Abhyankar    Notes:
5653d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
5654e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
5655d6ebe24aSShri Abhyankar 
56562bd2b0e6SSatish Balay    Level: advanced
56572bd2b0e6SSatish Balay 
5658d6ebe24aSShri Abhyankar @*/
5659d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5660d6ebe24aSShri Abhyankar {
5661d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
5662d6ebe24aSShri Abhyankar   SNES           snes;
5663d6ebe24aSShri Abhyankar 
5664d6ebe24aSShri Abhyankar   PetscFunctionBegin;
5665d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5666d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
5667d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
5668d6ebe24aSShri Abhyankar }
5669d6ebe24aSShri Abhyankar 
5670325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
5671c6db04a5SJed Brown #include <mex.h>
5672325fc9f4SBarry Smith 
5673325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
5674325fc9f4SBarry Smith 
5675325fc9f4SBarry Smith #undef __FUNCT__
5676325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
5677325fc9f4SBarry Smith /*
5678325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
5679325fc9f4SBarry Smith                          TSSetFunctionMatlab().
5680325fc9f4SBarry Smith 
5681325fc9f4SBarry Smith    Collective on TS
5682325fc9f4SBarry Smith 
5683325fc9f4SBarry Smith    Input Parameters:
5684325fc9f4SBarry Smith +  snes - the TS context
56850910c330SBarry Smith -  u - input vector
5686325fc9f4SBarry Smith 
5687325fc9f4SBarry Smith    Output Parameter:
5688325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
5689325fc9f4SBarry Smith 
5690325fc9f4SBarry Smith    Notes:
5691325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
5692325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
5693325fc9f4SBarry Smith    themselves.
5694325fc9f4SBarry Smith 
5695325fc9f4SBarry Smith    Level: developer
5696325fc9f4SBarry Smith 
5697325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5698325fc9f4SBarry Smith 
5699325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5700325fc9f4SBarry Smith */
57010910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
5702325fc9f4SBarry Smith {
5703325fc9f4SBarry Smith   PetscErrorCode  ierr;
5704325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5705325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
5706325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
5707325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
5708325fc9f4SBarry Smith 
5709325fc9f4SBarry Smith   PetscFunctionBegin;
5710325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
57110910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
57120910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
5713325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
57140910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
5715325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
5716325fc9f4SBarry Smith 
5717325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
57180910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
57190910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
57200910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
5721bbd56ea5SKarl Rupp 
5722325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5723325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
5724325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5725325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5726325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
5727325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
5728325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
5729325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
5730325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5731325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5732325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5733325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5734325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5735325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5736325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5737325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5738325fc9f4SBarry Smith   PetscFunctionReturn(0);
5739325fc9f4SBarry Smith }
5740325fc9f4SBarry Smith 
5741325fc9f4SBarry Smith 
5742325fc9f4SBarry Smith #undef __FUNCT__
5743325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
5744325fc9f4SBarry Smith /*
5745325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
5746325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
5747e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
5748325fc9f4SBarry Smith 
5749325fc9f4SBarry Smith    Logically Collective on TS
5750325fc9f4SBarry Smith 
5751325fc9f4SBarry Smith    Input Parameters:
5752325fc9f4SBarry Smith +  ts - the TS context
5753325fc9f4SBarry Smith -  func - function evaluation routine
5754325fc9f4SBarry Smith 
5755325fc9f4SBarry Smith    Calling sequence of func:
57560910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
5757325fc9f4SBarry Smith 
5758325fc9f4SBarry Smith    Level: beginner
5759325fc9f4SBarry Smith 
5760325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5761325fc9f4SBarry Smith 
5762325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5763325fc9f4SBarry Smith */
5764cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
5765325fc9f4SBarry Smith {
5766325fc9f4SBarry Smith   PetscErrorCode  ierr;
5767325fc9f4SBarry Smith   TSMatlabContext *sctx;
5768325fc9f4SBarry Smith 
5769325fc9f4SBarry Smith   PetscFunctionBegin;
5770325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5771325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5772325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5773325fc9f4SBarry Smith   /*
5774325fc9f4SBarry Smith      This should work, but it doesn't
5775325fc9f4SBarry Smith   sctx->ctx = ctx;
5776325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5777325fc9f4SBarry Smith   */
5778325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5779bbd56ea5SKarl Rupp 
57800298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
5781325fc9f4SBarry Smith   PetscFunctionReturn(0);
5782325fc9f4SBarry Smith }
5783325fc9f4SBarry Smith 
5784325fc9f4SBarry Smith #undef __FUNCT__
5785325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
5786325fc9f4SBarry Smith /*
5787325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
5788325fc9f4SBarry Smith                          TSSetJacobianMatlab().
5789325fc9f4SBarry Smith 
5790325fc9f4SBarry Smith    Collective on TS
5791325fc9f4SBarry Smith 
5792325fc9f4SBarry Smith    Input Parameters:
5793cdcf91faSSean Farley +  ts - the TS context
57940910c330SBarry Smith .  u - input vector
5795325fc9f4SBarry Smith .  A, B - the matrices
5796325fc9f4SBarry Smith -  ctx - user context
5797325fc9f4SBarry Smith 
5798325fc9f4SBarry Smith    Level: developer
5799325fc9f4SBarry Smith 
5800325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5801325fc9f4SBarry Smith 
5802325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5803325fc9f4SBarry Smith @*/
5804f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
5805325fc9f4SBarry Smith {
5806325fc9f4SBarry Smith   PetscErrorCode  ierr;
5807325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5808325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
5809325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
5810325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
5811325fc9f4SBarry Smith 
5812325fc9f4SBarry Smith   PetscFunctionBegin;
5813cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
58140910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5815325fc9f4SBarry Smith 
58160910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
5817325fc9f4SBarry Smith 
5818cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
58190910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
58200910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
58210910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
58220910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
5823bbd56ea5SKarl Rupp 
5824325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5825325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
5826325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5827325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5828325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
5829325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
5830325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
5831325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
5832325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
5833325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
5834325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5835325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5836325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5837325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5838325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5839325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5840325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5841325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
5842325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
5843325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5844325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
5845325fc9f4SBarry Smith   PetscFunctionReturn(0);
5846325fc9f4SBarry Smith }
5847325fc9f4SBarry Smith 
5848325fc9f4SBarry Smith 
5849325fc9f4SBarry Smith #undef __FUNCT__
5850325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
5851325fc9f4SBarry Smith /*
5852325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
5853e3c5b3baSBarry 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
5854325fc9f4SBarry Smith 
5855325fc9f4SBarry Smith    Logically Collective on TS
5856325fc9f4SBarry Smith 
5857325fc9f4SBarry Smith    Input Parameters:
5858cdcf91faSSean Farley +  ts - the TS context
5859325fc9f4SBarry Smith .  A,B - Jacobian matrices
5860325fc9f4SBarry Smith .  func - function evaluation routine
5861325fc9f4SBarry Smith -  ctx - user context
5862325fc9f4SBarry Smith 
5863325fc9f4SBarry Smith    Calling sequence of func:
58640910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
5865325fc9f4SBarry Smith 
5866325fc9f4SBarry Smith 
5867325fc9f4SBarry Smith    Level: developer
5868325fc9f4SBarry Smith 
5869325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5870325fc9f4SBarry Smith 
5871325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5872325fc9f4SBarry Smith */
5873cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
5874325fc9f4SBarry Smith {
5875325fc9f4SBarry Smith   PetscErrorCode  ierr;
5876325fc9f4SBarry Smith   TSMatlabContext *sctx;
5877325fc9f4SBarry Smith 
5878325fc9f4SBarry Smith   PetscFunctionBegin;
5879325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5880325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5881325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5882325fc9f4SBarry Smith   /*
5883325fc9f4SBarry Smith      This should work, but it doesn't
5884325fc9f4SBarry Smith   sctx->ctx = ctx;
5885325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5886325fc9f4SBarry Smith   */
5887325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5888bbd56ea5SKarl Rupp 
5889cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
5890325fc9f4SBarry Smith   PetscFunctionReturn(0);
5891325fc9f4SBarry Smith }
5892325fc9f4SBarry Smith 
5893b5b1a830SBarry Smith #undef __FUNCT__
5894b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
5895b5b1a830SBarry Smith /*
5896b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
5897b5b1a830SBarry Smith 
5898b5b1a830SBarry Smith    Collective on TS
5899b5b1a830SBarry Smith 
5900b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5901b5b1a830SBarry Smith @*/
59020910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
5903b5b1a830SBarry Smith {
5904b5b1a830SBarry Smith   PetscErrorCode  ierr;
5905b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5906a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
5907b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
5908b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
5909b5b1a830SBarry Smith 
5910b5b1a830SBarry Smith   PetscFunctionBegin;
5911cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
59120910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
5913b5b1a830SBarry Smith 
5914cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
59150910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5916bbd56ea5SKarl Rupp 
5917b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5918b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
5919b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
5920b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
5921b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
5922b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
5923b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
5924b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5925b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
5926b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
5927b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
5928b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
5929b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
5930b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
5931b5b1a830SBarry Smith   PetscFunctionReturn(0);
5932b5b1a830SBarry Smith }
5933b5b1a830SBarry Smith 
5934b5b1a830SBarry Smith 
5935b5b1a830SBarry Smith #undef __FUNCT__
5936b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
5937b5b1a830SBarry Smith /*
5938b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
5939b5b1a830SBarry Smith 
5940b5b1a830SBarry Smith    Level: developer
5941b5b1a830SBarry Smith 
5942b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
5943b5b1a830SBarry Smith 
5944b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5945b5b1a830SBarry Smith */
5946cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
5947b5b1a830SBarry Smith {
5948b5b1a830SBarry Smith   PetscErrorCode  ierr;
5949b5b1a830SBarry Smith   TSMatlabContext *sctx;
5950b5b1a830SBarry Smith 
5951b5b1a830SBarry Smith   PetscFunctionBegin;
5952b5b1a830SBarry Smith   /* currently sctx is memory bleed */
5953b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5954b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5955b5b1a830SBarry Smith   /*
5956b5b1a830SBarry Smith      This should work, but it doesn't
5957b5b1a830SBarry Smith   sctx->ctx = ctx;
5958b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5959b5b1a830SBarry Smith   */
5960b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5961bbd56ea5SKarl Rupp 
59620298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5963b5b1a830SBarry Smith   PetscFunctionReturn(0);
5964b5b1a830SBarry Smith }
5965325fc9f4SBarry Smith #endif
5966b3603a34SBarry Smith 
5967b3603a34SBarry Smith #undef __FUNCT__
59684f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
5969b3603a34SBarry Smith /*@C
59704f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5971b3603a34SBarry Smith        in a time based line graph
5972b3603a34SBarry Smith 
5973b3603a34SBarry Smith    Collective on TS
5974b3603a34SBarry Smith 
5975b3603a34SBarry Smith    Input Parameters:
5976b3603a34SBarry Smith +  ts - the TS context
5977b3603a34SBarry Smith .  step - current time-step
5978b3603a34SBarry Smith .  ptime - current time
59797db568b7SBarry Smith .  u - current solution
59807db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
5981b3603a34SBarry Smith 
5982b3d3934dSBarry Smith    Options Database:
59839ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
5984b3d3934dSBarry Smith 
5985b3603a34SBarry Smith    Level: intermediate
5986b3603a34SBarry Smith 
59876934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component solutions in a separate window
5988b3603a34SBarry Smith 
5989b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
5990b3603a34SBarry Smith 
59917db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
59927db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
59937db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
59947db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
5995b3603a34SBarry Smith @*/
59967db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
5997b3603a34SBarry Smith {
5998b3603a34SBarry Smith   PetscErrorCode    ierr;
59997db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
6000b3603a34SBarry Smith   const PetscScalar *yy;
600180666b62SBarry Smith   Vec               v;
6002b3603a34SBarry Smith 
6003b3603a34SBarry Smith   PetscFunctionBegin;
600458ff32f7SBarry Smith   if (!step) {
6005a9f9c1f6SBarry Smith     PetscDrawAxis axis;
60066934998bSLisandro Dalcin     PetscInt      dim;
6007a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6008a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
6009387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
6010387f4636SBarry Smith       char      **displaynames;
6011387f4636SBarry Smith       PetscBool flg;
6012387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6013387f4636SBarry Smith       ierr = PetscMalloc((dim+1)*sizeof(char*),&displaynames);CHKERRQ(ierr);
6014387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
6015c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
6016387f4636SBarry Smith       if (flg) {
6017a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
6018387f4636SBarry Smith       }
6019387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
6020387f4636SBarry Smith     }
6021387f4636SBarry Smith     if (ctx->displaynames) {
6022387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
6023387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
6024387f4636SBarry Smith     } else if (ctx->names) {
60250910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
60260b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6027387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
6028b0bc92c6SBarry Smith     } else {
6029b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6030b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6031387f4636SBarry Smith     }
60320b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
603358ff32f7SBarry Smith   }
60346934998bSLisandro Dalcin 
60356934998bSLisandro Dalcin   if (!ctx->transform) v = u;
60366934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
603780666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
60386934998bSLisandro Dalcin   if (ctx->displaynames) {
60396934998bSLisandro Dalcin     PetscInt i;
60406934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
60416934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
60426934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
60436934998bSLisandro Dalcin   } else {
6044e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6045e3efe391SJed Brown     PetscInt  i,n;
60466934998bSLisandro Dalcin     PetscReal *yreal;
604780666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
6048785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6049e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
60500b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6051e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6052e3efe391SJed Brown #else
60530b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6054e3efe391SJed Brown #endif
605580666b62SBarry Smith   }
60566934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
60576934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
60586934998bSLisandro Dalcin 
6059b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
60600b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
60616934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
60623923b477SBarry Smith   }
6063b3603a34SBarry Smith   PetscFunctionReturn(0);
6064b3603a34SBarry Smith }
6065b3603a34SBarry Smith 
6066387f4636SBarry Smith 
6067b3603a34SBarry Smith #undef __FUNCT__
606831152f8aSBarry Smith #define __FUNCT__ "TSMonitorLGSetVariableNames"
6069b037adc7SBarry Smith /*@C
607031152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6071b037adc7SBarry Smith 
6072b037adc7SBarry Smith    Collective on TS
6073b037adc7SBarry Smith 
6074b037adc7SBarry Smith    Input Parameters:
6075b037adc7SBarry Smith +  ts - the TS context
6076b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
6077b037adc7SBarry Smith 
6078b037adc7SBarry Smith    Level: intermediate
6079b037adc7SBarry Smith 
60807db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
60817db568b7SBarry Smith 
6082b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
6083b037adc7SBarry Smith 
6084a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
6085b037adc7SBarry Smith @*/
608631152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
6087b037adc7SBarry Smith {
6088b037adc7SBarry Smith   PetscErrorCode    ierr;
6089b037adc7SBarry Smith   PetscInt          i;
6090b037adc7SBarry Smith 
6091b037adc7SBarry Smith   PetscFunctionBegin;
6092b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6093b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
60945537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
6095b3d3934dSBarry Smith       break;
6096b3d3934dSBarry Smith     }
6097b3d3934dSBarry Smith   }
6098b3d3934dSBarry Smith   PetscFunctionReturn(0);
6099b3d3934dSBarry Smith }
6100b3d3934dSBarry Smith 
6101b3d3934dSBarry Smith #undef __FUNCT__
6102e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetVariableNames"
6103e673d494SBarry Smith /*@C
6104e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6105e673d494SBarry Smith 
6106e673d494SBarry Smith    Collective on TS
6107e673d494SBarry Smith 
6108e673d494SBarry Smith    Input Parameters:
6109e673d494SBarry Smith +  ts - the TS context
6110e673d494SBarry Smith -  names - the names of the components, final string must be NULL
6111e673d494SBarry Smith 
6112e673d494SBarry Smith    Level: intermediate
6113e673d494SBarry Smith 
6114e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6115e673d494SBarry Smith 
6116a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
6117e673d494SBarry Smith @*/
6118e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
6119e673d494SBarry Smith {
6120e673d494SBarry Smith   PetscErrorCode    ierr;
6121e673d494SBarry Smith 
6122e673d494SBarry Smith   PetscFunctionBegin;
6123e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
6124e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
6125e673d494SBarry Smith   PetscFunctionReturn(0);
6126e673d494SBarry Smith }
6127e673d494SBarry Smith 
6128e673d494SBarry Smith #undef __FUNCT__
6129b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorLGGetVariableNames"
6130b3d3934dSBarry Smith /*@C
6131b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
6132b3d3934dSBarry Smith 
6133b3d3934dSBarry Smith    Collective on TS
6134b3d3934dSBarry Smith 
6135b3d3934dSBarry Smith    Input Parameter:
6136b3d3934dSBarry Smith .  ts - the TS context
6137b3d3934dSBarry Smith 
6138b3d3934dSBarry Smith    Output Parameter:
6139b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
6140b3d3934dSBarry Smith 
6141b3d3934dSBarry Smith    Level: intermediate
6142b3d3934dSBarry Smith 
61437db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
61447db568b7SBarry Smith 
6145b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6146b3d3934dSBarry Smith 
6147b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6148b3d3934dSBarry Smith @*/
6149b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
6150b3d3934dSBarry Smith {
6151b3d3934dSBarry Smith   PetscInt       i;
6152b3d3934dSBarry Smith 
6153b3d3934dSBarry Smith   PetscFunctionBegin;
6154b3d3934dSBarry Smith   *names = NULL;
6155b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6156b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
61575537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
6158b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
6159b3d3934dSBarry Smith       break;
6160387f4636SBarry Smith     }
6161387f4636SBarry Smith   }
6162387f4636SBarry Smith   PetscFunctionReturn(0);
6163387f4636SBarry Smith }
6164387f4636SBarry Smith 
6165387f4636SBarry Smith #undef __FUNCT__
6166a66092f1SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables"
6167a66092f1SBarry Smith /*@C
6168a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
6169a66092f1SBarry Smith 
6170a66092f1SBarry Smith    Collective on TS
6171a66092f1SBarry Smith 
6172a66092f1SBarry Smith    Input Parameters:
6173a66092f1SBarry Smith +  ctx - the TSMonitorLG context
6174a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
6175a66092f1SBarry Smith 
6176a66092f1SBarry Smith    Level: intermediate
6177a66092f1SBarry Smith 
6178a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
6179a66092f1SBarry Smith 
6180a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6181a66092f1SBarry Smith @*/
6182a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6183a66092f1SBarry Smith {
6184a66092f1SBarry Smith   PetscInt          j = 0,k;
6185a66092f1SBarry Smith   PetscErrorCode    ierr;
6186a66092f1SBarry Smith 
6187a66092f1SBarry Smith   PetscFunctionBegin;
6188a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6189a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6190a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6191a66092f1SBarry Smith   while (displaynames[j]) j++;
6192a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6193a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6194a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6195a66092f1SBarry Smith   j = 0;
6196a66092f1SBarry Smith   while (displaynames[j]) {
6197a66092f1SBarry Smith     k = 0;
6198a66092f1SBarry Smith     while (ctx->names[k]) {
6199a66092f1SBarry Smith       PetscBool flg;
6200a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6201a66092f1SBarry Smith       if (flg) {
6202a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6203a66092f1SBarry Smith         break;
6204a66092f1SBarry Smith       }
6205a66092f1SBarry Smith       k++;
6206a66092f1SBarry Smith     }
6207a66092f1SBarry Smith     j++;
6208a66092f1SBarry Smith   }
6209a66092f1SBarry Smith   PetscFunctionReturn(0);
6210a66092f1SBarry Smith }
6211a66092f1SBarry Smith 
6212a66092f1SBarry Smith 
6213a66092f1SBarry Smith #undef __FUNCT__
6214387f4636SBarry Smith #define __FUNCT__ "TSMonitorLGSetDisplayVariables"
6215387f4636SBarry Smith /*@C
6216387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6217387f4636SBarry Smith 
6218387f4636SBarry Smith    Collective on TS
6219387f4636SBarry Smith 
6220387f4636SBarry Smith    Input Parameters:
6221387f4636SBarry Smith +  ts - the TS context
6222387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
6223387f4636SBarry Smith 
62247db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
62257db568b7SBarry Smith 
6226387f4636SBarry Smith    Level: intermediate
6227387f4636SBarry Smith 
6228387f4636SBarry Smith .keywords: TS,  vector, monitor, view
6229387f4636SBarry Smith 
6230387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6231387f4636SBarry Smith @*/
6232387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6233387f4636SBarry Smith {
6234a66092f1SBarry Smith   PetscInt          i;
6235387f4636SBarry Smith   PetscErrorCode    ierr;
6236387f4636SBarry Smith 
6237387f4636SBarry Smith   PetscFunctionBegin;
6238387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6239387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
62405537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6241b3d3934dSBarry Smith       break;
6242b037adc7SBarry Smith     }
6243b037adc7SBarry Smith   }
6244b037adc7SBarry Smith   PetscFunctionReturn(0);
6245b037adc7SBarry Smith }
6246b037adc7SBarry Smith 
6247b037adc7SBarry Smith #undef __FUNCT__
624880666b62SBarry Smith #define __FUNCT__ "TSMonitorLGSetTransform"
624980666b62SBarry Smith /*@C
625080666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
625180666b62SBarry Smith 
625280666b62SBarry Smith    Collective on TS
625380666b62SBarry Smith 
625480666b62SBarry Smith    Input Parameters:
625580666b62SBarry Smith +  ts - the TS context
625680666b62SBarry Smith .  transform - the transform function
62577684fa3eSBarry Smith .  destroy - function to destroy the optional context
625880666b62SBarry Smith -  ctx - optional context used by transform function
625980666b62SBarry Smith 
62607db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
62617db568b7SBarry Smith 
626280666b62SBarry Smith    Level: intermediate
626380666b62SBarry Smith 
626480666b62SBarry Smith .keywords: TS,  vector, monitor, view
626580666b62SBarry Smith 
6266a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
626780666b62SBarry Smith @*/
62687684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
626980666b62SBarry Smith {
627080666b62SBarry Smith   PetscInt          i;
6271a66092f1SBarry Smith   PetscErrorCode    ierr;
627280666b62SBarry Smith 
627380666b62SBarry Smith   PetscFunctionBegin;
627480666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
627580666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
62765537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
627780666b62SBarry Smith     }
627880666b62SBarry Smith   }
627980666b62SBarry Smith   PetscFunctionReturn(0);
628080666b62SBarry Smith }
628180666b62SBarry Smith 
628280666b62SBarry Smith #undef __FUNCT__
6283e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetTransform"
6284e673d494SBarry Smith /*@C
6285e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6286e673d494SBarry Smith 
6287e673d494SBarry Smith    Collective on TSLGCtx
6288e673d494SBarry Smith 
6289e673d494SBarry Smith    Input Parameters:
6290e673d494SBarry Smith +  ts - the TS context
6291e673d494SBarry Smith .  transform - the transform function
62927684fa3eSBarry Smith .  destroy - function to destroy the optional context
6293e673d494SBarry Smith -  ctx - optional context used by transform function
6294e673d494SBarry Smith 
6295e673d494SBarry Smith    Level: intermediate
6296e673d494SBarry Smith 
6297e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6298e673d494SBarry Smith 
6299a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6300e673d494SBarry Smith @*/
63017684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6302e673d494SBarry Smith {
6303e673d494SBarry Smith   PetscFunctionBegin;
6304e673d494SBarry Smith   ctx->transform    = transform;
63057684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6306e673d494SBarry Smith   ctx->transformctx = tctx;
6307e673d494SBarry Smith   PetscFunctionReturn(0);
6308e673d494SBarry Smith }
6309e673d494SBarry Smith 
6310b3603a34SBarry Smith #undef __FUNCT__
63114f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
6312ef20d060SBarry Smith /*@C
63134f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
6314ef20d060SBarry Smith        in a time based line graph
6315ef20d060SBarry Smith 
6316ef20d060SBarry Smith    Collective on TS
6317ef20d060SBarry Smith 
6318ef20d060SBarry Smith    Input Parameters:
6319ef20d060SBarry Smith +  ts - the TS context
6320ef20d060SBarry Smith .  step - current time-step
6321ef20d060SBarry Smith .  ptime - current time
63227db568b7SBarry Smith .  u - current solution
63237db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6324ef20d060SBarry Smith 
6325ef20d060SBarry Smith    Level: intermediate
6326ef20d060SBarry Smith 
63276934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component errors in a separate window
6328abd5a294SJed Brown 
6329abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6330abd5a294SJed Brown 
6331abd5a294SJed Brown    Options Database Keys:
63324f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6333ef20d060SBarry Smith 
6334ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
6335ef20d060SBarry Smith 
6336abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6337ef20d060SBarry Smith @*/
63380910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6339ef20d060SBarry Smith {
6340ef20d060SBarry Smith   PetscErrorCode    ierr;
63410b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6342ef20d060SBarry Smith   const PetscScalar *yy;
6343ef20d060SBarry Smith   Vec               y;
6344ef20d060SBarry Smith 
6345ef20d060SBarry Smith   PetscFunctionBegin;
6346a9f9c1f6SBarry Smith   if (!step) {
6347a9f9c1f6SBarry Smith     PetscDrawAxis axis;
63486934998bSLisandro Dalcin     PetscInt      dim;
6349a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
63501ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
63510910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6352a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6353a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6354a9f9c1f6SBarry Smith   }
63550910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6356ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
63570910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6358ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6359e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6360e3efe391SJed Brown   {
6361e3efe391SJed Brown     PetscReal *yreal;
6362e3efe391SJed Brown     PetscInt  i,n;
6363e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6364785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6365e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
63660b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6367e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6368e3efe391SJed Brown   }
6369e3efe391SJed Brown #else
63700b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6371e3efe391SJed Brown #endif
6372ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6373ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6374b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
63750b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
63766934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
63773923b477SBarry Smith   }
6378ef20d060SBarry Smith   PetscFunctionReturn(0);
6379ef20d060SBarry Smith }
6380ef20d060SBarry Smith 
6381201da799SBarry Smith #undef __FUNCT__
6382201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
6383201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6384201da799SBarry Smith {
6385201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6386201da799SBarry Smith   PetscReal      x   = ptime,y;
6387201da799SBarry Smith   PetscErrorCode ierr;
6388201da799SBarry Smith   PetscInt       its;
6389201da799SBarry Smith 
6390201da799SBarry Smith   PetscFunctionBegin;
6391201da799SBarry Smith   if (!n) {
6392201da799SBarry Smith     PetscDrawAxis axis;
6393201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6394201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
6395201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6396201da799SBarry Smith     ctx->snes_its = 0;
6397201da799SBarry Smith   }
6398201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
6399201da799SBarry Smith   y    = its - ctx->snes_its;
6400201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
64013fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6402201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
64036934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
6404201da799SBarry Smith   }
6405201da799SBarry Smith   ctx->snes_its = its;
6406201da799SBarry Smith   PetscFunctionReturn(0);
6407201da799SBarry Smith }
6408201da799SBarry Smith 
6409201da799SBarry Smith #undef __FUNCT__
6410201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
6411201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6412201da799SBarry Smith {
6413201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6414201da799SBarry Smith   PetscReal      x   = ptime,y;
6415201da799SBarry Smith   PetscErrorCode ierr;
6416201da799SBarry Smith   PetscInt       its;
6417201da799SBarry Smith 
6418201da799SBarry Smith   PetscFunctionBegin;
6419201da799SBarry Smith   if (!n) {
6420201da799SBarry Smith     PetscDrawAxis axis;
6421201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6422201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
6423201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6424201da799SBarry Smith     ctx->ksp_its = 0;
6425201da799SBarry Smith   }
6426201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
6427201da799SBarry Smith   y    = its - ctx->ksp_its;
6428201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
642999fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6430201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
64316934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
6432201da799SBarry Smith   }
6433201da799SBarry Smith   ctx->ksp_its = its;
6434201da799SBarry Smith   PetscFunctionReturn(0);
6435201da799SBarry Smith }
6436f9c1d6abSBarry Smith 
6437f9c1d6abSBarry Smith #undef __FUNCT__
6438f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
6439f9c1d6abSBarry Smith /*@
6440f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
6441f9c1d6abSBarry Smith 
6442f9c1d6abSBarry Smith    Collective on TS and Vec
6443f9c1d6abSBarry Smith 
6444f9c1d6abSBarry Smith    Input Parameters:
6445f9c1d6abSBarry Smith +  ts - the TS context
6446f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
6447f9c1d6abSBarry Smith 
6448f9c1d6abSBarry Smith    Output Parameters:
6449f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
6450f9c1d6abSBarry Smith 
6451f9c1d6abSBarry Smith    Level: developer
6452f9c1d6abSBarry Smith 
6453f9c1d6abSBarry Smith .keywords: TS, compute
6454f9c1d6abSBarry Smith 
6455f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
6456f9c1d6abSBarry Smith @*/
6457f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
6458f9c1d6abSBarry Smith {
6459f9c1d6abSBarry Smith   PetscErrorCode ierr;
6460f9c1d6abSBarry Smith 
6461f9c1d6abSBarry Smith   PetscFunctionBegin;
6462f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6463ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
6464f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
6465f9c1d6abSBarry Smith   PetscFunctionReturn(0);
6466f9c1d6abSBarry Smith }
646724655328SShri 
6468b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
6469b3d3934dSBarry Smith #undef __FUNCT__
6470b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxCreate"
6471b3d3934dSBarry Smith /*@C
6472b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
6473b3d3934dSBarry Smith 
6474b3d3934dSBarry Smith    Collective on TS
6475b3d3934dSBarry Smith 
6476b3d3934dSBarry Smith    Input Parameters:
6477b3d3934dSBarry Smith .  ts  - the ODE solver object
6478b3d3934dSBarry Smith 
6479b3d3934dSBarry Smith    Output Parameter:
6480b3d3934dSBarry Smith .  ctx - the context
6481b3d3934dSBarry Smith 
6482b3d3934dSBarry Smith    Level: intermediate
6483b3d3934dSBarry Smith 
6484b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
6485b3d3934dSBarry Smith 
6486b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
6487b3d3934dSBarry Smith 
6488b3d3934dSBarry Smith @*/
6489b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
6490b3d3934dSBarry Smith {
6491b3d3934dSBarry Smith   PetscErrorCode ierr;
6492b3d3934dSBarry Smith 
6493b3d3934dSBarry Smith   PetscFunctionBegin;
6494a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
6495b3d3934dSBarry Smith   PetscFunctionReturn(0);
6496b3d3934dSBarry Smith }
6497b3d3934dSBarry Smith 
6498b3d3934dSBarry Smith #undef __FUNCT__
6499b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelope"
6500b3d3934dSBarry Smith /*@C
6501b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
6502b3d3934dSBarry Smith 
6503b3d3934dSBarry Smith    Collective on TS
6504b3d3934dSBarry Smith 
6505b3d3934dSBarry Smith    Input Parameters:
6506b3d3934dSBarry Smith +  ts - the TS context
6507b3d3934dSBarry Smith .  step - current time-step
6508b3d3934dSBarry Smith .  ptime - current time
65097db568b7SBarry Smith .  u  - current solution
65107db568b7SBarry Smith -  dctx - the envelope context
6511b3d3934dSBarry Smith 
6512b3d3934dSBarry Smith    Options Database:
6513b3d3934dSBarry Smith .  -ts_monitor_envelope
6514b3d3934dSBarry Smith 
6515b3d3934dSBarry Smith    Level: intermediate
6516b3d3934dSBarry Smith 
6517b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
6518b3d3934dSBarry Smith 
6519b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6520b3d3934dSBarry Smith 
65217db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
6522b3d3934dSBarry Smith @*/
65237db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6524b3d3934dSBarry Smith {
6525b3d3934dSBarry Smith   PetscErrorCode       ierr;
65267db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
6527b3d3934dSBarry Smith 
6528b3d3934dSBarry Smith   PetscFunctionBegin;
6529b3d3934dSBarry Smith   if (!ctx->max) {
6530b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
6531b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
6532b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
6533b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
6534b3d3934dSBarry Smith   } else {
6535b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
6536b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
6537b3d3934dSBarry Smith   }
6538b3d3934dSBarry Smith   PetscFunctionReturn(0);
6539b3d3934dSBarry Smith }
6540b3d3934dSBarry Smith 
6541b3d3934dSBarry Smith 
6542b3d3934dSBarry Smith #undef __FUNCT__
6543b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeGetBounds"
6544b3d3934dSBarry Smith /*@C
6545b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
6546b3d3934dSBarry Smith 
6547b3d3934dSBarry Smith    Collective on TS
6548b3d3934dSBarry Smith 
6549b3d3934dSBarry Smith    Input Parameter:
6550b3d3934dSBarry Smith .  ts - the TS context
6551b3d3934dSBarry Smith 
6552b3d3934dSBarry Smith    Output Parameter:
6553b3d3934dSBarry Smith +  max - the maximum values
6554b3d3934dSBarry Smith -  min - the minimum values
6555b3d3934dSBarry Smith 
65567db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
65577db568b7SBarry Smith 
6558b3d3934dSBarry Smith    Level: intermediate
6559b3d3934dSBarry Smith 
6560b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6561b3d3934dSBarry Smith 
6562b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6563b3d3934dSBarry Smith @*/
6564b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
6565b3d3934dSBarry Smith {
6566b3d3934dSBarry Smith   PetscInt i;
6567b3d3934dSBarry Smith 
6568b3d3934dSBarry Smith   PetscFunctionBegin;
6569b3d3934dSBarry Smith   if (max) *max = NULL;
6570b3d3934dSBarry Smith   if (min) *min = NULL;
6571b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6572b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
65735537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
6574b3d3934dSBarry Smith       if (max) *max = ctx->max;
6575b3d3934dSBarry Smith       if (min) *min = ctx->min;
6576b3d3934dSBarry Smith       break;
6577b3d3934dSBarry Smith     }
6578b3d3934dSBarry Smith   }
6579b3d3934dSBarry Smith   PetscFunctionReturn(0);
6580b3d3934dSBarry Smith }
6581b3d3934dSBarry Smith 
6582b3d3934dSBarry Smith #undef __FUNCT__
6583b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy"
6584b3d3934dSBarry Smith /*@C
6585b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
6586b3d3934dSBarry Smith 
6587b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
6588b3d3934dSBarry Smith 
6589b3d3934dSBarry Smith    Input Parameter:
6590b3d3934dSBarry Smith .  ctx - the monitor context
6591b3d3934dSBarry Smith 
6592b3d3934dSBarry Smith    Level: intermediate
6593b3d3934dSBarry Smith 
6594b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
6595b3d3934dSBarry Smith 
65967db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
6597b3d3934dSBarry Smith @*/
6598b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
6599b3d3934dSBarry Smith {
6600b3d3934dSBarry Smith   PetscErrorCode ierr;
6601b3d3934dSBarry Smith 
6602b3d3934dSBarry Smith   PetscFunctionBegin;
6603b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
6604b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
6605b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
6606b3d3934dSBarry Smith   PetscFunctionReturn(0);
6607b3d3934dSBarry Smith }
6608f2dee214SBarry Smith 
660924655328SShri #undef __FUNCT__
661024655328SShri #define __FUNCT__ "TSRollBack"
661124655328SShri /*@
661224655328SShri    TSRollBack - Rolls back one time step
661324655328SShri 
661424655328SShri    Collective on TS
661524655328SShri 
661624655328SShri    Input Parameter:
661724655328SShri .  ts - the TS context obtained from TSCreate()
661824655328SShri 
661924655328SShri    Level: advanced
662024655328SShri 
662124655328SShri .keywords: TS, timestep, rollback
662224655328SShri 
662324655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
662424655328SShri @*/
662524655328SShri PetscErrorCode  TSRollBack(TS ts)
662624655328SShri {
662724655328SShri   PetscErrorCode ierr;
662824655328SShri 
662924655328SShri   PetscFunctionBegin;
663024655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
663124655328SShri 
663224655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
663324655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
663424655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
663524655328SShri   ts->ptime = ts->ptime_prev;
66368392e04aSShri Abhyankar   ts->steprollback = PETSC_TRUE; /* Flag to indicate that the step is rollbacked */
663724655328SShri   PetscFunctionReturn(0);
663824655328SShri }
6639aeb4809dSShri Abhyankar 
6640ff22ae23SHong Zhang #undef __FUNCT__
6641ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
6642ff22ae23SHong Zhang /*@
6643ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
6644ff22ae23SHong Zhang 
6645ff22ae23SHong Zhang    Input Parameter:
6646ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
6647ff22ae23SHong Zhang 
6648ff22ae23SHong Zhang    Level: advanced
6649ff22ae23SHong Zhang 
6650ff22ae23SHong Zhang .keywords: TS, getstages
6651ff22ae23SHong Zhang 
6652ff22ae23SHong Zhang .seealso: TSCreate()
6653ff22ae23SHong Zhang @*/
6654ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
6655ff22ae23SHong Zhang {
6656ff22ae23SHong Zhang   PetscErrorCode ierr;
6657ff22ae23SHong Zhang 
6658ff22ae23SHong Zhang   PetscFunctionBegin;
6659ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6660ff22ae23SHong Zhang   PetscValidPointer(ns,2);
6661ff22ae23SHong Zhang 
6662ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
6663ff22ae23SHong Zhang   else {
6664ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
6665ff22ae23SHong Zhang   }
6666ff22ae23SHong Zhang   PetscFunctionReturn(0);
6667ff22ae23SHong Zhang }
6668ff22ae23SHong Zhang 
6669847ff0e1SMatthew G. Knepley #undef __FUNCT__
6670847ff0e1SMatthew G. Knepley #define __FUNCT__ "TSComputeIJacobianDefaultColor"
6671847ff0e1SMatthew G. Knepley /*@C
6672847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
6673847ff0e1SMatthew G. Knepley 
6674847ff0e1SMatthew G. Knepley   Collective on SNES
6675847ff0e1SMatthew G. Knepley 
6676847ff0e1SMatthew G. Knepley   Input Parameters:
6677847ff0e1SMatthew G. Knepley + ts - the TS context
6678847ff0e1SMatthew G. Knepley . t - current timestep
6679847ff0e1SMatthew G. Knepley . U - state vector
6680847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
6681847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
6682847ff0e1SMatthew G. Knepley - ctx - an optional user context
6683847ff0e1SMatthew G. Knepley 
6684847ff0e1SMatthew G. Knepley   Output Parameters:
6685847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
6686847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
6687847ff0e1SMatthew G. Knepley 
6688847ff0e1SMatthew G. Knepley   Level: intermediate
6689847ff0e1SMatthew G. Knepley 
6690847ff0e1SMatthew G. Knepley   Notes:
6691847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
6692847ff0e1SMatthew G. Knepley 
6693847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
6694847ff0e1SMatthew G. Knepley 
6695847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
6696847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
6697847ff0e1SMatthew G. Knepley 
6698847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
6699847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
6700847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
6701847ff0e1SMatthew G. Knepley 
6702847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
6703847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
6704847ff0e1SMatthew G. Knepley @*/
6705847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
6706847ff0e1SMatthew G. Knepley {
6707847ff0e1SMatthew G. Knepley   SNES           snes;
6708847ff0e1SMatthew G. Knepley   MatFDColoring  color;
6709847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
6710847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
6711847ff0e1SMatthew G. Knepley 
6712847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
6713c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
6714847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
6715847ff0e1SMatthew G. Knepley   if (!color) {
6716847ff0e1SMatthew G. Knepley     DM         dm;
6717847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
6718847ff0e1SMatthew G. Knepley 
6719847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
6720847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
6721847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
6722847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
6723847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6724847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6725847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6726847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6727847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6728847ff0e1SMatthew G. Knepley     } else {
6729847ff0e1SMatthew G. Knepley       MatColoring mc;
6730847ff0e1SMatthew G. Knepley 
6731847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
6732847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
6733847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
6734847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
6735847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
6736847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
6737847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6738847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6739847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6740847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6741847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6742847ff0e1SMatthew G. Knepley     }
6743847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
6744847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
6745847ff0e1SMatthew G. Knepley   }
6746847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
6747847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
6748847ff0e1SMatthew G. Knepley   if (J != B) {
6749847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6750847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6751847ff0e1SMatthew G. Knepley   }
6752847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
6753847ff0e1SMatthew G. Knepley }
675493b34091SDebojyoti Ghosh 
675593b34091SDebojyoti Ghosh #undef __FUNCT__
6756cb9d8021SPierre Barbier de Reuille #define __FUNCT__ "TSSetFunctionDomainError"
6757cb9d8021SPierre Barbier de Reuille /*@
6758cb9d8021SPierre Barbier de Reuille     TSSetFunctionDomainError - Set the function testing if the current state vector is valid
6759cb9d8021SPierre Barbier de Reuille 
6760cb9d8021SPierre Barbier de Reuille     Input Parameters:
6761cb9d8021SPierre Barbier de Reuille     ts - the TS context
6762cb9d8021SPierre Barbier de Reuille     func - function called within TSFunctionDomainError
6763cb9d8021SPierre Barbier de Reuille 
6764cb9d8021SPierre Barbier de Reuille     Level: intermediate
6765cb9d8021SPierre Barbier de Reuille 
6766cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain
6767cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
6768cb9d8021SPierre Barbier de Reuille @*/
6769cb9d8021SPierre Barbier de Reuille 
6770d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
6771cb9d8021SPierre Barbier de Reuille {
6772cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
6773cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6774cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
6775cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
6776cb9d8021SPierre Barbier de Reuille }
6777cb9d8021SPierre Barbier de Reuille 
6778cb9d8021SPierre Barbier de Reuille #undef __FUNCT__
6779cb9d8021SPierre Barbier de Reuille #define __FUNCT__ "TSFunctionDomainError"
6780cb9d8021SPierre Barbier de Reuille /*@
6781cb9d8021SPierre Barbier de Reuille     TSFunctionDomainError - Check if the current state is valid
6782cb9d8021SPierre Barbier de Reuille 
6783cb9d8021SPierre Barbier de Reuille     Input Parameters:
6784cb9d8021SPierre Barbier de Reuille     ts - the TS context
6785cb9d8021SPierre Barbier de Reuille     stagetime - time of the simulation
6786d183316bSPierre Barbier de Reuille     Y - state vector to check.
6787cb9d8021SPierre Barbier de Reuille 
6788cb9d8021SPierre Barbier de Reuille     Output Parameter:
6789cb9d8021SPierre Barbier de Reuille     accept - Set to PETSC_FALSE if the current state vector is valid.
6790cb9d8021SPierre Barbier de Reuille 
6791cb9d8021SPierre Barbier de Reuille     Note:
6792cb9d8021SPierre Barbier de Reuille     This function should be used to ensure the state is in a valid part of the space.
6793cb9d8021SPierre Barbier de Reuille     For example, one can ensure here all values are positive.
679496a0c994SBarry Smith 
679596a0c994SBarry Smith     Level: advanced
6796cb9d8021SPierre Barbier de Reuille @*/
6797d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
6798cb9d8021SPierre Barbier de Reuille {
6799cb9d8021SPierre Barbier de Reuille   PetscErrorCode ierr;
6800cb9d8021SPierre Barbier de Reuille 
6801cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
6802cb9d8021SPierre Barbier de Reuille 
6803cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6804cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
6805cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
6806d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
6807cb9d8021SPierre Barbier de Reuille   }
6808cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
6809cb9d8021SPierre Barbier de Reuille }
68101ceb14c0SBarry Smith 
68111ceb14c0SBarry Smith #undef  __FUNCT__
6812e5168f73SEmil Constantinescu #define __FUNCT__ "TSClone"
681393b34091SDebojyoti Ghosh /*@C
6814e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
681593b34091SDebojyoti Ghosh 
681693b34091SDebojyoti Ghosh   Collective on MPI_Comm
681793b34091SDebojyoti Ghosh 
681893b34091SDebojyoti Ghosh   Input Parameter:
681993b34091SDebojyoti Ghosh . tsin    - The input TS
682093b34091SDebojyoti Ghosh 
682193b34091SDebojyoti Ghosh   Output Parameter:
6822e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
682393b34091SDebojyoti Ghosh 
68245eca1a21SEmil Constantinescu   Notes:
68255eca1a21SEmil 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.
68265eca1a21SEmil Constantinescu 
6827baa10174SEmil 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);
68285eca1a21SEmil Constantinescu 
68295eca1a21SEmil Constantinescu   Level: developer
683093b34091SDebojyoti Ghosh 
6831e5168f73SEmil Constantinescu .keywords: TS, clone
6832e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
683393b34091SDebojyoti Ghosh @*/
6834baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
683593b34091SDebojyoti Ghosh {
683693b34091SDebojyoti Ghosh   TS             t;
683793b34091SDebojyoti Ghosh   PetscErrorCode ierr;
6838dc846ba4SSatish Balay   SNES           snes_start;
6839dc846ba4SSatish Balay   DM             dm;
6840dc846ba4SSatish Balay   TSType         type;
684193b34091SDebojyoti Ghosh 
684293b34091SDebojyoti Ghosh   PetscFunctionBegin;
684393b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
684493b34091SDebojyoti Ghosh   *tsout = NULL;
684593b34091SDebojyoti Ghosh 
68467a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
684793b34091SDebojyoti Ghosh 
684893b34091SDebojyoti Ghosh   /* General TS description */
684993b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
685093b34091SDebojyoti Ghosh   t->setupcalled       = 0;
685193b34091SDebojyoti Ghosh   t->ksp_its           = 0;
685293b34091SDebojyoti Ghosh   t->snes_its          = 0;
685393b34091SDebojyoti Ghosh   t->nwork             = 0;
685493b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
685593b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
685693b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
685793b34091SDebojyoti Ghosh 
685834561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);                   CHKERRQ(ierr);
685934561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);                       CHKERRQ(ierr);
6860d15a3a53SEmil Constantinescu 
686193b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);                             CHKERRQ(ierr);
686293b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);                                 CHKERRQ(ierr);
686393b34091SDebojyoti Ghosh 
686493b34091SDebojyoti Ghosh   t->adapt=tsin->adapt;
686593b34091SDebojyoti Ghosh   PetscObjectReference((PetscObject)t->adapt);
686693b34091SDebojyoti Ghosh 
686793b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
686893b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
686993b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
687093b34091SDebojyoti Ghosh   t->time_step_orig    = tsin->time_step_orig;
687193b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
687293b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
687393b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
687493b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
687593b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
687693b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
687793b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
687893b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
687993b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
688093b34091SDebojyoti Ghosh 
688193b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type); CHKERRQ(ierr);
688293b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);     CHKERRQ(ierr);
688393b34091SDebojyoti Ghosh 
688493b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
688593b34091SDebojyoti Ghosh 
688693b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
688793b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
688893b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
688993b34091SDebojyoti Ghosh 
689093b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
689193b34091SDebojyoti Ghosh 
68920d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
68930d4fed19SBarry Smith     PetscInt i;
68940d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
68950d4fed19SBarry Smith     for (i=0; i<10; i++) {
68960d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
68970d4fed19SBarry Smith     }
68980d4fed19SBarry Smith   }
689993b34091SDebojyoti Ghosh   *tsout = t;
690093b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
690193b34091SDebojyoti Ghosh }
6902