xref: /petsc/src/ts/interface/ts.c (revision 780645306c45b558b8a77bd1a9880ce175fde594)
163dd3a1aSKris Buschelman 
2af0996ceSBarry Smith #include <petsc/private/tsimpl.h>        /*I "petscts.h"  I*/
3496e6a7aSJed Brown #include <petscdmshell.h>
41e25c274SJed Brown #include <petscdmda.h>
52d5ee99bSBarry Smith #include <petscviewer.h>
62d5ee99bSBarry Smith #include <petscdraw.h>
7d763cef2SBarry Smith 
8d5ba7fb7SMatthew Knepley /* Logging support */
9d74926cbSBarry Smith PetscClassId  TS_CLASSID, DMTS_CLASSID;
108d0ad7a8SHong Zhang PetscLogEvent TS_AdjointStep, TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
11d405a339SMatthew Knepley 
12feed9e9dSBarry Smith const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0};
1349354f04SShri Abhyankar 
142d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx {
152d5ee99bSBarry Smith   PetscViewer   viewer;
162d5ee99bSBarry Smith   Vec           initialsolution;
172d5ee99bSBarry Smith   PetscBool     showinitial;
182d5ee99bSBarry Smith   PetscInt      howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
192d5ee99bSBarry Smith   PetscBool     showtimestepandtime;
202d5ee99bSBarry Smith };
212d5ee99bSBarry Smith 
22bdad233fSMatthew Knepley #undef __FUNCT__
23fde5950dSBarry Smith #define __FUNCT__ "TSMonitorSetFromOptions"
24fde5950dSBarry Smith /*@C
25fde5950dSBarry Smith    TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
26fde5950dSBarry Smith 
27fde5950dSBarry Smith    Collective on TS
28fde5950dSBarry Smith 
29fde5950dSBarry Smith    Input Parameters:
30fde5950dSBarry Smith +  ts - TS object you wish to monitor
31fde5950dSBarry Smith .  name - the monitor type one is seeking
32fde5950dSBarry Smith .  help - message indicating what monitoring is done
33fde5950dSBarry Smith .  manual - manual page for the monitor
34fde5950dSBarry Smith .  monitor - the monitor function
35fde5950dSBarry Smith -  monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects
36fde5950dSBarry Smith 
37fde5950dSBarry Smith    Level: developer
38fde5950dSBarry Smith 
39fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
40fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
41fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
42fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
43fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
44fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
45fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
46fde5950dSBarry Smith @*/
47721cd6eeSBarry Smith PetscErrorCode  TSMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*))
48fde5950dSBarry Smith {
49fde5950dSBarry Smith   PetscErrorCode    ierr;
50fde5950dSBarry Smith   PetscViewer       viewer;
51fde5950dSBarry Smith   PetscViewerFormat format;
52fde5950dSBarry Smith   PetscBool         flg;
53fde5950dSBarry Smith 
54fde5950dSBarry Smith   PetscFunctionBegin;
55fde5950dSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
56fde5950dSBarry Smith   if (flg) {
57721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
58721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
59721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
60fde5950dSBarry Smith     if (monitorsetup) {
61721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
62fde5950dSBarry Smith     }
63721cd6eeSBarry Smith     ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr);
64fde5950dSBarry Smith   }
65fde5950dSBarry Smith   PetscFunctionReturn(0);
66fde5950dSBarry Smith }
67fde5950dSBarry Smith 
68fde5950dSBarry Smith #undef __FUNCT__
69fde5950dSBarry Smith #define __FUNCT__ "TSAdjointMonitorSetFromOptions"
70fde5950dSBarry Smith /*@C
71fde5950dSBarry Smith    TSAdjointMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
72fde5950dSBarry Smith 
73fde5950dSBarry Smith    Collective on TS
74fde5950dSBarry Smith 
75fde5950dSBarry Smith    Input Parameters:
76fde5950dSBarry Smith +  ts - TS object you wish to monitor
77fde5950dSBarry Smith .  name - the monitor type one is seeking
78fde5950dSBarry Smith .  help - message indicating what monitoring is done
79fde5950dSBarry Smith .  manual - manual page for the monitor
80fde5950dSBarry Smith .  monitor - the monitor function
81fde5950dSBarry Smith -  monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects
82fde5950dSBarry Smith 
83fde5950dSBarry Smith    Level: developer
84fde5950dSBarry Smith 
85fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
86fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
87fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
88fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
89fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
90fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
91fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
92fde5950dSBarry Smith @*/
93721cd6eeSBarry Smith PetscErrorCode  TSAdjointMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*))
94fde5950dSBarry Smith {
95fde5950dSBarry Smith   PetscErrorCode    ierr;
96fde5950dSBarry Smith   PetscViewer       viewer;
97fde5950dSBarry Smith   PetscViewerFormat format;
98fde5950dSBarry Smith   PetscBool         flg;
99fde5950dSBarry Smith 
100fde5950dSBarry Smith   PetscFunctionBegin;
101fde5950dSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
102fde5950dSBarry Smith   if (flg) {
103721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
104721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
105721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
106fde5950dSBarry Smith     if (monitorsetup) {
107721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
108fde5950dSBarry Smith     }
109721cd6eeSBarry Smith     ierr = TSAdjointMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr);
110fde5950dSBarry Smith   }
111fde5950dSBarry Smith   PetscFunctionReturn(0);
112fde5950dSBarry Smith }
113fde5950dSBarry Smith 
114fde5950dSBarry Smith #undef __FUNCT__
115bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions"
116bdad233fSMatthew Knepley /*@
117bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
118bdad233fSMatthew Knepley 
119bdad233fSMatthew Knepley    Collective on TS
120bdad233fSMatthew Knepley 
121bdad233fSMatthew Knepley    Input Parameter:
122bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
123bdad233fSMatthew Knepley 
124bdad233fSMatthew Knepley    Options Database Keys:
125cd11d68dSLisandro Dalcin +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, 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];
16731748224SBarry Smith   PetscReal              time_step;
16849354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
169d1212d36SBarry Smith   char                   dir[16];
170cd11d68dSLisandro Dalcin   TSIFunction            ifun;
1716991f827SBarry Smith   const char             *defaultType;
1726991f827SBarry Smith   char                   typeName[256];
173bdad233fSMatthew Knepley 
174bdad233fSMatthew Knepley   PetscFunctionBegin;
1750700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1766991f827SBarry Smith 
1776991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
178cd11d68dSLisandro Dalcin   ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
179cd11d68dSLisandro Dalcin 
180cd11d68dSLisandro Dalcin   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
181cd11d68dSLisandro Dalcin   if (((PetscObject)ts)->type_name)
182cd11d68dSLisandro Dalcin     defaultType = ((PetscObject)ts)->type_name;
183cd11d68dSLisandro Dalcin   else
184cd11d68dSLisandro Dalcin     defaultType = ifun ? TSBEULER : TSEULER;
1856991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr);
1866991f827SBarry Smith   if (opt) {
1876991f827SBarry Smith     ierr = TSSetType(ts,typeName);CHKERRQ(ierr);
1886991f827SBarry Smith   } else {
1896991f827SBarry Smith     ierr = TSSetType(ts,defaultType);CHKERRQ(ierr);
1906991f827SBarry Smith   }
191bdad233fSMatthew Knepley 
192bdad233fSMatthew Knepley   /* Handle generic TS options */
1930298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1940298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
1950298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
19631748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
197cd11d68dSLisandro Dalcin   if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);}
19849354f04SShri Abhyankar   ierr = PetscOptionsEnum("-ts_exact_final_time","Option for handling of final time step","TSSetExactFinalTime",TSExactFinalTimeOptions,(PetscEnum)ts->exact_final_time,(PetscEnum*)&eftopt,&flg);CHKERRQ(ierr);
19949354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
2000298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL);CHKERRQ(ierr);
2010298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
2020298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
2030298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
2040298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
205bdad233fSMatthew Knepley 
20656f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
20756f85f32SBarry Smith   {
20856f85f32SBarry Smith   PetscBool set;
20956f85f32SBarry Smith   flg  = PETSC_FALSE;
21056f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
21156f85f32SBarry Smith   if (set) {
21256f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
21356f85f32SBarry Smith   }
21456f85f32SBarry Smith   }
21556f85f32SBarry Smith #endif
21656f85f32SBarry Smith 
217bdad233fSMatthew Knepley   /* Monitor options */
218cd11d68dSLisandro Dalcin   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr);
219fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr);
220fde5950dSBarry Smith   ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);CHKERRQ(ierr);
221fde5950dSBarry Smith 
2225180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
2235180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
2245180491cSLisandro Dalcin 
2254f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
226b3603a34SBarry Smith   if (opt) {
2270b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2283923b477SBarry Smith     PetscInt       howoften = 1;
229b3603a34SBarry Smith 
2300298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
2316ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2324f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
233bdad233fSMatthew Knepley   }
2346ba87a44SLisandro Dalcin 
2354f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
236ef20d060SBarry Smith   if (opt) {
2370b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2383923b477SBarry Smith     PetscInt       howoften = 1;
239ef20d060SBarry Smith 
2400298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
2416ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2424f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
243ef20d060SBarry Smith   }
2446934998bSLisandro Dalcin 
2456934998bSLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2466934998bSLisandro Dalcin   if (opt) {
2476934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
2486934998bSLisandro Dalcin     PetscInt       howoften = 1;
2496934998bSLisandro Dalcin 
2506934998bSLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2516ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2526934998bSLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2536934998bSLisandro Dalcin   }
254201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
255201da799SBarry Smith   if (opt) {
256201da799SBarry Smith     TSMonitorLGCtx ctx;
257201da799SBarry Smith     PetscInt       howoften = 1;
258201da799SBarry Smith 
2590298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2606ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
261201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
262201da799SBarry Smith   }
263201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
264201da799SBarry Smith   if (opt) {
265201da799SBarry Smith     TSMonitorLGCtx ctx;
266201da799SBarry Smith     PetscInt       howoften = 1;
267201da799SBarry Smith 
2680298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2696ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
270201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
271201da799SBarry Smith   }
2728189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
2738189c53fSBarry Smith   if (opt) {
2748189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2758189c53fSBarry Smith     PetscInt          howoften = 1;
2768189c53fSBarry Smith 
2770298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
2786934998bSLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2798189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
2808189c53fSBarry Smith   }
281ef20d060SBarry Smith   opt  = PETSC_FALSE;
2820dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
283a7cc72afSBarry Smith   if (opt) {
28483a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
28583a4ac43SBarry Smith     PetscInt         howoften = 1;
286a80ad3e0SBarry Smith 
2870298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
2886934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
28983a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
290bdad233fSMatthew Knepley   }
291fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2929110b2e7SHong Zhang   ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr);
2939110b2e7SHong Zhang   if (opt) {
2949110b2e7SHong Zhang     TSMonitorDrawCtx ctx;
2959110b2e7SHong Zhang     PetscInt         howoften = 1;
2969110b2e7SHong Zhang 
2979110b2e7SHong Zhang     ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr);
2986934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2999110b2e7SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3009110b2e7SHong Zhang   }
3019110b2e7SHong Zhang   opt  = PETSC_FALSE;
3022d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
3032d5ee99bSBarry Smith   if (opt) {
3042d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
3052d5ee99bSBarry Smith     PetscReal        bounds[4];
3062d5ee99bSBarry Smith     PetscInt         n = 4;
3072d5ee99bSBarry Smith     PetscDraw        draw;
3086934998bSLisandro Dalcin     PetscDrawAxis    axis;
3092d5ee99bSBarry Smith 
3102d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
3112d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
3126934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr);
3132d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
3146934998bSLisandro Dalcin     ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr);
3156934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
3166934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
3172d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3182d5ee99bSBarry Smith   }
3192d5ee99bSBarry Smith   opt  = PETSC_FALSE;
3200dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
3213a471f94SBarry Smith   if (opt) {
32283a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
32383a4ac43SBarry Smith     PetscInt         howoften = 1;
3243a471f94SBarry Smith 
3250298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
3266934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
32783a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3283a471f94SBarry Smith   }
329fde5950dSBarry Smith 
330ed81e22dSJed Brown   opt  = PETSC_FALSE;
33191b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
332ed81e22dSJed Brown   if (flg) {
333ed81e22dSJed Brown     const char *ptr,*ptr2;
334ed81e22dSJed Brown     char       *filetemplate;
335ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
336ed81e22dSJed Brown     /* Do some cursory validation of the input. */
337ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
338ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
339ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
340ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
341ce94432eSBarry Smith       if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03D.vts");
342ed81e22dSJed Brown       if (ptr2) break;
343ed81e22dSJed Brown     }
344ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
345ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
346ed81e22dSJed Brown   }
347bdad233fSMatthew Knepley 
348d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
349d1212d36SBarry Smith   if (flg) {
350d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
351d1212d36SBarry Smith     int                  ray = 0;
352d1212d36SBarry Smith     DMDADirection        ddir;
353d1212d36SBarry Smith     DM                   da;
354d1212d36SBarry Smith     PetscMPIInt          rank;
355d1212d36SBarry Smith 
356ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
357d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
358d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
359ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
360d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
361d1212d36SBarry Smith 
362d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
363b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
364d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
365d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
366ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
367d1212d36SBarry Smith     if (!rank) {
368d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
369d1212d36SBarry Smith     }
37051b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
371d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
372d1212d36SBarry Smith   }
37351b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
37451b4a12fSMatthew G. Knepley   if (flg) {
37551b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
37651b4a12fSMatthew G. Knepley     int                 ray = 0;
37751b4a12fSMatthew G. Knepley     DMDADirection       ddir;
37851b4a12fSMatthew G. Knepley     DM                  da;
37951b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
380d1212d36SBarry Smith 
38151b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
38251b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
38351b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
38451b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
38551b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3861c3436cfSJed Brown 
38751b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
388b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
38951b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
39051b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
39151b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
39251b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
39351b4a12fSMatthew G. Knepley   }
394a7a1495cSBarry Smith 
395b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
396b3d3934dSBarry Smith   if (opt) {
397b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
398b3d3934dSBarry Smith 
399b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
400b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
401b3d3934dSBarry Smith   }
402b3d3934dSBarry Smith 
403847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
404847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
405847ff0e1SMatthew G. Knepley   if (flg) {
406847ff0e1SMatthew G. Knepley     DM   dm;
407847ff0e1SMatthew G. Knepley     DMTS tdm;
408847ff0e1SMatthew G. Knepley 
409847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
410847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
411847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
412847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
413847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
414847ff0e1SMatthew G. Knepley   }
415847ff0e1SMatthew G. Knepley 
416ee346746SBarry Smith   if (ts->adapt) {
417ee346746SBarry Smith     ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr);
418ee346746SBarry Smith   }
419d763cef2SBarry Smith 
420d763cef2SBarry Smith   /* Handle specific TS options */
421d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
4226991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
423d763cef2SBarry Smith   }
424fbc52257SHong Zhang 
42568bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
4264f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
42768bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
42868bece0bSHong Zhang   if (tflg) {
42968bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
43068bece0bSHong Zhang   }
4314f122a70SLisandro Dalcin   tflg = ts->adjoint_solve ? PETSC_TRUE : PETSC_FALSE;
43268bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
43368bece0bSHong Zhang   if (flg) {
43468bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
43568bece0bSHong Zhang     ts->adjoint_solve = tflg;
43668bece0bSHong Zhang   }
437d763cef2SBarry Smith 
438d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
4390633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
440fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
441d763cef2SBarry Smith 
4424f122a70SLisandro Dalcin   if (ts->trajectory) {
4434f122a70SLisandro Dalcin     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
444d763cef2SBarry Smith   }
44568bece0bSHong Zhang 
4464f122a70SLisandro Dalcin   ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr);
4474f122a70SLisandro Dalcin   if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);}
4484f122a70SLisandro Dalcin   ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
449d763cef2SBarry Smith   PetscFunctionReturn(0);
450d763cef2SBarry Smith }
451d763cef2SBarry Smith 
452d763cef2SBarry Smith #undef __FUNCT__
453bc952696SBarry Smith #define __FUNCT__ "TSSetSaveTrajectory"
454d2daff3dSHong Zhang /*@
455bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
456d2daff3dSHong Zhang 
457d2daff3dSHong Zhang    Collective on TS
458d2daff3dSHong Zhang 
459d2daff3dSHong Zhang    Input Parameters:
460bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
461bc952696SBarry Smith 
46268bece0bSHong Zhang Note: This routine should be called after all TS options have been set
463d2daff3dSHong Zhang 
464d2daff3dSHong Zhang    Level: intermediate
465d2daff3dSHong Zhang 
466bc952696SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve()
467d2daff3dSHong Zhang 
468bc952696SBarry Smith .keywords: TS, set, checkpoint,
469d2daff3dSHong Zhang @*/
470bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
471d2daff3dSHong Zhang {
472bc952696SBarry Smith   PetscErrorCode ierr;
473bc952696SBarry Smith 
474d2daff3dSHong Zhang   PetscFunctionBegin;
475d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
476bc952696SBarry Smith   if (!ts->trajectory) {
477bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
478972caf09SHong Zhang     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
479bc952696SBarry Smith   }
480d2daff3dSHong Zhang   PetscFunctionReturn(0);
481d2daff3dSHong Zhang }
482d2daff3dSHong Zhang 
483a7a1495cSBarry Smith #undef __FUNCT__
484a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
485a7a1495cSBarry Smith /*@
486a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
487a7a1495cSBarry Smith       set with TSSetRHSJacobian().
488a7a1495cSBarry Smith 
489a7a1495cSBarry Smith    Collective on TS and Vec
490a7a1495cSBarry Smith 
491a7a1495cSBarry Smith    Input Parameters:
492316643e7SJed Brown +  ts - the TS context
493a7a1495cSBarry Smith .  t - current timestep
4940910c330SBarry Smith -  U - input vector
495a7a1495cSBarry Smith 
496a7a1495cSBarry Smith    Output Parameters:
497a7a1495cSBarry Smith +  A - Jacobian matrix
498a7a1495cSBarry Smith .  B - optional preconditioning matrix
499a7a1495cSBarry Smith -  flag - flag indicating matrix structure
500a7a1495cSBarry Smith 
501a7a1495cSBarry Smith    Notes:
502a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
503a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
504a7a1495cSBarry Smith 
50594b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
506a7a1495cSBarry Smith    flag parameter.
507a7a1495cSBarry Smith 
508a7a1495cSBarry Smith    Level: developer
509a7a1495cSBarry Smith 
510a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
511a7a1495cSBarry Smith 
51294b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
513a7a1495cSBarry Smith @*/
514d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
515a7a1495cSBarry Smith {
516dfbe8321SBarry Smith   PetscErrorCode ierr;
517270bf2e7SJed Brown   PetscObjectState Ustate;
51824989b8cSPeter Brune   DM             dm;
519942e3340SBarry Smith   DMTS           tsdm;
52024989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
52124989b8cSPeter Brune   void           *ctx;
52224989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
523b2df71adSDebojyoti Ghosh   TSRHSFunction  rhsfunction;
524a7a1495cSBarry Smith 
525a7a1495cSBarry Smith   PetscFunctionBegin;
5260700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5270910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5280910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
52924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
530942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
53124989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
5320298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
533b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
53459e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
535b2df71adSDebojyoti Ghosh   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
5360e4ef248SJed Brown     PetscFunctionReturn(0);
537f8ede8e7SJed Brown   }
538d90be118SSean Farley 
539ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
540d90be118SSean Farley 
541e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
54294ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
54394ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
54494ab13aaSBarry Smith     if (A != B) {
54594ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
54694ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
547e1244c69SJed Brown     }
548e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
549e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
550e1244c69SJed Brown   }
551e1244c69SJed Brown 
55224989b8cSPeter Brune   if (rhsjacobianfunc) {
5536cd88445SBarry Smith     PetscBool missing;
55494ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
555a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
556d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
557a7a1495cSBarry Smith     PetscStackPop;
55894ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
5596cd88445SBarry Smith     if (A) {
5606cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
5616cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
5626cd88445SBarry Smith     }
5636cd88445SBarry Smith     if (B && B != A) {
5646cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
5656cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
5666cd88445SBarry Smith     }
567ef66eb69SBarry Smith   } else {
56894ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
56994ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
570ef66eb69SBarry Smith   }
5710e4ef248SJed Brown   ts->rhsjacobian.time       = t;
5720910c330SBarry Smith   ts->rhsjacobian.X          = U;
57359e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
574a7a1495cSBarry Smith   PetscFunctionReturn(0);
575a7a1495cSBarry Smith }
576a7a1495cSBarry Smith 
5774a2ae208SSatish Balay #undef __FUNCT__
5784a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
579316643e7SJed Brown /*@
580d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
581d763cef2SBarry Smith 
582316643e7SJed Brown    Collective on TS and Vec
583316643e7SJed Brown 
584316643e7SJed Brown    Input Parameters:
585316643e7SJed Brown +  ts - the TS context
586316643e7SJed Brown .  t - current time
5870910c330SBarry Smith -  U - state vector
588316643e7SJed Brown 
589316643e7SJed Brown    Output Parameter:
590316643e7SJed Brown .  y - right hand side
591316643e7SJed Brown 
592316643e7SJed Brown    Note:
593316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
594316643e7SJed Brown    is used internally within the nonlinear solvers.
595316643e7SJed Brown 
596316643e7SJed Brown    Level: developer
597316643e7SJed Brown 
598316643e7SJed Brown .keywords: TS, compute
599316643e7SJed Brown 
600316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
601316643e7SJed Brown @*/
6020910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
603d763cef2SBarry Smith {
604dfbe8321SBarry Smith   PetscErrorCode ierr;
60524989b8cSPeter Brune   TSRHSFunction  rhsfunction;
60624989b8cSPeter Brune   TSIFunction    ifunction;
60724989b8cSPeter Brune   void           *ctx;
60824989b8cSPeter Brune   DM             dm;
60924989b8cSPeter Brune 
610d763cef2SBarry Smith   PetscFunctionBegin;
6110700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6120910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6130700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
61424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
61524989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
6160298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
617d763cef2SBarry Smith 
618ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
619d763cef2SBarry Smith 
6200910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
62124989b8cSPeter Brune   if (rhsfunction) {
622d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
6230910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
624d763cef2SBarry Smith     PetscStackPop;
625214bc6a2SJed Brown   } else {
626214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
627b2cd27e8SJed Brown   }
62844a41b28SSean Farley 
6290910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
630d763cef2SBarry Smith   PetscFunctionReturn(0);
631d763cef2SBarry Smith }
632d763cef2SBarry Smith 
6334a2ae208SSatish Balay #undef __FUNCT__
634ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
635ef20d060SBarry Smith /*@
636ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
637ef20d060SBarry Smith 
638ef20d060SBarry Smith    Collective on TS and Vec
639ef20d060SBarry Smith 
640ef20d060SBarry Smith    Input Parameters:
641ef20d060SBarry Smith +  ts - the TS context
642ef20d060SBarry Smith -  t - current time
643ef20d060SBarry Smith 
644ef20d060SBarry Smith    Output Parameter:
6450910c330SBarry Smith .  U - the solution
646ef20d060SBarry Smith 
647ef20d060SBarry Smith    Note:
648ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
649ef20d060SBarry Smith    is used internally within the nonlinear solvers.
650ef20d060SBarry Smith 
651ef20d060SBarry Smith    Level: developer
652ef20d060SBarry Smith 
653ef20d060SBarry Smith .keywords: TS, compute
654ef20d060SBarry Smith 
655abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
656ef20d060SBarry Smith @*/
6570910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
658ef20d060SBarry Smith {
659ef20d060SBarry Smith   PetscErrorCode     ierr;
660ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
661ef20d060SBarry Smith   void               *ctx;
662ef20d060SBarry Smith   DM                 dm;
663ef20d060SBarry Smith 
664ef20d060SBarry Smith   PetscFunctionBegin;
665ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6660910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
667ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
668ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
669ef20d060SBarry Smith 
670ef20d060SBarry Smith   if (solutionfunction) {
6719b7cd975SBarry Smith     PetscStackPush("TS user solution function");
6720910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
673ef20d060SBarry Smith     PetscStackPop;
674ef20d060SBarry Smith   }
675ef20d060SBarry Smith   PetscFunctionReturn(0);
676ef20d060SBarry Smith }
6779b7cd975SBarry Smith #undef __FUNCT__
6789b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
6799b7cd975SBarry Smith /*@
6809b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
6819b7cd975SBarry Smith 
6829b7cd975SBarry Smith    Collective on TS and Vec
6839b7cd975SBarry Smith 
6849b7cd975SBarry Smith    Input Parameters:
6859b7cd975SBarry Smith +  ts - the TS context
6869b7cd975SBarry Smith -  t - current time
6879b7cd975SBarry Smith 
6889b7cd975SBarry Smith    Output Parameter:
6899b7cd975SBarry Smith .  U - the function value
6909b7cd975SBarry Smith 
6919b7cd975SBarry Smith    Note:
6929b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
6939b7cd975SBarry Smith    is used internally within the nonlinear solvers.
6949b7cd975SBarry Smith 
6959b7cd975SBarry Smith    Level: developer
6969b7cd975SBarry Smith 
6979b7cd975SBarry Smith .keywords: TS, compute
6989b7cd975SBarry Smith 
6999b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7009b7cd975SBarry Smith @*/
7019b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7029b7cd975SBarry Smith {
7039b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7049b7cd975SBarry Smith   void               *ctx;
7059b7cd975SBarry Smith   DM                 dm;
7069b7cd975SBarry Smith 
7079b7cd975SBarry Smith   PetscFunctionBegin;
7089b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7099b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7109b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7119b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7129b7cd975SBarry Smith 
7139b7cd975SBarry Smith   if (forcing) {
7149b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
7159b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
7169b7cd975SBarry Smith     PetscStackPop;
7179b7cd975SBarry Smith   }
7189b7cd975SBarry Smith   PetscFunctionReturn(0);
7199b7cd975SBarry Smith }
720ef20d060SBarry Smith 
721ef20d060SBarry Smith #undef __FUNCT__
722214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
723214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
724214bc6a2SJed Brown {
7252dd45cf8SJed Brown   Vec            F;
726214bc6a2SJed Brown   PetscErrorCode ierr;
727214bc6a2SJed Brown 
728214bc6a2SJed Brown   PetscFunctionBegin;
7290298fd71SBarry Smith   *Frhs = NULL;
7300298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
731214bc6a2SJed Brown   if (!ts->Frhs) {
7322dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
733214bc6a2SJed Brown   }
734214bc6a2SJed Brown   *Frhs = ts->Frhs;
735214bc6a2SJed Brown   PetscFunctionReturn(0);
736214bc6a2SJed Brown }
737214bc6a2SJed Brown 
738214bc6a2SJed Brown #undef __FUNCT__
739214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
740214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
741214bc6a2SJed Brown {
742214bc6a2SJed Brown   Mat            A,B;
7432dd45cf8SJed Brown   PetscErrorCode ierr;
744214bc6a2SJed Brown 
745214bc6a2SJed Brown   PetscFunctionBegin;
746c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
747c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
7480298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
749214bc6a2SJed Brown   if (Arhs) {
750214bc6a2SJed Brown     if (!ts->Arhs) {
751214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
752214bc6a2SJed Brown     }
753214bc6a2SJed Brown     *Arhs = ts->Arhs;
754214bc6a2SJed Brown   }
755214bc6a2SJed Brown   if (Brhs) {
756214bc6a2SJed Brown     if (!ts->Brhs) {
757bdb70873SJed Brown       if (A != B) {
758214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
759bdb70873SJed Brown       } else {
760bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
76151699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
762bdb70873SJed Brown       }
763214bc6a2SJed Brown     }
764214bc6a2SJed Brown     *Brhs = ts->Brhs;
765214bc6a2SJed Brown   }
766214bc6a2SJed Brown   PetscFunctionReturn(0);
767214bc6a2SJed Brown }
768214bc6a2SJed Brown 
769214bc6a2SJed Brown #undef __FUNCT__
770316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
771316643e7SJed Brown /*@
7720910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
773316643e7SJed Brown 
774316643e7SJed Brown    Collective on TS and Vec
775316643e7SJed Brown 
776316643e7SJed Brown    Input Parameters:
777316643e7SJed Brown +  ts - the TS context
778316643e7SJed Brown .  t - current time
7790910c330SBarry Smith .  U - state vector
7800910c330SBarry Smith .  Udot - time derivative of state vector
781214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
782316643e7SJed Brown 
783316643e7SJed Brown    Output Parameter:
784316643e7SJed Brown .  Y - right hand side
785316643e7SJed Brown 
786316643e7SJed Brown    Note:
787316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
788316643e7SJed Brown    is used internally within the nonlinear solvers.
789316643e7SJed Brown 
790316643e7SJed Brown    If the user did did not write their equations in implicit form, this
791316643e7SJed Brown    function recasts them in implicit form.
792316643e7SJed Brown 
793316643e7SJed Brown    Level: developer
794316643e7SJed Brown 
795316643e7SJed Brown .keywords: TS, compute
796316643e7SJed Brown 
797316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
798316643e7SJed Brown @*/
7990910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
800316643e7SJed Brown {
801316643e7SJed Brown   PetscErrorCode ierr;
80224989b8cSPeter Brune   TSIFunction    ifunction;
80324989b8cSPeter Brune   TSRHSFunction  rhsfunction;
80424989b8cSPeter Brune   void           *ctx;
80524989b8cSPeter Brune   DM             dm;
806316643e7SJed Brown 
807316643e7SJed Brown   PetscFunctionBegin;
8080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8090910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8100910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
8110700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
812316643e7SJed Brown 
81324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
81424989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
8150298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
81624989b8cSPeter Brune 
817ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
818d90be118SSean Farley 
8190910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
82024989b8cSPeter Brune   if (ifunction) {
821316643e7SJed Brown     PetscStackPush("TS user implicit function");
8220910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
823316643e7SJed Brown     PetscStackPop;
824214bc6a2SJed Brown   }
825214bc6a2SJed Brown   if (imex) {
82624989b8cSPeter Brune     if (!ifunction) {
8270910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
8282dd45cf8SJed Brown     }
82924989b8cSPeter Brune   } else if (rhsfunction) {
83024989b8cSPeter Brune     if (ifunction) {
831214bc6a2SJed Brown       Vec Frhs;
832214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
8330910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
834214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
8352dd45cf8SJed Brown     } else {
8360910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
8370910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
838316643e7SJed Brown     }
8394a6899ffSJed Brown   }
8400910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
841316643e7SJed Brown   PetscFunctionReturn(0);
842316643e7SJed Brown }
843316643e7SJed Brown 
844316643e7SJed Brown #undef __FUNCT__
845316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
846316643e7SJed Brown /*@
847316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
848316643e7SJed Brown 
849316643e7SJed Brown    Collective on TS and Vec
850316643e7SJed Brown 
851316643e7SJed Brown    Input
852316643e7SJed Brown       Input Parameters:
853316643e7SJed Brown +  ts - the TS context
854316643e7SJed Brown .  t - current timestep
8550910c330SBarry Smith .  U - state vector
8560910c330SBarry Smith .  Udot - time derivative of state vector
857214bc6a2SJed Brown .  shift - shift to apply, see note below
858214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
859316643e7SJed Brown 
860316643e7SJed Brown    Output Parameters:
861316643e7SJed Brown +  A - Jacobian matrix
862316643e7SJed Brown .  B - optional preconditioning matrix
863316643e7SJed Brown -  flag - flag indicating matrix structure
864316643e7SJed Brown 
865316643e7SJed Brown    Notes:
8660910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
867316643e7SJed Brown 
8680910c330SBarry Smith    dF/dU + shift*dF/dUdot
869316643e7SJed Brown 
870316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
871316643e7SJed Brown    is used internally within the nonlinear solvers.
872316643e7SJed Brown 
873316643e7SJed Brown    Level: developer
874316643e7SJed Brown 
875316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
876316643e7SJed Brown 
877316643e7SJed Brown .seealso:  TSSetIJacobian()
87863495f91SJed Brown @*/
879d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
880316643e7SJed Brown {
881316643e7SJed Brown   PetscErrorCode ierr;
88224989b8cSPeter Brune   TSIJacobian    ijacobian;
88324989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
88424989b8cSPeter Brune   DM             dm;
88524989b8cSPeter Brune   void           *ctx;
886316643e7SJed Brown 
887316643e7SJed Brown   PetscFunctionBegin;
8880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8890910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8900910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
891316643e7SJed Brown   PetscValidPointer(A,6);
89294ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
893316643e7SJed Brown   PetscValidPointer(B,7);
89494ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
89524989b8cSPeter Brune 
89624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
89724989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
8980298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
89924989b8cSPeter Brune 
900ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
901316643e7SJed Brown 
90294ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
90324989b8cSPeter Brune   if (ijacobian) {
9046cd88445SBarry Smith     PetscBool missing;
905316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
906d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
907316643e7SJed Brown     PetscStackPop;
9086cd88445SBarry Smith     if (A) {
9096cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
9106cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
9116cd88445SBarry Smith     }
9126cd88445SBarry Smith     if (B && B != A) {
9136cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
9146cd88445SBarry Smith       if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
9156cd88445SBarry Smith     }
9164a6899ffSJed Brown   }
917214bc6a2SJed Brown   if (imex) {
918b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
91994ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
92094ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
92194ab13aaSBarry Smith       if (A != B) {
92294ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
92394ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
924214bc6a2SJed Brown       }
925214bc6a2SJed Brown     }
926214bc6a2SJed Brown   } else {
927e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
928e1244c69SJed Brown     if (rhsjacobian) {
929214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
930d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
931e1244c69SJed Brown     }
93294ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
933e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
934e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
93594ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
93694ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
93794ab13aaSBarry Smith       if (A != B) {
93894ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
93994ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
940316643e7SJed Brown       }
941e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
942e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
943e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
94494ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
94594ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
94694ab13aaSBarry Smith         if (A != B) {
94794ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
94894ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
949214bc6a2SJed Brown         }
950316643e7SJed Brown       }
95194ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
95294ab13aaSBarry Smith       if (A != B) {
95394ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
954316643e7SJed Brown       }
955316643e7SJed Brown     }
956316643e7SJed Brown   }
95794ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
958316643e7SJed Brown   PetscFunctionReturn(0);
959316643e7SJed Brown }
960316643e7SJed Brown 
961316643e7SJed Brown #undef __FUNCT__
9624a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
963d763cef2SBarry Smith /*@C
964d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
965b5abc632SBarry Smith     where U_t = G(t,u).
966d763cef2SBarry Smith 
9673f9fe445SBarry Smith     Logically Collective on TS
968d763cef2SBarry Smith 
969d763cef2SBarry Smith     Input Parameters:
970d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
9710298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
972d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
973d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
9740298fd71SBarry Smith           function evaluation routine (may be NULL)
975d763cef2SBarry Smith 
976d763cef2SBarry Smith     Calling sequence of func:
97787828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
978d763cef2SBarry Smith 
979d763cef2SBarry Smith +   t - current timestep
980d763cef2SBarry Smith .   u - input vector
981d763cef2SBarry Smith .   F - function vector
982d763cef2SBarry Smith -   ctx - [optional] user-defined function context
983d763cef2SBarry Smith 
984d763cef2SBarry Smith     Level: beginner
985d763cef2SBarry Smith 
9862bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
9872bbac0d3SBarry Smith 
988d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
989d763cef2SBarry Smith 
990ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
991d763cef2SBarry Smith @*/
992089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
993d763cef2SBarry Smith {
994089b2837SJed Brown   PetscErrorCode ierr;
995089b2837SJed Brown   SNES           snes;
9960298fd71SBarry Smith   Vec            ralloc = NULL;
99724989b8cSPeter Brune   DM             dm;
998d763cef2SBarry Smith 
999089b2837SJed Brown   PetscFunctionBegin;
10000700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1001ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
100224989b8cSPeter Brune 
100324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
100424989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1005089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1006e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1007e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1008e856ceecSJed Brown     r = ralloc;
1009e856ceecSJed Brown   }
1010089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1011e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1012d763cef2SBarry Smith   PetscFunctionReturn(0);
1013d763cef2SBarry Smith }
1014d763cef2SBarry Smith 
10154a2ae208SSatish Balay #undef __FUNCT__
1016ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
1017ef20d060SBarry Smith /*@C
1018abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1019ef20d060SBarry Smith 
1020ef20d060SBarry Smith     Logically Collective on TS
1021ef20d060SBarry Smith 
1022ef20d060SBarry Smith     Input Parameters:
1023ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1024ef20d060SBarry Smith .   f - routine for evaluating the solution
1025ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
10260298fd71SBarry Smith           function evaluation routine (may be NULL)
1027ef20d060SBarry Smith 
1028ef20d060SBarry Smith     Calling sequence of func:
1029ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
1030ef20d060SBarry Smith 
1031ef20d060SBarry Smith +   t - current timestep
1032ef20d060SBarry Smith .   u - output vector
1033ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1034ef20d060SBarry Smith 
1035abd5a294SJed Brown     Notes:
1036abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1037abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1038abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1039abd5a294SJed Brown 
10404f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1041abd5a294SJed Brown 
1042ef20d060SBarry Smith     Level: beginner
1043ef20d060SBarry Smith 
1044ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1045ef20d060SBarry Smith 
10469b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
1047ef20d060SBarry Smith @*/
1048ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1049ef20d060SBarry Smith {
1050ef20d060SBarry Smith   PetscErrorCode ierr;
1051ef20d060SBarry Smith   DM             dm;
1052ef20d060SBarry Smith 
1053ef20d060SBarry Smith   PetscFunctionBegin;
1054ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1055ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1056ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1057ef20d060SBarry Smith   PetscFunctionReturn(0);
1058ef20d060SBarry Smith }
1059ef20d060SBarry Smith 
1060ef20d060SBarry Smith #undef __FUNCT__
10619b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
10629b7cd975SBarry Smith /*@C
10639b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
10649b7cd975SBarry Smith 
10659b7cd975SBarry Smith     Logically Collective on TS
10669b7cd975SBarry Smith 
10679b7cd975SBarry Smith     Input Parameters:
10689b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
10699b7cd975SBarry Smith .   f - routine for evaluating the forcing function
10709b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
10710298fd71SBarry Smith           function evaluation routine (may be NULL)
10729b7cd975SBarry Smith 
10739b7cd975SBarry Smith     Calling sequence of func:
10749b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
10759b7cd975SBarry Smith 
10769b7cd975SBarry Smith +   t - current timestep
10779b7cd975SBarry Smith .   u - output vector
10789b7cd975SBarry Smith -   ctx - [optional] user-defined function context
10799b7cd975SBarry Smith 
10809b7cd975SBarry Smith     Notes:
10819b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
10829b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
10839b7cd975SBarry Smith 
10849b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
10859b7cd975SBarry Smith 
10869b7cd975SBarry Smith     Level: beginner
10879b7cd975SBarry Smith 
10889b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
10899b7cd975SBarry Smith 
10909b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
10919b7cd975SBarry Smith @*/
1092d56366bfSLisandro Dalcin PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction f,void *ctx)
10939b7cd975SBarry Smith {
10949b7cd975SBarry Smith   PetscErrorCode ierr;
10959b7cd975SBarry Smith   DM             dm;
10969b7cd975SBarry Smith 
10979b7cd975SBarry Smith   PetscFunctionBegin;
10989b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10999b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
11009b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
11019b7cd975SBarry Smith   PetscFunctionReturn(0);
11029b7cd975SBarry Smith }
11039b7cd975SBarry Smith 
11049b7cd975SBarry Smith #undef __FUNCT__
11054a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
1106d763cef2SBarry Smith /*@C
1107f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1108b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1109d763cef2SBarry Smith 
11103f9fe445SBarry Smith    Logically Collective on TS
1111d763cef2SBarry Smith 
1112d763cef2SBarry Smith    Input Parameters:
1113d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1114e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1115e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1116d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1117d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
11180298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1119d763cef2SBarry Smith 
1120f7ab8db6SBarry Smith    Calling sequence of f:
1121ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1122d763cef2SBarry Smith 
1123d763cef2SBarry Smith +  t - current timestep
1124d763cef2SBarry Smith .  u - input vector
1125e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1126e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1127d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1128d763cef2SBarry Smith 
11296cd88445SBarry Smith    Notes:
11306cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
11316cd88445SBarry Smith 
11326cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1133ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1134d763cef2SBarry Smith 
1135d763cef2SBarry Smith    Level: beginner
1136d763cef2SBarry Smith 
1137d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1138d763cef2SBarry Smith 
1139ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1140d763cef2SBarry Smith 
1141d763cef2SBarry Smith @*/
1142e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1143d763cef2SBarry Smith {
1144277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1145089b2837SJed Brown   SNES           snes;
114624989b8cSPeter Brune   DM             dm;
114724989b8cSPeter Brune   TSIJacobian    ijacobian;
1148277b19d0SLisandro Dalcin 
1149d763cef2SBarry Smith   PetscFunctionBegin;
11500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1151e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1152e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1153e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1154e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1155d763cef2SBarry Smith 
115624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
115724989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1158e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1159e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1160e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1161e1244c69SJed Brown   }
11620298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1163089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11645f659677SPeter Brune   if (!ijacobian) {
1165e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
11660e4ef248SJed Brown   }
1167e5d3d808SBarry Smith   if (Amat) {
1168e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
11690e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1170e5d3d808SBarry Smith     ts->Arhs = Amat;
11710e4ef248SJed Brown   }
1172e5d3d808SBarry Smith   if (Pmat) {
1173e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
11740e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1175e5d3d808SBarry Smith     ts->Brhs = Pmat;
11760e4ef248SJed Brown   }
1177d763cef2SBarry Smith   PetscFunctionReturn(0);
1178d763cef2SBarry Smith }
1179d763cef2SBarry Smith 
1180316643e7SJed Brown 
1181316643e7SJed Brown #undef __FUNCT__
1182316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1183316643e7SJed Brown /*@C
1184b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1185316643e7SJed Brown 
11863f9fe445SBarry Smith    Logically Collective on TS
1187316643e7SJed Brown 
1188316643e7SJed Brown    Input Parameters:
1189316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
11900298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1191316643e7SJed Brown .  f   - the function evaluation routine
11920298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1193316643e7SJed Brown 
1194316643e7SJed Brown    Calling sequence of f:
1195316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1196316643e7SJed Brown 
1197316643e7SJed Brown +  t   - time at step/stage being solved
1198316643e7SJed Brown .  u   - state vector
1199316643e7SJed Brown .  u_t - time derivative of state vector
1200316643e7SJed Brown .  F   - function vector
1201316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1202316643e7SJed Brown 
1203316643e7SJed Brown    Important:
12042bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1205316643e7SJed Brown 
1206316643e7SJed Brown    Level: beginner
1207316643e7SJed Brown 
1208316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1209316643e7SJed Brown 
1210d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1211316643e7SJed Brown @*/
121251699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1213316643e7SJed Brown {
1214089b2837SJed Brown   PetscErrorCode ierr;
1215089b2837SJed Brown   SNES           snes;
121651699248SLisandro Dalcin   Vec            ralloc = NULL;
121724989b8cSPeter Brune   DM             dm;
1218316643e7SJed Brown 
1219316643e7SJed Brown   PetscFunctionBegin;
12200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
122151699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
122224989b8cSPeter Brune 
122324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
122424989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
122524989b8cSPeter Brune 
1226089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
122751699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
122851699248SLisandro Dalcin     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
122951699248SLisandro Dalcin     r  = ralloc;
1230e856ceecSJed Brown   }
123151699248SLisandro Dalcin   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
123251699248SLisandro Dalcin   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1233089b2837SJed Brown   PetscFunctionReturn(0);
1234089b2837SJed Brown }
1235089b2837SJed Brown 
1236089b2837SJed Brown #undef __FUNCT__
1237089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1238089b2837SJed Brown /*@C
1239089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1240089b2837SJed Brown 
1241089b2837SJed Brown    Not Collective
1242089b2837SJed Brown 
1243089b2837SJed Brown    Input Parameter:
1244089b2837SJed Brown .  ts - the TS context
1245089b2837SJed Brown 
1246089b2837SJed Brown    Output Parameter:
12470298fd71SBarry Smith +  r - vector to hold residual (or NULL)
12480298fd71SBarry Smith .  func - the function to compute residual (or NULL)
12490298fd71SBarry Smith -  ctx - the function context (or NULL)
1250089b2837SJed Brown 
1251089b2837SJed Brown    Level: advanced
1252089b2837SJed Brown 
1253089b2837SJed Brown .keywords: TS, nonlinear, get, function
1254089b2837SJed Brown 
1255089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1256089b2837SJed Brown @*/
1257089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1258089b2837SJed Brown {
1259089b2837SJed Brown   PetscErrorCode ierr;
1260089b2837SJed Brown   SNES           snes;
126124989b8cSPeter Brune   DM             dm;
1262089b2837SJed Brown 
1263089b2837SJed Brown   PetscFunctionBegin;
1264089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1265089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12660298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
126724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
126824989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1269089b2837SJed Brown   PetscFunctionReturn(0);
1270089b2837SJed Brown }
1271089b2837SJed Brown 
1272089b2837SJed Brown #undef __FUNCT__
1273089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1274089b2837SJed Brown /*@C
1275089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1276089b2837SJed Brown 
1277089b2837SJed Brown    Not Collective
1278089b2837SJed Brown 
1279089b2837SJed Brown    Input Parameter:
1280089b2837SJed Brown .  ts - the TS context
1281089b2837SJed Brown 
1282089b2837SJed Brown    Output Parameter:
12830298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
12840298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
12850298fd71SBarry Smith -  ctx - the function context (or NULL)
1286089b2837SJed Brown 
1287089b2837SJed Brown    Level: advanced
1288089b2837SJed Brown 
1289089b2837SJed Brown .keywords: TS, nonlinear, get, function
1290089b2837SJed Brown 
12912bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1292089b2837SJed Brown @*/
1293089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1294089b2837SJed Brown {
1295089b2837SJed Brown   PetscErrorCode ierr;
1296089b2837SJed Brown   SNES           snes;
129724989b8cSPeter Brune   DM             dm;
1298089b2837SJed Brown 
1299089b2837SJed Brown   PetscFunctionBegin;
1300089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1301089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13020298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
130324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
130424989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1305316643e7SJed Brown   PetscFunctionReturn(0);
1306316643e7SJed Brown }
1307316643e7SJed Brown 
1308316643e7SJed Brown #undef __FUNCT__
1309316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1310316643e7SJed Brown /*@C
1311a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1312ae8867d6SBarry Smith         provided with TSSetIFunction().
1313316643e7SJed Brown 
13143f9fe445SBarry Smith    Logically Collective on TS
1315316643e7SJed Brown 
1316316643e7SJed Brown    Input Parameters:
1317316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1318e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1319e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1320316643e7SJed Brown .  f   - the Jacobian evaluation routine
13210298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1322316643e7SJed Brown 
1323316643e7SJed Brown    Calling sequence of f:
1324ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1325316643e7SJed Brown 
1326316643e7SJed Brown +  t    - time at step/stage being solved
13271b4a444bSJed Brown .  U    - state vector
13281b4a444bSJed Brown .  U_t  - time derivative of state vector
1329316643e7SJed Brown .  a    - shift
1330e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1331e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1332316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1333316643e7SJed Brown 
1334316643e7SJed Brown    Notes:
1335e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1336316643e7SJed Brown 
1337895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1338895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1339895c21f2SBarry Smith 
1340a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1341b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1342a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1343a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1344a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1345a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1346a4f0a591SBarry Smith 
13476cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
13486cd88445SBarry Smith 
13496cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1350ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1351ca5f011dSBarry Smith 
1352316643e7SJed Brown    Level: beginner
1353316643e7SJed Brown 
1354316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1355316643e7SJed Brown 
1356ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1357316643e7SJed Brown 
1358316643e7SJed Brown @*/
1359e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1360316643e7SJed Brown {
1361316643e7SJed Brown   PetscErrorCode ierr;
1362089b2837SJed Brown   SNES           snes;
136324989b8cSPeter Brune   DM             dm;
1364316643e7SJed Brown 
1365316643e7SJed Brown   PetscFunctionBegin;
13660700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1367e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1368e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1369e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1370e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
137124989b8cSPeter Brune 
137224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
137324989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
137424989b8cSPeter Brune 
1375089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1376e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1377316643e7SJed Brown   PetscFunctionReturn(0);
1378316643e7SJed Brown }
1379316643e7SJed Brown 
13804a2ae208SSatish Balay #undef __FUNCT__
1381e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1382e1244c69SJed Brown /*@
1383e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1384e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1385e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1386e1244c69SJed Brown    not been changed by the TS.
1387e1244c69SJed Brown 
1388e1244c69SJed Brown    Logically Collective
1389e1244c69SJed Brown 
1390e1244c69SJed Brown    Input Arguments:
1391e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1392e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1393e1244c69SJed Brown 
1394e1244c69SJed Brown    Level: intermediate
1395e1244c69SJed Brown 
1396e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1397e1244c69SJed Brown @*/
1398e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1399e1244c69SJed Brown {
1400e1244c69SJed Brown   PetscFunctionBegin;
1401e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1402e1244c69SJed Brown   PetscFunctionReturn(0);
1403e1244c69SJed Brown }
1404e1244c69SJed Brown 
1405e1244c69SJed Brown #undef __FUNCT__
1406efe9872eSLisandro Dalcin #define __FUNCT__ "TSSetI2Function"
1407efe9872eSLisandro Dalcin /*@C
1408efe9872eSLisandro Dalcin    TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1409efe9872eSLisandro Dalcin 
1410efe9872eSLisandro Dalcin    Logically Collective on TS
1411efe9872eSLisandro Dalcin 
1412efe9872eSLisandro Dalcin    Input Parameters:
1413efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1414efe9872eSLisandro Dalcin .  F   - vector to hold the residual (or NULL to have it created internally)
1415efe9872eSLisandro Dalcin .  fun - the function evaluation routine
1416efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1417efe9872eSLisandro Dalcin 
1418efe9872eSLisandro Dalcin    Calling sequence of fun:
1419efe9872eSLisandro Dalcin $  fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx);
1420efe9872eSLisandro Dalcin 
1421efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1422efe9872eSLisandro Dalcin .  U    - state vector
1423efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1424efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1425efe9872eSLisandro Dalcin .  F    - function vector
1426efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine (may be NULL)
1427efe9872eSLisandro Dalcin 
1428efe9872eSLisandro Dalcin    Level: beginner
1429efe9872eSLisandro Dalcin 
1430efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function
1431efe9872eSLisandro Dalcin 
1432efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian()
1433efe9872eSLisandro Dalcin @*/
1434efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx)
1435efe9872eSLisandro Dalcin {
1436efe9872eSLisandro Dalcin   DM             dm;
1437efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1438efe9872eSLisandro Dalcin 
1439efe9872eSLisandro Dalcin   PetscFunctionBegin;
1440efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1441efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2);
1442efe9872eSLisandro Dalcin   ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr);
1443efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1444efe9872eSLisandro Dalcin   ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1445efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1446efe9872eSLisandro Dalcin }
1447efe9872eSLisandro Dalcin 
1448efe9872eSLisandro Dalcin #undef __FUNCT__
1449efe9872eSLisandro Dalcin #define __FUNCT__ "TSGetI2Function"
1450efe9872eSLisandro Dalcin /*@C
1451efe9872eSLisandro Dalcin   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1452efe9872eSLisandro Dalcin 
1453efe9872eSLisandro Dalcin   Not Collective
1454efe9872eSLisandro Dalcin 
1455efe9872eSLisandro Dalcin   Input Parameter:
1456efe9872eSLisandro Dalcin . ts - the TS context
1457efe9872eSLisandro Dalcin 
1458efe9872eSLisandro Dalcin   Output Parameter:
1459efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL)
1460efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL)
1461efe9872eSLisandro Dalcin - ctx - the function context (or NULL)
1462efe9872eSLisandro Dalcin 
1463efe9872eSLisandro Dalcin   Level: advanced
1464efe9872eSLisandro Dalcin 
1465efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function
1466efe9872eSLisandro Dalcin 
1467efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction()
1468efe9872eSLisandro Dalcin @*/
1469efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1470efe9872eSLisandro Dalcin {
1471efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1472efe9872eSLisandro Dalcin   SNES           snes;
1473efe9872eSLisandro Dalcin   DM             dm;
1474efe9872eSLisandro Dalcin 
1475efe9872eSLisandro Dalcin   PetscFunctionBegin;
1476efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1477efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1478efe9872eSLisandro Dalcin   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1479efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1480efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1481efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1482efe9872eSLisandro Dalcin }
1483efe9872eSLisandro Dalcin 
1484efe9872eSLisandro Dalcin #undef __FUNCT__
1485efe9872eSLisandro Dalcin #define __FUNCT__ "TSSetI2Jacobian"
1486efe9872eSLisandro Dalcin /*@C
1487bc77d74cSLisandro Dalcin    TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1488efe9872eSLisandro Dalcin         where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1489efe9872eSLisandro Dalcin 
1490efe9872eSLisandro Dalcin    Logically Collective on TS
1491efe9872eSLisandro Dalcin 
1492efe9872eSLisandro Dalcin    Input Parameters:
1493efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1494efe9872eSLisandro Dalcin .  J   - Jacobian matrix
1495efe9872eSLisandro Dalcin .  P   - preconditioning matrix for J (may be same as J)
1496efe9872eSLisandro Dalcin .  jac - the Jacobian evaluation routine
1497efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1498efe9872eSLisandro Dalcin 
1499efe9872eSLisandro Dalcin    Calling sequence of jac:
1500bc77d74cSLisandro Dalcin $  jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx);
1501efe9872eSLisandro Dalcin 
1502efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1503efe9872eSLisandro Dalcin .  U    - state vector
1504efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1505efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1506efe9872eSLisandro Dalcin .  v    - shift for U_t
1507efe9872eSLisandro Dalcin .  a    - shift for U_tt
1508efe9872eSLisandro Dalcin .  J    - Jacobian of G(U) = F(t,U,W+v*U,W'+a*U), equivalent to dF/dU + v*dF/dU_t  + a*dF/dU_tt
1509efe9872eSLisandro Dalcin .  P    - preconditioning matrix for J, may be same as J
1510efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine
1511efe9872eSLisandro Dalcin 
1512efe9872eSLisandro Dalcin    Notes:
1513efe9872eSLisandro Dalcin    The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1514efe9872eSLisandro Dalcin 
1515efe9872eSLisandro Dalcin    The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1516efe9872eSLisandro Dalcin    the Jacobian of G(U) = F(t,U,W+v*U,W'+a*U) where F(t,U,U_t,U_tt) = 0 is the DAE to be solved.
1517efe9872eSLisandro Dalcin    The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1518bc77d74cSLisandro Dalcin    parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1519efe9872eSLisandro Dalcin 
1520efe9872eSLisandro Dalcin    Level: beginner
1521efe9872eSLisandro Dalcin 
1522efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian
1523efe9872eSLisandro Dalcin 
1524efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1525efe9872eSLisandro Dalcin @*/
1526efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1527efe9872eSLisandro Dalcin {
1528efe9872eSLisandro Dalcin   DM             dm;
1529efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1530efe9872eSLisandro Dalcin 
1531efe9872eSLisandro Dalcin   PetscFunctionBegin;
1532efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1533efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2);
1534efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3);
1535efe9872eSLisandro Dalcin   ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr);
1536efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1537efe9872eSLisandro Dalcin   ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1538efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1539efe9872eSLisandro Dalcin }
1540efe9872eSLisandro Dalcin 
1541efe9872eSLisandro Dalcin #undef __FUNCT__
1542efe9872eSLisandro Dalcin #define __FUNCT__ "TSGetI2Jacobian"
1543efe9872eSLisandro Dalcin /*@C
1544efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1545efe9872eSLisandro Dalcin 
1546efe9872eSLisandro Dalcin   Not Collective, but parallel objects are returned if TS is parallel
1547efe9872eSLisandro Dalcin 
1548efe9872eSLisandro Dalcin   Input Parameter:
1549efe9872eSLisandro Dalcin . ts  - The TS context obtained from TSCreate()
1550efe9872eSLisandro Dalcin 
1551efe9872eSLisandro Dalcin   Output Parameters:
1552efe9872eSLisandro Dalcin + J  - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1553efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J
1554efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1555efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1556efe9872eSLisandro Dalcin 
1557efe9872eSLisandro Dalcin   Notes: You can pass in NULL for any return argument you do not need.
1558efe9872eSLisandro Dalcin 
1559efe9872eSLisandro Dalcin   Level: advanced
1560efe9872eSLisandro Dalcin 
1561efe9872eSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
1562efe9872eSLisandro Dalcin 
1563efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian
1564efe9872eSLisandro Dalcin @*/
1565efe9872eSLisandro Dalcin PetscErrorCode  TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1566efe9872eSLisandro Dalcin {
1567efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1568efe9872eSLisandro Dalcin   SNES           snes;
1569efe9872eSLisandro Dalcin   DM             dm;
1570efe9872eSLisandro Dalcin 
1571efe9872eSLisandro Dalcin   PetscFunctionBegin;
1572efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1573efe9872eSLisandro Dalcin   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
1574efe9872eSLisandro Dalcin   ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr);
1575efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1576efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1577efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1578efe9872eSLisandro Dalcin }
1579efe9872eSLisandro Dalcin 
1580efe9872eSLisandro Dalcin #undef __FUNCT__
1581efe9872eSLisandro Dalcin #define __FUNCT__ "TSComputeI2Function"
1582efe9872eSLisandro Dalcin /*@
1583efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1584efe9872eSLisandro Dalcin 
1585efe9872eSLisandro Dalcin   Collective on TS and Vec
1586efe9872eSLisandro Dalcin 
1587efe9872eSLisandro Dalcin   Input Parameters:
1588efe9872eSLisandro Dalcin + ts - the TS context
1589efe9872eSLisandro Dalcin . t - current time
1590efe9872eSLisandro Dalcin . U - state vector
1591efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t)
1592efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt)
1593efe9872eSLisandro Dalcin 
1594efe9872eSLisandro Dalcin   Output Parameter:
1595efe9872eSLisandro Dalcin . F - the residual vector
1596efe9872eSLisandro Dalcin 
1597efe9872eSLisandro Dalcin   Note:
1598efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1599efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1600efe9872eSLisandro Dalcin 
1601efe9872eSLisandro Dalcin   Level: developer
1602efe9872eSLisandro Dalcin 
1603efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector
1604efe9872eSLisandro Dalcin 
1605efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1606efe9872eSLisandro Dalcin @*/
1607efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1608efe9872eSLisandro Dalcin {
1609efe9872eSLisandro Dalcin   DM             dm;
1610efe9872eSLisandro Dalcin   TSI2Function   I2Function;
1611efe9872eSLisandro Dalcin   void           *ctx;
1612efe9872eSLisandro Dalcin   TSRHSFunction  rhsfunction;
1613efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1614efe9872eSLisandro Dalcin 
1615efe9872eSLisandro Dalcin   PetscFunctionBegin;
1616efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1617efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1618efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1619efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1620efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F,VEC_CLASSID,6);
1621efe9872eSLisandro Dalcin 
1622efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1623efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr);
1624efe9872eSLisandro Dalcin   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
1625efe9872eSLisandro Dalcin 
1626efe9872eSLisandro Dalcin   if (!I2Function) {
1627efe9872eSLisandro Dalcin     ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr);
1628efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1629efe9872eSLisandro Dalcin   }
1630efe9872eSLisandro Dalcin 
1631efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1632efe9872eSLisandro Dalcin 
1633efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit function");
1634efe9872eSLisandro Dalcin   ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr);
1635efe9872eSLisandro Dalcin   PetscStackPop;
1636efe9872eSLisandro Dalcin 
1637efe9872eSLisandro Dalcin   if (rhsfunction) {
1638efe9872eSLisandro Dalcin     Vec Frhs;
1639efe9872eSLisandro Dalcin     ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
1640efe9872eSLisandro Dalcin     ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
1641efe9872eSLisandro Dalcin     ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr);
1642efe9872eSLisandro Dalcin   }
1643efe9872eSLisandro Dalcin 
1644efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1645efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1646efe9872eSLisandro Dalcin }
1647efe9872eSLisandro Dalcin 
1648efe9872eSLisandro Dalcin #undef __FUNCT__
1649efe9872eSLisandro Dalcin #define __FUNCT__ "TSComputeI2Jacobian"
1650efe9872eSLisandro Dalcin /*@
1651efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1652efe9872eSLisandro Dalcin 
1653efe9872eSLisandro Dalcin   Collective on TS and Vec
1654efe9872eSLisandro Dalcin 
1655efe9872eSLisandro Dalcin   Input Parameters:
1656efe9872eSLisandro Dalcin + ts - the TS context
1657efe9872eSLisandro Dalcin . t - current timestep
1658efe9872eSLisandro Dalcin . U - state vector
1659efe9872eSLisandro Dalcin . V - time derivative of state vector
1660efe9872eSLisandro Dalcin . A - second time derivative of state vector
1661efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1662efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1663efe9872eSLisandro Dalcin 
1664efe9872eSLisandro Dalcin   Output Parameters:
1665efe9872eSLisandro Dalcin + J - Jacobian matrix
1666efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1667efe9872eSLisandro Dalcin 
1668efe9872eSLisandro Dalcin   Notes:
1669efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1670efe9872eSLisandro Dalcin 
1671efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1672efe9872eSLisandro Dalcin 
1673efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1674efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1675efe9872eSLisandro Dalcin 
1676efe9872eSLisandro Dalcin   Level: developer
1677efe9872eSLisandro Dalcin 
1678efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix
1679efe9872eSLisandro Dalcin 
1680efe9872eSLisandro Dalcin .seealso:  TSSetI2Jacobian()
1681efe9872eSLisandro Dalcin @*/
1682efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1683efe9872eSLisandro Dalcin {
1684efe9872eSLisandro Dalcin   DM             dm;
1685efe9872eSLisandro Dalcin   TSI2Jacobian   I2Jacobian;
1686efe9872eSLisandro Dalcin   void           *ctx;
1687efe9872eSLisandro Dalcin   TSRHSJacobian  rhsjacobian;
1688efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1689efe9872eSLisandro Dalcin 
1690efe9872eSLisandro Dalcin   PetscFunctionBegin;
1691efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1692efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1693efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1694efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1695efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J,MAT_CLASSID,8);
1696efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P,MAT_CLASSID,9);
1697efe9872eSLisandro Dalcin 
1698efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1699efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr);
1700efe9872eSLisandro Dalcin   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
1701efe9872eSLisandro Dalcin 
1702efe9872eSLisandro Dalcin   if (!I2Jacobian) {
1703efe9872eSLisandro Dalcin     ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr);
1704efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1705efe9872eSLisandro Dalcin   }
1706efe9872eSLisandro Dalcin 
1707efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1708efe9872eSLisandro Dalcin 
1709efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit Jacobian");
1710efe9872eSLisandro Dalcin   ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr);
1711efe9872eSLisandro Dalcin   PetscStackPop;
1712efe9872eSLisandro Dalcin 
1713efe9872eSLisandro Dalcin   if (rhsjacobian) {
1714efe9872eSLisandro Dalcin     Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1715efe9872eSLisandro Dalcin     ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr);
1716efe9872eSLisandro Dalcin     ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr);
1717efe9872eSLisandro Dalcin     ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr);
1718efe9872eSLisandro Dalcin     if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);}
1719efe9872eSLisandro Dalcin   }
1720efe9872eSLisandro Dalcin 
1721efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1722efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1723efe9872eSLisandro Dalcin }
1724efe9872eSLisandro Dalcin 
1725efe9872eSLisandro Dalcin #undef __FUNCT__
1726efe9872eSLisandro Dalcin #define __FUNCT__ "TS2SetSolution"
1727efe9872eSLisandro Dalcin /*@
1728efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1729efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1730efe9872eSLisandro Dalcin 
1731efe9872eSLisandro Dalcin    Logically Collective on TS and Vec
1732efe9872eSLisandro Dalcin 
1733efe9872eSLisandro Dalcin    Input Parameters:
1734efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1735efe9872eSLisandro Dalcin .  u - the solution vector
1736efe9872eSLisandro Dalcin -  v - the time derivative vector
1737efe9872eSLisandro Dalcin 
1738efe9872eSLisandro Dalcin    Level: beginner
1739efe9872eSLisandro Dalcin 
1740efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions
1741efe9872eSLisandro Dalcin @*/
1742efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1743efe9872eSLisandro Dalcin {
1744efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1745efe9872eSLisandro Dalcin 
1746efe9872eSLisandro Dalcin   PetscFunctionBegin;
1747efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1748efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1749efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1750efe9872eSLisandro Dalcin   ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
1751efe9872eSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr);
1752efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
1753efe9872eSLisandro Dalcin   ts->vec_dot = v;
1754efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1755efe9872eSLisandro Dalcin }
1756efe9872eSLisandro Dalcin 
1757efe9872eSLisandro Dalcin #undef __FUNCT__
1758efe9872eSLisandro Dalcin #define __FUNCT__ "TS2GetSolution"
1759efe9872eSLisandro Dalcin /*@
1760efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1761efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1762efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1763efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1764efe9872eSLisandro Dalcin 
1765efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1766efe9872eSLisandro Dalcin 
1767efe9872eSLisandro Dalcin    Input Parameter:
1768efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1769efe9872eSLisandro Dalcin 
1770efe9872eSLisandro Dalcin    Output Parameter:
1771efe9872eSLisandro Dalcin +  u - the vector containing the solution
1772efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1773efe9872eSLisandro Dalcin 
1774efe9872eSLisandro Dalcin    Level: intermediate
1775efe9872eSLisandro Dalcin 
1776efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1777efe9872eSLisandro Dalcin 
1778efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution
1779efe9872eSLisandro Dalcin @*/
1780efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1781efe9872eSLisandro Dalcin {
1782efe9872eSLisandro Dalcin   PetscFunctionBegin;
1783efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1784efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1785efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1786efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1787efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1788efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1789efe9872eSLisandro Dalcin }
1790efe9872eSLisandro Dalcin 
1791efe9872eSLisandro Dalcin #undef __FUNCT__
179255849f57SBarry Smith #define __FUNCT__ "TSLoad"
179355849f57SBarry Smith /*@C
179455849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
179555849f57SBarry Smith 
179655849f57SBarry Smith   Collective on PetscViewer
179755849f57SBarry Smith 
179855849f57SBarry Smith   Input Parameters:
179955849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
180055849f57SBarry Smith            some related function before a call to TSLoad().
180155849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
180255849f57SBarry Smith 
180355849f57SBarry Smith    Level: intermediate
180455849f57SBarry Smith 
180555849f57SBarry Smith   Notes:
180655849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
180755849f57SBarry Smith 
180855849f57SBarry Smith   Notes for advanced users:
180955849f57SBarry Smith   Most users should not need to know the details of the binary storage
181055849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
181155849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
181255849f57SBarry Smith   format is
181355849f57SBarry Smith .vb
181455849f57SBarry Smith      has not yet been determined
181555849f57SBarry Smith .ve
181655849f57SBarry Smith 
181755849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
181855849f57SBarry Smith @*/
1819f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
182055849f57SBarry Smith {
182155849f57SBarry Smith   PetscErrorCode ierr;
182255849f57SBarry Smith   PetscBool      isbinary;
182355849f57SBarry Smith   PetscInt       classid;
182455849f57SBarry Smith   char           type[256];
18252d53ad75SBarry Smith   DMTS           sdm;
1826ad6bc421SBarry Smith   DM             dm;
182755849f57SBarry Smith 
182855849f57SBarry Smith   PetscFunctionBegin;
1829f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
183055849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
183155849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
183255849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
183355849f57SBarry Smith 
1834060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1835ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1836060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1837f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1838f2c2a1b9SBarry Smith   if (ts->ops->load) {
1839f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1840f2c2a1b9SBarry Smith   }
1841ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1842ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1843ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1844f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1845f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
18462d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
18472d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
184855849f57SBarry Smith   PetscFunctionReturn(0);
184955849f57SBarry Smith }
185055849f57SBarry Smith 
18519804daf3SBarry Smith #include <petscdraw.h>
1852e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1853e04113cfSBarry Smith #include <petscviewersaws.h>
1854f05ece33SBarry Smith #endif
185555849f57SBarry Smith #undef __FUNCT__
18564a2ae208SSatish Balay #define __FUNCT__ "TSView"
18577e2c5f70SBarry Smith /*@C
1858d763cef2SBarry Smith     TSView - Prints the TS data structure.
1859d763cef2SBarry Smith 
18604c49b128SBarry Smith     Collective on TS
1861d763cef2SBarry Smith 
1862d763cef2SBarry Smith     Input Parameters:
1863d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1864d763cef2SBarry Smith -   viewer - visualization context
1865d763cef2SBarry Smith 
1866d763cef2SBarry Smith     Options Database Key:
1867d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1868d763cef2SBarry Smith 
1869d763cef2SBarry Smith     Notes:
1870d763cef2SBarry Smith     The available visualization contexts include
1871b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1872b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1873d763cef2SBarry Smith          output where only the first processor opens
1874d763cef2SBarry Smith          the file.  All other processors send their
1875d763cef2SBarry Smith          data to the first processor to print.
1876d763cef2SBarry Smith 
1877d763cef2SBarry Smith     The user can open an alternative visualization context with
1878b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1879d763cef2SBarry Smith 
1880d763cef2SBarry Smith     Level: beginner
1881d763cef2SBarry Smith 
1882d763cef2SBarry Smith .keywords: TS, timestep, view
1883d763cef2SBarry Smith 
1884b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1885d763cef2SBarry Smith @*/
18867087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1887d763cef2SBarry Smith {
1888dfbe8321SBarry Smith   PetscErrorCode ierr;
188919fd82e9SBarry Smith   TSType         type;
18902b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
18912d53ad75SBarry Smith   DMTS           sdm;
1892e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1893536b137fSBarry Smith   PetscBool      issaws;
1894f05ece33SBarry Smith #endif
1895d763cef2SBarry Smith 
1896d763cef2SBarry Smith   PetscFunctionBegin;
18970700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
18983050cee2SBarry Smith   if (!viewer) {
1899ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
19003050cee2SBarry Smith   }
19010700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1902c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1903fd16b177SBarry Smith 
1904251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1905251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
190655849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
19072b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1908e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1909536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1910f05ece33SBarry Smith #endif
191132077d6dSBarry Smith   if (iascii) {
1912dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
191377431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
19147c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1915d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
19165ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1917c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1918d763cef2SBarry Smith     }
19195ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1920193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
19212d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19222d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1923d52bd9f3SBarry Smith     if (ts->ops->view) {
1924d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1925d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1926d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1927d52bd9f3SBarry Smith     }
19280f5bd95cSBarry Smith   } else if (isstring) {
1929a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1930b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
193155849f57SBarry Smith   } else if (isbinary) {
193255849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
193355849f57SBarry Smith     MPI_Comm    comm;
193455849f57SBarry Smith     PetscMPIInt rank;
193555849f57SBarry Smith     char        type[256];
193655849f57SBarry Smith 
193755849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
193855849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
193955849f57SBarry Smith     if (!rank) {
194055849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
194155849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
194255849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
194355849f57SBarry Smith     }
194455849f57SBarry Smith     if (ts->ops->view) {
194555849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
194655849f57SBarry Smith     }
1947f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1948f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
19492d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19502d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
19512b0a91c0SBarry Smith   } else if (isdraw) {
19522b0a91c0SBarry Smith     PetscDraw draw;
19532b0a91c0SBarry Smith     char      str[36];
195489fd9fafSBarry Smith     PetscReal x,y,bottom,h;
19552b0a91c0SBarry Smith 
19562b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
19572b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
19582b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
19592b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
196051fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
196189fd9fafSBarry Smith     bottom = y - h;
19622b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
19632b0a91c0SBarry Smith     if (ts->ops->view) {
19642b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
19652b0a91c0SBarry Smith     }
19662b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1967e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1968536b137fSBarry Smith   } else if (issaws) {
1969d45a07a7SBarry Smith     PetscMPIInt rank;
19702657e9d9SBarry Smith     const char  *name;
19712657e9d9SBarry Smith 
19722657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1973d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1974d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1975d45a07a7SBarry Smith       char       dir[1024];
1976d45a07a7SBarry Smith 
1977e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1978a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
19792657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
19802657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
19812657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1982d763cef2SBarry Smith     }
19830acecf5bSBarry Smith     if (ts->ops->view) {
19840acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
19850acecf5bSBarry Smith     }
1986f05ece33SBarry Smith #endif
1987f05ece33SBarry Smith   }
1988f05ece33SBarry Smith 
1989b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1990251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1991b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1992d763cef2SBarry Smith   PetscFunctionReturn(0);
1993d763cef2SBarry Smith }
1994d763cef2SBarry Smith 
1995d763cef2SBarry Smith 
19964a2ae208SSatish Balay #undef __FUNCT__
19974a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1998b07ff414SBarry Smith /*@
1999d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2000d763cef2SBarry Smith    the timesteppers.
2001d763cef2SBarry Smith 
20023f9fe445SBarry Smith    Logically Collective on TS
2003d763cef2SBarry Smith 
2004d763cef2SBarry Smith    Input Parameters:
2005d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2006d763cef2SBarry Smith -  usrP - optional user context
2007d763cef2SBarry Smith 
2008daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2009daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2010daf670e6SBarry Smith 
2011d763cef2SBarry Smith    Level: intermediate
2012d763cef2SBarry Smith 
2013d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
2014d763cef2SBarry Smith 
2015d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2016d763cef2SBarry Smith @*/
20177087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2018d763cef2SBarry Smith {
2019d763cef2SBarry Smith   PetscFunctionBegin;
20200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2021d763cef2SBarry Smith   ts->user = usrP;
2022d763cef2SBarry Smith   PetscFunctionReturn(0);
2023d763cef2SBarry Smith }
2024d763cef2SBarry Smith 
20254a2ae208SSatish Balay #undef __FUNCT__
20264a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
2027b07ff414SBarry Smith /*@
2028d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2029d763cef2SBarry Smith     timestepper.
2030d763cef2SBarry Smith 
2031d763cef2SBarry Smith     Not Collective
2032d763cef2SBarry Smith 
2033d763cef2SBarry Smith     Input Parameter:
2034d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2035d763cef2SBarry Smith 
2036d763cef2SBarry Smith     Output Parameter:
2037d763cef2SBarry Smith .   usrP - user context
2038d763cef2SBarry Smith 
2039daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2040daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2041daf670e6SBarry Smith 
2042d763cef2SBarry Smith     Level: intermediate
2043d763cef2SBarry Smith 
2044d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
2045d763cef2SBarry Smith 
2046d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2047d763cef2SBarry Smith @*/
2048e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2049d763cef2SBarry Smith {
2050d763cef2SBarry Smith   PetscFunctionBegin;
20510700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2052e71120c6SJed Brown   *(void**)usrP = ts->user;
2053d763cef2SBarry Smith   PetscFunctionReturn(0);
2054d763cef2SBarry Smith }
2055d763cef2SBarry Smith 
20564a2ae208SSatish Balay #undef __FUNCT__
20574a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
2058d763cef2SBarry Smith /*@
2059b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
2060d763cef2SBarry Smith 
2061d763cef2SBarry Smith    Not Collective
2062d763cef2SBarry Smith 
2063d763cef2SBarry Smith    Input Parameter:
2064d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2065d763cef2SBarry Smith 
2066d763cef2SBarry Smith    Output Parameter:
2067b8123daeSJed Brown .  iter - number of steps completed so far
2068d763cef2SBarry Smith 
2069d763cef2SBarry Smith    Level: intermediate
2070d763cef2SBarry Smith 
2071d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
20729be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2073d763cef2SBarry Smith @*/
20747087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
2075d763cef2SBarry Smith {
2076d763cef2SBarry Smith   PetscFunctionBegin;
20770700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20784482741eSBarry Smith   PetscValidIntPointer(iter,2);
2079d763cef2SBarry Smith   *iter = ts->steps;
2080d763cef2SBarry Smith   PetscFunctionReturn(0);
2081d763cef2SBarry Smith }
2082d763cef2SBarry Smith 
20834a2ae208SSatish Balay #undef __FUNCT__
20844a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
2085d763cef2SBarry Smith /*@
2086d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
2087d763cef2SBarry Smith    as well as the initial time.
2088d763cef2SBarry Smith 
20893f9fe445SBarry Smith    Logically Collective on TS
2090d763cef2SBarry Smith 
2091d763cef2SBarry Smith    Input Parameters:
2092d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2093d763cef2SBarry Smith .  initial_time - the initial time
2094d763cef2SBarry Smith -  time_step - the size of the timestep
2095d763cef2SBarry Smith 
2096d763cef2SBarry Smith    Level: intermediate
2097d763cef2SBarry Smith 
2098d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
2099d763cef2SBarry Smith 
2100d763cef2SBarry Smith .keywords: TS, set, initial, timestep
2101d763cef2SBarry Smith @*/
21027087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
2103d763cef2SBarry Smith {
2104e144a568SJed Brown   PetscErrorCode ierr;
2105e144a568SJed Brown 
2106d763cef2SBarry Smith   PetscFunctionBegin;
21070700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2108e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
2109d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
2110d763cef2SBarry Smith   PetscFunctionReturn(0);
2111d763cef2SBarry Smith }
2112d763cef2SBarry Smith 
21134a2ae208SSatish Balay #undef __FUNCT__
21144a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
2115d763cef2SBarry Smith /*@
2116d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2117d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2118d763cef2SBarry Smith 
21193f9fe445SBarry Smith    Logically Collective on TS
2120d763cef2SBarry Smith 
2121d763cef2SBarry Smith    Input Parameters:
2122d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2123d763cef2SBarry Smith -  time_step - the size of the timestep
2124d763cef2SBarry Smith 
2125d763cef2SBarry Smith    Level: intermediate
2126d763cef2SBarry Smith 
2127d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2128d763cef2SBarry Smith 
2129d763cef2SBarry Smith .keywords: TS, set, timestep
2130d763cef2SBarry Smith @*/
21317087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2132d763cef2SBarry Smith {
2133d763cef2SBarry Smith   PetscFunctionBegin;
21340700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2135c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2136d763cef2SBarry Smith   ts->time_step = time_step;
2137d763cef2SBarry Smith   PetscFunctionReturn(0);
2138d763cef2SBarry Smith }
2139d763cef2SBarry Smith 
21404a2ae208SSatish Balay #undef __FUNCT__
2141a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
2142a43b19c4SJed Brown /*@
214349354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
214449354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
214549354f04SShri Abhyankar      or just return at the final time TS computed.
2146a43b19c4SJed Brown 
2147a43b19c4SJed Brown   Logically Collective on TS
2148a43b19c4SJed Brown 
2149a43b19c4SJed Brown    Input Parameter:
2150a43b19c4SJed Brown +   ts - the time-step context
215149354f04SShri Abhyankar -   eftopt - exact final time option
2152a43b19c4SJed Brown 
2153feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2154feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2155feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2156feed9e9dSBarry Smith 
2157feed9e9dSBarry Smith    Options Database:
2158feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2159feed9e9dSBarry Smith 
2160ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2161ee346746SBarry Smith     then the final time you selected.
2162ee346746SBarry Smith 
2163a43b19c4SJed Brown    Level: beginner
2164a43b19c4SJed Brown 
2165a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
2166a43b19c4SJed Brown @*/
216749354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2168a43b19c4SJed Brown {
2169a43b19c4SJed Brown   PetscFunctionBegin;
2170a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
217149354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
217249354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2173a43b19c4SJed Brown   PetscFunctionReturn(0);
2174a43b19c4SJed Brown }
2175a43b19c4SJed Brown 
2176a43b19c4SJed Brown #undef __FUNCT__
21774a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
2178d763cef2SBarry Smith /*@
2179d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2180d763cef2SBarry Smith 
2181d763cef2SBarry Smith    Not Collective
2182d763cef2SBarry Smith 
2183d763cef2SBarry Smith    Input Parameter:
2184d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2185d763cef2SBarry Smith 
2186d763cef2SBarry Smith    Output Parameter:
2187d763cef2SBarry Smith .  dt - the current timestep size
2188d763cef2SBarry Smith 
2189d763cef2SBarry Smith    Level: intermediate
2190d763cef2SBarry Smith 
2191d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2192d763cef2SBarry Smith 
2193d763cef2SBarry Smith .keywords: TS, get, timestep
2194d763cef2SBarry Smith @*/
21957087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2196d763cef2SBarry Smith {
2197d763cef2SBarry Smith   PetscFunctionBegin;
21980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2199f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2200d763cef2SBarry Smith   *dt = ts->time_step;
2201d763cef2SBarry Smith   PetscFunctionReturn(0);
2202d763cef2SBarry Smith }
2203d763cef2SBarry Smith 
22044a2ae208SSatish Balay #undef __FUNCT__
22054a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
2206d8e5e3e6SSatish Balay /*@
2207d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2208d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2209d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2210d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2211d763cef2SBarry Smith 
2212d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2213d763cef2SBarry Smith 
2214d763cef2SBarry Smith    Input Parameter:
2215d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2216d763cef2SBarry Smith 
2217d763cef2SBarry Smith    Output Parameter:
2218d763cef2SBarry Smith .  v - the vector containing the solution
2219d763cef2SBarry Smith 
222063e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
222163e21af5SBarry Smith    final time. It returns the solution at the next timestep.
222263e21af5SBarry Smith 
2223d763cef2SBarry Smith    Level: intermediate
2224d763cef2SBarry Smith 
222563e21af5SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime()
2226d763cef2SBarry Smith 
2227d763cef2SBarry Smith .keywords: TS, timestep, get, solution
2228d763cef2SBarry Smith @*/
22297087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2230d763cef2SBarry Smith {
2231d763cef2SBarry Smith   PetscFunctionBegin;
22320700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22334482741eSBarry Smith   PetscValidPointer(v,2);
22348737fe31SLisandro Dalcin   *v = ts->vec_sol;
2235d763cef2SBarry Smith   PetscFunctionReturn(0);
2236d763cef2SBarry Smith }
2237d763cef2SBarry Smith 
2238c235aa8dSHong Zhang #undef __FUNCT__
2239dfb21088SHong Zhang #define __FUNCT__ "TSGetCostGradients"
2240c235aa8dSHong Zhang /*@
2241dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
2242c235aa8dSHong Zhang 
2243c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
2244c235aa8dSHong Zhang 
2245c235aa8dSHong Zhang    Input Parameter:
2246c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
2247c235aa8dSHong Zhang 
2248c235aa8dSHong Zhang    Output Parameter:
2249abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
2250abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
2251c235aa8dSHong Zhang 
2252c235aa8dSHong Zhang    Level: intermediate
2253c235aa8dSHong Zhang 
2254c235aa8dSHong Zhang .seealso: TSGetTimeStep()
2255c235aa8dSHong Zhang 
2256c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
2257c235aa8dSHong Zhang @*/
2258dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
2259c235aa8dSHong Zhang {
2260c235aa8dSHong Zhang   PetscFunctionBegin;
2261c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2262abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
2263abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
2264abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
2265c235aa8dSHong Zhang   PetscFunctionReturn(0);
2266c235aa8dSHong Zhang }
2267c235aa8dSHong Zhang 
2268bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
22694a2ae208SSatish Balay #undef __FUNCT__
2270bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
2271d8e5e3e6SSatish Balay /*@
2272bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2273d763cef2SBarry Smith 
2274bdad233fSMatthew Knepley   Not collective
2275d763cef2SBarry Smith 
2276bdad233fSMatthew Knepley   Input Parameters:
2277bdad233fSMatthew Knepley + ts   - The TS
2278bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2279d763cef2SBarry Smith .vb
22800910c330SBarry Smith          U_t - A U = 0      (linear)
22810910c330SBarry Smith          U_t - A(t) U = 0   (linear)
22820910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2283d763cef2SBarry Smith .ve
2284d763cef2SBarry Smith 
2285d763cef2SBarry Smith    Level: beginner
2286d763cef2SBarry Smith 
2287bdad233fSMatthew Knepley .keywords: TS, problem type
2288bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2289d763cef2SBarry Smith @*/
22907087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2291a7cc72afSBarry Smith {
22929e2a6581SJed Brown   PetscErrorCode ierr;
22939e2a6581SJed Brown 
2294d763cef2SBarry Smith   PetscFunctionBegin;
22950700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2296bdad233fSMatthew Knepley   ts->problem_type = type;
22979e2a6581SJed Brown   if (type == TS_LINEAR) {
22989e2a6581SJed Brown     SNES snes;
22999e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
23009e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
23019e2a6581SJed Brown   }
2302d763cef2SBarry Smith   PetscFunctionReturn(0);
2303d763cef2SBarry Smith }
2304d763cef2SBarry Smith 
2305bdad233fSMatthew Knepley #undef __FUNCT__
2306bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
2307bdad233fSMatthew Knepley /*@C
2308bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2309bdad233fSMatthew Knepley 
2310bdad233fSMatthew Knepley   Not collective
2311bdad233fSMatthew Knepley 
2312bdad233fSMatthew Knepley   Input Parameter:
2313bdad233fSMatthew Knepley . ts   - The TS
2314bdad233fSMatthew Knepley 
2315bdad233fSMatthew Knepley   Output Parameter:
2316bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2317bdad233fSMatthew Knepley .vb
2318089b2837SJed Brown          M U_t = A U
2319089b2837SJed Brown          M(t) U_t = A(t) U
2320b5abc632SBarry Smith          F(t,U,U_t)
2321bdad233fSMatthew Knepley .ve
2322bdad233fSMatthew Knepley 
2323bdad233fSMatthew Knepley    Level: beginner
2324bdad233fSMatthew Knepley 
2325bdad233fSMatthew Knepley .keywords: TS, problem type
2326bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2327bdad233fSMatthew Knepley @*/
23287087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2329a7cc72afSBarry Smith {
2330bdad233fSMatthew Knepley   PetscFunctionBegin;
23310700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
23324482741eSBarry Smith   PetscValidIntPointer(type,2);
2333bdad233fSMatthew Knepley   *type = ts->problem_type;
2334bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2335bdad233fSMatthew Knepley }
2336d763cef2SBarry Smith 
23374a2ae208SSatish Balay #undef __FUNCT__
23384a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
2339d763cef2SBarry Smith /*@
2340d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
2341d763cef2SBarry Smith    of a timestepper.
2342d763cef2SBarry Smith 
2343d763cef2SBarry Smith    Collective on TS
2344d763cef2SBarry Smith 
2345d763cef2SBarry Smith    Input Parameter:
2346d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2347d763cef2SBarry Smith 
2348d763cef2SBarry Smith    Notes:
2349d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2350d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2351d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
2352d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2353d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
2354d763cef2SBarry Smith 
2355d763cef2SBarry Smith    Level: advanced
2356d763cef2SBarry Smith 
2357d763cef2SBarry Smith .keywords: TS, timestep, setup
2358d763cef2SBarry Smith 
2359d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
2360d763cef2SBarry Smith @*/
23617087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2362d763cef2SBarry Smith {
2363dfbe8321SBarry Smith   PetscErrorCode ierr;
23646c6b9e74SPeter Brune   DM             dm;
23656c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2366d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2367cd11d68dSLisandro Dalcin   TSIFunction    ifun;
23686c6b9e74SPeter Brune   TSIJacobian    ijac;
2369efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
23706c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
2371d763cef2SBarry Smith 
2372d763cef2SBarry Smith   PetscFunctionBegin;
23730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2374277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2375277b19d0SLisandro Dalcin 
23762c18e0fdSBarry Smith   ts->total_steps = 0;
23777adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2378cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
2379cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
2380d763cef2SBarry Smith   }
2381277b19d0SLisandro Dalcin 
2382277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
2383277b19d0SLisandro Dalcin 
2384e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
2385e1244c69SJed Brown     Mat Amat,Pmat;
2386e1244c69SJed Brown     SNES snes;
2387e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2388e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2389e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2390e1244c69SJed Brown      * have displaced the RHS matrix */
2391e1244c69SJed Brown     if (Amat == ts->Arhs) {
2392e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2393e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2394e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2395e1244c69SJed Brown     }
2396e1244c69SJed Brown     if (Pmat == ts->Brhs) {
2397e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2398e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2399e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2400e1244c69SJed Brown     }
2401e1244c69SJed Brown   }
2402277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2403000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2404277b19d0SLisandro Dalcin   }
2405277b19d0SLisandro Dalcin 
2406a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
24076c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
24086c6b9e74SPeter Brune    */
24096c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
24100298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
24116c6b9e74SPeter Brune   if (!func) {
24126c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
24136c6b9e74SPeter Brune   }
2414a6772fa2SLisandro Dalcin   /* If the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it.
24156c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
24166c6b9e74SPeter Brune    */
24170298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
24180298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
2419efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr);
24200298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
2421efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
24226c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
24236c6b9e74SPeter Brune   }
2424277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2425277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2426277b19d0SLisandro Dalcin }
2427277b19d0SLisandro Dalcin 
2428277b19d0SLisandro Dalcin #undef __FUNCT__
2429f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp"
2430f6a906c0SBarry Smith /*@
2431f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
2432f6a906c0SBarry Smith    of an adjoint solver
2433f6a906c0SBarry Smith 
2434f6a906c0SBarry Smith    Collective on TS
2435f6a906c0SBarry Smith 
2436f6a906c0SBarry Smith    Input Parameter:
2437f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
2438f6a906c0SBarry Smith 
2439f6a906c0SBarry Smith    Level: advanced
2440f6a906c0SBarry Smith 
2441f6a906c0SBarry Smith .keywords: TS, timestep, setup
2442f6a906c0SBarry Smith 
2443947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
2444f6a906c0SBarry Smith @*/
2445f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
2446f6a906c0SBarry Smith {
2447f6a906c0SBarry Smith   PetscErrorCode ierr;
2448f6a906c0SBarry Smith 
2449f6a906c0SBarry Smith   PetscFunctionBegin;
2450f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2451f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
2452dfb21088SHong Zhang   if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
2453d8151eeaSBarry Smith 
2454947abb85SHong Zhang   if (ts->vec_costintegral) { /* if there is integral in the cost function*/
2455d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2456d8151eeaSBarry Smith     if (ts->vecs_sensip){
2457d8151eeaSBarry Smith       ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2458d8151eeaSBarry Smith     }
2459947abb85SHong Zhang   }
2460d8151eeaSBarry Smith 
246142f2b339SBarry Smith   if (ts->ops->adjointsetup) {
246242f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
2463f6a906c0SBarry Smith   }
2464f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
2465f6a906c0SBarry Smith   PetscFunctionReturn(0);
2466f6a906c0SBarry Smith }
2467f6a906c0SBarry Smith 
2468f6a906c0SBarry Smith #undef __FUNCT__
2469277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
2470277b19d0SLisandro Dalcin /*@
2471277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2472277b19d0SLisandro Dalcin 
2473277b19d0SLisandro Dalcin    Collective on TS
2474277b19d0SLisandro Dalcin 
2475277b19d0SLisandro Dalcin    Input Parameter:
2476277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2477277b19d0SLisandro Dalcin 
2478277b19d0SLisandro Dalcin    Level: beginner
2479277b19d0SLisandro Dalcin 
2480277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2481277b19d0SLisandro Dalcin 
2482277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2483277b19d0SLisandro Dalcin @*/
2484277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2485277b19d0SLisandro Dalcin {
2486277b19d0SLisandro Dalcin   PetscErrorCode ierr;
2487277b19d0SLisandro Dalcin 
2488277b19d0SLisandro Dalcin   PetscFunctionBegin;
2489277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2490b18ea86cSHong Zhang 
2491277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2492277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2493277b19d0SLisandro Dalcin   }
2494277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2495e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2496bbd56ea5SKarl Rupp 
24974e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
24984e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2499214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
25006bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2501efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
2502e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2503e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
250438637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2505bbd56ea5SKarl Rupp 
2506947abb85SHong Zhang  if (ts->vec_costintegral) {
2507d8151eeaSBarry Smith     ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2508d8151eeaSBarry Smith     if (ts->vecs_drdp){
2509d8151eeaSBarry Smith       ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2510d8151eeaSBarry Smith     }
2511947abb85SHong Zhang   }
2512d8151eeaSBarry Smith   ts->vecs_sensi  = NULL;
2513d8151eeaSBarry Smith   ts->vecs_sensip = NULL;
2514ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
25152c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
251636eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2517277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2518d763cef2SBarry Smith   PetscFunctionReturn(0);
2519d763cef2SBarry Smith }
2520d763cef2SBarry Smith 
25214a2ae208SSatish Balay #undef __FUNCT__
25224a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
2523d8e5e3e6SSatish Balay /*@
2524d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2525d763cef2SBarry Smith    with TSCreate().
2526d763cef2SBarry Smith 
2527d763cef2SBarry Smith    Collective on TS
2528d763cef2SBarry Smith 
2529d763cef2SBarry Smith    Input Parameter:
2530d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2531d763cef2SBarry Smith 
2532d763cef2SBarry Smith    Level: beginner
2533d763cef2SBarry Smith 
2534d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2535d763cef2SBarry Smith 
2536d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2537d763cef2SBarry Smith @*/
25386bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2539d763cef2SBarry Smith {
25406849ba73SBarry Smith   PetscErrorCode ierr;
2541d763cef2SBarry Smith 
2542d763cef2SBarry Smith   PetscFunctionBegin;
25436bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
25446bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
25456bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2546d763cef2SBarry Smith 
25476bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2548277b19d0SLisandro Dalcin 
2549e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2550e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
25516bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
25526d4c513bSLisandro Dalcin 
2553bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2554bc952696SBarry Smith 
255584df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
25566427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
25576427ac75SLisandro Dalcin 
25586bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
25596bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
25606bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
25610dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
25626d4c513bSLisandro Dalcin 
2563a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2564d763cef2SBarry Smith   PetscFunctionReturn(0);
2565d763cef2SBarry Smith }
2566d763cef2SBarry Smith 
25674a2ae208SSatish Balay #undef __FUNCT__
25684a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2569d8e5e3e6SSatish Balay /*@
2570d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2571d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2572d763cef2SBarry Smith 
2573d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2574d763cef2SBarry Smith 
2575d763cef2SBarry Smith    Input Parameter:
2576d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2577d763cef2SBarry Smith 
2578d763cef2SBarry Smith    Output Parameter:
2579d763cef2SBarry Smith .  snes - the nonlinear solver context
2580d763cef2SBarry Smith 
2581d763cef2SBarry Smith    Notes:
2582d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2583d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
258494b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2585d763cef2SBarry Smith 
2586d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
25870298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2588d763cef2SBarry Smith 
2589d763cef2SBarry Smith    Level: beginner
2590d763cef2SBarry Smith 
2591d763cef2SBarry Smith .keywords: timestep, get, SNES
2592d763cef2SBarry Smith @*/
25937087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2594d763cef2SBarry Smith {
2595d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2596d372ba47SLisandro Dalcin 
2597d763cef2SBarry Smith   PetscFunctionBegin;
25980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25994482741eSBarry Smith   PetscValidPointer(snes,2);
2600d372ba47SLisandro Dalcin   if (!ts->snes) {
2601ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
26020298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
26033bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2604d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2605496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
26069e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
26079e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
26089e2a6581SJed Brown     }
2609d372ba47SLisandro Dalcin   }
2610d763cef2SBarry Smith   *snes = ts->snes;
2611d763cef2SBarry Smith   PetscFunctionReturn(0);
2612d763cef2SBarry Smith }
2613d763cef2SBarry Smith 
26144a2ae208SSatish Balay #undef __FUNCT__
2615deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2616deb2cd25SJed Brown /*@
2617deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2618deb2cd25SJed Brown 
2619deb2cd25SJed Brown    Collective
2620deb2cd25SJed Brown 
2621deb2cd25SJed Brown    Input Parameter:
2622deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2623deb2cd25SJed Brown -  snes - the nonlinear solver context
2624deb2cd25SJed Brown 
2625deb2cd25SJed Brown    Notes:
2626deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2627deb2cd25SJed Brown 
2628deb2cd25SJed Brown    Level: developer
2629deb2cd25SJed Brown 
2630deb2cd25SJed Brown .keywords: timestep, set, SNES
2631deb2cd25SJed Brown @*/
2632deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2633deb2cd25SJed Brown {
2634deb2cd25SJed Brown   PetscErrorCode ierr;
2635d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2636deb2cd25SJed Brown 
2637deb2cd25SJed Brown   PetscFunctionBegin;
2638deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2639deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2640deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2641deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2642bbd56ea5SKarl Rupp 
2643deb2cd25SJed Brown   ts->snes = snes;
2644bbd56ea5SKarl Rupp 
26450298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
26460298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2647740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
26480298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2649740132f1SEmil Constantinescu   }
2650deb2cd25SJed Brown   PetscFunctionReturn(0);
2651deb2cd25SJed Brown }
2652deb2cd25SJed Brown 
2653deb2cd25SJed Brown #undef __FUNCT__
265494b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2655d8e5e3e6SSatish Balay /*@
265694b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2657d763cef2SBarry Smith    a TS (timestepper) context.
2658d763cef2SBarry Smith 
265994b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2660d763cef2SBarry Smith 
2661d763cef2SBarry Smith    Input Parameter:
2662d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2663d763cef2SBarry Smith 
2664d763cef2SBarry Smith    Output Parameter:
266594b7f48cSBarry Smith .  ksp - the nonlinear solver context
2666d763cef2SBarry Smith 
2667d763cef2SBarry Smith    Notes:
266894b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2669d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2670d763cef2SBarry Smith    KSP and PC contexts as well.
2671d763cef2SBarry Smith 
267294b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
26730298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2674d763cef2SBarry Smith 
2675d763cef2SBarry Smith    Level: beginner
2676d763cef2SBarry Smith 
267794b7f48cSBarry Smith .keywords: timestep, get, KSP
2678d763cef2SBarry Smith @*/
26797087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2680d763cef2SBarry Smith {
2681d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2682089b2837SJed Brown   SNES           snes;
2683d372ba47SLisandro Dalcin 
2684d763cef2SBarry Smith   PetscFunctionBegin;
26850700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
26864482741eSBarry Smith   PetscValidPointer(ksp,2);
268717186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2688e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2689089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2690089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2691d763cef2SBarry Smith   PetscFunctionReturn(0);
2692d763cef2SBarry Smith }
2693d763cef2SBarry Smith 
2694d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2695d763cef2SBarry Smith 
26964a2ae208SSatish Balay #undef __FUNCT__
2697adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2698adb62b0dSMatthew Knepley /*@
2699adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2700adb62b0dSMatthew Knepley    maximum time for iteration.
2701adb62b0dSMatthew Knepley 
27023f9fe445SBarry Smith    Not Collective
2703adb62b0dSMatthew Knepley 
2704adb62b0dSMatthew Knepley    Input Parameters:
2705adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
27060298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
27070298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2708adb62b0dSMatthew Knepley 
2709adb62b0dSMatthew Knepley    Level: intermediate
2710adb62b0dSMatthew Knepley 
2711adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2712adb62b0dSMatthew Knepley @*/
27137087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2714adb62b0dSMatthew Knepley {
2715adb62b0dSMatthew Knepley   PetscFunctionBegin;
27160700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2717abc0a331SBarry Smith   if (maxsteps) {
27184482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2719adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2720adb62b0dSMatthew Knepley   }
2721abc0a331SBarry Smith   if (maxtime) {
27224482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2723adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2724adb62b0dSMatthew Knepley   }
2725adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2726adb62b0dSMatthew Knepley }
2727adb62b0dSMatthew Knepley 
2728adb62b0dSMatthew Knepley #undef __FUNCT__
27294a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2730d763cef2SBarry Smith /*@
2731d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2732d763cef2SBarry Smith    maximum time for iteration.
2733d763cef2SBarry Smith 
27343f9fe445SBarry Smith    Logically Collective on TS
2735d763cef2SBarry Smith 
2736d763cef2SBarry Smith    Input Parameters:
2737d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2738d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2739d763cef2SBarry Smith -  maxtime - final time to iterate to
2740d763cef2SBarry Smith 
2741d763cef2SBarry Smith    Options Database Keys:
2742d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
27433bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2744d763cef2SBarry Smith 
2745d763cef2SBarry Smith    Notes:
2746d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2747d763cef2SBarry Smith 
2748d763cef2SBarry Smith    Level: intermediate
2749d763cef2SBarry Smith 
2750d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2751a43b19c4SJed Brown 
2752a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2753d763cef2SBarry Smith @*/
27547087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2755d763cef2SBarry Smith {
2756d763cef2SBarry Smith   PetscFunctionBegin;
27570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2758c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2759c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
276039b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
276139b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2762d763cef2SBarry Smith   PetscFunctionReturn(0);
2763d763cef2SBarry Smith }
2764d763cef2SBarry Smith 
27654a2ae208SSatish Balay #undef __FUNCT__
27664a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2767d763cef2SBarry Smith /*@
2768d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2769d763cef2SBarry Smith    for use by the TS routines.
2770d763cef2SBarry Smith 
27713f9fe445SBarry Smith    Logically Collective on TS and Vec
2772d763cef2SBarry Smith 
2773d763cef2SBarry Smith    Input Parameters:
2774d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
27750910c330SBarry Smith -  u - the solution vector
2776d763cef2SBarry Smith 
2777d763cef2SBarry Smith    Level: beginner
2778d763cef2SBarry Smith 
2779d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2780d763cef2SBarry Smith @*/
27810910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2782d763cef2SBarry Smith {
27838737fe31SLisandro Dalcin   PetscErrorCode ierr;
2784496e6a7aSJed Brown   DM             dm;
27858737fe31SLisandro Dalcin 
2786d763cef2SBarry Smith   PetscFunctionBegin;
27870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27880910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
27890910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
27906bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
27910910c330SBarry Smith   ts->vec_sol = u;
2792bbd56ea5SKarl Rupp 
2793496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
27940910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2795d763cef2SBarry Smith   PetscFunctionReturn(0);
2796d763cef2SBarry Smith }
2797d763cef2SBarry Smith 
2798e74ef692SMatthew Knepley #undef __FUNCT__
279973b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps"
280073b18844SBarry Smith /*@
280173b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
280273b18844SBarry Smith 
280373b18844SBarry Smith    Logically Collective on TS
280473b18844SBarry Smith 
280573b18844SBarry Smith    Input Parameters:
280673b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
280773b18844SBarry Smith .  steps - number of steps to use
280873b18844SBarry Smith 
280973b18844SBarry Smith    Level: intermediate
281073b18844SBarry Smith 
281173b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
281273b18844SBarry Smith           so as to integrate back to less than the original timestep
281373b18844SBarry Smith 
281473b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
281573b18844SBarry Smith 
281673b18844SBarry Smith .seealso: TSSetExactFinalTime()
281773b18844SBarry Smith @*/
281873b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
281973b18844SBarry Smith {
282073b18844SBarry Smith   PetscFunctionBegin;
282173b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
282273b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
282373b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
282473b18844SBarry 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");
282573b18844SBarry Smith   ts->adjoint_max_steps = steps;
282673b18844SBarry Smith   PetscFunctionReturn(0);
282773b18844SBarry Smith }
282873b18844SBarry Smith 
282973b18844SBarry Smith #undef __FUNCT__
2830dfb21088SHong Zhang #define __FUNCT__ "TSSetCostGradients"
2831c235aa8dSHong Zhang /*@
2832dfb21088SHong 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
28330cf82b59SBarry Smith       for use by the TSAdjoint routines.
2834c235aa8dSHong Zhang 
2835c235aa8dSHong Zhang    Logically Collective on TS and Vec
2836c235aa8dSHong Zhang 
2837c235aa8dSHong Zhang    Input Parameters:
2838c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2839abc2977eSBarry 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
2840abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2841c235aa8dSHong Zhang 
2842c235aa8dSHong Zhang    Level: beginner
2843c235aa8dSHong Zhang 
2844abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
28450cf82b59SBarry Smith 
2846c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2847c235aa8dSHong Zhang @*/
2848dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
2849c235aa8dSHong Zhang {
2850c235aa8dSHong Zhang   PetscFunctionBegin;
2851c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2852abc2977eSBarry Smith   PetscValidPointer(lambda,2);
2853abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
2854abc2977eSBarry Smith   ts->vecs_sensip = mu;
2855dfb21088SHong 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");
2856abc2977eSBarry Smith   ts->numcost  = numcost;
2857ad8e2604SHong Zhang   PetscFunctionReturn(0);
2858ad8e2604SHong Zhang }
2859ad8e2604SHong Zhang 
2860ad8e2604SHong Zhang #undef __FUNCT__
28615bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian"
2862ad8e2604SHong Zhang /*@C
28630cf82b59SBarry 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.
2864ad8e2604SHong Zhang 
2865ad8e2604SHong Zhang   Logically Collective on TS
2866ad8e2604SHong Zhang 
2867ad8e2604SHong Zhang   Input Parameters:
2868ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2869ad8e2604SHong Zhang - func - The function
2870ad8e2604SHong Zhang 
2871ad8e2604SHong Zhang   Calling sequence of func:
28720cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
287305755b9cSHong Zhang +   t - current timestep
28740cf82b59SBarry Smith .   y - input vector (current ODE solution)
287505755b9cSHong Zhang .   A - output matrix
287605755b9cSHong Zhang -   ctx - [optional] user-defined function context
2877ad8e2604SHong Zhang 
2878ad8e2604SHong Zhang   Level: intermediate
2879ad8e2604SHong Zhang 
28800cf82b59SBarry 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
28810cf82b59SBarry Smith 
2882ad8e2604SHong Zhang .keywords: TS, sensitivity
2883ad8e2604SHong Zhang .seealso:
2884ad8e2604SHong Zhang @*/
28855bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2886ad8e2604SHong Zhang {
2887ad8e2604SHong Zhang   PetscErrorCode ierr;
2888ad8e2604SHong Zhang 
2889ad8e2604SHong Zhang   PetscFunctionBegin;
2890ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2891ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2892ad8e2604SHong Zhang 
2893ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2894ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2895ad8e2604SHong Zhang   if(Amat) {
2896ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2897ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2898ad8e2604SHong Zhang     ts->Jacp = Amat;
2899ad8e2604SHong Zhang   }
2900ad8e2604SHong Zhang   PetscFunctionReturn(0);
2901ad8e2604SHong Zhang }
2902ad8e2604SHong Zhang 
2903ad8e2604SHong Zhang #undef __FUNCT__
29045bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian"
29050cf82b59SBarry Smith /*@C
29065bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2907ad8e2604SHong Zhang 
2908ad8e2604SHong Zhang   Collective on TS
2909ad8e2604SHong Zhang 
2910ad8e2604SHong Zhang   Input Parameters:
2911ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2912ad8e2604SHong Zhang 
2913ad8e2604SHong Zhang   Level: developer
2914ad8e2604SHong Zhang 
2915ad8e2604SHong Zhang .keywords: TS, sensitivity
29165bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
2917ad8e2604SHong Zhang @*/
29185bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2919ad8e2604SHong Zhang {
2920ad8e2604SHong Zhang   PetscErrorCode ierr;
2921ad8e2604SHong Zhang 
2922ad8e2604SHong Zhang   PetscFunctionBegin;
2923ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2924ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2925ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2926ad8e2604SHong Zhang 
2927ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2928ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2929ad8e2604SHong Zhang   PetscStackPop;
2930c235aa8dSHong Zhang   PetscFunctionReturn(0);
2931c235aa8dSHong Zhang }
2932c235aa8dSHong Zhang 
2933c235aa8dSHong Zhang #undef __FUNCT__
2934dfb21088SHong Zhang #define __FUNCT__ "TSSetCostIntegrand"
29356fd0887fSHong Zhang /*@C
2936dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
29376fd0887fSHong Zhang 
29386fd0887fSHong Zhang     Logically Collective on TS
29396fd0887fSHong Zhang 
29406fd0887fSHong Zhang     Input Parameters:
29416fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
2942abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
29430cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
2944b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2945b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
2946b1cb36f3SHong Zhang .   fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run
2947b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
29486fd0887fSHong Zhang 
29490cf82b59SBarry Smith     Calling sequence of rf:
29500cf82b59SBarry Smith $     rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
29516fd0887fSHong Zhang 
29526fd0887fSHong Zhang +   t - current timestep
29530cf82b59SBarry Smith .   y - input vector
29540cf82b59SBarry Smith .   f - function result; one vector entry for each cost function
29556fd0887fSHong Zhang -   ctx - [optional] user-defined function context
29566fd0887fSHong Zhang 
2957b612ec54SBarry Smith    Calling sequence of drdyf:
29580cf82b59SBarry Smith $    PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
2959b612ec54SBarry Smith 
2960b612ec54SBarry Smith    Calling sequence of drdpf:
29610cf82b59SBarry Smith $    PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
2962b612ec54SBarry Smith 
2963b612ec54SBarry Smith     Level: intermediate
29646fd0887fSHong Zhang 
2965abc2977eSBarry Smith     Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions
29660cf82b59SBarry Smith 
29676fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
29686fd0887fSHong Zhang 
2969dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
29706fd0887fSHong Zhang @*/
2971dfb21088SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
2972d8151eeaSBarry Smith                                                           PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
2973b1cb36f3SHong Zhang                                                           PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),
2974b1cb36f3SHong Zhang                                                           PetscBool fwd,void *ctx)
29756fd0887fSHong Zhang {
29766fd0887fSHong Zhang   PetscErrorCode ierr;
29776fd0887fSHong Zhang 
29786fd0887fSHong Zhang   PetscFunctionBegin;
29796fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2980dfb21088SHong 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()");
2981c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
29826fd0887fSHong Zhang 
2983b1cb36f3SHong Zhang   ts->costintegralfwd  = fwd; /* Evaluate the cost integral in forward run if fwd is true */
2984abc2977eSBarry Smith   ierr                 = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
29852c39e106SBarry Smith   ierr                 = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
29860cf82b59SBarry Smith   ts->costintegrand    = rf;
298705755b9cSHong Zhang   ts->costintegrandctx = ctx;
2988b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
2989b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
29906fd0887fSHong Zhang   PetscFunctionReturn(0);
29916fd0887fSHong Zhang }
29926fd0887fSHong Zhang 
29936fd0887fSHong Zhang #undef __FUNCT__
2994dfb21088SHong Zhang #define __FUNCT__ "TSGetCostIntegral"
299536eaed60SHong Zhang /*@
2996dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
299736eaed60SHong Zhang    It is valid to call the routine after a backward run.
299836eaed60SHong Zhang 
299936eaed60SHong Zhang    Not Collective
300036eaed60SHong Zhang 
300136eaed60SHong Zhang    Input Parameter:
300236eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
300336eaed60SHong Zhang 
300436eaed60SHong Zhang    Output Parameter:
30052c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
300636eaed60SHong Zhang 
300736eaed60SHong Zhang    Level: intermediate
300836eaed60SHong Zhang 
3009dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
301036eaed60SHong Zhang 
301136eaed60SHong Zhang .keywords: TS, sensitivity analysis
301236eaed60SHong Zhang @*/
3013dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
301436eaed60SHong Zhang {
301536eaed60SHong Zhang   PetscFunctionBegin;
301636eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
301736eaed60SHong Zhang   PetscValidPointer(v,2);
30182c39e106SBarry Smith   *v = ts->vec_costintegral;
301936eaed60SHong Zhang   PetscFunctionReturn(0);
302036eaed60SHong Zhang }
302136eaed60SHong Zhang 
302236eaed60SHong Zhang #undef __FUNCT__
3023d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand"
30246fd0887fSHong Zhang /*@
30252c39e106SBarry Smith    TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
30266fd0887fSHong Zhang 
30276fd0887fSHong Zhang    Input Parameters:
30286fd0887fSHong Zhang +  ts - the TS context
30296fd0887fSHong Zhang .  t - current time
30300cf82b59SBarry Smith -  y - state vector, i.e. current solution
30316fd0887fSHong Zhang 
30326fd0887fSHong Zhang    Output Parameter:
3033abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
30346fd0887fSHong Zhang 
30356fd0887fSHong Zhang    Note:
30366fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
30376fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
30386fd0887fSHong Zhang 
30396fd0887fSHong Zhang    Level: developer
30406fd0887fSHong Zhang 
30416fd0887fSHong Zhang .keywords: TS, compute
30426fd0887fSHong Zhang 
3043dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
30446fd0887fSHong Zhang @*/
30450cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
30466fd0887fSHong Zhang {
30476fd0887fSHong Zhang   PetscErrorCode ierr;
30486fd0887fSHong Zhang 
30496fd0887fSHong Zhang   PetscFunctionBegin;
30506fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
30510cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
30526fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
30536fd0887fSHong Zhang 
30540cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
3055e4680132SHong Zhang   if (ts->costintegrand) {
3056e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
30570cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
30586fd0887fSHong Zhang     PetscStackPop;
30596fd0887fSHong Zhang   } else {
30606fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
30616fd0887fSHong Zhang   }
30626fd0887fSHong Zhang 
30630cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
30646fd0887fSHong Zhang   PetscFunctionReturn(0);
30656fd0887fSHong Zhang }
30666fd0887fSHong Zhang 
30676fd0887fSHong Zhang #undef __FUNCT__
3068d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction"
306905755b9cSHong Zhang /*@
3070d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
307105755b9cSHong Zhang 
307205755b9cSHong Zhang   Collective on TS
307305755b9cSHong Zhang 
307405755b9cSHong Zhang   Input Parameters:
307505755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
307605755b9cSHong Zhang 
307705755b9cSHong Zhang   Notes:
3078d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
307905755b9cSHong Zhang   so most users would not generally call this routine themselves.
308005755b9cSHong Zhang 
308105755b9cSHong Zhang   Level: developer
308205755b9cSHong Zhang 
308305755b9cSHong Zhang .keywords: TS, sensitivity
3084d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
308505755b9cSHong Zhang @*/
30860cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
308705755b9cSHong Zhang {
308805755b9cSHong Zhang   PetscErrorCode ierr;
308905755b9cSHong Zhang 
309005755b9cSHong Zhang   PetscFunctionBegin;
309105755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
30920cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
309305755b9cSHong Zhang 
309405755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
30950cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
309605755b9cSHong Zhang   PetscStackPop;
309705755b9cSHong Zhang   PetscFunctionReturn(0);
309805755b9cSHong Zhang }
309905755b9cSHong Zhang 
310005755b9cSHong Zhang #undef __FUNCT__
3101d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction"
310205755b9cSHong Zhang /*@
3103d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
310405755b9cSHong Zhang 
310505755b9cSHong Zhang   Collective on TS
310605755b9cSHong Zhang 
310705755b9cSHong Zhang   Input Parameters:
310805755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
310905755b9cSHong Zhang 
311005755b9cSHong Zhang   Notes:
311105755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
311205755b9cSHong Zhang   so most users would not generally call this routine themselves.
311305755b9cSHong Zhang 
311405755b9cSHong Zhang   Level: developer
311505755b9cSHong Zhang 
311605755b9cSHong Zhang .keywords: TS, sensitivity
3117d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
311805755b9cSHong Zhang @*/
31190cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
312005755b9cSHong Zhang {
312105755b9cSHong Zhang   PetscErrorCode ierr;
312205755b9cSHong Zhang 
312305755b9cSHong Zhang   PetscFunctionBegin;
312405755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31250cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
312605755b9cSHong Zhang 
312705755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
31280cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
312905755b9cSHong Zhang   PetscStackPop;
313005755b9cSHong Zhang   PetscFunctionReturn(0);
313105755b9cSHong Zhang }
313205755b9cSHong Zhang 
313305755b9cSHong Zhang #undef __FUNCT__
3134e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
3135ac226902SBarry Smith /*@C
3136000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
31373f2090d5SJed Brown   called once at the beginning of each time step.
3138000e7ae3SMatthew Knepley 
31393f9fe445SBarry Smith   Logically Collective on TS
3140000e7ae3SMatthew Knepley 
3141000e7ae3SMatthew Knepley   Input Parameters:
3142000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3143000e7ae3SMatthew Knepley - func - The function
3144000e7ae3SMatthew Knepley 
3145000e7ae3SMatthew Knepley   Calling sequence of func:
3146000e7ae3SMatthew Knepley . func (TS ts);
3147000e7ae3SMatthew Knepley 
3148000e7ae3SMatthew Knepley   Level: intermediate
3149000e7ae3SMatthew Knepley 
3150b8123daeSJed Brown   Note:
3151b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
3152b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
3153b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
3154b8123daeSJed Brown 
3155000e7ae3SMatthew Knepley .keywords: TS, timestep
31569be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
3157000e7ae3SMatthew Knepley @*/
31587087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3159000e7ae3SMatthew Knepley {
3160000e7ae3SMatthew Knepley   PetscFunctionBegin;
31610700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3162ae60f76fSBarry Smith   ts->prestep = func;
3163000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3164000e7ae3SMatthew Knepley }
3165000e7ae3SMatthew Knepley 
3166e74ef692SMatthew Knepley #undef __FUNCT__
31673f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
316809ee8438SJed Brown /*@
31693f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
31703f2090d5SJed Brown 
31713f2090d5SJed Brown   Collective on TS
31723f2090d5SJed Brown 
31733f2090d5SJed Brown   Input Parameters:
31743f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
31753f2090d5SJed Brown 
31763f2090d5SJed Brown   Notes:
31773f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
31783f2090d5SJed Brown   so most users would not generally call this routine themselves.
31793f2090d5SJed Brown 
31803f2090d5SJed Brown   Level: developer
31813f2090d5SJed Brown 
31823f2090d5SJed Brown .keywords: TS, timestep
31839be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
31843f2090d5SJed Brown @*/
31857087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
31863f2090d5SJed Brown {
31873f2090d5SJed Brown   PetscErrorCode ierr;
31883f2090d5SJed Brown 
31893f2090d5SJed Brown   PetscFunctionBegin;
31900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3191ae60f76fSBarry Smith   if (ts->prestep) {
3192ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
3193312ce896SJed Brown   }
31943f2090d5SJed Brown   PetscFunctionReturn(0);
31953f2090d5SJed Brown }
31963f2090d5SJed Brown 
31973f2090d5SJed Brown #undef __FUNCT__
3198b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
3199b8123daeSJed Brown /*@C
3200b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3201b8123daeSJed Brown   called once at the beginning of each stage.
3202b8123daeSJed Brown 
3203b8123daeSJed Brown   Logically Collective on TS
3204b8123daeSJed Brown 
3205b8123daeSJed Brown   Input Parameters:
3206b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3207b8123daeSJed Brown - func - The function
3208b8123daeSJed Brown 
3209b8123daeSJed Brown   Calling sequence of func:
3210b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
3211b8123daeSJed Brown 
3212b8123daeSJed Brown   Level: intermediate
3213b8123daeSJed Brown 
3214b8123daeSJed Brown   Note:
3215b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
3216b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
3217b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3218b8123daeSJed Brown 
3219b8123daeSJed Brown .keywords: TS, timestep
32209be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3221b8123daeSJed Brown @*/
3222b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3223b8123daeSJed Brown {
3224b8123daeSJed Brown   PetscFunctionBegin;
3225b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3226ae60f76fSBarry Smith   ts->prestage = func;
3227b8123daeSJed Brown   PetscFunctionReturn(0);
3228b8123daeSJed Brown }
3229b8123daeSJed Brown 
3230b8123daeSJed Brown #undef __FUNCT__
32319be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
32329be3e283SDebojyoti Ghosh /*@C
32339be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
32349be3e283SDebojyoti Ghosh   called once at the end of each stage.
32359be3e283SDebojyoti Ghosh 
32369be3e283SDebojyoti Ghosh   Logically Collective on TS
32379be3e283SDebojyoti Ghosh 
32389be3e283SDebojyoti Ghosh   Input Parameters:
32399be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
32409be3e283SDebojyoti Ghosh - func - The function
32419be3e283SDebojyoti Ghosh 
32429be3e283SDebojyoti Ghosh   Calling sequence of func:
32439be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
32449be3e283SDebojyoti Ghosh 
32459be3e283SDebojyoti Ghosh   Level: intermediate
32469be3e283SDebojyoti Ghosh 
32479be3e283SDebojyoti Ghosh   Note:
32489be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
32499be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
32509be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
32519be3e283SDebojyoti Ghosh 
32529be3e283SDebojyoti Ghosh .keywords: TS, timestep
32539be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
32549be3e283SDebojyoti Ghosh @*/
32559be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
32569be3e283SDebojyoti Ghosh {
32579be3e283SDebojyoti Ghosh   PetscFunctionBegin;
32589be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
32599be3e283SDebojyoti Ghosh   ts->poststage = func;
32609be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
32619be3e283SDebojyoti Ghosh }
32629be3e283SDebojyoti Ghosh 
32639be3e283SDebojyoti Ghosh #undef __FUNCT__
3264b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
3265b8123daeSJed Brown /*@
3266b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3267b8123daeSJed Brown 
3268b8123daeSJed Brown   Collective on TS
3269b8123daeSJed Brown 
3270b8123daeSJed Brown   Input Parameters:
3271b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
32729be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3273b8123daeSJed Brown 
3274b8123daeSJed Brown   Notes:
3275b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3276b8123daeSJed Brown   most users would not generally call this routine themselves.
3277b8123daeSJed Brown 
3278b8123daeSJed Brown   Level: developer
3279b8123daeSJed Brown 
3280b8123daeSJed Brown .keywords: TS, timestep
32819be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3282b8123daeSJed Brown @*/
3283b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3284b8123daeSJed Brown {
3285b8123daeSJed Brown   PetscErrorCode ierr;
3286b8123daeSJed Brown 
3287b8123daeSJed Brown   PetscFunctionBegin;
3288b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3289ae60f76fSBarry Smith   if (ts->prestage) {
3290ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3291b8123daeSJed Brown   }
3292b8123daeSJed Brown   PetscFunctionReturn(0);
3293b8123daeSJed Brown }
3294b8123daeSJed Brown 
3295b8123daeSJed Brown #undef __FUNCT__
32969be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
32979be3e283SDebojyoti Ghosh /*@
32989be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
32999be3e283SDebojyoti Ghosh 
33009be3e283SDebojyoti Ghosh   Collective on TS
33019be3e283SDebojyoti Ghosh 
33029be3e283SDebojyoti Ghosh   Input Parameters:
33039be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
33049be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
33059be3e283SDebojyoti Ghosh   stageindex  - Stage number
33069be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
33079be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
33089be3e283SDebojyoti Ghosh 
33099be3e283SDebojyoti Ghosh   Notes:
33109be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
33119be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
33129be3e283SDebojyoti Ghosh 
33139be3e283SDebojyoti Ghosh   Level: developer
33149be3e283SDebojyoti Ghosh 
33159be3e283SDebojyoti Ghosh .keywords: TS, timestep
33169be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
33179be3e283SDebojyoti Ghosh @*/
33189be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
33199be3e283SDebojyoti Ghosh {
33209be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
33219be3e283SDebojyoti Ghosh 
33229be3e283SDebojyoti Ghosh   PetscFunctionBegin;
33239be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33244beae5d8SLisandro Dalcin   if (ts->poststage) {
33259be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
33269be3e283SDebojyoti Ghosh   }
33279be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
33289be3e283SDebojyoti Ghosh }
33299be3e283SDebojyoti Ghosh 
33309be3e283SDebojyoti Ghosh #undef __FUNCT__
3331e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
3332ac226902SBarry Smith /*@C
3333000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
33343f2090d5SJed Brown   called once at the end of each time step.
3335000e7ae3SMatthew Knepley 
33363f9fe445SBarry Smith   Logically Collective on TS
3337000e7ae3SMatthew Knepley 
3338000e7ae3SMatthew Knepley   Input Parameters:
3339000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3340000e7ae3SMatthew Knepley - func - The function
3341000e7ae3SMatthew Knepley 
3342000e7ae3SMatthew Knepley   Calling sequence of func:
3343b8123daeSJed Brown $ func (TS ts);
3344000e7ae3SMatthew Knepley 
3345000e7ae3SMatthew Knepley   Level: intermediate
3346000e7ae3SMatthew Knepley 
3347000e7ae3SMatthew Knepley .keywords: TS, timestep
3348b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
3349000e7ae3SMatthew Knepley @*/
33507087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3351000e7ae3SMatthew Knepley {
3352000e7ae3SMatthew Knepley   PetscFunctionBegin;
33530700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3354ae60f76fSBarry Smith   ts->poststep = func;
3355000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3356000e7ae3SMatthew Knepley }
3357000e7ae3SMatthew Knepley 
3358e74ef692SMatthew Knepley #undef __FUNCT__
33593f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
336009ee8438SJed Brown /*@
33613f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
33623f2090d5SJed Brown 
33633f2090d5SJed Brown   Collective on TS
33643f2090d5SJed Brown 
33653f2090d5SJed Brown   Input Parameters:
33663f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
33673f2090d5SJed Brown 
33683f2090d5SJed Brown   Notes:
33693f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
33703f2090d5SJed Brown   so most users would not generally call this routine themselves.
33713f2090d5SJed Brown 
33723f2090d5SJed Brown   Level: developer
33733f2090d5SJed Brown 
33743f2090d5SJed Brown .keywords: TS, timestep
33753f2090d5SJed Brown @*/
33767087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
33773f2090d5SJed Brown {
33783f2090d5SJed Brown   PetscErrorCode ierr;
33793f2090d5SJed Brown 
33803f2090d5SJed Brown   PetscFunctionBegin;
33810700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3382ae60f76fSBarry Smith   if (ts->poststep) {
3383ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
338472ac3e02SJed Brown   }
33853f2090d5SJed Brown   PetscFunctionReturn(0);
33863f2090d5SJed Brown }
33873f2090d5SJed Brown 
3388d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3389d763cef2SBarry Smith 
33904a2ae208SSatish Balay #undef __FUNCT__
3391a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
3392d763cef2SBarry Smith /*@C
3393a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3394d763cef2SBarry Smith    timestep to display the iteration's  progress.
3395d763cef2SBarry Smith 
33963f9fe445SBarry Smith    Logically Collective on TS
3397d763cef2SBarry Smith 
3398d763cef2SBarry Smith    Input Parameters:
3399d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3400e213d8f1SJed Brown .  monitor - monitoring routine
3401329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
34020298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3403b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
34040298fd71SBarry Smith           (may be NULL)
3405d763cef2SBarry Smith 
3406e213d8f1SJed Brown    Calling sequence of monitor:
34070910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3408d763cef2SBarry Smith 
3409d763cef2SBarry Smith +    ts - the TS context
341063e21af5SBarry Smith .    steps - iteration number (after the final time step the monitor routine may be called with a step of -1, this indicates the solution has been interpolated to this time)
34111f06c33eSBarry Smith .    time - current time
34120910c330SBarry Smith .    u - current iterate
3413d763cef2SBarry Smith -    mctx - [optional] monitoring context
3414d763cef2SBarry Smith 
3415d763cef2SBarry Smith    Notes:
3416d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3417d763cef2SBarry Smith    already has been loaded.
3418d763cef2SBarry Smith 
3419025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
3420025f1a04SBarry Smith 
3421d763cef2SBarry Smith    Level: intermediate
3422d763cef2SBarry Smith 
3423d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3424d763cef2SBarry Smith 
3425a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3426d763cef2SBarry Smith @*/
3427c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3428d763cef2SBarry Smith {
3429*78064530SBarry Smith   PetscErrorCode ierr;
3430*78064530SBarry Smith   PetscInt       i;
3431*78064530SBarry Smith   PetscBool      identical;
3432*78064530SBarry Smith 
3433d763cef2SBarry Smith   PetscFunctionBegin;
34340700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3435*78064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
3436*78064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
3437*78064530SBarry Smith     if (identical) PetscFunctionReturn(0);
3438*78064530SBarry Smith   }
343917186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3440d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
34418704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3442d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3443d763cef2SBarry Smith   PetscFunctionReturn(0);
3444d763cef2SBarry Smith }
3445d763cef2SBarry Smith 
34464a2ae208SSatish Balay #undef __FUNCT__
3447a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
3448d763cef2SBarry Smith /*@C
3449a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3450d763cef2SBarry Smith 
34513f9fe445SBarry Smith    Logically Collective on TS
3452d763cef2SBarry Smith 
3453d763cef2SBarry Smith    Input Parameters:
3454d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3455d763cef2SBarry Smith 
3456d763cef2SBarry Smith    Notes:
3457d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3458d763cef2SBarry Smith 
3459d763cef2SBarry Smith    Level: intermediate
3460d763cef2SBarry Smith 
3461d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3462d763cef2SBarry Smith 
3463a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3464d763cef2SBarry Smith @*/
34657087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3466d763cef2SBarry Smith {
3467d952e501SBarry Smith   PetscErrorCode ierr;
3468d952e501SBarry Smith   PetscInt       i;
3469d952e501SBarry Smith 
3470d763cef2SBarry Smith   PetscFunctionBegin;
34710700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3472d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
34738704b422SBarry Smith     if (ts->monitordestroy[i]) {
34748704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3475d952e501SBarry Smith     }
3476d952e501SBarry Smith   }
3477d763cef2SBarry Smith   ts->numbermonitors = 0;
3478d763cef2SBarry Smith   PetscFunctionReturn(0);
3479d763cef2SBarry Smith }
3480d763cef2SBarry Smith 
34814a2ae208SSatish Balay #undef __FUNCT__
3482a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
3483721cd6eeSBarry Smith /*@C
3484721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
34855516499fSSatish Balay 
34865516499fSSatish Balay    Level: intermediate
348741251cbbSSatish Balay 
34885516499fSSatish Balay .keywords: TS, set, monitor
34895516499fSSatish Balay 
349063e21af5SBarry Smith .seealso:  TSMonitorSet()
349141251cbbSSatish Balay @*/
3492721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3493d763cef2SBarry Smith {
3494dfbe8321SBarry Smith   PetscErrorCode ierr;
3495721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
349641aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3497d132466eSBarry Smith 
3498d763cef2SBarry Smith   PetscFunctionBegin;
34994d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
350041aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
350141aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3502721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
350341aca3d6SBarry Smith   if (iascii) {
3504649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
350563e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
350663e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
350763e21af5SBarry Smith     } else {
35088392e04aSShri 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);
350963e21af5SBarry Smith     }
3510649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
351141aca3d6SBarry Smith   } else if (ibinary) {
351241aca3d6SBarry Smith     PetscMPIInt rank;
351341aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
351441aca3d6SBarry Smith     if (!rank) {
351541aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
351641aca3d6SBarry Smith     } else {
351741aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
351841aca3d6SBarry Smith     }
351941aca3d6SBarry Smith   }
3520721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3521d763cef2SBarry Smith   PetscFunctionReturn(0);
3522d763cef2SBarry Smith }
3523d763cef2SBarry Smith 
35244a2ae208SSatish Balay #undef __FUNCT__
35259110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorSet"
35269110b2e7SHong Zhang /*@C
35279110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
35289110b2e7SHong Zhang    timestep to display the iteration's  progress.
35299110b2e7SHong Zhang 
35309110b2e7SHong Zhang    Logically Collective on TS
35319110b2e7SHong Zhang 
35329110b2e7SHong Zhang    Input Parameters:
35339110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
35349110b2e7SHong Zhang .  adjointmonitor - monitoring routine
35359110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
35369110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
35379110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
35389110b2e7SHong Zhang           (may be NULL)
35399110b2e7SHong Zhang 
35409110b2e7SHong Zhang    Calling sequence of monitor:
35419110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
35429110b2e7SHong Zhang 
35439110b2e7SHong Zhang +    ts - the TS context
35449110b2e7SHong 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
35459110b2e7SHong Zhang                                been interpolated to)
35469110b2e7SHong Zhang .    time - current time
35479110b2e7SHong Zhang .    u - current iterate
35489110b2e7SHong Zhang .    numcost - number of cost functionos
35499110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
35509110b2e7SHong Zhang .    mu - sensitivities to parameters
35519110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
35529110b2e7SHong Zhang 
35539110b2e7SHong Zhang    Notes:
35549110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
35559110b2e7SHong Zhang    already has been loaded.
35569110b2e7SHong Zhang 
35579110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
35589110b2e7SHong Zhang 
35599110b2e7SHong Zhang    Level: intermediate
35609110b2e7SHong Zhang 
35619110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
35629110b2e7SHong Zhang 
35639110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
35649110b2e7SHong Zhang @*/
35659110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
35669110b2e7SHong Zhang {
3567*78064530SBarry Smith   PetscErrorCode ierr;
3568*78064530SBarry Smith   PetscInt       i;
3569*78064530SBarry Smith   PetscBool      identical;
3570*78064530SBarry Smith 
35719110b2e7SHong Zhang   PetscFunctionBegin;
35729110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3573*78064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
3574*78064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr);
3575*78064530SBarry Smith     if (identical) PetscFunctionReturn(0);
3576*78064530SBarry Smith   }
35779110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
35789110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
35799110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
35809110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
35819110b2e7SHong Zhang   PetscFunctionReturn(0);
35829110b2e7SHong Zhang }
35839110b2e7SHong Zhang 
35849110b2e7SHong Zhang #undef __FUNCT__
35859110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorCancel"
35869110b2e7SHong Zhang /*@C
35879110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
35889110b2e7SHong Zhang 
35899110b2e7SHong Zhang    Logically Collective on TS
35909110b2e7SHong Zhang 
35919110b2e7SHong Zhang    Input Parameters:
35929110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
35939110b2e7SHong Zhang 
35949110b2e7SHong Zhang    Notes:
35959110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
35969110b2e7SHong Zhang 
35979110b2e7SHong Zhang    Level: intermediate
35989110b2e7SHong Zhang 
35999110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
36009110b2e7SHong Zhang 
36019110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
36029110b2e7SHong Zhang @*/
36039110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
36049110b2e7SHong Zhang {
36059110b2e7SHong Zhang   PetscErrorCode ierr;
36069110b2e7SHong Zhang   PetscInt       i;
36079110b2e7SHong Zhang 
36089110b2e7SHong Zhang   PetscFunctionBegin;
36099110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
36109110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
36119110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
36129110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
36139110b2e7SHong Zhang     }
36149110b2e7SHong Zhang   }
36159110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
36169110b2e7SHong Zhang   PetscFunctionReturn(0);
36179110b2e7SHong Zhang }
36189110b2e7SHong Zhang 
36199110b2e7SHong Zhang #undef __FUNCT__
3620110eb670SHong Zhang #define __FUNCT__ "TSAdjointMonitorDefault"
3621721cd6eeSBarry Smith /*@C
3622721cd6eeSBarry Smith    TSAdjointMonitorDefault - the default monitor of adjoint computations
3623110eb670SHong Zhang 
3624110eb670SHong Zhang    Level: intermediate
3625110eb670SHong Zhang 
3626110eb670SHong Zhang .keywords: TS, set, monitor
3627110eb670SHong Zhang 
3628110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
3629110eb670SHong Zhang @*/
3630721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
3631110eb670SHong Zhang {
3632110eb670SHong Zhang   PetscErrorCode ierr;
3633721cd6eeSBarry Smith   PetscViewer    viewer = vf->viewer;
3634110eb670SHong Zhang 
3635110eb670SHong Zhang   PetscFunctionBegin;
3636110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3637721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
3638110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3639110eb670SHong 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);
3640110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3641721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3642110eb670SHong Zhang   PetscFunctionReturn(0);
3643110eb670SHong Zhang }
3644110eb670SHong Zhang 
3645110eb670SHong Zhang #undef __FUNCT__
3646cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
3647cd652676SJed Brown /*@
3648cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3649cd652676SJed Brown 
3650cd652676SJed Brown    Collective on TS
3651cd652676SJed Brown 
3652cd652676SJed Brown    Input Argument:
3653cd652676SJed Brown +  ts - time stepping context
3654cd652676SJed Brown -  t - time to interpolate to
3655cd652676SJed Brown 
3656cd652676SJed Brown    Output Argument:
36570910c330SBarry Smith .  U - state at given time
3658cd652676SJed Brown 
3659cd652676SJed Brown    Level: intermediate
3660cd652676SJed Brown 
3661cd652676SJed Brown    Developer Notes:
3662cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3663cd652676SJed Brown 
3664cd652676SJed Brown .keywords: TS, set
3665cd652676SJed Brown 
3666874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
3667cd652676SJed Brown @*/
36680910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3669cd652676SJed Brown {
3670cd652676SJed Brown   PetscErrorCode ierr;
3671cd652676SJed Brown 
3672cd652676SJed Brown   PetscFunctionBegin;
3673cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3674b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3675be5899b3SLisandro Dalcin   if (t < ts->ptime_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)ts->ptime_prev,(double)ts->ptime);
3676ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
36770910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3678cd652676SJed Brown   PetscFunctionReturn(0);
3679cd652676SJed Brown }
3680cd652676SJed Brown 
3681cd652676SJed Brown #undef __FUNCT__
36824a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3683d763cef2SBarry Smith /*@
36846d9e5789SSean Farley    TSStep - Steps one time step
3685d763cef2SBarry Smith 
3686d763cef2SBarry Smith    Collective on TS
3687d763cef2SBarry Smith 
3688d763cef2SBarry Smith    Input Parameter:
3689d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3690d763cef2SBarry Smith 
369127829d71SBarry Smith    Level: developer
3692d763cef2SBarry Smith 
3693b8123daeSJed Brown    Notes:
369427829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
369527829d71SBarry Smith 
3696b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3697b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3698b8123daeSJed Brown 
369925cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
370025cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
370125cb2221SBarry Smith 
3702d763cef2SBarry Smith .keywords: TS, timestep, solve
3703d763cef2SBarry Smith 
37049be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3705d763cef2SBarry Smith @*/
3706193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3707d763cef2SBarry Smith {
3708dfbe8321SBarry Smith   PetscErrorCode   ierr;
3709fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3710be5899b3SLisandro Dalcin   PetscReal        ptime;
3711d763cef2SBarry Smith 
3712d763cef2SBarry Smith   PetscFunctionBegin;
37130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3714fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3715fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3716fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3717fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3718fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3719fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3720302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
3721fffbeea8SBarry Smith 
3722d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
372368bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3724d405a339SMatthew Knepley 
3725a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSStep()");
3726be5899b3SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
3727a6772fa2SLisandro Dalcin 
3728be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
3729362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3730be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
3731e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3732d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3733193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3734d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3735be5899b3SLisandro Dalcin   ts->ptime_prev = ptime;
3736be5899b3SLisandro Dalcin   ts->steps++; ts->total_steps++;
3737be5899b3SLisandro Dalcin   ts->steprollback = PETSC_FALSE;
373828d5b5d6SLisandro Dalcin   ts->steprestart  = PETSC_FALSE;
3739362cd11cSLisandro Dalcin 
3740362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3741cef5090cSJed Brown     if (ts->errorifstepfailed) {
374208c7845fSBarry 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]);
374308c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3744d2daff3dSHong Zhang     }
374508c7845fSBarry Smith   } else if (!ts->reason) {
374608c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
374708c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
374808c7845fSBarry Smith   }
374908c7845fSBarry Smith   PetscFunctionReturn(0);
375008c7845fSBarry Smith }
375108c7845fSBarry Smith 
375208c7845fSBarry Smith #undef __FUNCT__
375308c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep"
375408c7845fSBarry Smith /*@
3755b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
375608c7845fSBarry Smith 
375708c7845fSBarry Smith    Collective on TS
375808c7845fSBarry Smith 
375908c7845fSBarry Smith    Input Parameter:
376008c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
376108c7845fSBarry Smith 
37626a4d4014SLisandro Dalcin    Level: intermediate
37636a4d4014SLisandro Dalcin 
3764b957a604SHong Zhang .keywords: TS, adjoint, step
37656a4d4014SLisandro Dalcin 
3766b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
37676a4d4014SLisandro Dalcin @*/
376808c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
37696a4d4014SLisandro Dalcin {
377008c7845fSBarry Smith   DM               dm;
37716a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
37726a4d4014SLisandro Dalcin 
37736a4d4014SLisandro Dalcin   PetscFunctionBegin;
37744a2ae208SSatish Balay   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
377508c7845fSBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
377608c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3777d763cef2SBarry Smith 
3778685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr);
3779d763cef2SBarry Smith 
3780be5899b3SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3781be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime;
378242f2b339SBarry 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);
3783be5899b3SLisandro Dalcin   ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
378442f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
37858d0ad7a8SHong Zhang   ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
3786be5899b3SLisandro Dalcin   ts->steps++; ts->total_steps--;
3787362cd11cSLisandro Dalcin 
3788362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3789cef5090cSJed Brown     if (ts->errorifstepfailed) {
37906c4ed002SBarry 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]);
37916c4ed002SBarry 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]);
37926c4ed002SBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3793cef5090cSJed Brown     }
3794362cd11cSLisandro Dalcin   } else if (!ts->reason) {
379573b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
3796362cd11cSLisandro Dalcin   }
3797d763cef2SBarry Smith   PetscFunctionReturn(0);
3798d763cef2SBarry Smith }
3799d763cef2SBarry Smith 
3800d763cef2SBarry Smith #undef __FUNCT__
38017cbde773SLisandro Dalcin #define __FUNCT__ "TSEvaluateWLTE"
38027cbde773SLisandro Dalcin /*@
38037cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
38047cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
38057cbde773SLisandro Dalcin 
38067cbde773SLisandro Dalcin    Collective on TS
38077cbde773SLisandro Dalcin 
38087cbde773SLisandro Dalcin    Input Arguments:
38097cbde773SLisandro Dalcin +  ts - time stepping context
38107cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
38117cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
38127cbde773SLisandro Dalcin 
38137cbde773SLisandro Dalcin    Output Arguments:
38147cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
38157cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
38167cbde773SLisandro Dalcin 
38177cbde773SLisandro Dalcin    Level: advanced
38187cbde773SLisandro Dalcin 
38197cbde773SLisandro Dalcin    Notes:
38207cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
38217cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
38227cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
38237cbde773SLisandro Dalcin 
38247cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
38257cbde773SLisandro Dalcin @*/
38267cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
38277cbde773SLisandro Dalcin {
38287cbde773SLisandro Dalcin   PetscErrorCode ierr;
38297cbde773SLisandro Dalcin 
38307cbde773SLisandro Dalcin   PetscFunctionBegin;
38317cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
38327cbde773SLisandro Dalcin   PetscValidType(ts,1);
38337cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
38347cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
38357cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
38367cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
38377cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
38387cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
38397cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
38407cbde773SLisandro Dalcin   PetscFunctionReturn(0);
38417cbde773SLisandro Dalcin }
38427cbde773SLisandro Dalcin 
38437cbde773SLisandro Dalcin #undef __FUNCT__
384405175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
384505175c85SJed Brown /*@
384605175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
384705175c85SJed Brown 
38481c3436cfSJed Brown    Collective on TS
384905175c85SJed Brown 
385005175c85SJed Brown    Input Arguments:
38511c3436cfSJed Brown +  ts - time stepping context
38521c3436cfSJed Brown .  order - desired order of accuracy
38530298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
385405175c85SJed Brown 
385505175c85SJed Brown    Output Arguments:
38560910c330SBarry Smith .  U - state at the end of the current step
385705175c85SJed Brown 
385805175c85SJed Brown    Level: advanced
385905175c85SJed Brown 
3860108c343cSJed Brown    Notes:
3861108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3862108c343cSJed 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.
3863108c343cSJed Brown 
38641c3436cfSJed Brown .seealso: TSStep(), TSAdapt
386505175c85SJed Brown @*/
38660910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
386705175c85SJed Brown {
386805175c85SJed Brown   PetscErrorCode ierr;
386905175c85SJed Brown 
387005175c85SJed Brown   PetscFunctionBegin;
387105175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
387205175c85SJed Brown   PetscValidType(ts,1);
38730910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3874ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
38750910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
387605175c85SJed Brown   PetscFunctionReturn(0);
387705175c85SJed Brown }
387805175c85SJed Brown 
3879b1cb36f3SHong Zhang #undef __FUNCT__
3880b1cb36f3SHong Zhang #define __FUNCT__ "TSForwardCostIntegral"
3881b1cb36f3SHong Zhang /*@
3882b1cb36f3SHong Zhang  TSForwardCostIntegral - Evaluate the cost integral in the forward run.
3883b1cb36f3SHong Zhang 
3884b1cb36f3SHong Zhang  Collective on TS
3885b1cb36f3SHong Zhang 
3886b1cb36f3SHong Zhang  Input Arguments:
3887b1cb36f3SHong Zhang  .  ts - time stepping context
3888b1cb36f3SHong Zhang 
3889b1cb36f3SHong Zhang  Level: advanced
3890b1cb36f3SHong Zhang 
3891b1cb36f3SHong Zhang  Notes:
3892b1cb36f3SHong Zhang  This function cannot be called until TSStep() has been completed.
3893b1cb36f3SHong Zhang 
3894b1cb36f3SHong Zhang  .seealso: TSSolve(), TSAdjointCostIntegral()
3895b1cb36f3SHong Zhang  @*/
3896b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts)
3897b1cb36f3SHong Zhang {
3898b1cb36f3SHong Zhang     PetscErrorCode ierr;
3899b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3900b1cb36f3SHong 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);
3901b1cb36f3SHong Zhang     ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr);
3902b1cb36f3SHong Zhang     PetscFunctionReturn(0);
3903b1cb36f3SHong Zhang }
3904d67e68b7SBarry Smith 
390505175c85SJed Brown #undef __FUNCT__
3906d763cef2SBarry Smith #define __FUNCT__ "TSSolve"
3907d763cef2SBarry Smith /*@
3908d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
3909d763cef2SBarry Smith 
3910d763cef2SBarry Smith    Collective on TS
3911d763cef2SBarry Smith 
3912d763cef2SBarry Smith    Input Parameter:
3913d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
391463e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
391563e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
39165a3a76d0SJed Brown 
3917d763cef2SBarry Smith    Level: beginner
3918d763cef2SBarry Smith 
39195a3a76d0SJed Brown    Notes:
39205a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
39215a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
39225a3a76d0SJed Brown    stepped over the final time.
39235a3a76d0SJed Brown 
3924d763cef2SBarry Smith .keywords: TS, timestep, solve
3925d763cef2SBarry Smith 
392663e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
3927d763cef2SBarry Smith @*/
3928cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
3929d763cef2SBarry Smith {
3930b06615a5SLisandro Dalcin   Vec               solution;
3931d763cef2SBarry Smith   PetscErrorCode    ierr;
3932d763cef2SBarry Smith 
3933d763cef2SBarry Smith   PetscFunctionBegin;
3934d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3935f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3936feed9e9dSBarry Smith 
393749354f04SShri 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 */
3938b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
39390910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3940b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3941b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3942b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
39435a3a76d0SJed Brown     }
39440910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3945bbd56ea5SKarl Rupp   } else if (u) {
39460910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
39475a3a76d0SJed Brown   }
3948b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
394968bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3950a6772fa2SLisandro Dalcin 
3951a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSSolve()");
3952a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
3953a6772fa2SLisandro Dalcin 
3954d763cef2SBarry Smith   /* reset time step and iteration counters */
3955193ac0bcSJed Brown   ts->steps             = 0;
39565ef26d82SJed Brown   ts->ksp_its           = 0;
39575ef26d82SJed Brown   ts->snes_its          = 0;
3958c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
3959c610991cSLisandro Dalcin   ts->reject            = 0;
3960193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
3961193ac0bcSJed Brown 
3962ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3963f05ece33SBarry Smith 
3964193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
3965193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
3966a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3967cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3968a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
3969be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
3970db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3971db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3972cdf0de3dSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
39736427ac75SLisandro Dalcin     ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
397428d5b5d6SLisandro Dalcin     ts->steprollback = PETSC_FALSE;
397528d5b5d6SLisandro Dalcin     ts->steprestart  = PETSC_TRUE;
39766427ac75SLisandro Dalcin 
3977e1a7a14fSJed Brown     while (!ts->reason) {
3978193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
39799687d888SLisandro Dalcin       if (!ts->steprollback) {
39809687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
39819687d888SLisandro Dalcin       }
3982193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
3983e783b05fSHong Zhang       if (ts->vec_costintegral && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */
3984b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
3985b1cb36f3SHong Zhang       }
3986e783b05fSHong Zhang       ierr = TSEventHandler(ts);CHKERRQ(ierr); /* The right-hand side may be changed due to event. Be careful with Any computation using the RHS information after this point. */
3987e783b05fSHong Zhang       if (!ts->steprollback) {
3988cdf0de3dSShri Abhyankar         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
39891eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
3990aeb4809dSShri Abhyankar       }
3991193ac0bcSJed Brown     }
399263e21af5SBarry Smith     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
39936427ac75SLisandro Dalcin 
399449354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
39950910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3996cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3997b06615a5SLisandro Dalcin       solution = u;
399863e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
39990574a7fbSJed Brown     } else {
4000ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4001cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4002b06615a5SLisandro Dalcin       solution = ts->vec_sol;
40030574a7fbSJed Brown     }
4004193ac0bcSJed Brown   }
4005d2daff3dSHong Zhang 
4006ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
400763e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
400856f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
4009ef222394SBarry Smith   if (ts->adjoint_solve) {
4010ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
40112b0a91c0SBarry Smith   }
4012d763cef2SBarry Smith   PetscFunctionReturn(0);
4013d763cef2SBarry Smith }
4014d763cef2SBarry Smith 
4015d763cef2SBarry Smith #undef __FUNCT__
4016b1cb36f3SHong Zhang #define __FUNCT__ "TSAdjointCostIntegral"
4017b1cb36f3SHong Zhang /*@
4018b1cb36f3SHong Zhang  TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run.
4019b1cb36f3SHong Zhang 
4020b1cb36f3SHong Zhang  Collective on TS
4021b1cb36f3SHong Zhang 
4022b1cb36f3SHong Zhang  Input Arguments:
4023b1cb36f3SHong Zhang  .  ts - time stepping context
4024b1cb36f3SHong Zhang 
4025b1cb36f3SHong Zhang  Level: advanced
4026b1cb36f3SHong Zhang 
4027b1cb36f3SHong Zhang  Notes:
4028b1cb36f3SHong Zhang  This function cannot be called until TSAdjointStep() has been completed.
4029b1cb36f3SHong Zhang 
4030b1cb36f3SHong Zhang  .seealso: TSAdjointSolve(), TSAdjointStep
4031b1cb36f3SHong Zhang  @*/
4032b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts)
4033b1cb36f3SHong Zhang {
4034b1cb36f3SHong Zhang     PetscErrorCode ierr;
4035b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4036b1cb36f3SHong 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);
4037b1cb36f3SHong Zhang     ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr);
4038b1cb36f3SHong Zhang     PetscFunctionReturn(0);
4039b1cb36f3SHong Zhang }
4040b1cb36f3SHong Zhang 
4041b1cb36f3SHong Zhang #undef __FUNCT__
4042c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve"
4043c88f2d44SBarry Smith /*@
4044c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
4045c88f2d44SBarry Smith 
4046c88f2d44SBarry Smith    Collective on TS
4047c88f2d44SBarry Smith 
4048c88f2d44SBarry Smith    Input Parameter:
40492c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
4050c88f2d44SBarry Smith 
4051e87fd094SBarry Smith    Options Database:
4052e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions
4053e87fd094SBarry Smith 
4054c88f2d44SBarry Smith    Level: intermediate
4055c88f2d44SBarry Smith 
4056c88f2d44SBarry Smith    Notes:
4057c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
4058c88f2d44SBarry Smith 
405973b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
406073b18844SBarry Smith 
4061c88f2d44SBarry Smith .keywords: TS, timestep, solve
4062c88f2d44SBarry Smith 
4063b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
4064c88f2d44SBarry Smith @*/
40652c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
4066c88f2d44SBarry Smith {
4067c88f2d44SBarry Smith   PetscErrorCode    ierr;
4068c88f2d44SBarry Smith 
4069c88f2d44SBarry Smith   PetscFunctionBegin;
4070c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4071c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
407268bece0bSHong Zhang 
4073c88f2d44SBarry Smith   /* reset time step and iteration counters */
4074c88f2d44SBarry Smith   ts->steps             = 0;
4075c88f2d44SBarry Smith   ts->ksp_its           = 0;
4076c88f2d44SBarry Smith   ts->snes_its          = 0;
4077c88f2d44SBarry Smith   ts->num_snes_failures = 0;
4078c88f2d44SBarry Smith   ts->reject            = 0;
4079c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
4080c88f2d44SBarry Smith 
408173b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
4082c88f2d44SBarry Smith 
408373b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
4084c88f2d44SBarry Smith   while (!ts->reason) {
408555c52731SHong Zhang     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
40869110b2e7SHong Zhang     ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
40876427ac75SLisandro Dalcin     ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr);
4088616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
4089b1cb36f3SHong Zhang     if (ts->vec_costintegral && !ts->costintegralfwd) {
4090b1cb36f3SHong Zhang       ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr);
4091b1cb36f3SHong Zhang     }
4092c88f2d44SBarry Smith   }
409326656371SHong Zhang   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
409426656371SHong Zhang   ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
4095c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
4096e210cd0eSHong Zhang   ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr);
4097685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
4098c88f2d44SBarry Smith   PetscFunctionReturn(0);
4099c88f2d44SBarry Smith }
4100c88f2d44SBarry Smith 
4101c88f2d44SBarry Smith #undef __FUNCT__
4102d763cef2SBarry Smith #define __FUNCT__ "TSMonitor"
41037db568b7SBarry Smith /*@C
4104228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4105228d79bcSJed Brown 
4106228d79bcSJed Brown    Collective on TS
4107228d79bcSJed Brown 
4108228d79bcSJed Brown    Input Parameters:
4109228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
4110228d79bcSJed Brown .  step - step number that has just completed
4111228d79bcSJed Brown .  ptime - model time of the state
41120910c330SBarry Smith -  u - state at the current model time
4113228d79bcSJed Brown 
4114228d79bcSJed Brown    Notes:
41157db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
41167db568b7SBarry Smith    Users would almost never call this routine directly.
4117228d79bcSJed Brown 
411863e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
411963e21af5SBarry Smith 
41207db568b7SBarry Smith    Level: developer
4121228d79bcSJed Brown 
4122228d79bcSJed Brown .keywords: TS, timestep
4123228d79bcSJed Brown @*/
41240910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4125d763cef2SBarry Smith {
4126d6152f81SLisandro Dalcin   DM             dm;
4127a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
4128d6152f81SLisandro Dalcin   PetscErrorCode ierr;
4129d763cef2SBarry Smith 
4130d763cef2SBarry Smith   PetscFunctionBegin;
4131b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4132b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4133d6152f81SLisandro Dalcin 
4134d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
4135d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
4136d6152f81SLisandro Dalcin 
41375edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
4138d763cef2SBarry Smith   for (i=0; i<n; i++) {
41390910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
4140d763cef2SBarry Smith   }
41415edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
4142d763cef2SBarry Smith   PetscFunctionReturn(0);
4143d763cef2SBarry Smith }
4144d763cef2SBarry Smith 
41459110b2e7SHong Zhang #undef __FUNCT__
41469110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitor"
41477db568b7SBarry Smith /*@C
41489110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
41499110b2e7SHong Zhang 
41509110b2e7SHong Zhang    Collective on TS
41519110b2e7SHong Zhang 
41529110b2e7SHong Zhang    Input Parameters:
41539110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
41549110b2e7SHong Zhang .  step - step number that has just completed
41559110b2e7SHong Zhang .  ptime - model time of the state
41569110b2e7SHong Zhang .  u - state at the current model time
41579110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
41589110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
41599110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
41609110b2e7SHong Zhang 
41619110b2e7SHong Zhang    Notes:
41627db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
41637db568b7SBarry Smith    Users would almost never call this routine directly.
41649110b2e7SHong Zhang 
41657db568b7SBarry Smith    Level: developer
41669110b2e7SHong Zhang 
41679110b2e7SHong Zhang .keywords: TS, timestep
41689110b2e7SHong Zhang @*/
41699110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
41709110b2e7SHong Zhang {
41719110b2e7SHong Zhang   PetscErrorCode ierr;
41729110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
41739110b2e7SHong Zhang 
41749110b2e7SHong Zhang   PetscFunctionBegin;
41759110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
41769110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
41779110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
41789110b2e7SHong Zhang   for (i=0; i<n; i++) {
41799110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
41809110b2e7SHong Zhang   }
41819110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
41829110b2e7SHong Zhang   PetscFunctionReturn(0);
41839110b2e7SHong Zhang }
41849110b2e7SHong Zhang 
4185d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
41864a2ae208SSatish Balay #undef __FUNCT__
4187a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
4188d763cef2SBarry Smith /*@C
41897db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4190a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
4191d763cef2SBarry Smith 
4192d763cef2SBarry Smith    Collective on TS
4193d763cef2SBarry Smith 
4194d763cef2SBarry Smith    Input Parameters:
4195d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
4196d763cef2SBarry Smith .  label - the title to put in the title bar
41977c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
4198a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
4199a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4200d763cef2SBarry Smith 
4201d763cef2SBarry Smith    Output Parameter:
42020b039ecaSBarry Smith .  ctx - the context
4203d763cef2SBarry Smith 
4204d763cef2SBarry Smith    Options Database Key:
42054f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
42067db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
42077db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
42087db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
42097db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4210b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4211d763cef2SBarry Smith 
4212d763cef2SBarry Smith    Notes:
4213a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
4214d763cef2SBarry Smith 
42157db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
42167db568b7SBarry Smith 
42177db568b7SBarry 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
42187db568b7SBarry 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
42197db568b7SBarry Smith    as the first argument.
42207db568b7SBarry Smith 
42217db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
42227db568b7SBarry Smith 
42237db568b7SBarry Smith 
4224d763cef2SBarry Smith    Level: intermediate
4225d763cef2SBarry Smith 
42267db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
4227d763cef2SBarry Smith 
42287db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
42297db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
42307db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
42317db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
42327db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
42337c922b88SBarry Smith 
4234d763cef2SBarry Smith @*/
4235a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4236d763cef2SBarry Smith {
42377f52daa2SLisandro Dalcin   PetscDraw      draw;
4238dfbe8321SBarry Smith   PetscErrorCode ierr;
4239d763cef2SBarry Smith 
4240d763cef2SBarry Smith   PetscFunctionBegin;
4241b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
42427f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
42437f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
42447f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
4245287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
42467f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
4247a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
4248d763cef2SBarry Smith   PetscFunctionReturn(0);
4249d763cef2SBarry Smith }
4250d763cef2SBarry Smith 
42514a2ae208SSatish Balay #undef __FUNCT__
42524f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
4253b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4254d763cef2SBarry Smith {
42550b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4256c32365f1SBarry Smith   PetscReal      x   = ptime,y;
4257dfbe8321SBarry Smith   PetscErrorCode ierr;
4258d763cef2SBarry Smith 
4259d763cef2SBarry Smith   PetscFunctionBegin;
426063e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
4261b06615a5SLisandro Dalcin   if (!step) {
4262a9f9c1f6SBarry Smith     PetscDrawAxis axis;
4263a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
42646934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr);
4265a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4266a9f9c1f6SBarry Smith   }
4267c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
42680b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
4269b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
42700b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
42716934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
42723923b477SBarry Smith   }
4273d763cef2SBarry Smith   PetscFunctionReturn(0);
4274d763cef2SBarry Smith }
4275d763cef2SBarry Smith 
42764a2ae208SSatish Balay #undef __FUNCT__
4277a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
4278d763cef2SBarry Smith /*@C
4279a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4280a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
4281d763cef2SBarry Smith 
42820b039ecaSBarry Smith    Collective on TSMonitorLGCtx
4283d763cef2SBarry Smith 
4284d763cef2SBarry Smith    Input Parameter:
42850b039ecaSBarry Smith .  ctx - the monitor context
4286d763cef2SBarry Smith 
4287d763cef2SBarry Smith    Level: intermediate
4288d763cef2SBarry Smith 
4289d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
4290d763cef2SBarry Smith 
42914f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
4292d763cef2SBarry Smith @*/
4293a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4294d763cef2SBarry Smith {
4295dfbe8321SBarry Smith   PetscErrorCode ierr;
4296d763cef2SBarry Smith 
4297d763cef2SBarry Smith   PetscFunctionBegin;
42987684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
42997684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
43007684fa3eSBarry Smith   }
43010b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
430231152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
4303387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
4304387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
4305387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
43060b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
4307d763cef2SBarry Smith   PetscFunctionReturn(0);
4308d763cef2SBarry Smith }
4309d763cef2SBarry Smith 
43104a2ae208SSatish Balay #undef __FUNCT__
43114a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
4312d763cef2SBarry Smith /*@
4313b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4314d763cef2SBarry Smith 
4315d763cef2SBarry Smith    Not Collective
4316d763cef2SBarry Smith 
4317d763cef2SBarry Smith    Input Parameter:
4318d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4319d763cef2SBarry Smith 
4320d763cef2SBarry Smith    Output Parameter:
432163e21af5SBarry Smith .  t  - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime().
4322d763cef2SBarry Smith 
4323d763cef2SBarry Smith    Level: beginner
4324d763cef2SBarry Smith 
4325b8123daeSJed Brown    Note:
4326b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
43279be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4328b8123daeSJed Brown 
432963e21af5SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime()
4330d763cef2SBarry Smith 
4331d763cef2SBarry Smith .keywords: TS, get, time
4332d763cef2SBarry Smith @*/
43337087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4334d763cef2SBarry Smith {
4335d763cef2SBarry Smith   PetscFunctionBegin;
43360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4337f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4338d763cef2SBarry Smith   *t = ts->ptime;
4339d763cef2SBarry Smith   PetscFunctionReturn(0);
4340d763cef2SBarry Smith }
4341d763cef2SBarry Smith 
43424a2ae208SSatish Balay #undef __FUNCT__
4343e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
4344e5e524a1SHong Zhang /*@
4345e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4346e5e524a1SHong Zhang 
4347e5e524a1SHong Zhang    Not Collective
4348e5e524a1SHong Zhang 
4349e5e524a1SHong Zhang    Input Parameter:
4350e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4351e5e524a1SHong Zhang 
4352e5e524a1SHong Zhang    Output Parameter:
4353e5e524a1SHong Zhang .  t  - the previous time
4354e5e524a1SHong Zhang 
4355e5e524a1SHong Zhang    Level: beginner
4356e5e524a1SHong Zhang 
4357e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
4358e5e524a1SHong Zhang 
4359e5e524a1SHong Zhang .keywords: TS, get, time
4360e5e524a1SHong Zhang @*/
4361e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4362e5e524a1SHong Zhang {
4363e5e524a1SHong Zhang   PetscFunctionBegin;
4364e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4365e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4366e5e524a1SHong Zhang   *t = ts->ptime_prev;
4367e5e524a1SHong Zhang   PetscFunctionReturn(0);
4368e5e524a1SHong Zhang }
4369e5e524a1SHong Zhang 
4370e5e524a1SHong Zhang #undef __FUNCT__
43716a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
43726a4d4014SLisandro Dalcin /*@
43736a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
43746a4d4014SLisandro Dalcin 
43753f9fe445SBarry Smith    Logically Collective on TS
43766a4d4014SLisandro Dalcin 
43776a4d4014SLisandro Dalcin    Input Parameters:
43786a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
43796a4d4014SLisandro Dalcin -  time - the time
43806a4d4014SLisandro Dalcin 
43816a4d4014SLisandro Dalcin    Level: intermediate
43826a4d4014SLisandro Dalcin 
43836a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
43846a4d4014SLisandro Dalcin 
43856a4d4014SLisandro Dalcin .keywords: TS, set, time
43866a4d4014SLisandro Dalcin @*/
43877087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
43886a4d4014SLisandro Dalcin {
43896a4d4014SLisandro Dalcin   PetscFunctionBegin;
43900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4391c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
43926a4d4014SLisandro Dalcin   ts->ptime = t;
43936a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
43946a4d4014SLisandro Dalcin }
43956a4d4014SLisandro Dalcin 
43966a4d4014SLisandro Dalcin #undef __FUNCT__
43974a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
4398d763cef2SBarry Smith /*@C
4399d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4400d763cef2SBarry Smith    TS options in the database.
4401d763cef2SBarry Smith 
44023f9fe445SBarry Smith    Logically Collective on TS
4403d763cef2SBarry Smith 
4404d763cef2SBarry Smith    Input Parameter:
4405d763cef2SBarry Smith +  ts     - The TS context
4406d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4407d763cef2SBarry Smith 
4408d763cef2SBarry Smith    Notes:
4409d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4410d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4411d763cef2SBarry Smith    hyphen.
4412d763cef2SBarry Smith 
4413d763cef2SBarry Smith    Level: advanced
4414d763cef2SBarry Smith 
4415d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
4416d763cef2SBarry Smith 
4417d763cef2SBarry Smith .seealso: TSSetFromOptions()
4418d763cef2SBarry Smith 
4419d763cef2SBarry Smith @*/
44207087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4421d763cef2SBarry Smith {
4422dfbe8321SBarry Smith   PetscErrorCode ierr;
4423089b2837SJed Brown   SNES           snes;
4424d763cef2SBarry Smith 
4425d763cef2SBarry Smith   PetscFunctionBegin;
44260700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4427d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4428089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4429089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4430d763cef2SBarry Smith   PetscFunctionReturn(0);
4431d763cef2SBarry Smith }
4432d763cef2SBarry Smith 
4433d763cef2SBarry Smith 
44344a2ae208SSatish Balay #undef __FUNCT__
44354a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
4436d763cef2SBarry Smith /*@C
4437d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4438d763cef2SBarry Smith    TS options in the database.
4439d763cef2SBarry Smith 
44403f9fe445SBarry Smith    Logically Collective on TS
4441d763cef2SBarry Smith 
4442d763cef2SBarry Smith    Input Parameter:
4443d763cef2SBarry Smith +  ts     - The TS context
4444d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4445d763cef2SBarry Smith 
4446d763cef2SBarry Smith    Notes:
4447d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4448d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4449d763cef2SBarry Smith    hyphen.
4450d763cef2SBarry Smith 
4451d763cef2SBarry Smith    Level: advanced
4452d763cef2SBarry Smith 
4453d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
4454d763cef2SBarry Smith 
4455d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4456d763cef2SBarry Smith 
4457d763cef2SBarry Smith @*/
44587087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4459d763cef2SBarry Smith {
4460dfbe8321SBarry Smith   PetscErrorCode ierr;
4461089b2837SJed Brown   SNES           snes;
4462d763cef2SBarry Smith 
4463d763cef2SBarry Smith   PetscFunctionBegin;
44640700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4465d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4466089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4467089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4468d763cef2SBarry Smith   PetscFunctionReturn(0);
4469d763cef2SBarry Smith }
4470d763cef2SBarry Smith 
44714a2ae208SSatish Balay #undef __FUNCT__
44724a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
4473d763cef2SBarry Smith /*@C
4474d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4475d763cef2SBarry Smith    TS options in the database.
4476d763cef2SBarry Smith 
4477d763cef2SBarry Smith    Not Collective
4478d763cef2SBarry Smith 
4479d763cef2SBarry Smith    Input Parameter:
4480d763cef2SBarry Smith .  ts - The TS context
4481d763cef2SBarry Smith 
4482d763cef2SBarry Smith    Output Parameter:
4483d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4484d763cef2SBarry Smith 
4485d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
4486d763cef2SBarry Smith    sufficient length to hold the prefix.
4487d763cef2SBarry Smith 
4488d763cef2SBarry Smith    Level: intermediate
4489d763cef2SBarry Smith 
4490d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
4491d763cef2SBarry Smith 
4492d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4493d763cef2SBarry Smith @*/
44947087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4495d763cef2SBarry Smith {
4496dfbe8321SBarry Smith   PetscErrorCode ierr;
4497d763cef2SBarry Smith 
4498d763cef2SBarry Smith   PetscFunctionBegin;
44990700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45004482741eSBarry Smith   PetscValidPointer(prefix,2);
4501d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4502d763cef2SBarry Smith   PetscFunctionReturn(0);
4503d763cef2SBarry Smith }
4504d763cef2SBarry Smith 
45054a2ae208SSatish Balay #undef __FUNCT__
45064a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
4507d763cef2SBarry Smith /*@C
4508d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4509d763cef2SBarry Smith 
4510d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4511d763cef2SBarry Smith 
4512d763cef2SBarry Smith    Input Parameter:
4513d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4514d763cef2SBarry Smith 
4515d763cef2SBarry Smith    Output Parameters:
4516e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4517e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4518e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4519e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4520d763cef2SBarry Smith 
45210298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
4522d763cef2SBarry Smith 
4523d763cef2SBarry Smith    Level: intermediate
4524d763cef2SBarry Smith 
452526d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
4526d763cef2SBarry Smith 
4527d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
4528d763cef2SBarry Smith @*/
4529e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4530d763cef2SBarry Smith {
4531089b2837SJed Brown   PetscErrorCode ierr;
4532089b2837SJed Brown   SNES           snes;
453324989b8cSPeter Brune   DM             dm;
4534089b2837SJed Brown 
4535d763cef2SBarry Smith   PetscFunctionBegin;
4536089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4537e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
453824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
453924989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4540d763cef2SBarry Smith   PetscFunctionReturn(0);
4541d763cef2SBarry Smith }
4542d763cef2SBarry Smith 
45431713a123SBarry Smith #undef __FUNCT__
45442eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
45452eca1d9cSJed Brown /*@C
45462eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
45472eca1d9cSJed Brown 
45482eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
45492eca1d9cSJed Brown 
45502eca1d9cSJed Brown    Input Parameter:
45512eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
45522eca1d9cSJed Brown 
45532eca1d9cSJed Brown    Output Parameters:
4554e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4555e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
45562eca1d9cSJed Brown .  f   - The function to compute the matrices
45572eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
45582eca1d9cSJed Brown 
45590298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
45602eca1d9cSJed Brown 
45612eca1d9cSJed Brown    Level: advanced
45622eca1d9cSJed Brown 
45632eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
45642eca1d9cSJed Brown 
45652eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
45662eca1d9cSJed Brown @*/
4567e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
45682eca1d9cSJed Brown {
4569089b2837SJed Brown   PetscErrorCode ierr;
4570089b2837SJed Brown   SNES           snes;
457124989b8cSPeter Brune   DM             dm;
45720910c330SBarry Smith 
45732eca1d9cSJed Brown   PetscFunctionBegin;
4574089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4575f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4576e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
457724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
457824989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
45792eca1d9cSJed Brown   PetscFunctionReturn(0);
45802eca1d9cSJed Brown }
45812eca1d9cSJed Brown 
45826083293cSBarry Smith 
45832eca1d9cSJed Brown #undef __FUNCT__
458483a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
45851713a123SBarry Smith /*@C
458683a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
45871713a123SBarry Smith    VecView() for the solution at each timestep
45881713a123SBarry Smith 
45891713a123SBarry Smith    Collective on TS
45901713a123SBarry Smith 
45911713a123SBarry Smith    Input Parameters:
45921713a123SBarry Smith +  ts - the TS context
45931713a123SBarry Smith .  step - current time-step
4594142b95e3SSatish Balay .  ptime - current time
45950298fd71SBarry Smith -  dummy - either a viewer or NULL
45961713a123SBarry Smith 
459799fdda47SBarry Smith    Options Database:
459899fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
459999fdda47SBarry Smith 
4600387f4636SBarry 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
460199fdda47SBarry Smith        will look bad
460299fdda47SBarry Smith 
46031713a123SBarry Smith    Level: intermediate
46041713a123SBarry Smith 
46051713a123SBarry Smith .keywords: TS,  vector, monitor, view
46061713a123SBarry Smith 
4607a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
46081713a123SBarry Smith @*/
46090910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
46101713a123SBarry Smith {
4611dfbe8321SBarry Smith   PetscErrorCode   ierr;
461283a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4613473a3ab2SBarry Smith   PetscDraw        draw;
46141713a123SBarry Smith 
46151713a123SBarry Smith   PetscFunctionBegin;
46166083293cSBarry Smith   if (!step && ictx->showinitial) {
46176083293cSBarry Smith     if (!ictx->initialsolution) {
46180910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
46191713a123SBarry Smith     }
46200910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
46216083293cSBarry Smith   }
4622b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
46230dcf80beSBarry Smith 
46246083293cSBarry Smith   if (ictx->showinitial) {
46256083293cSBarry Smith     PetscReal pause;
46266083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
46276083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
46286083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
46296083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
46306083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
46316083293cSBarry Smith   }
46320910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4633473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
463451fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4635473a3ab2SBarry Smith     char      time[32];
4636473a3ab2SBarry Smith 
4637473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
463885b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4639473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4640473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
464151fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4642473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4643473a3ab2SBarry Smith   }
4644473a3ab2SBarry Smith 
46456083293cSBarry Smith   if (ictx->showinitial) {
46466083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
46476083293cSBarry Smith   }
46481713a123SBarry Smith   PetscFunctionReturn(0);
46491713a123SBarry Smith }
46501713a123SBarry Smith 
46512d5ee99bSBarry Smith #undef __FUNCT__
46529110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorDrawSensi"
46539110b2e7SHong Zhang /*@C
46549110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
46559110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
46569110b2e7SHong Zhang 
46579110b2e7SHong Zhang    Collective on TS
46589110b2e7SHong Zhang 
46599110b2e7SHong Zhang    Input Parameters:
46609110b2e7SHong Zhang +  ts - the TS context
46619110b2e7SHong Zhang .  step - current time-step
46629110b2e7SHong Zhang .  ptime - current time
46639110b2e7SHong Zhang .  u - current state
46649110b2e7SHong Zhang .  numcost - number of cost functions
46659110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
46669110b2e7SHong Zhang .  mu - sensitivities to parameters
46679110b2e7SHong Zhang -  dummy - either a viewer or NULL
46689110b2e7SHong Zhang 
46699110b2e7SHong Zhang    Level: intermediate
46709110b2e7SHong Zhang 
46719110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
46729110b2e7SHong Zhang 
46739110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
46749110b2e7SHong Zhang @*/
46759110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
46769110b2e7SHong Zhang {
46779110b2e7SHong Zhang   PetscErrorCode   ierr;
46789110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
46799110b2e7SHong Zhang   PetscDraw        draw;
4680a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
4681a0046e2cSSatish Balay   char             time[32];
46829110b2e7SHong Zhang 
46839110b2e7SHong Zhang   PetscFunctionBegin;
46849110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
46859110b2e7SHong Zhang 
46869110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
46879110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
46889110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
46899110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
46909110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
46919110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
46929110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
46939110b2e7SHong Zhang   PetscFunctionReturn(0);
46949110b2e7SHong Zhang }
46959110b2e7SHong Zhang 
46969110b2e7SHong Zhang #undef __FUNCT__
46972d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
46982d5ee99bSBarry Smith /*@C
46992d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
47002d5ee99bSBarry Smith 
47012d5ee99bSBarry Smith    Collective on TS
47022d5ee99bSBarry Smith 
47032d5ee99bSBarry Smith    Input Parameters:
47042d5ee99bSBarry Smith +  ts - the TS context
47052d5ee99bSBarry Smith .  step - current time-step
47062d5ee99bSBarry Smith .  ptime - current time
47072d5ee99bSBarry Smith -  dummy - either a viewer or NULL
47082d5ee99bSBarry Smith 
47092d5ee99bSBarry Smith    Level: intermediate
47102d5ee99bSBarry Smith 
47112d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
47122d5ee99bSBarry Smith 
47132d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
47142d5ee99bSBarry Smith @*/
47152d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
47162d5ee99bSBarry Smith {
47172d5ee99bSBarry Smith   PetscErrorCode    ierr;
47182d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
47192d5ee99bSBarry Smith   PetscDraw         draw;
47206934998bSLisandro Dalcin   PetscDrawAxis     axis;
47212d5ee99bSBarry Smith   PetscInt          n;
47222d5ee99bSBarry Smith   PetscMPIInt       size;
47236934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
47242d5ee99bSBarry Smith   char              time[32];
47252d5ee99bSBarry Smith   const PetscScalar *U;
47262d5ee99bSBarry Smith 
47272d5ee99bSBarry Smith   PetscFunctionBegin;
47286934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
47296934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
47302d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
47316934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
47322d5ee99bSBarry Smith 
47332d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
47346934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
47356934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
47366934998bSLisandro Dalcin   if (!step) {
47376934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
47386934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
47396934998bSLisandro Dalcin   }
47402d5ee99bSBarry Smith 
47412d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
47426934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
47436934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
4744a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
47456934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
47462d5ee99bSBarry Smith 
47476934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
47486934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
47492d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
47504b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
475185b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
47522d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
475351fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
47542d5ee99bSBarry Smith   }
47556934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
47562d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
47576934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
47582d5ee99bSBarry Smith   PetscFunctionReturn(0);
47592d5ee99bSBarry Smith }
47602d5ee99bSBarry Smith 
47611713a123SBarry Smith 
47626c699258SBarry Smith #undef __FUNCT__
476383a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
47646083293cSBarry Smith /*@C
476583a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
47666083293cSBarry Smith 
47676083293cSBarry Smith    Collective on TS
47686083293cSBarry Smith 
47696083293cSBarry Smith    Input Parameters:
47706083293cSBarry Smith .    ctx - the monitor context
47716083293cSBarry Smith 
47726083293cSBarry Smith    Level: intermediate
47736083293cSBarry Smith 
47746083293cSBarry Smith .keywords: TS,  vector, monitor, view
47756083293cSBarry Smith 
477683a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
47776083293cSBarry Smith @*/
477883a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
47796083293cSBarry Smith {
47806083293cSBarry Smith   PetscErrorCode ierr;
47816083293cSBarry Smith 
47826083293cSBarry Smith   PetscFunctionBegin;
478383a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
478483a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
478583a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
47866083293cSBarry Smith   PetscFunctionReturn(0);
47876083293cSBarry Smith }
47886083293cSBarry Smith 
47896083293cSBarry Smith #undef __FUNCT__
479083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
47916083293cSBarry Smith /*@C
479283a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
47936083293cSBarry Smith 
47946083293cSBarry Smith    Collective on TS
47956083293cSBarry Smith 
47966083293cSBarry Smith    Input Parameter:
47976083293cSBarry Smith .    ts - time-step context
47986083293cSBarry Smith 
47996083293cSBarry Smith    Output Patameter:
48006083293cSBarry Smith .    ctx - the monitor context
48016083293cSBarry Smith 
480299fdda47SBarry Smith    Options Database:
480399fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
480499fdda47SBarry Smith 
48056083293cSBarry Smith    Level: intermediate
48066083293cSBarry Smith 
48076083293cSBarry Smith .keywords: TS,  vector, monitor, view
48086083293cSBarry Smith 
480983a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
48106083293cSBarry Smith @*/
481183a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
48126083293cSBarry Smith {
48136083293cSBarry Smith   PetscErrorCode   ierr;
48146083293cSBarry Smith 
48156083293cSBarry Smith   PetscFunctionBegin;
4816b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
481783a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4818e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4819bbd56ea5SKarl Rupp 
482083a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4821473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
4822c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4823473a3ab2SBarry Smith 
4824473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
4825c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
48266083293cSBarry Smith   PetscFunctionReturn(0);
48276083293cSBarry Smith }
48286083293cSBarry Smith 
48296083293cSBarry Smith #undef __FUNCT__
483083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
48313a471f94SBarry Smith /*@C
483283a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
48333a471f94SBarry Smith    VecView() for the error at each timestep
48343a471f94SBarry Smith 
48353a471f94SBarry Smith    Collective on TS
48363a471f94SBarry Smith 
48373a471f94SBarry Smith    Input Parameters:
48383a471f94SBarry Smith +  ts - the TS context
48393a471f94SBarry Smith .  step - current time-step
48403a471f94SBarry Smith .  ptime - current time
48410298fd71SBarry Smith -  dummy - either a viewer or NULL
48423a471f94SBarry Smith 
48433a471f94SBarry Smith    Level: intermediate
48443a471f94SBarry Smith 
48453a471f94SBarry Smith .keywords: TS,  vector, monitor, view
48463a471f94SBarry Smith 
48473a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
48483a471f94SBarry Smith @*/
48490910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
48503a471f94SBarry Smith {
48513a471f94SBarry Smith   PetscErrorCode   ierr;
485283a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
485383a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
48543a471f94SBarry Smith   Vec              work;
48553a471f94SBarry Smith 
48563a471f94SBarry Smith   PetscFunctionBegin;
4857b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
48580910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
48593a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
48600910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
48613a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
48623a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
48633a471f94SBarry Smith   PetscFunctionReturn(0);
48643a471f94SBarry Smith }
48653a471f94SBarry Smith 
4866af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
48673a471f94SBarry Smith #undef __FUNCT__
48686c699258SBarry Smith #define __FUNCT__ "TSSetDM"
48696c699258SBarry Smith /*@
48706c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
48716c699258SBarry Smith 
48723f9fe445SBarry Smith    Logically Collective on TS and DM
48736c699258SBarry Smith 
48746c699258SBarry Smith    Input Parameters:
48756c699258SBarry Smith +  ts - the preconditioner context
48766c699258SBarry Smith -  dm - the dm
48776c699258SBarry Smith 
48786c699258SBarry Smith    Level: intermediate
48796c699258SBarry Smith 
48806c699258SBarry Smith 
48816c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
48826c699258SBarry Smith @*/
48837087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
48846c699258SBarry Smith {
48856c699258SBarry Smith   PetscErrorCode ierr;
4886089b2837SJed Brown   SNES           snes;
4887942e3340SBarry Smith   DMTS           tsdm;
48886c699258SBarry Smith 
48896c699258SBarry Smith   PetscFunctionBegin;
48900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
489170663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4892942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
48932a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4894942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4895942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
489624989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
489724989b8cSPeter Brune         tsdm->originaldm = dm;
489824989b8cSPeter Brune       }
489924989b8cSPeter Brune     }
49006bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
490124989b8cSPeter Brune   }
49026c699258SBarry Smith   ts->dm = dm;
4903bbd56ea5SKarl Rupp 
4904089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4905089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
49066c699258SBarry Smith   PetscFunctionReturn(0);
49076c699258SBarry Smith }
49086c699258SBarry Smith 
49096c699258SBarry Smith #undef __FUNCT__
49106c699258SBarry Smith #define __FUNCT__ "TSGetDM"
49116c699258SBarry Smith /*@
49126c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
49136c699258SBarry Smith 
49143f9fe445SBarry Smith    Not Collective
49156c699258SBarry Smith 
49166c699258SBarry Smith    Input Parameter:
49176c699258SBarry Smith . ts - the preconditioner context
49186c699258SBarry Smith 
49196c699258SBarry Smith    Output Parameter:
49206c699258SBarry Smith .  dm - the dm
49216c699258SBarry Smith 
49226c699258SBarry Smith    Level: intermediate
49236c699258SBarry Smith 
49246c699258SBarry Smith 
49256c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
49266c699258SBarry Smith @*/
49277087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
49286c699258SBarry Smith {
4929496e6a7aSJed Brown   PetscErrorCode ierr;
4930496e6a7aSJed Brown 
49316c699258SBarry Smith   PetscFunctionBegin;
49320700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4933496e6a7aSJed Brown   if (!ts->dm) {
4934ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4935496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4936496e6a7aSJed Brown   }
49376c699258SBarry Smith   *dm = ts->dm;
49386c699258SBarry Smith   PetscFunctionReturn(0);
49396c699258SBarry Smith }
49401713a123SBarry Smith 
49410f5c6efeSJed Brown #undef __FUNCT__
49420f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
49430f5c6efeSJed Brown /*@
49440f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
49450f5c6efeSJed Brown 
49463f9fe445SBarry Smith    Logically Collective on SNES
49470f5c6efeSJed Brown 
49480f5c6efeSJed Brown    Input Parameter:
4949d42a1c89SJed Brown + snes - nonlinear solver
49500910c330SBarry Smith . U - the current state at which to evaluate the residual
4951d42a1c89SJed Brown - ctx - user context, must be a TS
49520f5c6efeSJed Brown 
49530f5c6efeSJed Brown    Output Parameter:
49540f5c6efeSJed Brown . F - the nonlinear residual
49550f5c6efeSJed Brown 
49560f5c6efeSJed Brown    Notes:
49570f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
49580f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
49590f5c6efeSJed Brown 
49600f5c6efeSJed Brown    Level: advanced
49610f5c6efeSJed Brown 
49620f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
49630f5c6efeSJed Brown @*/
49640910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
49650f5c6efeSJed Brown {
49660f5c6efeSJed Brown   TS             ts = (TS)ctx;
49670f5c6efeSJed Brown   PetscErrorCode ierr;
49680f5c6efeSJed Brown 
49690f5c6efeSJed Brown   PetscFunctionBegin;
49700f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
49710910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
49720f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
49730f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
49740910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
49750f5c6efeSJed Brown   PetscFunctionReturn(0);
49760f5c6efeSJed Brown }
49770f5c6efeSJed Brown 
49780f5c6efeSJed Brown #undef __FUNCT__
49790f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
49800f5c6efeSJed Brown /*@
49810f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
49820f5c6efeSJed Brown 
49830f5c6efeSJed Brown    Collective on SNES
49840f5c6efeSJed Brown 
49850f5c6efeSJed Brown    Input Parameter:
49860f5c6efeSJed Brown + snes - nonlinear solver
49870910c330SBarry Smith . U - the current state at which to evaluate the residual
49880f5c6efeSJed Brown - ctx - user context, must be a TS
49890f5c6efeSJed Brown 
49900f5c6efeSJed Brown    Output Parameter:
49910f5c6efeSJed Brown + A - the Jacobian
49920f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
49930f5c6efeSJed Brown - flag - indicates any structure change in the matrix
49940f5c6efeSJed Brown 
49950f5c6efeSJed Brown    Notes:
49960f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
49970f5c6efeSJed Brown 
49980f5c6efeSJed Brown    Level: developer
49990f5c6efeSJed Brown 
50000f5c6efeSJed Brown .seealso: SNESSetJacobian()
50010f5c6efeSJed Brown @*/
5002d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
50030f5c6efeSJed Brown {
50040f5c6efeSJed Brown   TS             ts = (TS)ctx;
50050f5c6efeSJed Brown   PetscErrorCode ierr;
50060f5c6efeSJed Brown 
50070f5c6efeSJed Brown   PetscFunctionBegin;
50080f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
50090910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
50100f5c6efeSJed Brown   PetscValidPointer(A,3);
501194ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
50120f5c6efeSJed Brown   PetscValidPointer(B,4);
501394ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
50140f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
5015d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
50160f5c6efeSJed Brown   PetscFunctionReturn(0);
50170f5c6efeSJed Brown }
5018325fc9f4SBarry Smith 
50190e4ef248SJed Brown #undef __FUNCT__
50200e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
50210e4ef248SJed Brown /*@C
50229ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
50230e4ef248SJed Brown 
50240e4ef248SJed Brown    Collective on TS
50250e4ef248SJed Brown 
50260e4ef248SJed Brown    Input Arguments:
50270e4ef248SJed Brown +  ts - time stepping context
50280e4ef248SJed Brown .  t - time at which to evaluate
50290910c330SBarry Smith .  U - state at which to evaluate
50300e4ef248SJed Brown -  ctx - context
50310e4ef248SJed Brown 
50320e4ef248SJed Brown    Output Arguments:
50330e4ef248SJed Brown .  F - right hand side
50340e4ef248SJed Brown 
50350e4ef248SJed Brown    Level: intermediate
50360e4ef248SJed Brown 
50370e4ef248SJed Brown    Notes:
50380e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
50390e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
50400e4ef248SJed Brown 
50410e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
50420e4ef248SJed Brown @*/
50430910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
50440e4ef248SJed Brown {
50450e4ef248SJed Brown   PetscErrorCode ierr;
50460e4ef248SJed Brown   Mat            Arhs,Brhs;
50470e4ef248SJed Brown 
50480e4ef248SJed Brown   PetscFunctionBegin;
50490e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
5050d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
50510910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
50520e4ef248SJed Brown   PetscFunctionReturn(0);
50530e4ef248SJed Brown }
50540e4ef248SJed Brown 
50550e4ef248SJed Brown #undef __FUNCT__
50560e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
50570e4ef248SJed Brown /*@C
50580e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
50590e4ef248SJed Brown 
50600e4ef248SJed Brown    Collective on TS
50610e4ef248SJed Brown 
50620e4ef248SJed Brown    Input Arguments:
50630e4ef248SJed Brown +  ts - time stepping context
50640e4ef248SJed Brown .  t - time at which to evaluate
50650910c330SBarry Smith .  U - state at which to evaluate
50660e4ef248SJed Brown -  ctx - context
50670e4ef248SJed Brown 
50680e4ef248SJed Brown    Output Arguments:
50690e4ef248SJed Brown +  A - pointer to operator
50700e4ef248SJed Brown .  B - pointer to preconditioning matrix
50710e4ef248SJed Brown -  flg - matrix structure flag
50720e4ef248SJed Brown 
50730e4ef248SJed Brown    Level: intermediate
50740e4ef248SJed Brown 
50750e4ef248SJed Brown    Notes:
50760e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
50770e4ef248SJed Brown 
50780e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
50790e4ef248SJed Brown @*/
5080d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
50810e4ef248SJed Brown {
50820e4ef248SJed Brown   PetscFunctionBegin;
50830e4ef248SJed Brown   PetscFunctionReturn(0);
50840e4ef248SJed Brown }
50850e4ef248SJed Brown 
50860026cea9SSean Farley #undef __FUNCT__
50870026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
50880026cea9SSean Farley /*@C
50890026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
50900026cea9SSean Farley 
50910026cea9SSean Farley    Collective on TS
50920026cea9SSean Farley 
50930026cea9SSean Farley    Input Arguments:
50940026cea9SSean Farley +  ts - time stepping context
50950026cea9SSean Farley .  t - time at which to evaluate
50960910c330SBarry Smith .  U - state at which to evaluate
50970910c330SBarry Smith .  Udot - time derivative of state vector
50980026cea9SSean Farley -  ctx - context
50990026cea9SSean Farley 
51000026cea9SSean Farley    Output Arguments:
51010026cea9SSean Farley .  F - left hand side
51020026cea9SSean Farley 
51030026cea9SSean Farley    Level: intermediate
51040026cea9SSean Farley 
51050026cea9SSean Farley    Notes:
51060910c330SBarry 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
51070026cea9SSean Farley    user is required to write their own TSComputeIFunction.
51080026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
51090026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
51100026cea9SSean Farley 
51119ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
51129ae8fd06SBarry Smith 
51139ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
51140026cea9SSean Farley @*/
51150910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
51160026cea9SSean Farley {
51170026cea9SSean Farley   PetscErrorCode ierr;
51180026cea9SSean Farley   Mat            A,B;
51190026cea9SSean Farley 
51200026cea9SSean Farley   PetscFunctionBegin;
51210298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
5122d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
51230910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
51240026cea9SSean Farley   PetscFunctionReturn(0);
51250026cea9SSean Farley }
51260026cea9SSean Farley 
51270026cea9SSean Farley #undef __FUNCT__
51280026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
51290026cea9SSean Farley /*@C
5130b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
51310026cea9SSean Farley 
51320026cea9SSean Farley    Collective on TS
51330026cea9SSean Farley 
51340026cea9SSean Farley    Input Arguments:
51350026cea9SSean Farley +  ts - time stepping context
51360026cea9SSean Farley .  t - time at which to evaluate
51370910c330SBarry Smith .  U - state at which to evaluate
51380910c330SBarry Smith .  Udot - time derivative of state vector
51390026cea9SSean Farley .  shift - shift to apply
51400026cea9SSean Farley -  ctx - context
51410026cea9SSean Farley 
51420026cea9SSean Farley    Output Arguments:
51430026cea9SSean Farley +  A - pointer to operator
51440026cea9SSean Farley .  B - pointer to preconditioning matrix
51450026cea9SSean Farley -  flg - matrix structure flag
51460026cea9SSean Farley 
5147b41af12eSJed Brown    Level: advanced
51480026cea9SSean Farley 
51490026cea9SSean Farley    Notes:
51500026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
51510026cea9SSean Farley 
5152b41af12eSJed Brown    It is only appropriate for problems of the form
5153b41af12eSJed Brown 
5154b41af12eSJed Brown $     M Udot = F(U,t)
5155b41af12eSJed Brown 
5156b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
5157b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5158b41af12eSJed Brown   an implicit operator of the form
5159b41af12eSJed Brown 
5160b41af12eSJed Brown $    shift*M + J
5161b41af12eSJed Brown 
5162b41af12eSJed 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
5163b41af12eSJed Brown   a copy of M or reassemble it when requested.
5164b41af12eSJed Brown 
51650026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
51660026cea9SSean Farley @*/
5167d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
51680026cea9SSean Farley {
5169b41af12eSJed Brown   PetscErrorCode ierr;
5170b41af12eSJed Brown 
51710026cea9SSean Farley   PetscFunctionBegin;
517294ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
5173b41af12eSJed Brown   ts->ijacobian.shift = shift;
51740026cea9SSean Farley   PetscFunctionReturn(0);
51750026cea9SSean Farley }
5176b41af12eSJed Brown 
5177e817cc15SEmil Constantinescu #undef __FUNCT__
5178e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
5179e817cc15SEmil Constantinescu /*@
5180e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
5181e817cc15SEmil Constantinescu 
5182e817cc15SEmil Constantinescu    Not Collective
5183e817cc15SEmil Constantinescu 
5184e817cc15SEmil Constantinescu    Input Parameter:
5185e817cc15SEmil Constantinescu .  ts - the TS context
5186e817cc15SEmil Constantinescu 
5187e817cc15SEmil Constantinescu    Output Parameter:
51884e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
5189e817cc15SEmil Constantinescu 
5190e817cc15SEmil Constantinescu    Level: beginner
5191e817cc15SEmil Constantinescu 
5192e817cc15SEmil Constantinescu .keywords: TS, equation type
5193e817cc15SEmil Constantinescu 
5194e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
5195e817cc15SEmil Constantinescu @*/
5196e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
5197e817cc15SEmil Constantinescu {
5198e817cc15SEmil Constantinescu   PetscFunctionBegin;
5199e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5200e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
5201e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
5202e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5203e817cc15SEmil Constantinescu }
5204e817cc15SEmil Constantinescu 
5205e817cc15SEmil Constantinescu #undef __FUNCT__
5206e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
5207e817cc15SEmil Constantinescu /*@
5208e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
5209e817cc15SEmil Constantinescu 
5210e817cc15SEmil Constantinescu    Not Collective
5211e817cc15SEmil Constantinescu 
5212e817cc15SEmil Constantinescu    Input Parameter:
5213e817cc15SEmil Constantinescu +  ts - the TS context
52141297b224SEmil Constantinescu -  equation_type - see TSEquationType
5215e817cc15SEmil Constantinescu 
5216e817cc15SEmil Constantinescu    Level: advanced
5217e817cc15SEmil Constantinescu 
5218e817cc15SEmil Constantinescu .keywords: TS, equation type
5219e817cc15SEmil Constantinescu 
5220e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
5221e817cc15SEmil Constantinescu @*/
5222e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
5223e817cc15SEmil Constantinescu {
5224e817cc15SEmil Constantinescu   PetscFunctionBegin;
5225e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5226e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
5227e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5228e817cc15SEmil Constantinescu }
52290026cea9SSean Farley 
52304af1b03aSJed Brown #undef __FUNCT__
52314af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
52324af1b03aSJed Brown /*@
52334af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
52344af1b03aSJed Brown 
52354af1b03aSJed Brown    Not Collective
52364af1b03aSJed Brown 
52374af1b03aSJed Brown    Input Parameter:
52384af1b03aSJed Brown .  ts - the TS context
52394af1b03aSJed Brown 
52404af1b03aSJed Brown    Output Parameter:
52414af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
52424af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
52434af1b03aSJed Brown 
5244487e0bb9SJed Brown    Level: beginner
52454af1b03aSJed Brown 
5246cd652676SJed Brown    Notes:
5247cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
52484af1b03aSJed Brown 
52494af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
52504af1b03aSJed Brown 
52514af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
52524af1b03aSJed Brown @*/
52534af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
52544af1b03aSJed Brown {
52554af1b03aSJed Brown   PetscFunctionBegin;
52564af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
52574af1b03aSJed Brown   PetscValidPointer(reason,2);
52584af1b03aSJed Brown   *reason = ts->reason;
52594af1b03aSJed Brown   PetscFunctionReturn(0);
52604af1b03aSJed Brown }
52614af1b03aSJed Brown 
5262fb1732b5SBarry Smith #undef __FUNCT__
5263d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
5264d6ad946cSShri Abhyankar /*@
5265d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5266d6ad946cSShri Abhyankar 
5267d6ad946cSShri Abhyankar    Not Collective
5268d6ad946cSShri Abhyankar 
5269d6ad946cSShri Abhyankar    Input Parameter:
5270d6ad946cSShri Abhyankar +  ts - the TS context
5271d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5272d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
5273d6ad946cSShri Abhyankar 
5274f5abba47SShri Abhyankar    Level: advanced
5275d6ad946cSShri Abhyankar 
5276d6ad946cSShri Abhyankar    Notes:
5277d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
5278d6ad946cSShri Abhyankar 
5279d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
5280d6ad946cSShri Abhyankar 
5281d6ad946cSShri Abhyankar .seealso: TSConvergedReason
5282d6ad946cSShri Abhyankar @*/
5283d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
5284d6ad946cSShri Abhyankar {
5285d6ad946cSShri Abhyankar   PetscFunctionBegin;
5286d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5287d6ad946cSShri Abhyankar   ts->reason = reason;
5288d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
5289d6ad946cSShri Abhyankar }
5290d6ad946cSShri Abhyankar 
5291d6ad946cSShri Abhyankar #undef __FUNCT__
5292cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
5293cc708dedSBarry Smith /*@
5294cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
5295cc708dedSBarry Smith 
5296cc708dedSBarry Smith    Not Collective
5297cc708dedSBarry Smith 
5298cc708dedSBarry Smith    Input Parameter:
5299cc708dedSBarry Smith .  ts - the TS context
5300cc708dedSBarry Smith 
5301cc708dedSBarry Smith    Output Parameter:
530263e21af5SBarry Smith .  ftime - the final time. This time corresponds to the final time set with TSSetDuration()
5303cc708dedSBarry Smith 
5304487e0bb9SJed Brown    Level: beginner
5305cc708dedSBarry Smith 
5306cc708dedSBarry Smith    Notes:
5307cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
5308cc708dedSBarry Smith 
5309cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
5310cc708dedSBarry Smith 
5311cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
5312cc708dedSBarry Smith @*/
5313cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
5314cc708dedSBarry Smith {
5315cc708dedSBarry Smith   PetscFunctionBegin;
5316cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5317cc708dedSBarry Smith   PetscValidPointer(ftime,2);
5318cc708dedSBarry Smith   *ftime = ts->solvetime;
5319cc708dedSBarry Smith   PetscFunctionReturn(0);
5320cc708dedSBarry Smith }
5321cc708dedSBarry Smith 
5322cc708dedSBarry Smith #undef __FUNCT__
53232c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps"
53242c18e0fdSBarry Smith /*@
53252c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
53262c18e0fdSBarry Smith 
53272c18e0fdSBarry Smith    Not Collective
53282c18e0fdSBarry Smith 
53292c18e0fdSBarry Smith    Input Parameter:
53302c18e0fdSBarry Smith .  ts - the TS context
53312c18e0fdSBarry Smith 
53322c18e0fdSBarry Smith    Output Parameter:
53332c18e0fdSBarry Smith .  steps - the number of steps
53342c18e0fdSBarry Smith 
53352c18e0fdSBarry Smith    Level: beginner
53362c18e0fdSBarry Smith 
53372c18e0fdSBarry Smith    Notes:
53382c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
53392c18e0fdSBarry Smith 
53402c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
53412c18e0fdSBarry Smith 
53422c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
53432c18e0fdSBarry Smith @*/
53442c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
53452c18e0fdSBarry Smith {
53462c18e0fdSBarry Smith   PetscFunctionBegin;
53472c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53482c18e0fdSBarry Smith   PetscValidPointer(steps,2);
53492c18e0fdSBarry Smith   *steps = ts->total_steps;
53502c18e0fdSBarry Smith   PetscFunctionReturn(0);
53512c18e0fdSBarry Smith }
53522c18e0fdSBarry Smith 
53532c18e0fdSBarry Smith #undef __FUNCT__
53545ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
53559f67acb7SJed Brown /*@
53565ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
53579f67acb7SJed Brown    used by the time integrator.
53589f67acb7SJed Brown 
53599f67acb7SJed Brown    Not Collective
53609f67acb7SJed Brown 
53619f67acb7SJed Brown    Input Parameter:
53629f67acb7SJed Brown .  ts - TS context
53639f67acb7SJed Brown 
53649f67acb7SJed Brown    Output Parameter:
53659f67acb7SJed Brown .  nits - number of nonlinear iterations
53669f67acb7SJed Brown 
53679f67acb7SJed Brown    Notes:
53689f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
53699f67acb7SJed Brown 
53709f67acb7SJed Brown    Level: intermediate
53719f67acb7SJed Brown 
53729f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
53739f67acb7SJed Brown 
53745ef26d82SJed Brown .seealso:  TSGetKSPIterations()
53759f67acb7SJed Brown @*/
53765ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
53779f67acb7SJed Brown {
53789f67acb7SJed Brown   PetscFunctionBegin;
53799f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53809f67acb7SJed Brown   PetscValidIntPointer(nits,2);
53815ef26d82SJed Brown   *nits = ts->snes_its;
53829f67acb7SJed Brown   PetscFunctionReturn(0);
53839f67acb7SJed Brown }
53849f67acb7SJed Brown 
53859f67acb7SJed Brown #undef __FUNCT__
53865ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
53879f67acb7SJed Brown /*@
53885ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
53899f67acb7SJed Brown    used by the time integrator.
53909f67acb7SJed Brown 
53919f67acb7SJed Brown    Not Collective
53929f67acb7SJed Brown 
53939f67acb7SJed Brown    Input Parameter:
53949f67acb7SJed Brown .  ts - TS context
53959f67acb7SJed Brown 
53969f67acb7SJed Brown    Output Parameter:
53979f67acb7SJed Brown .  lits - number of linear iterations
53989f67acb7SJed Brown 
53999f67acb7SJed Brown    Notes:
54009f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
54019f67acb7SJed Brown 
54029f67acb7SJed Brown    Level: intermediate
54039f67acb7SJed Brown 
54049f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
54059f67acb7SJed Brown 
54065ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
54079f67acb7SJed Brown @*/
54085ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
54099f67acb7SJed Brown {
54109f67acb7SJed Brown   PetscFunctionBegin;
54119f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
54129f67acb7SJed Brown   PetscValidIntPointer(lits,2);
54135ef26d82SJed Brown   *lits = ts->ksp_its;
54149f67acb7SJed Brown   PetscFunctionReturn(0);
54159f67acb7SJed Brown }
54169f67acb7SJed Brown 
54179f67acb7SJed Brown #undef __FUNCT__
5418cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
5419cef5090cSJed Brown /*@
5420cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5421cef5090cSJed Brown 
5422cef5090cSJed Brown    Not Collective
5423cef5090cSJed Brown 
5424cef5090cSJed Brown    Input Parameter:
5425cef5090cSJed Brown .  ts - TS context
5426cef5090cSJed Brown 
5427cef5090cSJed Brown    Output Parameter:
5428cef5090cSJed Brown .  rejects - number of steps rejected
5429cef5090cSJed Brown 
5430cef5090cSJed Brown    Notes:
5431cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5432cef5090cSJed Brown 
5433cef5090cSJed Brown    Level: intermediate
5434cef5090cSJed Brown 
5435cef5090cSJed Brown .keywords: TS, get, number
5436cef5090cSJed Brown 
54375ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5438cef5090cSJed Brown @*/
5439cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5440cef5090cSJed Brown {
5441cef5090cSJed Brown   PetscFunctionBegin;
5442cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5443cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5444cef5090cSJed Brown   *rejects = ts->reject;
5445cef5090cSJed Brown   PetscFunctionReturn(0);
5446cef5090cSJed Brown }
5447cef5090cSJed Brown 
5448cef5090cSJed Brown #undef __FUNCT__
5449cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
5450cef5090cSJed Brown /*@
5451cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5452cef5090cSJed Brown 
5453cef5090cSJed Brown    Not Collective
5454cef5090cSJed Brown 
5455cef5090cSJed Brown    Input Parameter:
5456cef5090cSJed Brown .  ts - TS context
5457cef5090cSJed Brown 
5458cef5090cSJed Brown    Output Parameter:
5459cef5090cSJed Brown .  fails - number of failed nonlinear solves
5460cef5090cSJed Brown 
5461cef5090cSJed Brown    Notes:
5462cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5463cef5090cSJed Brown 
5464cef5090cSJed Brown    Level: intermediate
5465cef5090cSJed Brown 
5466cef5090cSJed Brown .keywords: TS, get, number
5467cef5090cSJed Brown 
54685ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5469cef5090cSJed Brown @*/
5470cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5471cef5090cSJed Brown {
5472cef5090cSJed Brown   PetscFunctionBegin;
5473cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5474cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5475cef5090cSJed Brown   *fails = ts->num_snes_failures;
5476cef5090cSJed Brown   PetscFunctionReturn(0);
5477cef5090cSJed Brown }
5478cef5090cSJed Brown 
5479cef5090cSJed Brown #undef __FUNCT__
5480cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
5481cef5090cSJed Brown /*@
5482cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5483cef5090cSJed Brown 
5484cef5090cSJed Brown    Not Collective
5485cef5090cSJed Brown 
5486cef5090cSJed Brown    Input Parameter:
5487cef5090cSJed Brown +  ts - TS context
5488cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5489cef5090cSJed Brown 
5490cef5090cSJed Brown    Notes:
5491cef5090cSJed Brown    The counter is reset to zero for each step
5492cef5090cSJed Brown 
5493cef5090cSJed Brown    Options Database Key:
5494cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5495cef5090cSJed Brown 
5496cef5090cSJed Brown    Level: intermediate
5497cef5090cSJed Brown 
5498cef5090cSJed Brown .keywords: TS, set, maximum, number
5499cef5090cSJed Brown 
55005ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5501cef5090cSJed Brown @*/
5502cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5503cef5090cSJed Brown {
5504cef5090cSJed Brown   PetscFunctionBegin;
5505cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5506cef5090cSJed Brown   ts->max_reject = rejects;
5507cef5090cSJed Brown   PetscFunctionReturn(0);
5508cef5090cSJed Brown }
5509cef5090cSJed Brown 
5510cef5090cSJed Brown #undef __FUNCT__
5511cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
5512cef5090cSJed Brown /*@
5513cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5514cef5090cSJed Brown 
5515cef5090cSJed Brown    Not Collective
5516cef5090cSJed Brown 
5517cef5090cSJed Brown    Input Parameter:
5518cef5090cSJed Brown +  ts - TS context
5519cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5520cef5090cSJed Brown 
5521cef5090cSJed Brown    Notes:
5522cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5523cef5090cSJed Brown 
5524cef5090cSJed Brown    Options Database Key:
5525cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5526cef5090cSJed Brown 
5527cef5090cSJed Brown    Level: intermediate
5528cef5090cSJed Brown 
5529cef5090cSJed Brown .keywords: TS, set, maximum, number
5530cef5090cSJed Brown 
55315ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5532cef5090cSJed Brown @*/
5533cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5534cef5090cSJed Brown {
5535cef5090cSJed Brown   PetscFunctionBegin;
5536cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5537cef5090cSJed Brown   ts->max_snes_failures = fails;
5538cef5090cSJed Brown   PetscFunctionReturn(0);
5539cef5090cSJed Brown }
5540cef5090cSJed Brown 
5541cef5090cSJed Brown #undef __FUNCT__
55424e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
5543cef5090cSJed Brown /*@
5544cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5545cef5090cSJed Brown 
5546cef5090cSJed Brown    Not Collective
5547cef5090cSJed Brown 
5548cef5090cSJed Brown    Input Parameter:
5549cef5090cSJed Brown +  ts - TS context
5550cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5551cef5090cSJed Brown 
5552cef5090cSJed Brown    Options Database Key:
5553cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5554cef5090cSJed Brown 
5555cef5090cSJed Brown    Level: intermediate
5556cef5090cSJed Brown 
5557cef5090cSJed Brown .keywords: TS, set, error
5558cef5090cSJed Brown 
55595ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5560cef5090cSJed Brown @*/
5561cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5562cef5090cSJed Brown {
5563cef5090cSJed Brown   PetscFunctionBegin;
5564cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5565cef5090cSJed Brown   ts->errorifstepfailed = err;
5566cef5090cSJed Brown   PetscFunctionReturn(0);
5567cef5090cSJed Brown }
5568cef5090cSJed Brown 
5569cef5090cSJed Brown #undef __FUNCT__
5570fde5950dSBarry Smith #define __FUNCT__ "TSMonitorSolution"
5571fb1732b5SBarry Smith /*@C
5572fde5950dSBarry 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
5573fb1732b5SBarry Smith 
5574fb1732b5SBarry Smith    Collective on TS
5575fb1732b5SBarry Smith 
5576fb1732b5SBarry Smith    Input Parameters:
5577fb1732b5SBarry Smith +  ts - the TS context
5578fb1732b5SBarry Smith .  step - current time-step
5579fb1732b5SBarry Smith .  ptime - current time
55800910c330SBarry Smith .  u - current state
5581721cd6eeSBarry Smith -  vf - viewer and its format
5582fb1732b5SBarry Smith 
5583fb1732b5SBarry Smith    Level: intermediate
5584fb1732b5SBarry Smith 
5585fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
5586fb1732b5SBarry Smith 
5587fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5588fb1732b5SBarry Smith @*/
5589721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5590fb1732b5SBarry Smith {
5591fb1732b5SBarry Smith   PetscErrorCode ierr;
5592fb1732b5SBarry Smith 
5593fb1732b5SBarry Smith   PetscFunctionBegin;
5594721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5595721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5596721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5597ed81e22dSJed Brown   PetscFunctionReturn(0);
5598ed81e22dSJed Brown }
5599ed81e22dSJed Brown 
5600ed81e22dSJed Brown #undef __FUNCT__
5601ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
5602ed81e22dSJed Brown /*@C
5603ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5604ed81e22dSJed Brown 
5605ed81e22dSJed Brown    Collective on TS
5606ed81e22dSJed Brown 
5607ed81e22dSJed Brown    Input Parameters:
5608ed81e22dSJed Brown +  ts - the TS context
5609ed81e22dSJed Brown .  step - current time-step
5610ed81e22dSJed Brown .  ptime - current time
56110910c330SBarry Smith .  u - current state
5612ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5613ed81e22dSJed Brown 
5614ed81e22dSJed Brown    Level: intermediate
5615ed81e22dSJed Brown 
5616ed81e22dSJed Brown    Notes:
5617ed81e22dSJed 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.
5618ed81e22dSJed Brown    These are named according to the file name template.
5619ed81e22dSJed Brown 
5620ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5621ed81e22dSJed Brown 
5622ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5623ed81e22dSJed Brown 
5624ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5625ed81e22dSJed Brown @*/
56260910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5627ed81e22dSJed Brown {
5628ed81e22dSJed Brown   PetscErrorCode ierr;
5629ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5630ed81e22dSJed Brown   PetscViewer    viewer;
5631ed81e22dSJed Brown 
5632ed81e22dSJed Brown   PetscFunctionBegin;
563363e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
56348caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5635ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
56360910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5637ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5638ed81e22dSJed Brown   PetscFunctionReturn(0);
5639ed81e22dSJed Brown }
5640ed81e22dSJed Brown 
5641ed81e22dSJed Brown #undef __FUNCT__
5642ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
5643ed81e22dSJed Brown /*@C
5644ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5645ed81e22dSJed Brown 
5646ed81e22dSJed Brown    Collective on TS
5647ed81e22dSJed Brown 
5648ed81e22dSJed Brown    Input Parameters:
5649ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5650ed81e22dSJed Brown 
5651ed81e22dSJed Brown    Level: intermediate
5652ed81e22dSJed Brown 
5653ed81e22dSJed Brown    Note:
5654ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5655ed81e22dSJed Brown 
5656ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5657ed81e22dSJed Brown 
5658ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5659ed81e22dSJed Brown @*/
5660ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5661ed81e22dSJed Brown {
5662ed81e22dSJed Brown   PetscErrorCode ierr;
5663ed81e22dSJed Brown 
5664ed81e22dSJed Brown   PetscFunctionBegin;
5665ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5666fb1732b5SBarry Smith   PetscFunctionReturn(0);
5667fb1732b5SBarry Smith }
5668fb1732b5SBarry Smith 
566984df9cb4SJed Brown #undef __FUNCT__
5670552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
567184df9cb4SJed Brown /*@
5672552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
567384df9cb4SJed Brown 
5674ed81e22dSJed Brown    Collective on TS if controller has not been created yet
567584df9cb4SJed Brown 
567684df9cb4SJed Brown    Input Arguments:
5677ed81e22dSJed Brown .  ts - time stepping context
567884df9cb4SJed Brown 
567984df9cb4SJed Brown    Output Arguments:
5680ed81e22dSJed Brown .  adapt - adaptive controller
568184df9cb4SJed Brown 
568284df9cb4SJed Brown    Level: intermediate
568384df9cb4SJed Brown 
5684ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
568584df9cb4SJed Brown @*/
5686552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
568784df9cb4SJed Brown {
568884df9cb4SJed Brown   PetscErrorCode ierr;
568984df9cb4SJed Brown 
569084df9cb4SJed Brown   PetscFunctionBegin;
569184df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5692bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
569384df9cb4SJed Brown   if (!ts->adapt) {
5694ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
56953bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
56961c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
569784df9cb4SJed Brown   }
5698bec58848SLisandro Dalcin   *adapt = ts->adapt;
569984df9cb4SJed Brown   PetscFunctionReturn(0);
570084df9cb4SJed Brown }
5701d6ebe24aSShri Abhyankar 
5702d6ebe24aSShri Abhyankar #undef __FUNCT__
57031c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
57041c3436cfSJed Brown /*@
57051c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
57061c3436cfSJed Brown 
57071c3436cfSJed Brown    Logically Collective
57081c3436cfSJed Brown 
57091c3436cfSJed Brown    Input Arguments:
57101c3436cfSJed Brown +  ts - time integration context
57111c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
57120298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
57131c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
57140298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
57151c3436cfSJed Brown 
5716a3cdaa26SBarry Smith    Options Database keys:
5717a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5718a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5719a3cdaa26SBarry Smith 
57203ff766beSShri Abhyankar    Notes:
57213ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
57223ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
57233ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
57243ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
57253ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
57263ff766beSShri Abhyankar    differential variables.
57273ff766beSShri Abhyankar 
57281c3436cfSJed Brown    Level: beginner
57291c3436cfSJed Brown 
5730c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
57311c3436cfSJed Brown @*/
57321c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
57331c3436cfSJed Brown {
57341c3436cfSJed Brown   PetscErrorCode ierr;
57351c3436cfSJed Brown 
57361c3436cfSJed Brown   PetscFunctionBegin;
5737c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
57381c3436cfSJed Brown   if (vatol) {
57391c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
57401c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
57411c3436cfSJed Brown     ts->vatol = vatol;
57421c3436cfSJed Brown   }
5743c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
57441c3436cfSJed Brown   if (vrtol) {
57451c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
57461c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
57471c3436cfSJed Brown     ts->vrtol = vrtol;
57481c3436cfSJed Brown   }
57491c3436cfSJed Brown   PetscFunctionReturn(0);
57501c3436cfSJed Brown }
57511c3436cfSJed Brown 
57521c3436cfSJed Brown #undef __FUNCT__
5753c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
5754c5033834SJed Brown /*@
5755c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5756c5033834SJed Brown 
5757c5033834SJed Brown    Logically Collective
5758c5033834SJed Brown 
5759c5033834SJed Brown    Input Arguments:
5760c5033834SJed Brown .  ts - time integration context
5761c5033834SJed Brown 
5762c5033834SJed Brown    Output Arguments:
57630298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
57640298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
57650298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
57660298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5767c5033834SJed Brown 
5768c5033834SJed Brown    Level: beginner
5769c5033834SJed Brown 
5770c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5771c5033834SJed Brown @*/
5772c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5773c5033834SJed Brown {
5774c5033834SJed Brown   PetscFunctionBegin;
5775c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5776c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5777c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5778c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5779c5033834SJed Brown   PetscFunctionReturn(0);
5780c5033834SJed Brown }
5781c5033834SJed Brown 
5782c5033834SJed Brown #undef __FUNCT__
57839c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNorm2"
57849c6b16b5SShri Abhyankar /*@
5785a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
57869c6b16b5SShri Abhyankar 
57879c6b16b5SShri Abhyankar    Collective on TS
57889c6b16b5SShri Abhyankar 
57899c6b16b5SShri Abhyankar    Input Arguments:
57909c6b16b5SShri Abhyankar +  ts - time stepping context
5791a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5792a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
57939c6b16b5SShri Abhyankar 
57949c6b16b5SShri Abhyankar    Output Arguments:
57959c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
57969c6b16b5SShri Abhyankar 
57979c6b16b5SShri Abhyankar    Level: developer
57989c6b16b5SShri Abhyankar 
5799deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
58009c6b16b5SShri Abhyankar @*/
5801a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm)
58029c6b16b5SShri Abhyankar {
58039c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
58049c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
58059c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
58069c6b16b5SShri Abhyankar   PetscReal         sum,gsum;
58079c6b16b5SShri Abhyankar   PetscReal         tol;
58089c6b16b5SShri Abhyankar 
58099c6b16b5SShri Abhyankar   PetscFunctionBegin;
58109c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5811a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5812a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5813a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5814a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5815a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5816a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5817a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
58189c6b16b5SShri Abhyankar 
58199c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
58209c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
58219c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
58229c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
58239c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
58249c6b16b5SShri Abhyankar   sum  = 0.;
58259c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
58269c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
58279c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58289c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58299c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
58309c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58319c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
58329c6b16b5SShri Abhyankar     }
58339c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58349c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58359c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
58369c6b16b5SShri Abhyankar     const PetscScalar *atol;
58379c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58389c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
58399c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58409c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
58419c6b16b5SShri Abhyankar     }
58429c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58439c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
58449c6b16b5SShri Abhyankar     const PetscScalar *rtol;
58459c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58469c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
58479c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58489c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
58499c6b16b5SShri Abhyankar     }
58509c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58519c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
58529c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
58539c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58549c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
58559c6b16b5SShri Abhyankar     }
58569c6b16b5SShri Abhyankar   }
58579c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
58589c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
58599c6b16b5SShri Abhyankar 
5860b2566f29SBarry Smith   ierr  = MPIU_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
58619c6b16b5SShri Abhyankar   *norm = PetscSqrtReal(gsum / N);
58629c6b16b5SShri Abhyankar 
58639c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
58649c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
58659c6b16b5SShri Abhyankar }
58669c6b16b5SShri Abhyankar 
58679c6b16b5SShri Abhyankar #undef __FUNCT__
58689c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNormInfinity"
58699c6b16b5SShri Abhyankar /*@
5870a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
58719c6b16b5SShri Abhyankar 
58729c6b16b5SShri Abhyankar    Collective on TS
58739c6b16b5SShri Abhyankar 
58749c6b16b5SShri Abhyankar    Input Arguments:
58759c6b16b5SShri Abhyankar +  ts - time stepping context
5876a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5877a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
58789c6b16b5SShri Abhyankar 
58799c6b16b5SShri Abhyankar    Output Arguments:
58809c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
58819c6b16b5SShri Abhyankar 
58829c6b16b5SShri Abhyankar    Level: developer
58839c6b16b5SShri Abhyankar 
5884deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
58859c6b16b5SShri Abhyankar @*/
5886a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm)
58879c6b16b5SShri Abhyankar {
58889c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
58899c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart,k;
58909c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
58919c6b16b5SShri Abhyankar   PetscReal         max,gmax;
58929c6b16b5SShri Abhyankar   PetscReal         tol;
58939c6b16b5SShri Abhyankar 
58949c6b16b5SShri Abhyankar   PetscFunctionBegin;
58959c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5896a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5897a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5898a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5899a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5900a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5901a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5902a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
59039c6b16b5SShri Abhyankar 
59049c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
59059c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
59069c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
59079c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
59089c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
59099c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
59109c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
59119c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59129c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59139c6b16b5SShri Abhyankar     k = 0;
59149c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
59159c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
59169c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
59179c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59189c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
59199c6b16b5SShri Abhyankar     }
59209c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59219c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59229c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
59239c6b16b5SShri Abhyankar     const PetscScalar *atol;
59249c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59259c6b16b5SShri Abhyankar     k = 0;
59269c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
59279c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
59289c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
59299c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59309c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
59319c6b16b5SShri Abhyankar     }
59329c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59339c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
59349c6b16b5SShri Abhyankar     const PetscScalar *rtol;
59359c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59369c6b16b5SShri Abhyankar     k = 0;
59379c6b16b5SShri Abhyankar     tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
59389c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
59399c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
59409c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59419c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
59429c6b16b5SShri Abhyankar     }
59439c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59449c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
59459c6b16b5SShri Abhyankar     k = 0;
59469c6b16b5SShri Abhyankar     tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
59479c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
59489c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
59499c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59509c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
59519c6b16b5SShri Abhyankar     }
59529c6b16b5SShri Abhyankar   }
59539c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
59549c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
59559c6b16b5SShri Abhyankar 
5956b2566f29SBarry Smith   ierr  = MPIU_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
59579c6b16b5SShri Abhyankar   *norm = gmax;
59589c6b16b5SShri Abhyankar 
59599c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
59609c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
59619c6b16b5SShri Abhyankar }
59629c6b16b5SShri Abhyankar 
59639c6b16b5SShri Abhyankar #undef __FUNCT__
59647619abb3SShri #define __FUNCT__ "TSErrorWeightedNorm"
59651c3436cfSJed Brown /*@
5966a4868fbcSLisandro Dalcin    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors
59671c3436cfSJed Brown 
59681c3436cfSJed Brown    Collective on TS
59691c3436cfSJed Brown 
59701c3436cfSJed Brown    Input Arguments:
59711c3436cfSJed Brown +  ts - time stepping context
5972a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5973a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
5974a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
59757619abb3SShri 
59761c3436cfSJed Brown    Output Arguments:
59771c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
59781c3436cfSJed Brown 
5979a4868fbcSLisandro Dalcin 
5980a4868fbcSLisandro Dalcin    Options Database Keys:
5981a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5982a4868fbcSLisandro Dalcin 
59831c3436cfSJed Brown    Level: developer
59841c3436cfSJed Brown 
5985deea92deSShri .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
59861c3436cfSJed Brown @*/
5987a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm)
59881c3436cfSJed Brown {
59898beabaa1SBarry Smith   PetscErrorCode ierr;
59901c3436cfSJed Brown 
59911c3436cfSJed Brown   PetscFunctionBegin;
5992a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
5993a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNorm2(ts,U,Y,norm);CHKERRQ(ierr);
5994a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
5995a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm);CHKERRQ(ierr);
5996a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
59971c3436cfSJed Brown   PetscFunctionReturn(0);
59981c3436cfSJed Brown }
59991c3436cfSJed Brown 
60001c3436cfSJed Brown #undef __FUNCT__
60018d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
60028d59e960SJed Brown /*@
60038d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
60048d59e960SJed Brown 
60058d59e960SJed Brown    Logically Collective on TS
60068d59e960SJed Brown 
60078d59e960SJed Brown    Input Arguments:
60088d59e960SJed Brown +  ts - time stepping context
60098d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
60108d59e960SJed Brown 
60118d59e960SJed Brown    Note:
60128d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
60138d59e960SJed Brown 
60148d59e960SJed Brown    Level: intermediate
60158d59e960SJed Brown 
60168d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
60178d59e960SJed Brown @*/
60188d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
60198d59e960SJed Brown {
60208d59e960SJed Brown   PetscFunctionBegin;
60218d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
60228d59e960SJed Brown   ts->cfltime_local = cfltime;
60238d59e960SJed Brown   ts->cfltime       = -1.;
60248d59e960SJed Brown   PetscFunctionReturn(0);
60258d59e960SJed Brown }
60268d59e960SJed Brown 
60278d59e960SJed Brown #undef __FUNCT__
60288d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
60298d59e960SJed Brown /*@
60308d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
60318d59e960SJed Brown 
60328d59e960SJed Brown    Collective on TS
60338d59e960SJed Brown 
60348d59e960SJed Brown    Input Arguments:
60358d59e960SJed Brown .  ts - time stepping context
60368d59e960SJed Brown 
60378d59e960SJed Brown    Output Arguments:
60388d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
60398d59e960SJed Brown 
60408d59e960SJed Brown    Level: advanced
60418d59e960SJed Brown 
60428d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
60438d59e960SJed Brown @*/
60448d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
60458d59e960SJed Brown {
60468d59e960SJed Brown   PetscErrorCode ierr;
60478d59e960SJed Brown 
60488d59e960SJed Brown   PetscFunctionBegin;
60498d59e960SJed Brown   if (ts->cfltime < 0) {
6050b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
60518d59e960SJed Brown   }
60528d59e960SJed Brown   *cfltime = ts->cfltime;
60538d59e960SJed Brown   PetscFunctionReturn(0);
60548d59e960SJed Brown }
60558d59e960SJed Brown 
60568d59e960SJed Brown #undef __FUNCT__
6057d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
6058d6ebe24aSShri Abhyankar /*@
6059d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6060d6ebe24aSShri Abhyankar 
6061d6ebe24aSShri Abhyankar    Input Parameters:
6062d6ebe24aSShri Abhyankar .  ts   - the TS context.
6063d6ebe24aSShri Abhyankar .  xl   - lower bound.
6064d6ebe24aSShri Abhyankar .  xu   - upper bound.
6065d6ebe24aSShri Abhyankar 
6066d6ebe24aSShri Abhyankar    Notes:
6067d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6068e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6069d6ebe24aSShri Abhyankar 
60702bd2b0e6SSatish Balay    Level: advanced
60712bd2b0e6SSatish Balay 
6072d6ebe24aSShri Abhyankar @*/
6073d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6074d6ebe24aSShri Abhyankar {
6075d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6076d6ebe24aSShri Abhyankar   SNES           snes;
6077d6ebe24aSShri Abhyankar 
6078d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6079d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6080d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6081d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6082d6ebe24aSShri Abhyankar }
6083d6ebe24aSShri Abhyankar 
6084325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
6085c6db04a5SJed Brown #include <mex.h>
6086325fc9f4SBarry Smith 
6087325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
6088325fc9f4SBarry Smith 
6089325fc9f4SBarry Smith #undef __FUNCT__
6090325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
6091325fc9f4SBarry Smith /*
6092325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
6093325fc9f4SBarry Smith                          TSSetFunctionMatlab().
6094325fc9f4SBarry Smith 
6095325fc9f4SBarry Smith    Collective on TS
6096325fc9f4SBarry Smith 
6097325fc9f4SBarry Smith    Input Parameters:
6098325fc9f4SBarry Smith +  snes - the TS context
60990910c330SBarry Smith -  u - input vector
6100325fc9f4SBarry Smith 
6101325fc9f4SBarry Smith    Output Parameter:
6102325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
6103325fc9f4SBarry Smith 
6104325fc9f4SBarry Smith    Notes:
6105325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
6106325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
6107325fc9f4SBarry Smith    themselves.
6108325fc9f4SBarry Smith 
6109325fc9f4SBarry Smith    Level: developer
6110325fc9f4SBarry Smith 
6111325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6112325fc9f4SBarry Smith 
6113325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6114325fc9f4SBarry Smith */
61150910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
6116325fc9f4SBarry Smith {
6117325fc9f4SBarry Smith   PetscErrorCode  ierr;
6118325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6119325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
6120325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
6121325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
6122325fc9f4SBarry Smith 
6123325fc9f4SBarry Smith   PetscFunctionBegin;
6124325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
61250910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
61260910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
6127325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
61280910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
6129325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
6130325fc9f4SBarry Smith 
6131325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
61320910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
61330910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
61340910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
6135bbd56ea5SKarl Rupp 
6136325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6137325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
6138325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6139325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6140325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
6141325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
6142325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
6143325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
6144325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6145325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6146325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6147325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6148325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6149325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6150325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6151325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6152325fc9f4SBarry Smith   PetscFunctionReturn(0);
6153325fc9f4SBarry Smith }
6154325fc9f4SBarry Smith 
6155325fc9f4SBarry Smith 
6156325fc9f4SBarry Smith #undef __FUNCT__
6157325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
6158325fc9f4SBarry Smith /*
6159325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
6160325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
6161e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
6162325fc9f4SBarry Smith 
6163325fc9f4SBarry Smith    Logically Collective on TS
6164325fc9f4SBarry Smith 
6165325fc9f4SBarry Smith    Input Parameters:
6166325fc9f4SBarry Smith +  ts - the TS context
6167325fc9f4SBarry Smith -  func - function evaluation routine
6168325fc9f4SBarry Smith 
6169325fc9f4SBarry Smith    Calling sequence of func:
61700910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
6171325fc9f4SBarry Smith 
6172325fc9f4SBarry Smith    Level: beginner
6173325fc9f4SBarry Smith 
6174325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
6175325fc9f4SBarry Smith 
6176325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6177325fc9f4SBarry Smith */
6178cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
6179325fc9f4SBarry Smith {
6180325fc9f4SBarry Smith   PetscErrorCode  ierr;
6181325fc9f4SBarry Smith   TSMatlabContext *sctx;
6182325fc9f4SBarry Smith 
6183325fc9f4SBarry Smith   PetscFunctionBegin;
6184325fc9f4SBarry Smith   /* currently sctx is memory bleed */
6185325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
6186325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6187325fc9f4SBarry Smith   /*
6188325fc9f4SBarry Smith      This should work, but it doesn't
6189325fc9f4SBarry Smith   sctx->ctx = ctx;
6190325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6191325fc9f4SBarry Smith   */
6192325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6193bbd56ea5SKarl Rupp 
61940298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
6195325fc9f4SBarry Smith   PetscFunctionReturn(0);
6196325fc9f4SBarry Smith }
6197325fc9f4SBarry Smith 
6198325fc9f4SBarry Smith #undef __FUNCT__
6199325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
6200325fc9f4SBarry Smith /*
6201325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
6202325fc9f4SBarry Smith                          TSSetJacobianMatlab().
6203325fc9f4SBarry Smith 
6204325fc9f4SBarry Smith    Collective on TS
6205325fc9f4SBarry Smith 
6206325fc9f4SBarry Smith    Input Parameters:
6207cdcf91faSSean Farley +  ts - the TS context
62080910c330SBarry Smith .  u - input vector
6209325fc9f4SBarry Smith .  A, B - the matrices
6210325fc9f4SBarry Smith -  ctx - user context
6211325fc9f4SBarry Smith 
6212325fc9f4SBarry Smith    Level: developer
6213325fc9f4SBarry Smith 
6214325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6215325fc9f4SBarry Smith 
6216325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6217325fc9f4SBarry Smith @*/
6218f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
6219325fc9f4SBarry Smith {
6220325fc9f4SBarry Smith   PetscErrorCode  ierr;
6221325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6222325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
6223325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
6224325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
6225325fc9f4SBarry Smith 
6226325fc9f4SBarry Smith   PetscFunctionBegin;
6227cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
62280910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
6229325fc9f4SBarry Smith 
62300910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
6231325fc9f4SBarry Smith 
6232cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
62330910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
62340910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
62350910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
62360910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
6237bbd56ea5SKarl Rupp 
6238325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6239325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
6240325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6241325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6242325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
6243325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
6244325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
6245325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
6246325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
6247325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
6248325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6249325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6250325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6251325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6252325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6253325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6254325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6255325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
6256325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
6257325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6258325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
6259325fc9f4SBarry Smith   PetscFunctionReturn(0);
6260325fc9f4SBarry Smith }
6261325fc9f4SBarry Smith 
6262325fc9f4SBarry Smith 
6263325fc9f4SBarry Smith #undef __FUNCT__
6264325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
6265325fc9f4SBarry Smith /*
6266325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
6267e3c5b3baSBarry 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
6268325fc9f4SBarry Smith 
6269325fc9f4SBarry Smith    Logically Collective on TS
6270325fc9f4SBarry Smith 
6271325fc9f4SBarry Smith    Input Parameters:
6272cdcf91faSSean Farley +  ts - the TS context
6273325fc9f4SBarry Smith .  A,B - Jacobian matrices
6274325fc9f4SBarry Smith .  func - function evaluation routine
6275325fc9f4SBarry Smith -  ctx - user context
6276325fc9f4SBarry Smith 
6277325fc9f4SBarry Smith    Calling sequence of func:
62780910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
6279325fc9f4SBarry Smith 
6280325fc9f4SBarry Smith 
6281325fc9f4SBarry Smith    Level: developer
6282325fc9f4SBarry Smith 
6283325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
6284325fc9f4SBarry Smith 
6285325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6286325fc9f4SBarry Smith */
6287cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
6288325fc9f4SBarry Smith {
6289325fc9f4SBarry Smith   PetscErrorCode  ierr;
6290325fc9f4SBarry Smith   TSMatlabContext *sctx;
6291325fc9f4SBarry Smith 
6292325fc9f4SBarry Smith   PetscFunctionBegin;
6293325fc9f4SBarry Smith   /* currently sctx is memory bleed */
6294325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
6295325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6296325fc9f4SBarry Smith   /*
6297325fc9f4SBarry Smith      This should work, but it doesn't
6298325fc9f4SBarry Smith   sctx->ctx = ctx;
6299325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6300325fc9f4SBarry Smith   */
6301325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6302bbd56ea5SKarl Rupp 
6303cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
6304325fc9f4SBarry Smith   PetscFunctionReturn(0);
6305325fc9f4SBarry Smith }
6306325fc9f4SBarry Smith 
6307b5b1a830SBarry Smith #undef __FUNCT__
6308b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
6309b5b1a830SBarry Smith /*
6310b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
6311b5b1a830SBarry Smith 
6312b5b1a830SBarry Smith    Collective on TS
6313b5b1a830SBarry Smith 
6314b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6315b5b1a830SBarry Smith @*/
63160910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
6317b5b1a830SBarry Smith {
6318b5b1a830SBarry Smith   PetscErrorCode  ierr;
6319b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6320a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
6321b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
6322b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
6323b5b1a830SBarry Smith 
6324b5b1a830SBarry Smith   PetscFunctionBegin;
6325cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
63260910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
6327b5b1a830SBarry Smith 
6328cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
63290910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
6330bbd56ea5SKarl Rupp 
6331b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6332b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
6333b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
6334b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
6335b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
6336b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
6337b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
6338b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6339b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
6340b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
6341b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
6342b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
6343b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
6344b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
6345b5b1a830SBarry Smith   PetscFunctionReturn(0);
6346b5b1a830SBarry Smith }
6347b5b1a830SBarry Smith 
6348b5b1a830SBarry Smith 
6349b5b1a830SBarry Smith #undef __FUNCT__
6350b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
6351b5b1a830SBarry Smith /*
6352b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
6353b5b1a830SBarry Smith 
6354b5b1a830SBarry Smith    Level: developer
6355b5b1a830SBarry Smith 
6356b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
6357b5b1a830SBarry Smith 
6358b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6359b5b1a830SBarry Smith */
6360cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
6361b5b1a830SBarry Smith {
6362b5b1a830SBarry Smith   PetscErrorCode  ierr;
6363b5b1a830SBarry Smith   TSMatlabContext *sctx;
6364b5b1a830SBarry Smith 
6365b5b1a830SBarry Smith   PetscFunctionBegin;
6366b5b1a830SBarry Smith   /* currently sctx is memory bleed */
6367b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
6368b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6369b5b1a830SBarry Smith   /*
6370b5b1a830SBarry Smith      This should work, but it doesn't
6371b5b1a830SBarry Smith   sctx->ctx = ctx;
6372b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6373b5b1a830SBarry Smith   */
6374b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6375bbd56ea5SKarl Rupp 
63760298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
6377b5b1a830SBarry Smith   PetscFunctionReturn(0);
6378b5b1a830SBarry Smith }
6379325fc9f4SBarry Smith #endif
6380b3603a34SBarry Smith 
6381b3603a34SBarry Smith #undef __FUNCT__
63824f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
6383b3603a34SBarry Smith /*@C
63844f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
6385b3603a34SBarry Smith        in a time based line graph
6386b3603a34SBarry Smith 
6387b3603a34SBarry Smith    Collective on TS
6388b3603a34SBarry Smith 
6389b3603a34SBarry Smith    Input Parameters:
6390b3603a34SBarry Smith +  ts - the TS context
6391b3603a34SBarry Smith .  step - current time-step
6392b3603a34SBarry Smith .  ptime - current time
63937db568b7SBarry Smith .  u - current solution
63947db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
6395b3603a34SBarry Smith 
6396b3d3934dSBarry Smith    Options Database:
63979ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
6398b3d3934dSBarry Smith 
6399b3603a34SBarry Smith    Level: intermediate
6400b3603a34SBarry Smith 
64016934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component solutions in a separate window
6402b3603a34SBarry Smith 
6403b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
6404b3603a34SBarry Smith 
64057db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
64067db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
64077db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
64087db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
6409b3603a34SBarry Smith @*/
64107db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6411b3603a34SBarry Smith {
6412b3603a34SBarry Smith   PetscErrorCode    ierr;
64137db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
6414b3603a34SBarry Smith   const PetscScalar *yy;
641580666b62SBarry Smith   Vec               v;
6416b3603a34SBarry Smith 
6417b3603a34SBarry Smith   PetscFunctionBegin;
641863e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
641958ff32f7SBarry Smith   if (!step) {
6420a9f9c1f6SBarry Smith     PetscDrawAxis axis;
64216934998bSLisandro Dalcin     PetscInt      dim;
6422a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6423a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
6424387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
6425387f4636SBarry Smith       char      **displaynames;
6426387f4636SBarry Smith       PetscBool flg;
6427387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6428387f4636SBarry Smith       ierr = PetscMalloc((dim+1)*sizeof(char*),&displaynames);CHKERRQ(ierr);
6429387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
6430c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
6431387f4636SBarry Smith       if (flg) {
6432a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
6433387f4636SBarry Smith       }
6434387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
6435387f4636SBarry Smith     }
6436387f4636SBarry Smith     if (ctx->displaynames) {
6437387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
6438387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
6439387f4636SBarry Smith     } else if (ctx->names) {
64400910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
64410b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6442387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
6443b0bc92c6SBarry Smith     } else {
6444b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6445b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6446387f4636SBarry Smith     }
64470b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
644858ff32f7SBarry Smith   }
64496934998bSLisandro Dalcin 
64506934998bSLisandro Dalcin   if (!ctx->transform) v = u;
64516934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
645280666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
64536934998bSLisandro Dalcin   if (ctx->displaynames) {
64546934998bSLisandro Dalcin     PetscInt i;
64556934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
64566934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
64576934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
64586934998bSLisandro Dalcin   } else {
6459e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6460e3efe391SJed Brown     PetscInt  i,n;
64616934998bSLisandro Dalcin     PetscReal *yreal;
646280666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
6463785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6464e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
64650b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6466e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6467e3efe391SJed Brown #else
64680b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6469e3efe391SJed Brown #endif
647080666b62SBarry Smith   }
64716934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
64726934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
64736934998bSLisandro Dalcin 
6474b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
64750b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
64766934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
64773923b477SBarry Smith   }
6478b3603a34SBarry Smith   PetscFunctionReturn(0);
6479b3603a34SBarry Smith }
6480b3603a34SBarry Smith 
6481387f4636SBarry Smith 
6482b3603a34SBarry Smith #undef __FUNCT__
648331152f8aSBarry Smith #define __FUNCT__ "TSMonitorLGSetVariableNames"
6484b037adc7SBarry Smith /*@C
648531152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6486b037adc7SBarry Smith 
6487b037adc7SBarry Smith    Collective on TS
6488b037adc7SBarry Smith 
6489b037adc7SBarry Smith    Input Parameters:
6490b037adc7SBarry Smith +  ts - the TS context
6491b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
6492b037adc7SBarry Smith 
6493b037adc7SBarry Smith    Level: intermediate
6494b037adc7SBarry Smith 
64957db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
64967db568b7SBarry Smith 
6497b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
6498b037adc7SBarry Smith 
6499a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
6500b037adc7SBarry Smith @*/
650131152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
6502b037adc7SBarry Smith {
6503b037adc7SBarry Smith   PetscErrorCode    ierr;
6504b037adc7SBarry Smith   PetscInt          i;
6505b037adc7SBarry Smith 
6506b037adc7SBarry Smith   PetscFunctionBegin;
6507b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6508b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
65095537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
6510b3d3934dSBarry Smith       break;
6511b3d3934dSBarry Smith     }
6512b3d3934dSBarry Smith   }
6513b3d3934dSBarry Smith   PetscFunctionReturn(0);
6514b3d3934dSBarry Smith }
6515b3d3934dSBarry Smith 
6516b3d3934dSBarry Smith #undef __FUNCT__
6517e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetVariableNames"
6518e673d494SBarry Smith /*@C
6519e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6520e673d494SBarry Smith 
6521e673d494SBarry Smith    Collective on TS
6522e673d494SBarry Smith 
6523e673d494SBarry Smith    Input Parameters:
6524e673d494SBarry Smith +  ts - the TS context
6525e673d494SBarry Smith -  names - the names of the components, final string must be NULL
6526e673d494SBarry Smith 
6527e673d494SBarry Smith    Level: intermediate
6528e673d494SBarry Smith 
6529e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6530e673d494SBarry Smith 
6531a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
6532e673d494SBarry Smith @*/
6533e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
6534e673d494SBarry Smith {
6535e673d494SBarry Smith   PetscErrorCode    ierr;
6536e673d494SBarry Smith 
6537e673d494SBarry Smith   PetscFunctionBegin;
6538e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
6539e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
6540e673d494SBarry Smith   PetscFunctionReturn(0);
6541e673d494SBarry Smith }
6542e673d494SBarry Smith 
6543e673d494SBarry Smith #undef __FUNCT__
6544b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorLGGetVariableNames"
6545b3d3934dSBarry Smith /*@C
6546b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
6547b3d3934dSBarry Smith 
6548b3d3934dSBarry Smith    Collective on TS
6549b3d3934dSBarry Smith 
6550b3d3934dSBarry Smith    Input Parameter:
6551b3d3934dSBarry Smith .  ts - the TS context
6552b3d3934dSBarry Smith 
6553b3d3934dSBarry Smith    Output Parameter:
6554b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
6555b3d3934dSBarry Smith 
6556b3d3934dSBarry Smith    Level: intermediate
6557b3d3934dSBarry Smith 
65587db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
65597db568b7SBarry Smith 
6560b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6561b3d3934dSBarry Smith 
6562b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6563b3d3934dSBarry Smith @*/
6564b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
6565b3d3934dSBarry Smith {
6566b3d3934dSBarry Smith   PetscInt       i;
6567b3d3934dSBarry Smith 
6568b3d3934dSBarry Smith   PetscFunctionBegin;
6569b3d3934dSBarry Smith   *names = NULL;
6570b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6571b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
65725537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
6573b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
6574b3d3934dSBarry Smith       break;
6575387f4636SBarry Smith     }
6576387f4636SBarry Smith   }
6577387f4636SBarry Smith   PetscFunctionReturn(0);
6578387f4636SBarry Smith }
6579387f4636SBarry Smith 
6580387f4636SBarry Smith #undef __FUNCT__
6581a66092f1SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables"
6582a66092f1SBarry Smith /*@C
6583a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
6584a66092f1SBarry Smith 
6585a66092f1SBarry Smith    Collective on TS
6586a66092f1SBarry Smith 
6587a66092f1SBarry Smith    Input Parameters:
6588a66092f1SBarry Smith +  ctx - the TSMonitorLG context
6589a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
6590a66092f1SBarry Smith 
6591a66092f1SBarry Smith    Level: intermediate
6592a66092f1SBarry Smith 
6593a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
6594a66092f1SBarry Smith 
6595a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6596a66092f1SBarry Smith @*/
6597a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6598a66092f1SBarry Smith {
6599a66092f1SBarry Smith   PetscInt          j = 0,k;
6600a66092f1SBarry Smith   PetscErrorCode    ierr;
6601a66092f1SBarry Smith 
6602a66092f1SBarry Smith   PetscFunctionBegin;
6603a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6604a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6605a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6606a66092f1SBarry Smith   while (displaynames[j]) j++;
6607a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6608a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6609a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6610a66092f1SBarry Smith   j = 0;
6611a66092f1SBarry Smith   while (displaynames[j]) {
6612a66092f1SBarry Smith     k = 0;
6613a66092f1SBarry Smith     while (ctx->names[k]) {
6614a66092f1SBarry Smith       PetscBool flg;
6615a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6616a66092f1SBarry Smith       if (flg) {
6617a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6618a66092f1SBarry Smith         break;
6619a66092f1SBarry Smith       }
6620a66092f1SBarry Smith       k++;
6621a66092f1SBarry Smith     }
6622a66092f1SBarry Smith     j++;
6623a66092f1SBarry Smith   }
6624a66092f1SBarry Smith   PetscFunctionReturn(0);
6625a66092f1SBarry Smith }
6626a66092f1SBarry Smith 
6627a66092f1SBarry Smith 
6628a66092f1SBarry Smith #undef __FUNCT__
6629387f4636SBarry Smith #define __FUNCT__ "TSMonitorLGSetDisplayVariables"
6630387f4636SBarry Smith /*@C
6631387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6632387f4636SBarry Smith 
6633387f4636SBarry Smith    Collective on TS
6634387f4636SBarry Smith 
6635387f4636SBarry Smith    Input Parameters:
6636387f4636SBarry Smith +  ts - the TS context
6637387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
6638387f4636SBarry Smith 
66397db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66407db568b7SBarry Smith 
6641387f4636SBarry Smith    Level: intermediate
6642387f4636SBarry Smith 
6643387f4636SBarry Smith .keywords: TS,  vector, monitor, view
6644387f4636SBarry Smith 
6645387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6646387f4636SBarry Smith @*/
6647387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6648387f4636SBarry Smith {
6649a66092f1SBarry Smith   PetscInt          i;
6650387f4636SBarry Smith   PetscErrorCode    ierr;
6651387f4636SBarry Smith 
6652387f4636SBarry Smith   PetscFunctionBegin;
6653387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6654387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
66555537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6656b3d3934dSBarry Smith       break;
6657b037adc7SBarry Smith     }
6658b037adc7SBarry Smith   }
6659b037adc7SBarry Smith   PetscFunctionReturn(0);
6660b037adc7SBarry Smith }
6661b037adc7SBarry Smith 
6662b037adc7SBarry Smith #undef __FUNCT__
666380666b62SBarry Smith #define __FUNCT__ "TSMonitorLGSetTransform"
666480666b62SBarry Smith /*@C
666580666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
666680666b62SBarry Smith 
666780666b62SBarry Smith    Collective on TS
666880666b62SBarry Smith 
666980666b62SBarry Smith    Input Parameters:
667080666b62SBarry Smith +  ts - the TS context
667180666b62SBarry Smith .  transform - the transform function
66727684fa3eSBarry Smith .  destroy - function to destroy the optional context
667380666b62SBarry Smith -  ctx - optional context used by transform function
667480666b62SBarry Smith 
66757db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66767db568b7SBarry Smith 
667780666b62SBarry Smith    Level: intermediate
667880666b62SBarry Smith 
667980666b62SBarry Smith .keywords: TS,  vector, monitor, view
668080666b62SBarry Smith 
6681a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
668280666b62SBarry Smith @*/
66837684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
668480666b62SBarry Smith {
668580666b62SBarry Smith   PetscInt          i;
6686a66092f1SBarry Smith   PetscErrorCode    ierr;
668780666b62SBarry Smith 
668880666b62SBarry Smith   PetscFunctionBegin;
668980666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
669080666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
66915537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
669280666b62SBarry Smith     }
669380666b62SBarry Smith   }
669480666b62SBarry Smith   PetscFunctionReturn(0);
669580666b62SBarry Smith }
669680666b62SBarry Smith 
669780666b62SBarry Smith #undef __FUNCT__
6698e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetTransform"
6699e673d494SBarry Smith /*@C
6700e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6701e673d494SBarry Smith 
6702e673d494SBarry Smith    Collective on TSLGCtx
6703e673d494SBarry Smith 
6704e673d494SBarry Smith    Input Parameters:
6705e673d494SBarry Smith +  ts - the TS context
6706e673d494SBarry Smith .  transform - the transform function
67077684fa3eSBarry Smith .  destroy - function to destroy the optional context
6708e673d494SBarry Smith -  ctx - optional context used by transform function
6709e673d494SBarry Smith 
6710e673d494SBarry Smith    Level: intermediate
6711e673d494SBarry Smith 
6712e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6713e673d494SBarry Smith 
6714a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6715e673d494SBarry Smith @*/
67167684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6717e673d494SBarry Smith {
6718e673d494SBarry Smith   PetscFunctionBegin;
6719e673d494SBarry Smith   ctx->transform    = transform;
67207684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6721e673d494SBarry Smith   ctx->transformctx = tctx;
6722e673d494SBarry Smith   PetscFunctionReturn(0);
6723e673d494SBarry Smith }
6724e673d494SBarry Smith 
6725b3603a34SBarry Smith #undef __FUNCT__
67264f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
6727ef20d060SBarry Smith /*@C
67284f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
6729ef20d060SBarry Smith        in a time based line graph
6730ef20d060SBarry Smith 
6731ef20d060SBarry Smith    Collective on TS
6732ef20d060SBarry Smith 
6733ef20d060SBarry Smith    Input Parameters:
6734ef20d060SBarry Smith +  ts - the TS context
6735ef20d060SBarry Smith .  step - current time-step
6736ef20d060SBarry Smith .  ptime - current time
67377db568b7SBarry Smith .  u - current solution
67387db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6739ef20d060SBarry Smith 
6740ef20d060SBarry Smith    Level: intermediate
6741ef20d060SBarry Smith 
67426934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component errors in a separate window
6743abd5a294SJed Brown 
6744abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6745abd5a294SJed Brown 
6746abd5a294SJed Brown    Options Database Keys:
67474f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6748ef20d060SBarry Smith 
6749ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
6750ef20d060SBarry Smith 
6751abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6752ef20d060SBarry Smith @*/
67530910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6754ef20d060SBarry Smith {
6755ef20d060SBarry Smith   PetscErrorCode    ierr;
67560b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6757ef20d060SBarry Smith   const PetscScalar *yy;
6758ef20d060SBarry Smith   Vec               y;
6759ef20d060SBarry Smith 
6760ef20d060SBarry Smith   PetscFunctionBegin;
6761a9f9c1f6SBarry Smith   if (!step) {
6762a9f9c1f6SBarry Smith     PetscDrawAxis axis;
67636934998bSLisandro Dalcin     PetscInt      dim;
6764a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
67651ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
67660910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6767a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6768a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6769a9f9c1f6SBarry Smith   }
67700910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6771ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
67720910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6773ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6774e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6775e3efe391SJed Brown   {
6776e3efe391SJed Brown     PetscReal *yreal;
6777e3efe391SJed Brown     PetscInt  i,n;
6778e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6779785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6780e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
67810b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6782e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6783e3efe391SJed Brown   }
6784e3efe391SJed Brown #else
67850b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6786e3efe391SJed Brown #endif
6787ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6788ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6789b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
67900b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
67916934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
67923923b477SBarry Smith   }
6793ef20d060SBarry Smith   PetscFunctionReturn(0);
6794ef20d060SBarry Smith }
6795ef20d060SBarry Smith 
6796201da799SBarry Smith #undef __FUNCT__
6797201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
6798201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6799201da799SBarry Smith {
6800201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6801201da799SBarry Smith   PetscReal      x   = ptime,y;
6802201da799SBarry Smith   PetscErrorCode ierr;
6803201da799SBarry Smith   PetscInt       its;
6804201da799SBarry Smith 
6805201da799SBarry Smith   PetscFunctionBegin;
680663e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
6807201da799SBarry Smith   if (!n) {
6808201da799SBarry Smith     PetscDrawAxis axis;
6809201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6810201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
6811201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6812201da799SBarry Smith     ctx->snes_its = 0;
6813201da799SBarry Smith   }
6814201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
6815201da799SBarry Smith   y    = its - ctx->snes_its;
6816201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
68173fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6818201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
68196934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
6820201da799SBarry Smith   }
6821201da799SBarry Smith   ctx->snes_its = its;
6822201da799SBarry Smith   PetscFunctionReturn(0);
6823201da799SBarry Smith }
6824201da799SBarry Smith 
6825201da799SBarry Smith #undef __FUNCT__
6826201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
6827201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6828201da799SBarry Smith {
6829201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6830201da799SBarry Smith   PetscReal      x   = ptime,y;
6831201da799SBarry Smith   PetscErrorCode ierr;
6832201da799SBarry Smith   PetscInt       its;
6833201da799SBarry Smith 
6834201da799SBarry Smith   PetscFunctionBegin;
683563e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
6836201da799SBarry Smith   if (!n) {
6837201da799SBarry Smith     PetscDrawAxis axis;
6838201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6839201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
6840201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6841201da799SBarry Smith     ctx->ksp_its = 0;
6842201da799SBarry Smith   }
6843201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
6844201da799SBarry Smith   y    = its - ctx->ksp_its;
6845201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
684699fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6847201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
68486934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
6849201da799SBarry Smith   }
6850201da799SBarry Smith   ctx->ksp_its = its;
6851201da799SBarry Smith   PetscFunctionReturn(0);
6852201da799SBarry Smith }
6853f9c1d6abSBarry Smith 
6854f9c1d6abSBarry Smith #undef __FUNCT__
6855f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
6856f9c1d6abSBarry Smith /*@
6857f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
6858f9c1d6abSBarry Smith 
6859f9c1d6abSBarry Smith    Collective on TS and Vec
6860f9c1d6abSBarry Smith 
6861f9c1d6abSBarry Smith    Input Parameters:
6862f9c1d6abSBarry Smith +  ts - the TS context
6863f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
6864f9c1d6abSBarry Smith 
6865f9c1d6abSBarry Smith    Output Parameters:
6866f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
6867f9c1d6abSBarry Smith 
6868f9c1d6abSBarry Smith    Level: developer
6869f9c1d6abSBarry Smith 
6870f9c1d6abSBarry Smith .keywords: TS, compute
6871f9c1d6abSBarry Smith 
6872f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
6873f9c1d6abSBarry Smith @*/
6874f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
6875f9c1d6abSBarry Smith {
6876f9c1d6abSBarry Smith   PetscErrorCode ierr;
6877f9c1d6abSBarry Smith 
6878f9c1d6abSBarry Smith   PetscFunctionBegin;
6879f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6880ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
6881f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
6882f9c1d6abSBarry Smith   PetscFunctionReturn(0);
6883f9c1d6abSBarry Smith }
688424655328SShri 
6885b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
6886b3d3934dSBarry Smith #undef __FUNCT__
6887b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxCreate"
6888b3d3934dSBarry Smith /*@C
6889b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
6890b3d3934dSBarry Smith 
6891b3d3934dSBarry Smith    Collective on TS
6892b3d3934dSBarry Smith 
6893b3d3934dSBarry Smith    Input Parameters:
6894b3d3934dSBarry Smith .  ts  - the ODE solver object
6895b3d3934dSBarry Smith 
6896b3d3934dSBarry Smith    Output Parameter:
6897b3d3934dSBarry Smith .  ctx - the context
6898b3d3934dSBarry Smith 
6899b3d3934dSBarry Smith    Level: intermediate
6900b3d3934dSBarry Smith 
6901b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
6902b3d3934dSBarry Smith 
6903b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
6904b3d3934dSBarry Smith 
6905b3d3934dSBarry Smith @*/
6906b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
6907b3d3934dSBarry Smith {
6908b3d3934dSBarry Smith   PetscErrorCode ierr;
6909b3d3934dSBarry Smith 
6910b3d3934dSBarry Smith   PetscFunctionBegin;
6911a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
6912b3d3934dSBarry Smith   PetscFunctionReturn(0);
6913b3d3934dSBarry Smith }
6914b3d3934dSBarry Smith 
6915b3d3934dSBarry Smith #undef __FUNCT__
6916b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelope"
6917b3d3934dSBarry Smith /*@C
6918b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
6919b3d3934dSBarry Smith 
6920b3d3934dSBarry Smith    Collective on TS
6921b3d3934dSBarry Smith 
6922b3d3934dSBarry Smith    Input Parameters:
6923b3d3934dSBarry Smith +  ts - the TS context
6924b3d3934dSBarry Smith .  step - current time-step
6925b3d3934dSBarry Smith .  ptime - current time
69267db568b7SBarry Smith .  u  - current solution
69277db568b7SBarry Smith -  dctx - the envelope context
6928b3d3934dSBarry Smith 
6929b3d3934dSBarry Smith    Options Database:
6930b3d3934dSBarry Smith .  -ts_monitor_envelope
6931b3d3934dSBarry Smith 
6932b3d3934dSBarry Smith    Level: intermediate
6933b3d3934dSBarry Smith 
6934b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
6935b3d3934dSBarry Smith 
6936b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6937b3d3934dSBarry Smith 
69387db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
6939b3d3934dSBarry Smith @*/
69407db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6941b3d3934dSBarry Smith {
6942b3d3934dSBarry Smith   PetscErrorCode       ierr;
69437db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
6944b3d3934dSBarry Smith 
6945b3d3934dSBarry Smith   PetscFunctionBegin;
6946b3d3934dSBarry Smith   if (!ctx->max) {
6947b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
6948b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
6949b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
6950b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
6951b3d3934dSBarry Smith   } else {
6952b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
6953b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
6954b3d3934dSBarry Smith   }
6955b3d3934dSBarry Smith   PetscFunctionReturn(0);
6956b3d3934dSBarry Smith }
6957b3d3934dSBarry Smith 
6958b3d3934dSBarry Smith 
6959b3d3934dSBarry Smith #undef __FUNCT__
6960b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeGetBounds"
6961b3d3934dSBarry Smith /*@C
6962b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
6963b3d3934dSBarry Smith 
6964b3d3934dSBarry Smith    Collective on TS
6965b3d3934dSBarry Smith 
6966b3d3934dSBarry Smith    Input Parameter:
6967b3d3934dSBarry Smith .  ts - the TS context
6968b3d3934dSBarry Smith 
6969b3d3934dSBarry Smith    Output Parameter:
6970b3d3934dSBarry Smith +  max - the maximum values
6971b3d3934dSBarry Smith -  min - the minimum values
6972b3d3934dSBarry Smith 
69737db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
69747db568b7SBarry Smith 
6975b3d3934dSBarry Smith    Level: intermediate
6976b3d3934dSBarry Smith 
6977b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6978b3d3934dSBarry Smith 
6979b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6980b3d3934dSBarry Smith @*/
6981b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
6982b3d3934dSBarry Smith {
6983b3d3934dSBarry Smith   PetscInt i;
6984b3d3934dSBarry Smith 
6985b3d3934dSBarry Smith   PetscFunctionBegin;
6986b3d3934dSBarry Smith   if (max) *max = NULL;
6987b3d3934dSBarry Smith   if (min) *min = NULL;
6988b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6989b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
69905537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
6991b3d3934dSBarry Smith       if (max) *max = ctx->max;
6992b3d3934dSBarry Smith       if (min) *min = ctx->min;
6993b3d3934dSBarry Smith       break;
6994b3d3934dSBarry Smith     }
6995b3d3934dSBarry Smith   }
6996b3d3934dSBarry Smith   PetscFunctionReturn(0);
6997b3d3934dSBarry Smith }
6998b3d3934dSBarry Smith 
6999b3d3934dSBarry Smith #undef __FUNCT__
7000b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy"
7001b3d3934dSBarry Smith /*@C
7002b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7003b3d3934dSBarry Smith 
7004b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7005b3d3934dSBarry Smith 
7006b3d3934dSBarry Smith    Input Parameter:
7007b3d3934dSBarry Smith .  ctx - the monitor context
7008b3d3934dSBarry Smith 
7009b3d3934dSBarry Smith    Level: intermediate
7010b3d3934dSBarry Smith 
7011b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
7012b3d3934dSBarry Smith 
70137db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7014b3d3934dSBarry Smith @*/
7015b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7016b3d3934dSBarry Smith {
7017b3d3934dSBarry Smith   PetscErrorCode ierr;
7018b3d3934dSBarry Smith 
7019b3d3934dSBarry Smith   PetscFunctionBegin;
7020b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7021b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7022b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7023b3d3934dSBarry Smith   PetscFunctionReturn(0);
7024b3d3934dSBarry Smith }
7025f2dee214SBarry Smith 
702624655328SShri #undef __FUNCT__
702724655328SShri #define __FUNCT__ "TSRollBack"
702824655328SShri /*@
702924655328SShri    TSRollBack - Rolls back one time step
703024655328SShri 
703124655328SShri    Collective on TS
703224655328SShri 
703324655328SShri    Input Parameter:
703424655328SShri .  ts - the TS context obtained from TSCreate()
703524655328SShri 
703624655328SShri    Level: advanced
703724655328SShri 
703824655328SShri .keywords: TS, timestep, rollback
703924655328SShri 
704024655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
704124655328SShri @*/
704224655328SShri PetscErrorCode  TSRollBack(TS ts)
704324655328SShri {
704424655328SShri   PetscErrorCode ierr;
704524655328SShri 
704624655328SShri   PetscFunctionBegin;
704724655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7048b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
704924655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
705024655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
705124655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
705224655328SShri   ts->ptime = ts->ptime_prev;
7053be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
7054be5899b3SLisandro Dalcin   ts->steps--; ts->total_steps--;
7055b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
705624655328SShri   PetscFunctionReturn(0);
705724655328SShri }
7058aeb4809dSShri Abhyankar 
7059ff22ae23SHong Zhang #undef __FUNCT__
7060ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
7061ff22ae23SHong Zhang /*@
7062ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7063ff22ae23SHong Zhang 
7064ff22ae23SHong Zhang    Input Parameter:
7065ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7066ff22ae23SHong Zhang 
7067ff22ae23SHong Zhang    Level: advanced
7068ff22ae23SHong Zhang 
7069ff22ae23SHong Zhang .keywords: TS, getstages
7070ff22ae23SHong Zhang 
7071ff22ae23SHong Zhang .seealso: TSCreate()
7072ff22ae23SHong Zhang @*/
7073ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7074ff22ae23SHong Zhang {
7075ff22ae23SHong Zhang   PetscErrorCode ierr;
7076ff22ae23SHong Zhang 
7077ff22ae23SHong Zhang   PetscFunctionBegin;
7078ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7079ff22ae23SHong Zhang   PetscValidPointer(ns,2);
7080ff22ae23SHong Zhang 
7081ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
7082ff22ae23SHong Zhang   else {
7083ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7084ff22ae23SHong Zhang   }
7085ff22ae23SHong Zhang   PetscFunctionReturn(0);
7086ff22ae23SHong Zhang }
7087ff22ae23SHong Zhang 
7088847ff0e1SMatthew G. Knepley #undef __FUNCT__
7089847ff0e1SMatthew G. Knepley #define __FUNCT__ "TSComputeIJacobianDefaultColor"
7090847ff0e1SMatthew G. Knepley /*@C
7091847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7092847ff0e1SMatthew G. Knepley 
7093847ff0e1SMatthew G. Knepley   Collective on SNES
7094847ff0e1SMatthew G. Knepley 
7095847ff0e1SMatthew G. Knepley   Input Parameters:
7096847ff0e1SMatthew G. Knepley + ts - the TS context
7097847ff0e1SMatthew G. Knepley . t - current timestep
7098847ff0e1SMatthew G. Knepley . U - state vector
7099847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7100847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7101847ff0e1SMatthew G. Knepley - ctx - an optional user context
7102847ff0e1SMatthew G. Knepley 
7103847ff0e1SMatthew G. Knepley   Output Parameters:
7104847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7105847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7106847ff0e1SMatthew G. Knepley 
7107847ff0e1SMatthew G. Knepley   Level: intermediate
7108847ff0e1SMatthew G. Knepley 
7109847ff0e1SMatthew G. Knepley   Notes:
7110847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7111847ff0e1SMatthew G. Knepley 
7112847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7113847ff0e1SMatthew G. Knepley 
7114847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7115847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7116847ff0e1SMatthew G. Knepley 
7117847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7118847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7119847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7120847ff0e1SMatthew G. Knepley 
7121847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
7122847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7123847ff0e1SMatthew G. Knepley @*/
7124847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7125847ff0e1SMatthew G. Knepley {
7126847ff0e1SMatthew G. Knepley   SNES           snes;
7127847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7128847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7129847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
7130847ff0e1SMatthew G. Knepley 
7131847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
7132c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
7133847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
7134847ff0e1SMatthew G. Knepley   if (!color) {
7135847ff0e1SMatthew G. Knepley     DM         dm;
7136847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
7137847ff0e1SMatthew G. Knepley 
7138847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
7139847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
7140847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
7141847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
7142847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7143847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7144847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7145847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7146847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7147847ff0e1SMatthew G. Knepley     } else {
7148847ff0e1SMatthew G. Knepley       MatColoring mc;
7149847ff0e1SMatthew G. Knepley 
7150847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
7151847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
7152847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
7153847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
7154847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
7155847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
7156847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7157847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7158847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7159847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7160847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7161847ff0e1SMatthew G. Knepley     }
7162847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
7163847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
7164847ff0e1SMatthew G. Knepley   }
7165847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
7166847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
7167847ff0e1SMatthew G. Knepley   if (J != B) {
7168847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7169847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7170847ff0e1SMatthew G. Knepley   }
7171847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
7172847ff0e1SMatthew G. Knepley }
717393b34091SDebojyoti Ghosh 
717493b34091SDebojyoti Ghosh #undef __FUNCT__
7175cb9d8021SPierre Barbier de Reuille #define __FUNCT__ "TSSetFunctionDomainError"
7176cb9d8021SPierre Barbier de Reuille /*@
7177cb9d8021SPierre Barbier de Reuille     TSSetFunctionDomainError - Set the function testing if the current state vector is valid
7178cb9d8021SPierre Barbier de Reuille 
7179cb9d8021SPierre Barbier de Reuille     Input Parameters:
7180cb9d8021SPierre Barbier de Reuille     ts - the TS context
7181cb9d8021SPierre Barbier de Reuille     func - function called within TSFunctionDomainError
7182cb9d8021SPierre Barbier de Reuille 
7183cb9d8021SPierre Barbier de Reuille     Level: intermediate
7184cb9d8021SPierre Barbier de Reuille 
7185cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain
7186cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
7187cb9d8021SPierre Barbier de Reuille @*/
7188cb9d8021SPierre Barbier de Reuille 
7189d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
7190cb9d8021SPierre Barbier de Reuille {
7191cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7192cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7193cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
7194cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7195cb9d8021SPierre Barbier de Reuille }
7196cb9d8021SPierre Barbier de Reuille 
7197cb9d8021SPierre Barbier de Reuille #undef __FUNCT__
7198cb9d8021SPierre Barbier de Reuille #define __FUNCT__ "TSFunctionDomainError"
7199cb9d8021SPierre Barbier de Reuille /*@
7200cb9d8021SPierre Barbier de Reuille     TSFunctionDomainError - Check if the current state is valid
7201cb9d8021SPierre Barbier de Reuille 
7202cb9d8021SPierre Barbier de Reuille     Input Parameters:
7203cb9d8021SPierre Barbier de Reuille     ts - the TS context
7204cb9d8021SPierre Barbier de Reuille     stagetime - time of the simulation
7205d183316bSPierre Barbier de Reuille     Y - state vector to check.
7206cb9d8021SPierre Barbier de Reuille 
7207cb9d8021SPierre Barbier de Reuille     Output Parameter:
7208cb9d8021SPierre Barbier de Reuille     accept - Set to PETSC_FALSE if the current state vector is valid.
7209cb9d8021SPierre Barbier de Reuille 
7210cb9d8021SPierre Barbier de Reuille     Note:
7211cb9d8021SPierre Barbier de Reuille     This function should be used to ensure the state is in a valid part of the space.
7212cb9d8021SPierre Barbier de Reuille     For example, one can ensure here all values are positive.
721396a0c994SBarry Smith 
721496a0c994SBarry Smith     Level: advanced
7215cb9d8021SPierre Barbier de Reuille @*/
7216d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
7217cb9d8021SPierre Barbier de Reuille {
7218cb9d8021SPierre Barbier de Reuille   PetscErrorCode ierr;
7219cb9d8021SPierre Barbier de Reuille 
7220cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7221cb9d8021SPierre Barbier de Reuille 
7222cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7223cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
7224cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
7225d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
7226cb9d8021SPierre Barbier de Reuille   }
7227cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7228cb9d8021SPierre Barbier de Reuille }
72291ceb14c0SBarry Smith 
72301ceb14c0SBarry Smith #undef  __FUNCT__
7231e5168f73SEmil Constantinescu #define __FUNCT__ "TSClone"
723293b34091SDebojyoti Ghosh /*@C
7233e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
723493b34091SDebojyoti Ghosh 
723593b34091SDebojyoti Ghosh   Collective on MPI_Comm
723693b34091SDebojyoti Ghosh 
723793b34091SDebojyoti Ghosh   Input Parameter:
723893b34091SDebojyoti Ghosh . tsin    - The input TS
723993b34091SDebojyoti Ghosh 
724093b34091SDebojyoti Ghosh   Output Parameter:
7241e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
724293b34091SDebojyoti Ghosh 
72435eca1a21SEmil Constantinescu   Notes:
72445eca1a21SEmil 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.
72455eca1a21SEmil Constantinescu 
7246baa10174SEmil 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);
72475eca1a21SEmil Constantinescu 
72485eca1a21SEmil Constantinescu   Level: developer
724993b34091SDebojyoti Ghosh 
7250e5168f73SEmil Constantinescu .keywords: TS, clone
7251e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
725293b34091SDebojyoti Ghosh @*/
7253baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
725493b34091SDebojyoti Ghosh {
725593b34091SDebojyoti Ghosh   TS             t;
725693b34091SDebojyoti Ghosh   PetscErrorCode ierr;
7257dc846ba4SSatish Balay   SNES           snes_start;
7258dc846ba4SSatish Balay   DM             dm;
7259dc846ba4SSatish Balay   TSType         type;
726093b34091SDebojyoti Ghosh 
726193b34091SDebojyoti Ghosh   PetscFunctionBegin;
726293b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
726393b34091SDebojyoti Ghosh   *tsout = NULL;
726493b34091SDebojyoti Ghosh 
72657a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
726693b34091SDebojyoti Ghosh 
726793b34091SDebojyoti Ghosh   /* General TS description */
726893b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
726993b34091SDebojyoti Ghosh   t->setupcalled       = 0;
727093b34091SDebojyoti Ghosh   t->ksp_its           = 0;
727193b34091SDebojyoti Ghosh   t->snes_its          = 0;
727293b34091SDebojyoti Ghosh   t->nwork             = 0;
727393b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
727493b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
727593b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
727693b34091SDebojyoti Ghosh 
727734561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
727834561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
7279d15a3a53SEmil Constantinescu 
728093b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
728193b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
728293b34091SDebojyoti Ghosh 
728393b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
728451699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
728593b34091SDebojyoti Ghosh 
728693b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
728793b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
728893b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
728993b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
729093b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
729193b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
729293b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
729393b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
729493b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
729593b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
729693b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
729793b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
729893b34091SDebojyoti Ghosh 
729993b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
730093b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
730193b34091SDebojyoti Ghosh 
730293b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
730393b34091SDebojyoti Ghosh 
730493b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
730593b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
730693b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
730793b34091SDebojyoti Ghosh 
730893b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
730993b34091SDebojyoti Ghosh 
73100d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
73110d4fed19SBarry Smith     PetscInt i;
73120d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
73130d4fed19SBarry Smith     for (i=0; i<10; i++) {
73140d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
73150d4fed19SBarry Smith     }
73160d4fed19SBarry Smith   }
731793b34091SDebojyoti Ghosh   *tsout = t;
731893b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
731993b34091SDebojyoti Ghosh }
7320