xref: /petsc/src/ts/interface/ts.c (revision be5899b337ba0cfa5eb720cdae190eefe60949dd)
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) {
929bd373395SBarry Smith       if (ijacobian) {
930214bc6a2SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
931bd373395SBarry Smith       } else {
932bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
933214bc6a2SJed Brown       }
934d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
935e1244c69SJed Brown     }
93694ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
937e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
938e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
93994ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
94094ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
94194ab13aaSBarry Smith       if (A != B) {
94294ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
94394ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
944316643e7SJed Brown       }
945e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
946e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
947e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
94894ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
94994ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
95094ab13aaSBarry Smith         if (A != B) {
95194ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
95294ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
953214bc6a2SJed Brown         }
954316643e7SJed Brown       }
95594ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
95694ab13aaSBarry Smith       if (A != B) {
95794ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
958316643e7SJed Brown       }
959316643e7SJed Brown     }
960316643e7SJed Brown   }
96194ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
962316643e7SJed Brown   PetscFunctionReturn(0);
963316643e7SJed Brown }
964316643e7SJed Brown 
965316643e7SJed Brown #undef __FUNCT__
9664a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
967d763cef2SBarry Smith /*@C
968d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
969b5abc632SBarry Smith     where U_t = G(t,u).
970d763cef2SBarry Smith 
9713f9fe445SBarry Smith     Logically Collective on TS
972d763cef2SBarry Smith 
973d763cef2SBarry Smith     Input Parameters:
974d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
9750298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
976d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
977d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
9780298fd71SBarry Smith           function evaluation routine (may be NULL)
979d763cef2SBarry Smith 
980d763cef2SBarry Smith     Calling sequence of func:
98187828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
982d763cef2SBarry Smith 
983d763cef2SBarry Smith +   t - current timestep
984d763cef2SBarry Smith .   u - input vector
985d763cef2SBarry Smith .   F - function vector
986d763cef2SBarry Smith -   ctx - [optional] user-defined function context
987d763cef2SBarry Smith 
988d763cef2SBarry Smith     Level: beginner
989d763cef2SBarry Smith 
9902bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
9912bbac0d3SBarry Smith 
992d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
993d763cef2SBarry Smith 
994ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
995d763cef2SBarry Smith @*/
996089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
997d763cef2SBarry Smith {
998089b2837SJed Brown   PetscErrorCode ierr;
999089b2837SJed Brown   SNES           snes;
10000298fd71SBarry Smith   Vec            ralloc = NULL;
100124989b8cSPeter Brune   DM             dm;
1002d763cef2SBarry Smith 
1003089b2837SJed Brown   PetscFunctionBegin;
10040700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1005ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
100624989b8cSPeter Brune 
100724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
100824989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1009089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1010e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1011e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1012e856ceecSJed Brown     r = ralloc;
1013e856ceecSJed Brown   }
1014089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1015e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1016d763cef2SBarry Smith   PetscFunctionReturn(0);
1017d763cef2SBarry Smith }
1018d763cef2SBarry Smith 
10194a2ae208SSatish Balay #undef __FUNCT__
1020ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
1021ef20d060SBarry Smith /*@C
1022abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1023ef20d060SBarry Smith 
1024ef20d060SBarry Smith     Logically Collective on TS
1025ef20d060SBarry Smith 
1026ef20d060SBarry Smith     Input Parameters:
1027ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1028ef20d060SBarry Smith .   f - routine for evaluating the solution
1029ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
10300298fd71SBarry Smith           function evaluation routine (may be NULL)
1031ef20d060SBarry Smith 
1032ef20d060SBarry Smith     Calling sequence of func:
1033ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
1034ef20d060SBarry Smith 
1035ef20d060SBarry Smith +   t - current timestep
1036ef20d060SBarry Smith .   u - output vector
1037ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1038ef20d060SBarry Smith 
1039abd5a294SJed Brown     Notes:
1040abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1041abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1042abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1043abd5a294SJed Brown 
10444f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1045abd5a294SJed Brown 
1046ef20d060SBarry Smith     Level: beginner
1047ef20d060SBarry Smith 
1048ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1049ef20d060SBarry Smith 
10509b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
1051ef20d060SBarry Smith @*/
1052ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1053ef20d060SBarry Smith {
1054ef20d060SBarry Smith   PetscErrorCode ierr;
1055ef20d060SBarry Smith   DM             dm;
1056ef20d060SBarry Smith 
1057ef20d060SBarry Smith   PetscFunctionBegin;
1058ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1059ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1060ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1061ef20d060SBarry Smith   PetscFunctionReturn(0);
1062ef20d060SBarry Smith }
1063ef20d060SBarry Smith 
1064ef20d060SBarry Smith #undef __FUNCT__
10659b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
10669b7cd975SBarry Smith /*@C
10679b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
10689b7cd975SBarry Smith 
10699b7cd975SBarry Smith     Logically Collective on TS
10709b7cd975SBarry Smith 
10719b7cd975SBarry Smith     Input Parameters:
10729b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
10739b7cd975SBarry Smith .   f - routine for evaluating the forcing function
10749b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
10750298fd71SBarry Smith           function evaluation routine (may be NULL)
10769b7cd975SBarry Smith 
10779b7cd975SBarry Smith     Calling sequence of func:
10789b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
10799b7cd975SBarry Smith 
10809b7cd975SBarry Smith +   t - current timestep
10819b7cd975SBarry Smith .   u - output vector
10829b7cd975SBarry Smith -   ctx - [optional] user-defined function context
10839b7cd975SBarry Smith 
10849b7cd975SBarry Smith     Notes:
10859b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
10869b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
10879b7cd975SBarry Smith 
10889b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
10899b7cd975SBarry Smith 
10909b7cd975SBarry Smith     Level: beginner
10919b7cd975SBarry Smith 
10929b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
10939b7cd975SBarry Smith 
10949b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
10959b7cd975SBarry Smith @*/
1096d56366bfSLisandro Dalcin PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction f,void *ctx)
10979b7cd975SBarry Smith {
10989b7cd975SBarry Smith   PetscErrorCode ierr;
10999b7cd975SBarry Smith   DM             dm;
11009b7cd975SBarry Smith 
11019b7cd975SBarry Smith   PetscFunctionBegin;
11029b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
11039b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
11049b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
11059b7cd975SBarry Smith   PetscFunctionReturn(0);
11069b7cd975SBarry Smith }
11079b7cd975SBarry Smith 
11089b7cd975SBarry Smith #undef __FUNCT__
11094a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
1110d763cef2SBarry Smith /*@C
1111f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1112b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1113d763cef2SBarry Smith 
11143f9fe445SBarry Smith    Logically Collective on TS
1115d763cef2SBarry Smith 
1116d763cef2SBarry Smith    Input Parameters:
1117d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1118e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1119e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1120d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1121d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
11220298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1123d763cef2SBarry Smith 
1124f7ab8db6SBarry Smith    Calling sequence of f:
1125ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1126d763cef2SBarry Smith 
1127d763cef2SBarry Smith +  t - current timestep
1128d763cef2SBarry Smith .  u - input vector
1129e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1130e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1131d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1132d763cef2SBarry Smith 
11336cd88445SBarry Smith    Notes:
11346cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
11356cd88445SBarry Smith 
11366cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1137ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1138d763cef2SBarry Smith 
1139d763cef2SBarry Smith    Level: beginner
1140d763cef2SBarry Smith 
1141d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1142d763cef2SBarry Smith 
1143ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1144d763cef2SBarry Smith 
1145d763cef2SBarry Smith @*/
1146e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1147d763cef2SBarry Smith {
1148277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1149089b2837SJed Brown   SNES           snes;
115024989b8cSPeter Brune   DM             dm;
115124989b8cSPeter Brune   TSIJacobian    ijacobian;
1152277b19d0SLisandro Dalcin 
1153d763cef2SBarry Smith   PetscFunctionBegin;
11540700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1155e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1156e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1157e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1158e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1159d763cef2SBarry Smith 
116024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
116124989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1162e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1163e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1164e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1165e1244c69SJed Brown   }
11660298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1167089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11685f659677SPeter Brune   if (!ijacobian) {
1169e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
11700e4ef248SJed Brown   }
1171e5d3d808SBarry Smith   if (Amat) {
1172e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
11730e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1174e5d3d808SBarry Smith     ts->Arhs = Amat;
11750e4ef248SJed Brown   }
1176e5d3d808SBarry Smith   if (Pmat) {
1177e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
11780e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1179e5d3d808SBarry Smith     ts->Brhs = Pmat;
11800e4ef248SJed Brown   }
1181d763cef2SBarry Smith   PetscFunctionReturn(0);
1182d763cef2SBarry Smith }
1183d763cef2SBarry Smith 
1184316643e7SJed Brown 
1185316643e7SJed Brown #undef __FUNCT__
1186316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1187316643e7SJed Brown /*@C
1188b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1189316643e7SJed Brown 
11903f9fe445SBarry Smith    Logically Collective on TS
1191316643e7SJed Brown 
1192316643e7SJed Brown    Input Parameters:
1193316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
11940298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1195316643e7SJed Brown .  f   - the function evaluation routine
11960298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1197316643e7SJed Brown 
1198316643e7SJed Brown    Calling sequence of f:
1199316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1200316643e7SJed Brown 
1201316643e7SJed Brown +  t   - time at step/stage being solved
1202316643e7SJed Brown .  u   - state vector
1203316643e7SJed Brown .  u_t - time derivative of state vector
1204316643e7SJed Brown .  F   - function vector
1205316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1206316643e7SJed Brown 
1207316643e7SJed Brown    Important:
12082bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1209316643e7SJed Brown 
1210316643e7SJed Brown    Level: beginner
1211316643e7SJed Brown 
1212316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1213316643e7SJed Brown 
1214d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1215316643e7SJed Brown @*/
121651699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1217316643e7SJed Brown {
1218089b2837SJed Brown   PetscErrorCode ierr;
1219089b2837SJed Brown   SNES           snes;
122051699248SLisandro Dalcin   Vec            ralloc = NULL;
122124989b8cSPeter Brune   DM             dm;
1222316643e7SJed Brown 
1223316643e7SJed Brown   PetscFunctionBegin;
12240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
122551699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
122624989b8cSPeter Brune 
122724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
122824989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
122924989b8cSPeter Brune 
1230089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
123151699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
123251699248SLisandro Dalcin     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
123351699248SLisandro Dalcin     r  = ralloc;
1234e856ceecSJed Brown   }
123551699248SLisandro Dalcin   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
123651699248SLisandro Dalcin   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1237089b2837SJed Brown   PetscFunctionReturn(0);
1238089b2837SJed Brown }
1239089b2837SJed Brown 
1240089b2837SJed Brown #undef __FUNCT__
1241089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1242089b2837SJed Brown /*@C
1243089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1244089b2837SJed Brown 
1245089b2837SJed Brown    Not Collective
1246089b2837SJed Brown 
1247089b2837SJed Brown    Input Parameter:
1248089b2837SJed Brown .  ts - the TS context
1249089b2837SJed Brown 
1250089b2837SJed Brown    Output Parameter:
12510298fd71SBarry Smith +  r - vector to hold residual (or NULL)
12520298fd71SBarry Smith .  func - the function to compute residual (or NULL)
12530298fd71SBarry Smith -  ctx - the function context (or NULL)
1254089b2837SJed Brown 
1255089b2837SJed Brown    Level: advanced
1256089b2837SJed Brown 
1257089b2837SJed Brown .keywords: TS, nonlinear, get, function
1258089b2837SJed Brown 
1259089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1260089b2837SJed Brown @*/
1261089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1262089b2837SJed Brown {
1263089b2837SJed Brown   PetscErrorCode ierr;
1264089b2837SJed Brown   SNES           snes;
126524989b8cSPeter Brune   DM             dm;
1266089b2837SJed Brown 
1267089b2837SJed Brown   PetscFunctionBegin;
1268089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1269089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12700298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
127124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
127224989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1273089b2837SJed Brown   PetscFunctionReturn(0);
1274089b2837SJed Brown }
1275089b2837SJed Brown 
1276089b2837SJed Brown #undef __FUNCT__
1277089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1278089b2837SJed Brown /*@C
1279089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1280089b2837SJed Brown 
1281089b2837SJed Brown    Not Collective
1282089b2837SJed Brown 
1283089b2837SJed Brown    Input Parameter:
1284089b2837SJed Brown .  ts - the TS context
1285089b2837SJed Brown 
1286089b2837SJed Brown    Output Parameter:
12870298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
12880298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
12890298fd71SBarry Smith -  ctx - the function context (or NULL)
1290089b2837SJed Brown 
1291089b2837SJed Brown    Level: advanced
1292089b2837SJed Brown 
1293089b2837SJed Brown .keywords: TS, nonlinear, get, function
1294089b2837SJed Brown 
12952bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1296089b2837SJed Brown @*/
1297089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1298089b2837SJed Brown {
1299089b2837SJed Brown   PetscErrorCode ierr;
1300089b2837SJed Brown   SNES           snes;
130124989b8cSPeter Brune   DM             dm;
1302089b2837SJed Brown 
1303089b2837SJed Brown   PetscFunctionBegin;
1304089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1305089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13060298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
130724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
130824989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1309316643e7SJed Brown   PetscFunctionReturn(0);
1310316643e7SJed Brown }
1311316643e7SJed Brown 
1312316643e7SJed Brown #undef __FUNCT__
1313316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1314316643e7SJed Brown /*@C
1315a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1316ae8867d6SBarry Smith         provided with TSSetIFunction().
1317316643e7SJed Brown 
13183f9fe445SBarry Smith    Logically Collective on TS
1319316643e7SJed Brown 
1320316643e7SJed Brown    Input Parameters:
1321316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1322e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1323e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1324316643e7SJed Brown .  f   - the Jacobian evaluation routine
13250298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1326316643e7SJed Brown 
1327316643e7SJed Brown    Calling sequence of f:
1328ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1329316643e7SJed Brown 
1330316643e7SJed Brown +  t    - time at step/stage being solved
13311b4a444bSJed Brown .  U    - state vector
13321b4a444bSJed Brown .  U_t  - time derivative of state vector
1333316643e7SJed Brown .  a    - shift
1334e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1335e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1336316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1337316643e7SJed Brown 
1338316643e7SJed Brown    Notes:
1339e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1340316643e7SJed Brown 
1341895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1342895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1343895c21f2SBarry Smith 
1344a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1345b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1346a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1347a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1348a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1349a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1350a4f0a591SBarry Smith 
13516cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
13526cd88445SBarry Smith 
13536cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1354ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1355ca5f011dSBarry Smith 
1356316643e7SJed Brown    Level: beginner
1357316643e7SJed Brown 
1358316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1359316643e7SJed Brown 
1360ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1361316643e7SJed Brown 
1362316643e7SJed Brown @*/
1363e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1364316643e7SJed Brown {
1365316643e7SJed Brown   PetscErrorCode ierr;
1366089b2837SJed Brown   SNES           snes;
136724989b8cSPeter Brune   DM             dm;
1368316643e7SJed Brown 
1369316643e7SJed Brown   PetscFunctionBegin;
13700700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1371e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1372e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1373e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1374e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
137524989b8cSPeter Brune 
137624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
137724989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
137824989b8cSPeter Brune 
1379089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1380e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1381316643e7SJed Brown   PetscFunctionReturn(0);
1382316643e7SJed Brown }
1383316643e7SJed Brown 
13844a2ae208SSatish Balay #undef __FUNCT__
1385e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1386e1244c69SJed Brown /*@
1387e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1388e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1389e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1390e1244c69SJed Brown    not been changed by the TS.
1391e1244c69SJed Brown 
1392e1244c69SJed Brown    Logically Collective
1393e1244c69SJed Brown 
1394e1244c69SJed Brown    Input Arguments:
1395e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1396e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1397e1244c69SJed Brown 
1398e1244c69SJed Brown    Level: intermediate
1399e1244c69SJed Brown 
1400e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1401e1244c69SJed Brown @*/
1402e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1403e1244c69SJed Brown {
1404e1244c69SJed Brown   PetscFunctionBegin;
1405e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1406e1244c69SJed Brown   PetscFunctionReturn(0);
1407e1244c69SJed Brown }
1408e1244c69SJed Brown 
1409e1244c69SJed Brown #undef __FUNCT__
141055849f57SBarry Smith #define __FUNCT__ "TSLoad"
141155849f57SBarry Smith /*@C
141255849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
141355849f57SBarry Smith 
141455849f57SBarry Smith   Collective on PetscViewer
141555849f57SBarry Smith 
141655849f57SBarry Smith   Input Parameters:
141755849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
141855849f57SBarry Smith            some related function before a call to TSLoad().
141955849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
142055849f57SBarry Smith 
142155849f57SBarry Smith    Level: intermediate
142255849f57SBarry Smith 
142355849f57SBarry Smith   Notes:
142455849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
142555849f57SBarry Smith 
142655849f57SBarry Smith   Notes for advanced users:
142755849f57SBarry Smith   Most users should not need to know the details of the binary storage
142855849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
142955849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
143055849f57SBarry Smith   format is
143155849f57SBarry Smith .vb
143255849f57SBarry Smith      has not yet been determined
143355849f57SBarry Smith .ve
143455849f57SBarry Smith 
143555849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
143655849f57SBarry Smith @*/
1437f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
143855849f57SBarry Smith {
143955849f57SBarry Smith   PetscErrorCode ierr;
144055849f57SBarry Smith   PetscBool      isbinary;
144155849f57SBarry Smith   PetscInt       classid;
144255849f57SBarry Smith   char           type[256];
14432d53ad75SBarry Smith   DMTS           sdm;
1444ad6bc421SBarry Smith   DM             dm;
144555849f57SBarry Smith 
144655849f57SBarry Smith   PetscFunctionBegin;
1447f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
144855849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
144955849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
145055849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
145155849f57SBarry Smith 
1452060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1453ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1454060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1455f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1456f2c2a1b9SBarry Smith   if (ts->ops->load) {
1457f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1458f2c2a1b9SBarry Smith   }
1459ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1460ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1461ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1462f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1463f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
14642d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14652d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
146655849f57SBarry Smith   PetscFunctionReturn(0);
146755849f57SBarry Smith }
146855849f57SBarry Smith 
14699804daf3SBarry Smith #include <petscdraw.h>
1470e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1471e04113cfSBarry Smith #include <petscviewersaws.h>
1472f05ece33SBarry Smith #endif
147355849f57SBarry Smith #undef __FUNCT__
14744a2ae208SSatish Balay #define __FUNCT__ "TSView"
14757e2c5f70SBarry Smith /*@C
1476d763cef2SBarry Smith     TSView - Prints the TS data structure.
1477d763cef2SBarry Smith 
14784c49b128SBarry Smith     Collective on TS
1479d763cef2SBarry Smith 
1480d763cef2SBarry Smith     Input Parameters:
1481d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1482d763cef2SBarry Smith -   viewer - visualization context
1483d763cef2SBarry Smith 
1484d763cef2SBarry Smith     Options Database Key:
1485d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1486d763cef2SBarry Smith 
1487d763cef2SBarry Smith     Notes:
1488d763cef2SBarry Smith     The available visualization contexts include
1489b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1490b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1491d763cef2SBarry Smith          output where only the first processor opens
1492d763cef2SBarry Smith          the file.  All other processors send their
1493d763cef2SBarry Smith          data to the first processor to print.
1494d763cef2SBarry Smith 
1495d763cef2SBarry Smith     The user can open an alternative visualization context with
1496b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1497d763cef2SBarry Smith 
1498d763cef2SBarry Smith     Level: beginner
1499d763cef2SBarry Smith 
1500d763cef2SBarry Smith .keywords: TS, timestep, view
1501d763cef2SBarry Smith 
1502b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1503d763cef2SBarry Smith @*/
15047087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1505d763cef2SBarry Smith {
1506dfbe8321SBarry Smith   PetscErrorCode ierr;
150719fd82e9SBarry Smith   TSType         type;
15082b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
15092d53ad75SBarry Smith   DMTS           sdm;
1510e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1511536b137fSBarry Smith   PetscBool      issaws;
1512f05ece33SBarry Smith #endif
1513d763cef2SBarry Smith 
1514d763cef2SBarry Smith   PetscFunctionBegin;
15150700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
15163050cee2SBarry Smith   if (!viewer) {
1517ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
15183050cee2SBarry Smith   }
15190700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1520c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1521fd16b177SBarry Smith 
1522251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1523251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
152455849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
15252b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1526e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1527536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1528f05ece33SBarry Smith #endif
152932077d6dSBarry Smith   if (iascii) {
1530dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
153177431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
15327c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1533d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
15345ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1535c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1536d763cef2SBarry Smith     }
15375ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1538193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
15392d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
15402d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1541d52bd9f3SBarry Smith     if (ts->ops->view) {
1542d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1543d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1544d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1545d52bd9f3SBarry Smith     }
15460f5bd95cSBarry Smith   } else if (isstring) {
1547a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1548b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
154955849f57SBarry Smith   } else if (isbinary) {
155055849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
155155849f57SBarry Smith     MPI_Comm    comm;
155255849f57SBarry Smith     PetscMPIInt rank;
155355849f57SBarry Smith     char        type[256];
155455849f57SBarry Smith 
155555849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
155655849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
155755849f57SBarry Smith     if (!rank) {
155855849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
155955849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
156055849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
156155849f57SBarry Smith     }
156255849f57SBarry Smith     if (ts->ops->view) {
156355849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
156455849f57SBarry Smith     }
1565f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1566f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
15672d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
15682d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
15692b0a91c0SBarry Smith   } else if (isdraw) {
15702b0a91c0SBarry Smith     PetscDraw draw;
15712b0a91c0SBarry Smith     char      str[36];
157289fd9fafSBarry Smith     PetscReal x,y,bottom,h;
15732b0a91c0SBarry Smith 
15742b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
15752b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
15762b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
15772b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
157851fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
157989fd9fafSBarry Smith     bottom = y - h;
15802b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
15812b0a91c0SBarry Smith     if (ts->ops->view) {
15822b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
15832b0a91c0SBarry Smith     }
15842b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1585e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1586536b137fSBarry Smith   } else if (issaws) {
1587d45a07a7SBarry Smith     PetscMPIInt rank;
15882657e9d9SBarry Smith     const char  *name;
15892657e9d9SBarry Smith 
15902657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1591d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1592d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1593d45a07a7SBarry Smith       char       dir[1024];
1594d45a07a7SBarry Smith 
1595e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1596a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
15972657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
15982657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
15992657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1600d763cef2SBarry Smith     }
16010acecf5bSBarry Smith     if (ts->ops->view) {
16020acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
16030acecf5bSBarry Smith     }
1604f05ece33SBarry Smith #endif
1605f05ece33SBarry Smith   }
1606f05ece33SBarry Smith 
1607b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1608251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1609b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1610d763cef2SBarry Smith   PetscFunctionReturn(0);
1611d763cef2SBarry Smith }
1612d763cef2SBarry Smith 
1613d763cef2SBarry Smith 
16144a2ae208SSatish Balay #undef __FUNCT__
16154a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1616b07ff414SBarry Smith /*@
1617d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1618d763cef2SBarry Smith    the timesteppers.
1619d763cef2SBarry Smith 
16203f9fe445SBarry Smith    Logically Collective on TS
1621d763cef2SBarry Smith 
1622d763cef2SBarry Smith    Input Parameters:
1623d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1624d763cef2SBarry Smith -  usrP - optional user context
1625d763cef2SBarry Smith 
1626daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
1627daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
1628daf670e6SBarry Smith 
1629d763cef2SBarry Smith    Level: intermediate
1630d763cef2SBarry Smith 
1631d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1632d763cef2SBarry Smith 
1633d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1634d763cef2SBarry Smith @*/
16357087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1636d763cef2SBarry Smith {
1637d763cef2SBarry Smith   PetscFunctionBegin;
16380700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1639d763cef2SBarry Smith   ts->user = usrP;
1640d763cef2SBarry Smith   PetscFunctionReturn(0);
1641d763cef2SBarry Smith }
1642d763cef2SBarry Smith 
16434a2ae208SSatish Balay #undef __FUNCT__
16444a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1645b07ff414SBarry Smith /*@
1646d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1647d763cef2SBarry Smith     timestepper.
1648d763cef2SBarry Smith 
1649d763cef2SBarry Smith     Not Collective
1650d763cef2SBarry Smith 
1651d763cef2SBarry Smith     Input Parameter:
1652d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1653d763cef2SBarry Smith 
1654d763cef2SBarry Smith     Output Parameter:
1655d763cef2SBarry Smith .   usrP - user context
1656d763cef2SBarry Smith 
1657daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
1658daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
1659daf670e6SBarry Smith 
1660d763cef2SBarry Smith     Level: intermediate
1661d763cef2SBarry Smith 
1662d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1663d763cef2SBarry Smith 
1664d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1665d763cef2SBarry Smith @*/
1666e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1667d763cef2SBarry Smith {
1668d763cef2SBarry Smith   PetscFunctionBegin;
16690700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1670e71120c6SJed Brown   *(void**)usrP = ts->user;
1671d763cef2SBarry Smith   PetscFunctionReturn(0);
1672d763cef2SBarry Smith }
1673d763cef2SBarry Smith 
16744a2ae208SSatish Balay #undef __FUNCT__
16754a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1676d763cef2SBarry Smith /*@
1677b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1678d763cef2SBarry Smith 
1679d763cef2SBarry Smith    Not Collective
1680d763cef2SBarry Smith 
1681d763cef2SBarry Smith    Input Parameter:
1682d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1683d763cef2SBarry Smith 
1684d763cef2SBarry Smith    Output Parameter:
1685b8123daeSJed Brown .  iter - number of steps completed so far
1686d763cef2SBarry Smith 
1687d763cef2SBarry Smith    Level: intermediate
1688d763cef2SBarry Smith 
1689d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
16909be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1691d763cef2SBarry Smith @*/
16927087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1693d763cef2SBarry Smith {
1694d763cef2SBarry Smith   PetscFunctionBegin;
16950700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
16964482741eSBarry Smith   PetscValidIntPointer(iter,2);
1697d763cef2SBarry Smith   *iter = ts->steps;
1698d763cef2SBarry Smith   PetscFunctionReturn(0);
1699d763cef2SBarry Smith }
1700d763cef2SBarry Smith 
17014a2ae208SSatish Balay #undef __FUNCT__
17024a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1703d763cef2SBarry Smith /*@
1704d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1705d763cef2SBarry Smith    as well as the initial time.
1706d763cef2SBarry Smith 
17073f9fe445SBarry Smith    Logically Collective on TS
1708d763cef2SBarry Smith 
1709d763cef2SBarry Smith    Input Parameters:
1710d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1711d763cef2SBarry Smith .  initial_time - the initial time
1712d763cef2SBarry Smith -  time_step - the size of the timestep
1713d763cef2SBarry Smith 
1714d763cef2SBarry Smith    Level: intermediate
1715d763cef2SBarry Smith 
1716d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1717d763cef2SBarry Smith 
1718d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1719d763cef2SBarry Smith @*/
17207087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1721d763cef2SBarry Smith {
1722e144a568SJed Brown   PetscErrorCode ierr;
1723e144a568SJed Brown 
1724d763cef2SBarry Smith   PetscFunctionBegin;
17250700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1726e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1727d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1728d763cef2SBarry Smith   PetscFunctionReturn(0);
1729d763cef2SBarry Smith }
1730d763cef2SBarry Smith 
17314a2ae208SSatish Balay #undef __FUNCT__
17324a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1733d763cef2SBarry Smith /*@
1734d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1735d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1736d763cef2SBarry Smith 
17373f9fe445SBarry Smith    Logically Collective on TS
1738d763cef2SBarry Smith 
1739d763cef2SBarry Smith    Input Parameters:
1740d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1741d763cef2SBarry Smith -  time_step - the size of the timestep
1742d763cef2SBarry Smith 
1743d763cef2SBarry Smith    Level: intermediate
1744d763cef2SBarry Smith 
1745d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1746d763cef2SBarry Smith 
1747d763cef2SBarry Smith .keywords: TS, set, timestep
1748d763cef2SBarry Smith @*/
17497087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1750d763cef2SBarry Smith {
1751d763cef2SBarry Smith   PetscFunctionBegin;
17520700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1753c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1754d763cef2SBarry Smith   ts->time_step = time_step;
1755d763cef2SBarry Smith   PetscFunctionReturn(0);
1756d763cef2SBarry Smith }
1757d763cef2SBarry Smith 
17584a2ae208SSatish Balay #undef __FUNCT__
1759a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1760a43b19c4SJed Brown /*@
176149354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
176249354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
176349354f04SShri Abhyankar      or just return at the final time TS computed.
1764a43b19c4SJed Brown 
1765a43b19c4SJed Brown   Logically Collective on TS
1766a43b19c4SJed Brown 
1767a43b19c4SJed Brown    Input Parameter:
1768a43b19c4SJed Brown +   ts - the time-step context
176949354f04SShri Abhyankar -   eftopt - exact final time option
1770a43b19c4SJed Brown 
1771feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
1772feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
1773feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
1774feed9e9dSBarry Smith 
1775feed9e9dSBarry Smith    Options Database:
1776feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
1777feed9e9dSBarry Smith 
1778ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
1779ee346746SBarry Smith     then the final time you selected.
1780ee346746SBarry Smith 
1781a43b19c4SJed Brown    Level: beginner
1782a43b19c4SJed Brown 
1783a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1784a43b19c4SJed Brown @*/
178549354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1786a43b19c4SJed Brown {
1787a43b19c4SJed Brown   PetscFunctionBegin;
1788a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
178949354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
179049354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1791a43b19c4SJed Brown   PetscFunctionReturn(0);
1792a43b19c4SJed Brown }
1793a43b19c4SJed Brown 
1794a43b19c4SJed Brown #undef __FUNCT__
17954a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1796d763cef2SBarry Smith /*@
1797d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1798d763cef2SBarry Smith 
1799d763cef2SBarry Smith    Not Collective
1800d763cef2SBarry Smith 
1801d763cef2SBarry Smith    Input Parameter:
1802d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1803d763cef2SBarry Smith 
1804d763cef2SBarry Smith    Output Parameter:
1805d763cef2SBarry Smith .  dt - the current timestep size
1806d763cef2SBarry Smith 
1807d763cef2SBarry Smith    Level: intermediate
1808d763cef2SBarry Smith 
1809d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1810d763cef2SBarry Smith 
1811d763cef2SBarry Smith .keywords: TS, get, timestep
1812d763cef2SBarry Smith @*/
18137087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1814d763cef2SBarry Smith {
1815d763cef2SBarry Smith   PetscFunctionBegin;
18160700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1817f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1818d763cef2SBarry Smith   *dt = ts->time_step;
1819d763cef2SBarry Smith   PetscFunctionReturn(0);
1820d763cef2SBarry Smith }
1821d763cef2SBarry Smith 
18224a2ae208SSatish Balay #undef __FUNCT__
18234a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1824d8e5e3e6SSatish Balay /*@
1825d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1826d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1827d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1828d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1829d763cef2SBarry Smith 
1830d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1831d763cef2SBarry Smith 
1832d763cef2SBarry Smith    Input Parameter:
1833d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1834d763cef2SBarry Smith 
1835d763cef2SBarry Smith    Output Parameter:
1836d763cef2SBarry Smith .  v - the vector containing the solution
1837d763cef2SBarry Smith 
183863e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
183963e21af5SBarry Smith    final time. It returns the solution at the next timestep.
184063e21af5SBarry Smith 
1841d763cef2SBarry Smith    Level: intermediate
1842d763cef2SBarry Smith 
184363e21af5SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime()
1844d763cef2SBarry Smith 
1845d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1846d763cef2SBarry Smith @*/
18477087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1848d763cef2SBarry Smith {
1849d763cef2SBarry Smith   PetscFunctionBegin;
18500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
18514482741eSBarry Smith   PetscValidPointer(v,2);
18528737fe31SLisandro Dalcin   *v = ts->vec_sol;
1853d763cef2SBarry Smith   PetscFunctionReturn(0);
1854d763cef2SBarry Smith }
1855d763cef2SBarry Smith 
1856c235aa8dSHong Zhang #undef __FUNCT__
1857dfb21088SHong Zhang #define __FUNCT__ "TSGetCostGradients"
1858c235aa8dSHong Zhang /*@
1859dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
1860c235aa8dSHong Zhang 
1861c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
1862c235aa8dSHong Zhang 
1863c235aa8dSHong Zhang    Input Parameter:
1864c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
1865c235aa8dSHong Zhang 
1866c235aa8dSHong Zhang    Output Parameter:
1867abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
1868abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
1869c235aa8dSHong Zhang 
1870c235aa8dSHong Zhang    Level: intermediate
1871c235aa8dSHong Zhang 
1872c235aa8dSHong Zhang .seealso: TSGetTimeStep()
1873c235aa8dSHong Zhang 
1874c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
1875c235aa8dSHong Zhang @*/
1876dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
1877c235aa8dSHong Zhang {
1878c235aa8dSHong Zhang   PetscFunctionBegin;
1879c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1880abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
1881abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
1882abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
1883c235aa8dSHong Zhang   PetscFunctionReturn(0);
1884c235aa8dSHong Zhang }
1885c235aa8dSHong Zhang 
1886bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
18874a2ae208SSatish Balay #undef __FUNCT__
1888bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1889d8e5e3e6SSatish Balay /*@
1890bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1891d763cef2SBarry Smith 
1892bdad233fSMatthew Knepley   Not collective
1893d763cef2SBarry Smith 
1894bdad233fSMatthew Knepley   Input Parameters:
1895bdad233fSMatthew Knepley + ts   - The TS
1896bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1897d763cef2SBarry Smith .vb
18980910c330SBarry Smith          U_t - A U = 0      (linear)
18990910c330SBarry Smith          U_t - A(t) U = 0   (linear)
19000910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1901d763cef2SBarry Smith .ve
1902d763cef2SBarry Smith 
1903d763cef2SBarry Smith    Level: beginner
1904d763cef2SBarry Smith 
1905bdad233fSMatthew Knepley .keywords: TS, problem type
1906bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1907d763cef2SBarry Smith @*/
19087087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1909a7cc72afSBarry Smith {
19109e2a6581SJed Brown   PetscErrorCode ierr;
19119e2a6581SJed Brown 
1912d763cef2SBarry Smith   PetscFunctionBegin;
19130700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1914bdad233fSMatthew Knepley   ts->problem_type = type;
19159e2a6581SJed Brown   if (type == TS_LINEAR) {
19169e2a6581SJed Brown     SNES snes;
19179e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
19189e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
19199e2a6581SJed Brown   }
1920d763cef2SBarry Smith   PetscFunctionReturn(0);
1921d763cef2SBarry Smith }
1922d763cef2SBarry Smith 
1923bdad233fSMatthew Knepley #undef __FUNCT__
1924bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1925bdad233fSMatthew Knepley /*@C
1926bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1927bdad233fSMatthew Knepley 
1928bdad233fSMatthew Knepley   Not collective
1929bdad233fSMatthew Knepley 
1930bdad233fSMatthew Knepley   Input Parameter:
1931bdad233fSMatthew Knepley . ts   - The TS
1932bdad233fSMatthew Knepley 
1933bdad233fSMatthew Knepley   Output Parameter:
1934bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1935bdad233fSMatthew Knepley .vb
1936089b2837SJed Brown          M U_t = A U
1937089b2837SJed Brown          M(t) U_t = A(t) U
1938b5abc632SBarry Smith          F(t,U,U_t)
1939bdad233fSMatthew Knepley .ve
1940bdad233fSMatthew Knepley 
1941bdad233fSMatthew Knepley    Level: beginner
1942bdad233fSMatthew Knepley 
1943bdad233fSMatthew Knepley .keywords: TS, problem type
1944bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1945bdad233fSMatthew Knepley @*/
19467087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1947a7cc72afSBarry Smith {
1948bdad233fSMatthew Knepley   PetscFunctionBegin;
19490700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
19504482741eSBarry Smith   PetscValidIntPointer(type,2);
1951bdad233fSMatthew Knepley   *type = ts->problem_type;
1952bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1953bdad233fSMatthew Knepley }
1954d763cef2SBarry Smith 
19554a2ae208SSatish Balay #undef __FUNCT__
19564a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1957d763cef2SBarry Smith /*@
1958d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1959d763cef2SBarry Smith    of a timestepper.
1960d763cef2SBarry Smith 
1961d763cef2SBarry Smith    Collective on TS
1962d763cef2SBarry Smith 
1963d763cef2SBarry Smith    Input Parameter:
1964d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1965d763cef2SBarry Smith 
1966d763cef2SBarry Smith    Notes:
1967d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1968d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1969d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1970d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1971d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1972d763cef2SBarry Smith 
1973d763cef2SBarry Smith    Level: advanced
1974d763cef2SBarry Smith 
1975d763cef2SBarry Smith .keywords: TS, timestep, setup
1976d763cef2SBarry Smith 
1977d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1978d763cef2SBarry Smith @*/
19797087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1980d763cef2SBarry Smith {
1981dfbe8321SBarry Smith   PetscErrorCode ierr;
19826c6b9e74SPeter Brune   DM             dm;
19836c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1984d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
1985cd11d68dSLisandro Dalcin   TSIFunction    ifun;
19866c6b9e74SPeter Brune   TSIJacobian    ijac;
19876c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1988d763cef2SBarry Smith 
1989d763cef2SBarry Smith   PetscFunctionBegin;
19900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1991277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1992277b19d0SLisandro Dalcin 
19932c18e0fdSBarry Smith   ts->total_steps = 0;
19947adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
1995cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
1996cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
1997d763cef2SBarry Smith   }
1998277b19d0SLisandro Dalcin 
1999277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
2000277b19d0SLisandro Dalcin 
2001e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
2002e1244c69SJed Brown     Mat Amat,Pmat;
2003e1244c69SJed Brown     SNES snes;
2004e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2005e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2006e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2007e1244c69SJed Brown      * have displaced the RHS matrix */
2008e1244c69SJed Brown     if (Amat == ts->Arhs) {
2009e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2010e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2011e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2012e1244c69SJed Brown     }
2013e1244c69SJed Brown     if (Pmat == ts->Brhs) {
2014e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2015e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2016e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2017e1244c69SJed Brown     }
2018e1244c69SJed Brown   }
2019277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2020000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2021277b19d0SLisandro Dalcin   }
2022277b19d0SLisandro Dalcin 
2023a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
20246c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
20256c6b9e74SPeter Brune    */
20266c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
20270298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
20286c6b9e74SPeter Brune   if (!func) {
20296c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
20306c6b9e74SPeter Brune   }
2031a6772fa2SLisandro 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.
20326c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
20336c6b9e74SPeter Brune    */
20340298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
20350298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
20360298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
20376c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
20386c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
20396c6b9e74SPeter Brune   }
2040277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2041277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2042277b19d0SLisandro Dalcin }
2043277b19d0SLisandro Dalcin 
2044277b19d0SLisandro Dalcin #undef __FUNCT__
2045f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp"
2046f6a906c0SBarry Smith /*@
2047f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
2048f6a906c0SBarry Smith    of an adjoint solver
2049f6a906c0SBarry Smith 
2050f6a906c0SBarry Smith    Collective on TS
2051f6a906c0SBarry Smith 
2052f6a906c0SBarry Smith    Input Parameter:
2053f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
2054f6a906c0SBarry Smith 
2055f6a906c0SBarry Smith    Level: advanced
2056f6a906c0SBarry Smith 
2057f6a906c0SBarry Smith .keywords: TS, timestep, setup
2058f6a906c0SBarry Smith 
2059947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
2060f6a906c0SBarry Smith @*/
2061f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
2062f6a906c0SBarry Smith {
2063f6a906c0SBarry Smith   PetscErrorCode ierr;
2064f6a906c0SBarry Smith 
2065f6a906c0SBarry Smith   PetscFunctionBegin;
2066f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2067f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
2068dfb21088SHong Zhang   if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
2069d8151eeaSBarry Smith 
2070947abb85SHong Zhang   if (ts->vec_costintegral) { /* if there is integral in the cost function*/
2071d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2072d8151eeaSBarry Smith     if (ts->vecs_sensip){
2073d8151eeaSBarry Smith       ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2074d8151eeaSBarry Smith     }
2075947abb85SHong Zhang   }
2076d8151eeaSBarry Smith 
207742f2b339SBarry Smith   if (ts->ops->adjointsetup) {
207842f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
2079f6a906c0SBarry Smith   }
2080f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
2081f6a906c0SBarry Smith   PetscFunctionReturn(0);
2082f6a906c0SBarry Smith }
2083f6a906c0SBarry Smith 
2084f6a906c0SBarry Smith #undef __FUNCT__
2085277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
2086277b19d0SLisandro Dalcin /*@
2087277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2088277b19d0SLisandro Dalcin 
2089277b19d0SLisandro Dalcin    Collective on TS
2090277b19d0SLisandro Dalcin 
2091277b19d0SLisandro Dalcin    Input Parameter:
2092277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2093277b19d0SLisandro Dalcin 
2094277b19d0SLisandro Dalcin    Level: beginner
2095277b19d0SLisandro Dalcin 
2096277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2097277b19d0SLisandro Dalcin 
2098277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2099277b19d0SLisandro Dalcin @*/
2100277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2101277b19d0SLisandro Dalcin {
2102277b19d0SLisandro Dalcin   PetscErrorCode ierr;
2103277b19d0SLisandro Dalcin 
2104277b19d0SLisandro Dalcin   PetscFunctionBegin;
2105277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2106b18ea86cSHong Zhang 
2107277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2108277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2109277b19d0SLisandro Dalcin   }
2110277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2111e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2112bbd56ea5SKarl Rupp 
21134e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
21144e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2115214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
21166bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2117e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2118e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
211938637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2120bbd56ea5SKarl Rupp 
2121947abb85SHong Zhang  if (ts->vec_costintegral) {
2122d8151eeaSBarry Smith     ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2123d8151eeaSBarry Smith     if (ts->vecs_drdp){
2124d8151eeaSBarry Smith       ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2125d8151eeaSBarry Smith     }
2126947abb85SHong Zhang   }
2127d8151eeaSBarry Smith   ts->vecs_sensi  = NULL;
2128d8151eeaSBarry Smith   ts->vecs_sensip = NULL;
2129ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
21302c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
213136eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2132277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2133d763cef2SBarry Smith   PetscFunctionReturn(0);
2134d763cef2SBarry Smith }
2135d763cef2SBarry Smith 
21364a2ae208SSatish Balay #undef __FUNCT__
21374a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
2138d8e5e3e6SSatish Balay /*@
2139d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2140d763cef2SBarry Smith    with TSCreate().
2141d763cef2SBarry Smith 
2142d763cef2SBarry Smith    Collective on TS
2143d763cef2SBarry Smith 
2144d763cef2SBarry Smith    Input Parameter:
2145d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2146d763cef2SBarry Smith 
2147d763cef2SBarry Smith    Level: beginner
2148d763cef2SBarry Smith 
2149d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2150d763cef2SBarry Smith 
2151d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2152d763cef2SBarry Smith @*/
21536bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2154d763cef2SBarry Smith {
21556849ba73SBarry Smith   PetscErrorCode ierr;
2156d763cef2SBarry Smith 
2157d763cef2SBarry Smith   PetscFunctionBegin;
21586bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
21596bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
21606bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2161d763cef2SBarry Smith 
21626bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2163277b19d0SLisandro Dalcin 
2164e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2165e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
21666bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
21676d4c513bSLisandro Dalcin 
2168bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2169bc952696SBarry Smith 
217084df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
21716427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
21726427ac75SLisandro Dalcin 
21736bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
21746bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
21756bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
21760dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
21776d4c513bSLisandro Dalcin 
2178a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2179d763cef2SBarry Smith   PetscFunctionReturn(0);
2180d763cef2SBarry Smith }
2181d763cef2SBarry Smith 
21824a2ae208SSatish Balay #undef __FUNCT__
21834a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2184d8e5e3e6SSatish Balay /*@
2185d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2186d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2187d763cef2SBarry Smith 
2188d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2189d763cef2SBarry Smith 
2190d763cef2SBarry Smith    Input Parameter:
2191d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2192d763cef2SBarry Smith 
2193d763cef2SBarry Smith    Output Parameter:
2194d763cef2SBarry Smith .  snes - the nonlinear solver context
2195d763cef2SBarry Smith 
2196d763cef2SBarry Smith    Notes:
2197d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2198d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
219994b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2200d763cef2SBarry Smith 
2201d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
22020298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2203d763cef2SBarry Smith 
2204d763cef2SBarry Smith    Level: beginner
2205d763cef2SBarry Smith 
2206d763cef2SBarry Smith .keywords: timestep, get, SNES
2207d763cef2SBarry Smith @*/
22087087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2209d763cef2SBarry Smith {
2210d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2211d372ba47SLisandro Dalcin 
2212d763cef2SBarry Smith   PetscFunctionBegin;
22130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22144482741eSBarry Smith   PetscValidPointer(snes,2);
2215d372ba47SLisandro Dalcin   if (!ts->snes) {
2216ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
22170298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
22183bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2219d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2220496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
22219e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
22229e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
22239e2a6581SJed Brown     }
2224d372ba47SLisandro Dalcin   }
2225d763cef2SBarry Smith   *snes = ts->snes;
2226d763cef2SBarry Smith   PetscFunctionReturn(0);
2227d763cef2SBarry Smith }
2228d763cef2SBarry Smith 
22294a2ae208SSatish Balay #undef __FUNCT__
2230deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2231deb2cd25SJed Brown /*@
2232deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2233deb2cd25SJed Brown 
2234deb2cd25SJed Brown    Collective
2235deb2cd25SJed Brown 
2236deb2cd25SJed Brown    Input Parameter:
2237deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2238deb2cd25SJed Brown -  snes - the nonlinear solver context
2239deb2cd25SJed Brown 
2240deb2cd25SJed Brown    Notes:
2241deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2242deb2cd25SJed Brown 
2243deb2cd25SJed Brown    Level: developer
2244deb2cd25SJed Brown 
2245deb2cd25SJed Brown .keywords: timestep, set, SNES
2246deb2cd25SJed Brown @*/
2247deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2248deb2cd25SJed Brown {
2249deb2cd25SJed Brown   PetscErrorCode ierr;
2250d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2251deb2cd25SJed Brown 
2252deb2cd25SJed Brown   PetscFunctionBegin;
2253deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2254deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2255deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2256deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2257bbd56ea5SKarl Rupp 
2258deb2cd25SJed Brown   ts->snes = snes;
2259bbd56ea5SKarl Rupp 
22600298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
22610298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2262740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
22630298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2264740132f1SEmil Constantinescu   }
2265deb2cd25SJed Brown   PetscFunctionReturn(0);
2266deb2cd25SJed Brown }
2267deb2cd25SJed Brown 
2268deb2cd25SJed Brown #undef __FUNCT__
226994b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2270d8e5e3e6SSatish Balay /*@
227194b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2272d763cef2SBarry Smith    a TS (timestepper) context.
2273d763cef2SBarry Smith 
227494b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2275d763cef2SBarry Smith 
2276d763cef2SBarry Smith    Input Parameter:
2277d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2278d763cef2SBarry Smith 
2279d763cef2SBarry Smith    Output Parameter:
228094b7f48cSBarry Smith .  ksp - the nonlinear solver context
2281d763cef2SBarry Smith 
2282d763cef2SBarry Smith    Notes:
228394b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2284d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2285d763cef2SBarry Smith    KSP and PC contexts as well.
2286d763cef2SBarry Smith 
228794b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
22880298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2289d763cef2SBarry Smith 
2290d763cef2SBarry Smith    Level: beginner
2291d763cef2SBarry Smith 
229294b7f48cSBarry Smith .keywords: timestep, get, KSP
2293d763cef2SBarry Smith @*/
22947087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2295d763cef2SBarry Smith {
2296d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2297089b2837SJed Brown   SNES           snes;
2298d372ba47SLisandro Dalcin 
2299d763cef2SBarry Smith   PetscFunctionBegin;
23000700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
23014482741eSBarry Smith   PetscValidPointer(ksp,2);
230217186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2303e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2304089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2305089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2306d763cef2SBarry Smith   PetscFunctionReturn(0);
2307d763cef2SBarry Smith }
2308d763cef2SBarry Smith 
2309d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2310d763cef2SBarry Smith 
23114a2ae208SSatish Balay #undef __FUNCT__
2312adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2313adb62b0dSMatthew Knepley /*@
2314adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2315adb62b0dSMatthew Knepley    maximum time for iteration.
2316adb62b0dSMatthew Knepley 
23173f9fe445SBarry Smith    Not Collective
2318adb62b0dSMatthew Knepley 
2319adb62b0dSMatthew Knepley    Input Parameters:
2320adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
23210298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
23220298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2323adb62b0dSMatthew Knepley 
2324adb62b0dSMatthew Knepley    Level: intermediate
2325adb62b0dSMatthew Knepley 
2326adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2327adb62b0dSMatthew Knepley @*/
23287087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2329adb62b0dSMatthew Knepley {
2330adb62b0dSMatthew Knepley   PetscFunctionBegin;
23310700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2332abc0a331SBarry Smith   if (maxsteps) {
23334482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2334adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2335adb62b0dSMatthew Knepley   }
2336abc0a331SBarry Smith   if (maxtime) {
23374482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2338adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2339adb62b0dSMatthew Knepley   }
2340adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2341adb62b0dSMatthew Knepley }
2342adb62b0dSMatthew Knepley 
2343adb62b0dSMatthew Knepley #undef __FUNCT__
23444a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2345d763cef2SBarry Smith /*@
2346d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2347d763cef2SBarry Smith    maximum time for iteration.
2348d763cef2SBarry Smith 
23493f9fe445SBarry Smith    Logically Collective on TS
2350d763cef2SBarry Smith 
2351d763cef2SBarry Smith    Input Parameters:
2352d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2353d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2354d763cef2SBarry Smith -  maxtime - final time to iterate to
2355d763cef2SBarry Smith 
2356d763cef2SBarry Smith    Options Database Keys:
2357d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
23583bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2359d763cef2SBarry Smith 
2360d763cef2SBarry Smith    Notes:
2361d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2362d763cef2SBarry Smith 
2363d763cef2SBarry Smith    Level: intermediate
2364d763cef2SBarry Smith 
2365d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2366a43b19c4SJed Brown 
2367a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2368d763cef2SBarry Smith @*/
23697087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2370d763cef2SBarry Smith {
2371d763cef2SBarry Smith   PetscFunctionBegin;
23720700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2373c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2374c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
237539b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
237639b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2377d763cef2SBarry Smith   PetscFunctionReturn(0);
2378d763cef2SBarry Smith }
2379d763cef2SBarry Smith 
23804a2ae208SSatish Balay #undef __FUNCT__
23814a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2382d763cef2SBarry Smith /*@
2383d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2384d763cef2SBarry Smith    for use by the TS routines.
2385d763cef2SBarry Smith 
23863f9fe445SBarry Smith    Logically Collective on TS and Vec
2387d763cef2SBarry Smith 
2388d763cef2SBarry Smith    Input Parameters:
2389d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
23900910c330SBarry Smith -  u - the solution vector
2391d763cef2SBarry Smith 
2392d763cef2SBarry Smith    Level: beginner
2393d763cef2SBarry Smith 
2394d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2395d763cef2SBarry Smith @*/
23960910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2397d763cef2SBarry Smith {
23988737fe31SLisandro Dalcin   PetscErrorCode ierr;
2399496e6a7aSJed Brown   DM             dm;
24008737fe31SLisandro Dalcin 
2401d763cef2SBarry Smith   PetscFunctionBegin;
24020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24030910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
24040910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
24056bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
24060910c330SBarry Smith   ts->vec_sol = u;
2407bbd56ea5SKarl Rupp 
2408496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
24090910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2410d763cef2SBarry Smith   PetscFunctionReturn(0);
2411d763cef2SBarry Smith }
2412d763cef2SBarry Smith 
2413e74ef692SMatthew Knepley #undef __FUNCT__
241473b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps"
241573b18844SBarry Smith /*@
241673b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
241773b18844SBarry Smith 
241873b18844SBarry Smith    Logically Collective on TS
241973b18844SBarry Smith 
242073b18844SBarry Smith    Input Parameters:
242173b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
242273b18844SBarry Smith .  steps - number of steps to use
242373b18844SBarry Smith 
242473b18844SBarry Smith    Level: intermediate
242573b18844SBarry Smith 
242673b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
242773b18844SBarry Smith           so as to integrate back to less than the original timestep
242873b18844SBarry Smith 
242973b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
243073b18844SBarry Smith 
243173b18844SBarry Smith .seealso: TSSetExactFinalTime()
243273b18844SBarry Smith @*/
243373b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
243473b18844SBarry Smith {
243573b18844SBarry Smith   PetscFunctionBegin;
243673b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
243773b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
243873b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
243973b18844SBarry 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");
244073b18844SBarry Smith   ts->adjoint_max_steps = steps;
244173b18844SBarry Smith   PetscFunctionReturn(0);
244273b18844SBarry Smith }
244373b18844SBarry Smith 
244473b18844SBarry Smith #undef __FUNCT__
2445dfb21088SHong Zhang #define __FUNCT__ "TSSetCostGradients"
2446c235aa8dSHong Zhang /*@
2447dfb21088SHong 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
24480cf82b59SBarry Smith       for use by the TSAdjoint routines.
2449c235aa8dSHong Zhang 
2450c235aa8dSHong Zhang    Logically Collective on TS and Vec
2451c235aa8dSHong Zhang 
2452c235aa8dSHong Zhang    Input Parameters:
2453c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2454abc2977eSBarry 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
2455abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2456c235aa8dSHong Zhang 
2457c235aa8dSHong Zhang    Level: beginner
2458c235aa8dSHong Zhang 
2459abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
24600cf82b59SBarry Smith 
2461c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2462c235aa8dSHong Zhang @*/
2463dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
2464c235aa8dSHong Zhang {
2465c235aa8dSHong Zhang   PetscFunctionBegin;
2466c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2467abc2977eSBarry Smith   PetscValidPointer(lambda,2);
2468abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
2469abc2977eSBarry Smith   ts->vecs_sensip = mu;
2470dfb21088SHong 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");
2471abc2977eSBarry Smith   ts->numcost  = numcost;
2472ad8e2604SHong Zhang   PetscFunctionReturn(0);
2473ad8e2604SHong Zhang }
2474ad8e2604SHong Zhang 
2475ad8e2604SHong Zhang #undef __FUNCT__
24765bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian"
2477ad8e2604SHong Zhang /*@C
24780cf82b59SBarry 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.
2479ad8e2604SHong Zhang 
2480ad8e2604SHong Zhang   Logically Collective on TS
2481ad8e2604SHong Zhang 
2482ad8e2604SHong Zhang   Input Parameters:
2483ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2484ad8e2604SHong Zhang - func - The function
2485ad8e2604SHong Zhang 
2486ad8e2604SHong Zhang   Calling sequence of func:
24870cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
248805755b9cSHong Zhang +   t - current timestep
24890cf82b59SBarry Smith .   y - input vector (current ODE solution)
249005755b9cSHong Zhang .   A - output matrix
249105755b9cSHong Zhang -   ctx - [optional] user-defined function context
2492ad8e2604SHong Zhang 
2493ad8e2604SHong Zhang   Level: intermediate
2494ad8e2604SHong Zhang 
24950cf82b59SBarry 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
24960cf82b59SBarry Smith 
2497ad8e2604SHong Zhang .keywords: TS, sensitivity
2498ad8e2604SHong Zhang .seealso:
2499ad8e2604SHong Zhang @*/
25005bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2501ad8e2604SHong Zhang {
2502ad8e2604SHong Zhang   PetscErrorCode ierr;
2503ad8e2604SHong Zhang 
2504ad8e2604SHong Zhang   PetscFunctionBegin;
2505ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2506ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2507ad8e2604SHong Zhang 
2508ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2509ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2510ad8e2604SHong Zhang   if(Amat) {
2511ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2512ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2513ad8e2604SHong Zhang     ts->Jacp = Amat;
2514ad8e2604SHong Zhang   }
2515ad8e2604SHong Zhang   PetscFunctionReturn(0);
2516ad8e2604SHong Zhang }
2517ad8e2604SHong Zhang 
2518ad8e2604SHong Zhang #undef __FUNCT__
25195bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian"
25200cf82b59SBarry Smith /*@C
25215bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2522ad8e2604SHong Zhang 
2523ad8e2604SHong Zhang   Collective on TS
2524ad8e2604SHong Zhang 
2525ad8e2604SHong Zhang   Input Parameters:
2526ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2527ad8e2604SHong Zhang 
2528ad8e2604SHong Zhang   Level: developer
2529ad8e2604SHong Zhang 
2530ad8e2604SHong Zhang .keywords: TS, sensitivity
25315bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
2532ad8e2604SHong Zhang @*/
25335bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2534ad8e2604SHong Zhang {
2535ad8e2604SHong Zhang   PetscErrorCode ierr;
2536ad8e2604SHong Zhang 
2537ad8e2604SHong Zhang   PetscFunctionBegin;
2538ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2539ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2540ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2541ad8e2604SHong Zhang 
2542ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2543ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2544ad8e2604SHong Zhang   PetscStackPop;
2545c235aa8dSHong Zhang   PetscFunctionReturn(0);
2546c235aa8dSHong Zhang }
2547c235aa8dSHong Zhang 
2548c235aa8dSHong Zhang #undef __FUNCT__
2549dfb21088SHong Zhang #define __FUNCT__ "TSSetCostIntegrand"
25506fd0887fSHong Zhang /*@C
2551dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
25526fd0887fSHong Zhang 
25536fd0887fSHong Zhang     Logically Collective on TS
25546fd0887fSHong Zhang 
25556fd0887fSHong Zhang     Input Parameters:
25566fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
2557abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
25580cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
2559b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2560b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
2561b1cb36f3SHong Zhang .   fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run
2562b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
25636fd0887fSHong Zhang 
25640cf82b59SBarry Smith     Calling sequence of rf:
25650cf82b59SBarry Smith $     rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
25666fd0887fSHong Zhang 
25676fd0887fSHong Zhang +   t - current timestep
25680cf82b59SBarry Smith .   y - input vector
25690cf82b59SBarry Smith .   f - function result; one vector entry for each cost function
25706fd0887fSHong Zhang -   ctx - [optional] user-defined function context
25716fd0887fSHong Zhang 
2572b612ec54SBarry Smith    Calling sequence of drdyf:
25730cf82b59SBarry Smith $    PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
2574b612ec54SBarry Smith 
2575b612ec54SBarry Smith    Calling sequence of drdpf:
25760cf82b59SBarry Smith $    PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
2577b612ec54SBarry Smith 
2578b612ec54SBarry Smith     Level: intermediate
25796fd0887fSHong Zhang 
2580abc2977eSBarry Smith     Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions
25810cf82b59SBarry Smith 
25826fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
25836fd0887fSHong Zhang 
2584dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
25856fd0887fSHong Zhang @*/
2586dfb21088SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
2587d8151eeaSBarry Smith                                                           PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
2588b1cb36f3SHong Zhang                                                           PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),
2589b1cb36f3SHong Zhang                                                           PetscBool fwd,void *ctx)
25906fd0887fSHong Zhang {
25916fd0887fSHong Zhang   PetscErrorCode ierr;
25926fd0887fSHong Zhang 
25936fd0887fSHong Zhang   PetscFunctionBegin;
25946fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2595dfb21088SHong 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()");
2596c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
25976fd0887fSHong Zhang 
2598b1cb36f3SHong Zhang   ts->costintegralfwd  = fwd; /* Evaluate the cost integral in forward run if fwd is true */
2599abc2977eSBarry Smith   ierr                 = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
26002c39e106SBarry Smith   ierr                 = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
26010cf82b59SBarry Smith   ts->costintegrand    = rf;
260205755b9cSHong Zhang   ts->costintegrandctx = ctx;
2603b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
2604b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
26056fd0887fSHong Zhang   PetscFunctionReturn(0);
26066fd0887fSHong Zhang }
26076fd0887fSHong Zhang 
26086fd0887fSHong Zhang #undef __FUNCT__
2609dfb21088SHong Zhang #define __FUNCT__ "TSGetCostIntegral"
261036eaed60SHong Zhang /*@
2611dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
261236eaed60SHong Zhang    It is valid to call the routine after a backward run.
261336eaed60SHong Zhang 
261436eaed60SHong Zhang    Not Collective
261536eaed60SHong Zhang 
261636eaed60SHong Zhang    Input Parameter:
261736eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
261836eaed60SHong Zhang 
261936eaed60SHong Zhang    Output Parameter:
26202c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
262136eaed60SHong Zhang 
262236eaed60SHong Zhang    Level: intermediate
262336eaed60SHong Zhang 
2624dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
262536eaed60SHong Zhang 
262636eaed60SHong Zhang .keywords: TS, sensitivity analysis
262736eaed60SHong Zhang @*/
2628dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
262936eaed60SHong Zhang {
263036eaed60SHong Zhang   PetscFunctionBegin;
263136eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
263236eaed60SHong Zhang   PetscValidPointer(v,2);
26332c39e106SBarry Smith   *v = ts->vec_costintegral;
263436eaed60SHong Zhang   PetscFunctionReturn(0);
263536eaed60SHong Zhang }
263636eaed60SHong Zhang 
263736eaed60SHong Zhang #undef __FUNCT__
2638d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand"
26396fd0887fSHong Zhang /*@
26402c39e106SBarry Smith    TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
26416fd0887fSHong Zhang 
26426fd0887fSHong Zhang    Input Parameters:
26436fd0887fSHong Zhang +  ts - the TS context
26446fd0887fSHong Zhang .  t - current time
26450cf82b59SBarry Smith -  y - state vector, i.e. current solution
26466fd0887fSHong Zhang 
26476fd0887fSHong Zhang    Output Parameter:
2648abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
26496fd0887fSHong Zhang 
26506fd0887fSHong Zhang    Note:
26516fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
26526fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
26536fd0887fSHong Zhang 
26546fd0887fSHong Zhang    Level: developer
26556fd0887fSHong Zhang 
26566fd0887fSHong Zhang .keywords: TS, compute
26576fd0887fSHong Zhang 
2658dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
26596fd0887fSHong Zhang @*/
26600cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
26616fd0887fSHong Zhang {
26626fd0887fSHong Zhang   PetscErrorCode ierr;
26636fd0887fSHong Zhang 
26646fd0887fSHong Zhang   PetscFunctionBegin;
26656fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
26660cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
26676fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
26686fd0887fSHong Zhang 
26690cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
2670e4680132SHong Zhang   if (ts->costintegrand) {
2671e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
26720cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
26736fd0887fSHong Zhang     PetscStackPop;
26746fd0887fSHong Zhang   } else {
26756fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
26766fd0887fSHong Zhang   }
26776fd0887fSHong Zhang 
26780cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
26796fd0887fSHong Zhang   PetscFunctionReturn(0);
26806fd0887fSHong Zhang }
26816fd0887fSHong Zhang 
26826fd0887fSHong Zhang #undef __FUNCT__
2683d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction"
268405755b9cSHong Zhang /*@
2685d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
268605755b9cSHong Zhang 
268705755b9cSHong Zhang   Collective on TS
268805755b9cSHong Zhang 
268905755b9cSHong Zhang   Input Parameters:
269005755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
269105755b9cSHong Zhang 
269205755b9cSHong Zhang   Notes:
2693d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
269405755b9cSHong Zhang   so most users would not generally call this routine themselves.
269505755b9cSHong Zhang 
269605755b9cSHong Zhang   Level: developer
269705755b9cSHong Zhang 
269805755b9cSHong Zhang .keywords: TS, sensitivity
2699d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
270005755b9cSHong Zhang @*/
27010cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
270205755b9cSHong Zhang {
270305755b9cSHong Zhang   PetscErrorCode ierr;
270405755b9cSHong Zhang 
270505755b9cSHong Zhang   PetscFunctionBegin;
270605755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27070cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
270805755b9cSHong Zhang 
270905755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
27100cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
271105755b9cSHong Zhang   PetscStackPop;
271205755b9cSHong Zhang   PetscFunctionReturn(0);
271305755b9cSHong Zhang }
271405755b9cSHong Zhang 
271505755b9cSHong Zhang #undef __FUNCT__
2716d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction"
271705755b9cSHong Zhang /*@
2718d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
271905755b9cSHong Zhang 
272005755b9cSHong Zhang   Collective on TS
272105755b9cSHong Zhang 
272205755b9cSHong Zhang   Input Parameters:
272305755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
272405755b9cSHong Zhang 
272505755b9cSHong Zhang   Notes:
272605755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
272705755b9cSHong Zhang   so most users would not generally call this routine themselves.
272805755b9cSHong Zhang 
272905755b9cSHong Zhang   Level: developer
273005755b9cSHong Zhang 
273105755b9cSHong Zhang .keywords: TS, sensitivity
2732d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
273305755b9cSHong Zhang @*/
27340cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
273505755b9cSHong Zhang {
273605755b9cSHong Zhang   PetscErrorCode ierr;
273705755b9cSHong Zhang 
273805755b9cSHong Zhang   PetscFunctionBegin;
273905755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27400cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
274105755b9cSHong Zhang 
274205755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
27430cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
274405755b9cSHong Zhang   PetscStackPop;
274505755b9cSHong Zhang   PetscFunctionReturn(0);
274605755b9cSHong Zhang }
274705755b9cSHong Zhang 
274805755b9cSHong Zhang #undef __FUNCT__
2749e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2750ac226902SBarry Smith /*@C
2751000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
27523f2090d5SJed Brown   called once at the beginning of each time step.
2753000e7ae3SMatthew Knepley 
27543f9fe445SBarry Smith   Logically Collective on TS
2755000e7ae3SMatthew Knepley 
2756000e7ae3SMatthew Knepley   Input Parameters:
2757000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2758000e7ae3SMatthew Knepley - func - The function
2759000e7ae3SMatthew Knepley 
2760000e7ae3SMatthew Knepley   Calling sequence of func:
2761000e7ae3SMatthew Knepley . func (TS ts);
2762000e7ae3SMatthew Knepley 
2763000e7ae3SMatthew Knepley   Level: intermediate
2764000e7ae3SMatthew Knepley 
2765b8123daeSJed Brown   Note:
2766b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2767b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2768b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2769b8123daeSJed Brown 
2770000e7ae3SMatthew Knepley .keywords: TS, timestep
27719be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2772000e7ae3SMatthew Knepley @*/
27737087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2774000e7ae3SMatthew Knepley {
2775000e7ae3SMatthew Knepley   PetscFunctionBegin;
27760700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2777ae60f76fSBarry Smith   ts->prestep = func;
2778000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2779000e7ae3SMatthew Knepley }
2780000e7ae3SMatthew Knepley 
2781e74ef692SMatthew Knepley #undef __FUNCT__
27823f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
278309ee8438SJed Brown /*@
27843f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
27853f2090d5SJed Brown 
27863f2090d5SJed Brown   Collective on TS
27873f2090d5SJed Brown 
27883f2090d5SJed Brown   Input Parameters:
27893f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
27903f2090d5SJed Brown 
27913f2090d5SJed Brown   Notes:
27923f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
27933f2090d5SJed Brown   so most users would not generally call this routine themselves.
27943f2090d5SJed Brown 
27953f2090d5SJed Brown   Level: developer
27963f2090d5SJed Brown 
27973f2090d5SJed Brown .keywords: TS, timestep
27989be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
27993f2090d5SJed Brown @*/
28007087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
28013f2090d5SJed Brown {
28023f2090d5SJed Brown   PetscErrorCode ierr;
28033f2090d5SJed Brown 
28043f2090d5SJed Brown   PetscFunctionBegin;
28050700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2806ae60f76fSBarry Smith   if (ts->prestep) {
2807ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2808312ce896SJed Brown   }
28093f2090d5SJed Brown   PetscFunctionReturn(0);
28103f2090d5SJed Brown }
28113f2090d5SJed Brown 
28123f2090d5SJed Brown #undef __FUNCT__
2813b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2814b8123daeSJed Brown /*@C
2815b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2816b8123daeSJed Brown   called once at the beginning of each stage.
2817b8123daeSJed Brown 
2818b8123daeSJed Brown   Logically Collective on TS
2819b8123daeSJed Brown 
2820b8123daeSJed Brown   Input Parameters:
2821b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2822b8123daeSJed Brown - func - The function
2823b8123daeSJed Brown 
2824b8123daeSJed Brown   Calling sequence of func:
2825b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2826b8123daeSJed Brown 
2827b8123daeSJed Brown   Level: intermediate
2828b8123daeSJed Brown 
2829b8123daeSJed Brown   Note:
2830b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2831b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2832b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2833b8123daeSJed Brown 
2834b8123daeSJed Brown .keywords: TS, timestep
28359be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2836b8123daeSJed Brown @*/
2837b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2838b8123daeSJed Brown {
2839b8123daeSJed Brown   PetscFunctionBegin;
2840b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2841ae60f76fSBarry Smith   ts->prestage = func;
2842b8123daeSJed Brown   PetscFunctionReturn(0);
2843b8123daeSJed Brown }
2844b8123daeSJed Brown 
2845b8123daeSJed Brown #undef __FUNCT__
28469be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
28479be3e283SDebojyoti Ghosh /*@C
28489be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
28499be3e283SDebojyoti Ghosh   called once at the end of each stage.
28509be3e283SDebojyoti Ghosh 
28519be3e283SDebojyoti Ghosh   Logically Collective on TS
28529be3e283SDebojyoti Ghosh 
28539be3e283SDebojyoti Ghosh   Input Parameters:
28549be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
28559be3e283SDebojyoti Ghosh - func - The function
28569be3e283SDebojyoti Ghosh 
28579be3e283SDebojyoti Ghosh   Calling sequence of func:
28589be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
28599be3e283SDebojyoti Ghosh 
28609be3e283SDebojyoti Ghosh   Level: intermediate
28619be3e283SDebojyoti Ghosh 
28629be3e283SDebojyoti Ghosh   Note:
28639be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
28649be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
28659be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
28669be3e283SDebojyoti Ghosh 
28679be3e283SDebojyoti Ghosh .keywords: TS, timestep
28689be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
28699be3e283SDebojyoti Ghosh @*/
28709be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
28719be3e283SDebojyoti Ghosh {
28729be3e283SDebojyoti Ghosh   PetscFunctionBegin;
28739be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
28749be3e283SDebojyoti Ghosh   ts->poststage = func;
28759be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
28769be3e283SDebojyoti Ghosh }
28779be3e283SDebojyoti Ghosh 
28789be3e283SDebojyoti Ghosh #undef __FUNCT__
2879b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2880b8123daeSJed Brown /*@
2881b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2882b8123daeSJed Brown 
2883b8123daeSJed Brown   Collective on TS
2884b8123daeSJed Brown 
2885b8123daeSJed Brown   Input Parameters:
2886b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
28879be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2888b8123daeSJed Brown 
2889b8123daeSJed Brown   Notes:
2890b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2891b8123daeSJed Brown   most users would not generally call this routine themselves.
2892b8123daeSJed Brown 
2893b8123daeSJed Brown   Level: developer
2894b8123daeSJed Brown 
2895b8123daeSJed Brown .keywords: TS, timestep
28969be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2897b8123daeSJed Brown @*/
2898b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2899b8123daeSJed Brown {
2900b8123daeSJed Brown   PetscErrorCode ierr;
2901b8123daeSJed Brown 
2902b8123daeSJed Brown   PetscFunctionBegin;
2903b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2904ae60f76fSBarry Smith   if (ts->prestage) {
2905ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2906b8123daeSJed Brown   }
2907b8123daeSJed Brown   PetscFunctionReturn(0);
2908b8123daeSJed Brown }
2909b8123daeSJed Brown 
2910b8123daeSJed Brown #undef __FUNCT__
29119be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
29129be3e283SDebojyoti Ghosh /*@
29139be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
29149be3e283SDebojyoti Ghosh 
29159be3e283SDebojyoti Ghosh   Collective on TS
29169be3e283SDebojyoti Ghosh 
29179be3e283SDebojyoti Ghosh   Input Parameters:
29189be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
29199be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
29209be3e283SDebojyoti Ghosh   stageindex  - Stage number
29219be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
29229be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
29239be3e283SDebojyoti Ghosh 
29249be3e283SDebojyoti Ghosh   Notes:
29259be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
29269be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
29279be3e283SDebojyoti Ghosh 
29289be3e283SDebojyoti Ghosh   Level: developer
29299be3e283SDebojyoti Ghosh 
29309be3e283SDebojyoti Ghosh .keywords: TS, timestep
29319be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
29329be3e283SDebojyoti Ghosh @*/
29339be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
29349be3e283SDebojyoti Ghosh {
29359be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
29369be3e283SDebojyoti Ghosh 
29379be3e283SDebojyoti Ghosh   PetscFunctionBegin;
29389be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29394beae5d8SLisandro Dalcin   if (ts->poststage) {
29409be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
29419be3e283SDebojyoti Ghosh   }
29429be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
29439be3e283SDebojyoti Ghosh }
29449be3e283SDebojyoti Ghosh 
29459be3e283SDebojyoti Ghosh #undef __FUNCT__
2946e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2947ac226902SBarry Smith /*@C
2948000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
29493f2090d5SJed Brown   called once at the end of each time step.
2950000e7ae3SMatthew Knepley 
29513f9fe445SBarry Smith   Logically Collective on TS
2952000e7ae3SMatthew Knepley 
2953000e7ae3SMatthew Knepley   Input Parameters:
2954000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2955000e7ae3SMatthew Knepley - func - The function
2956000e7ae3SMatthew Knepley 
2957000e7ae3SMatthew Knepley   Calling sequence of func:
2958b8123daeSJed Brown $ func (TS ts);
2959000e7ae3SMatthew Knepley 
2960000e7ae3SMatthew Knepley   Level: intermediate
2961000e7ae3SMatthew Knepley 
2962000e7ae3SMatthew Knepley .keywords: TS, timestep
2963b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2964000e7ae3SMatthew Knepley @*/
29657087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2966000e7ae3SMatthew Knepley {
2967000e7ae3SMatthew Knepley   PetscFunctionBegin;
29680700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2969ae60f76fSBarry Smith   ts->poststep = func;
2970000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2971000e7ae3SMatthew Knepley }
2972000e7ae3SMatthew Knepley 
2973e74ef692SMatthew Knepley #undef __FUNCT__
29743f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
297509ee8438SJed Brown /*@
29763f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
29773f2090d5SJed Brown 
29783f2090d5SJed Brown   Collective on TS
29793f2090d5SJed Brown 
29803f2090d5SJed Brown   Input Parameters:
29813f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
29823f2090d5SJed Brown 
29833f2090d5SJed Brown   Notes:
29843f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
29853f2090d5SJed Brown   so most users would not generally call this routine themselves.
29863f2090d5SJed Brown 
29873f2090d5SJed Brown   Level: developer
29883f2090d5SJed Brown 
29893f2090d5SJed Brown .keywords: TS, timestep
29903f2090d5SJed Brown @*/
29917087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
29923f2090d5SJed Brown {
29933f2090d5SJed Brown   PetscErrorCode ierr;
29943f2090d5SJed Brown 
29953f2090d5SJed Brown   PetscFunctionBegin;
29960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2997ae60f76fSBarry Smith   if (ts->poststep) {
2998ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
299972ac3e02SJed Brown   }
30003f2090d5SJed Brown   PetscFunctionReturn(0);
30013f2090d5SJed Brown }
30023f2090d5SJed Brown 
3003d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3004d763cef2SBarry Smith 
30054a2ae208SSatish Balay #undef __FUNCT__
3006a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
3007d763cef2SBarry Smith /*@C
3008a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3009d763cef2SBarry Smith    timestep to display the iteration's  progress.
3010d763cef2SBarry Smith 
30113f9fe445SBarry Smith    Logically Collective on TS
3012d763cef2SBarry Smith 
3013d763cef2SBarry Smith    Input Parameters:
3014d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3015e213d8f1SJed Brown .  monitor - monitoring routine
3016329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
30170298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3018b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
30190298fd71SBarry Smith           (may be NULL)
3020d763cef2SBarry Smith 
3021e213d8f1SJed Brown    Calling sequence of monitor:
30220910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3023d763cef2SBarry Smith 
3024d763cef2SBarry Smith +    ts - the TS context
302563e21af5SBarry 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)
30261f06c33eSBarry Smith .    time - current time
30270910c330SBarry Smith .    u - current iterate
3028d763cef2SBarry Smith -    mctx - [optional] monitoring context
3029d763cef2SBarry Smith 
3030d763cef2SBarry Smith    Notes:
3031d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3032d763cef2SBarry Smith    already has been loaded.
3033d763cef2SBarry Smith 
3034025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
3035025f1a04SBarry Smith 
3036d763cef2SBarry Smith    Level: intermediate
3037d763cef2SBarry Smith 
3038d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3039d763cef2SBarry Smith 
3040a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3041d763cef2SBarry Smith @*/
3042c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3043d763cef2SBarry Smith {
3044d763cef2SBarry Smith   PetscFunctionBegin;
30450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
304617186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3047d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
30488704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3049d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3050d763cef2SBarry Smith   PetscFunctionReturn(0);
3051d763cef2SBarry Smith }
3052d763cef2SBarry Smith 
30534a2ae208SSatish Balay #undef __FUNCT__
3054a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
3055d763cef2SBarry Smith /*@C
3056a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3057d763cef2SBarry Smith 
30583f9fe445SBarry Smith    Logically Collective on TS
3059d763cef2SBarry Smith 
3060d763cef2SBarry Smith    Input Parameters:
3061d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3062d763cef2SBarry Smith 
3063d763cef2SBarry Smith    Notes:
3064d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3065d763cef2SBarry Smith 
3066d763cef2SBarry Smith    Level: intermediate
3067d763cef2SBarry Smith 
3068d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3069d763cef2SBarry Smith 
3070a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3071d763cef2SBarry Smith @*/
30727087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3073d763cef2SBarry Smith {
3074d952e501SBarry Smith   PetscErrorCode ierr;
3075d952e501SBarry Smith   PetscInt       i;
3076d952e501SBarry Smith 
3077d763cef2SBarry Smith   PetscFunctionBegin;
30780700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3079d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
30808704b422SBarry Smith     if (ts->monitordestroy[i]) {
30818704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3082d952e501SBarry Smith     }
3083d952e501SBarry Smith   }
3084d763cef2SBarry Smith   ts->numbermonitors = 0;
3085d763cef2SBarry Smith   PetscFunctionReturn(0);
3086d763cef2SBarry Smith }
3087d763cef2SBarry Smith 
30884a2ae208SSatish Balay #undef __FUNCT__
3089a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
3090721cd6eeSBarry Smith /*@C
3091721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
30925516499fSSatish Balay 
30935516499fSSatish Balay    Level: intermediate
309441251cbbSSatish Balay 
30955516499fSSatish Balay .keywords: TS, set, monitor
30965516499fSSatish Balay 
309763e21af5SBarry Smith .seealso:  TSMonitorSet()
309841251cbbSSatish Balay @*/
3099721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3100d763cef2SBarry Smith {
3101dfbe8321SBarry Smith   PetscErrorCode ierr;
3102721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
310341aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3104d132466eSBarry Smith 
3105d763cef2SBarry Smith   PetscFunctionBegin;
31064d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
310741aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
310841aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3109721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
311041aca3d6SBarry Smith   if (iascii) {
3111649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
311263e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
311363e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
311463e21af5SBarry Smith     } else {
31158392e04aSShri Abhyankar       ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr);
311663e21af5SBarry Smith     }
3117649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
311841aca3d6SBarry Smith   } else if (ibinary) {
311941aca3d6SBarry Smith     PetscMPIInt rank;
312041aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
312141aca3d6SBarry Smith     if (!rank) {
312241aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
312341aca3d6SBarry Smith     } else {
312441aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
312541aca3d6SBarry Smith     }
312641aca3d6SBarry Smith   }
3127721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3128d763cef2SBarry Smith   PetscFunctionReturn(0);
3129d763cef2SBarry Smith }
3130d763cef2SBarry Smith 
31314a2ae208SSatish Balay #undef __FUNCT__
31329110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorSet"
31339110b2e7SHong Zhang /*@C
31349110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
31359110b2e7SHong Zhang    timestep to display the iteration's  progress.
31369110b2e7SHong Zhang 
31379110b2e7SHong Zhang    Logically Collective on TS
31389110b2e7SHong Zhang 
31399110b2e7SHong Zhang    Input Parameters:
31409110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
31419110b2e7SHong Zhang .  adjointmonitor - monitoring routine
31429110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
31439110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
31449110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
31459110b2e7SHong Zhang           (may be NULL)
31469110b2e7SHong Zhang 
31479110b2e7SHong Zhang    Calling sequence of monitor:
31489110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
31499110b2e7SHong Zhang 
31509110b2e7SHong Zhang +    ts - the TS context
31519110b2e7SHong 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
31529110b2e7SHong Zhang                                been interpolated to)
31539110b2e7SHong Zhang .    time - current time
31549110b2e7SHong Zhang .    u - current iterate
31559110b2e7SHong Zhang .    numcost - number of cost functionos
31569110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
31579110b2e7SHong Zhang .    mu - sensitivities to parameters
31589110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
31599110b2e7SHong Zhang 
31609110b2e7SHong Zhang    Notes:
31619110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
31629110b2e7SHong Zhang    already has been loaded.
31639110b2e7SHong Zhang 
31649110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
31659110b2e7SHong Zhang 
31669110b2e7SHong Zhang    Level: intermediate
31679110b2e7SHong Zhang 
31689110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
31699110b2e7SHong Zhang 
31709110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
31719110b2e7SHong Zhang @*/
31729110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
31739110b2e7SHong Zhang {
31749110b2e7SHong Zhang   PetscFunctionBegin;
31759110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31769110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
31779110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
31789110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
31799110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
31809110b2e7SHong Zhang   PetscFunctionReturn(0);
31819110b2e7SHong Zhang }
31829110b2e7SHong Zhang 
31839110b2e7SHong Zhang #undef __FUNCT__
31849110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorCancel"
31859110b2e7SHong Zhang /*@C
31869110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
31879110b2e7SHong Zhang 
31889110b2e7SHong Zhang    Logically Collective on TS
31899110b2e7SHong Zhang 
31909110b2e7SHong Zhang    Input Parameters:
31919110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
31929110b2e7SHong Zhang 
31939110b2e7SHong Zhang    Notes:
31949110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
31959110b2e7SHong Zhang 
31969110b2e7SHong Zhang    Level: intermediate
31979110b2e7SHong Zhang 
31989110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
31999110b2e7SHong Zhang 
32009110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
32019110b2e7SHong Zhang @*/
32029110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
32039110b2e7SHong Zhang {
32049110b2e7SHong Zhang   PetscErrorCode ierr;
32059110b2e7SHong Zhang   PetscInt       i;
32069110b2e7SHong Zhang 
32079110b2e7SHong Zhang   PetscFunctionBegin;
32089110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
32099110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
32109110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
32119110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
32129110b2e7SHong Zhang     }
32139110b2e7SHong Zhang   }
32149110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
32159110b2e7SHong Zhang   PetscFunctionReturn(0);
32169110b2e7SHong Zhang }
32179110b2e7SHong Zhang 
32189110b2e7SHong Zhang #undef __FUNCT__
3219110eb670SHong Zhang #define __FUNCT__ "TSAdjointMonitorDefault"
3220721cd6eeSBarry Smith /*@C
3221721cd6eeSBarry Smith    TSAdjointMonitorDefault - the default monitor of adjoint computations
3222110eb670SHong Zhang 
3223110eb670SHong Zhang    Level: intermediate
3224110eb670SHong Zhang 
3225110eb670SHong Zhang .keywords: TS, set, monitor
3226110eb670SHong Zhang 
3227110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
3228110eb670SHong Zhang @*/
3229721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
3230110eb670SHong Zhang {
3231110eb670SHong Zhang   PetscErrorCode ierr;
3232721cd6eeSBarry Smith   PetscViewer    viewer = vf->viewer;
3233110eb670SHong Zhang 
3234110eb670SHong Zhang   PetscFunctionBegin;
3235110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3236721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
3237110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3238110eb670SHong 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);
3239110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3240721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3241110eb670SHong Zhang   PetscFunctionReturn(0);
3242110eb670SHong Zhang }
3243110eb670SHong Zhang 
3244110eb670SHong Zhang #undef __FUNCT__
3245cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
3246cd652676SJed Brown /*@
3247cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3248cd652676SJed Brown 
3249cd652676SJed Brown    Collective on TS
3250cd652676SJed Brown 
3251cd652676SJed Brown    Input Argument:
3252cd652676SJed Brown +  ts - time stepping context
3253cd652676SJed Brown -  t - time to interpolate to
3254cd652676SJed Brown 
3255cd652676SJed Brown    Output Argument:
32560910c330SBarry Smith .  U - state at given time
3257cd652676SJed Brown 
3258cd652676SJed Brown    Level: intermediate
3259cd652676SJed Brown 
3260cd652676SJed Brown    Developer Notes:
3261cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3262cd652676SJed Brown 
3263cd652676SJed Brown .keywords: TS, set
3264cd652676SJed Brown 
3265874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
3266cd652676SJed Brown @*/
32670910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3268cd652676SJed Brown {
3269cd652676SJed Brown   PetscErrorCode ierr;
3270cd652676SJed Brown 
3271cd652676SJed Brown   PetscFunctionBegin;
3272cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3273b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3274*be5899b3SLisandro 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);
3275ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
32760910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3277cd652676SJed Brown   PetscFunctionReturn(0);
3278cd652676SJed Brown }
3279cd652676SJed Brown 
3280cd652676SJed Brown #undef __FUNCT__
32814a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3282d763cef2SBarry Smith /*@
32836d9e5789SSean Farley    TSStep - Steps one time step
3284d763cef2SBarry Smith 
3285d763cef2SBarry Smith    Collective on TS
3286d763cef2SBarry Smith 
3287d763cef2SBarry Smith    Input Parameter:
3288d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3289d763cef2SBarry Smith 
329027829d71SBarry Smith    Level: developer
3291d763cef2SBarry Smith 
3292b8123daeSJed Brown    Notes:
329327829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
329427829d71SBarry Smith 
3295b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3296b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3297b8123daeSJed Brown 
329825cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
329925cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
330025cb2221SBarry Smith 
3301d763cef2SBarry Smith .keywords: TS, timestep, solve
3302d763cef2SBarry Smith 
33039be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3304d763cef2SBarry Smith @*/
3305193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3306d763cef2SBarry Smith {
3307dfbe8321SBarry Smith   PetscErrorCode   ierr;
3308fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3309*be5899b3SLisandro Dalcin   PetscReal        ptime;
3310d763cef2SBarry Smith 
3311d763cef2SBarry Smith   PetscFunctionBegin;
33120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3313fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3314fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3315fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3316fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3317fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3318fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3319302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
3320fffbeea8SBarry Smith 
3321d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
332268bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3323d405a339SMatthew Knepley 
3324a6772fa2SLisandro 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()");
3325*be5899b3SLisandro 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");
3326a6772fa2SLisandro Dalcin 
3327*be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
3328362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3329*be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
3330e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3331d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3332193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3333d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3334*be5899b3SLisandro Dalcin   ts->ptime_prev = ptime;
3335*be5899b3SLisandro Dalcin   ts->steps++; ts->total_steps++;
3336*be5899b3SLisandro Dalcin   ts->steprollback = PETSC_FALSE;
3337362cd11cSLisandro Dalcin 
3338362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3339cef5090cSJed Brown     if (ts->errorifstepfailed) {
334008c7845fSBarry 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]);
334108c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3342d2daff3dSHong Zhang     }
334308c7845fSBarry Smith   } else if (!ts->reason) {
334408c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
334508c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
334608c7845fSBarry Smith   }
334708c7845fSBarry Smith   PetscFunctionReturn(0);
334808c7845fSBarry Smith }
334908c7845fSBarry Smith 
335008c7845fSBarry Smith #undef __FUNCT__
335108c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep"
335208c7845fSBarry Smith /*@
3353b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
335408c7845fSBarry Smith 
335508c7845fSBarry Smith    Collective on TS
335608c7845fSBarry Smith 
335708c7845fSBarry Smith    Input Parameter:
335808c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
335908c7845fSBarry Smith 
33606a4d4014SLisandro Dalcin    Level: intermediate
33616a4d4014SLisandro Dalcin 
3362b957a604SHong Zhang .keywords: TS, adjoint, step
33636a4d4014SLisandro Dalcin 
3364b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
33656a4d4014SLisandro Dalcin @*/
336608c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
33676a4d4014SLisandro Dalcin {
336808c7845fSBarry Smith   DM               dm;
33696a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
33706a4d4014SLisandro Dalcin 
33716a4d4014SLisandro Dalcin   PetscFunctionBegin;
33724a2ae208SSatish Balay   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
337308c7845fSBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
337408c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3375d763cef2SBarry Smith 
3376685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr);
3377d763cef2SBarry Smith 
3378*be5899b3SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3379*be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime;
338042f2b339SBarry 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);
3381*be5899b3SLisandro Dalcin   ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
338242f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
33838d0ad7a8SHong Zhang   ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
3384*be5899b3SLisandro Dalcin   ts->steps++; ts->total_steps--;
3385362cd11cSLisandro Dalcin 
3386362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3387cef5090cSJed Brown     if (ts->errorifstepfailed) {
33886c4ed002SBarry 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]);
33896c4ed002SBarry 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]);
33906c4ed002SBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3391cef5090cSJed Brown     }
3392362cd11cSLisandro Dalcin   } else if (!ts->reason) {
339373b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
3394362cd11cSLisandro Dalcin   }
3395d763cef2SBarry Smith   PetscFunctionReturn(0);
3396d763cef2SBarry Smith }
3397d763cef2SBarry Smith 
3398d763cef2SBarry Smith #undef __FUNCT__
33997cbde773SLisandro Dalcin #define __FUNCT__ "TSEvaluateWLTE"
34007cbde773SLisandro Dalcin /*@
34017cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
34027cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
34037cbde773SLisandro Dalcin 
34047cbde773SLisandro Dalcin    Collective on TS
34057cbde773SLisandro Dalcin 
34067cbde773SLisandro Dalcin    Input Arguments:
34077cbde773SLisandro Dalcin +  ts - time stepping context
34087cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
34097cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
34107cbde773SLisandro Dalcin 
34117cbde773SLisandro Dalcin    Output Arguments:
34127cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
34137cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
34147cbde773SLisandro Dalcin 
34157cbde773SLisandro Dalcin    Level: advanced
34167cbde773SLisandro Dalcin 
34177cbde773SLisandro Dalcin    Notes:
34187cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
34197cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
34207cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
34217cbde773SLisandro Dalcin 
34227cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
34237cbde773SLisandro Dalcin @*/
34247cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
34257cbde773SLisandro Dalcin {
34267cbde773SLisandro Dalcin   PetscErrorCode ierr;
34277cbde773SLisandro Dalcin 
34287cbde773SLisandro Dalcin   PetscFunctionBegin;
34297cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34307cbde773SLisandro Dalcin   PetscValidType(ts,1);
34317cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
34327cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
34337cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
34347cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
34357cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
34367cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
34377cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
34387cbde773SLisandro Dalcin   PetscFunctionReturn(0);
34397cbde773SLisandro Dalcin }
34407cbde773SLisandro Dalcin 
34417cbde773SLisandro Dalcin #undef __FUNCT__
344205175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
344305175c85SJed Brown /*@
344405175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
344505175c85SJed Brown 
34461c3436cfSJed Brown    Collective on TS
344705175c85SJed Brown 
344805175c85SJed Brown    Input Arguments:
34491c3436cfSJed Brown +  ts - time stepping context
34501c3436cfSJed Brown .  order - desired order of accuracy
34510298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
345205175c85SJed Brown 
345305175c85SJed Brown    Output Arguments:
34540910c330SBarry Smith .  U - state at the end of the current step
345505175c85SJed Brown 
345605175c85SJed Brown    Level: advanced
345705175c85SJed Brown 
3458108c343cSJed Brown    Notes:
3459108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3460108c343cSJed 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.
3461108c343cSJed Brown 
34621c3436cfSJed Brown .seealso: TSStep(), TSAdapt
346305175c85SJed Brown @*/
34640910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
346505175c85SJed Brown {
346605175c85SJed Brown   PetscErrorCode ierr;
346705175c85SJed Brown 
346805175c85SJed Brown   PetscFunctionBegin;
346905175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
347005175c85SJed Brown   PetscValidType(ts,1);
34710910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3472ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
34730910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
347405175c85SJed Brown   PetscFunctionReturn(0);
347505175c85SJed Brown }
347605175c85SJed Brown 
3477b1cb36f3SHong Zhang #undef __FUNCT__
3478b1cb36f3SHong Zhang #define __FUNCT__ "TSForwardCostIntegral"
3479b1cb36f3SHong Zhang /*@
3480b1cb36f3SHong Zhang  TSForwardCostIntegral - Evaluate the cost integral in the forward run.
3481b1cb36f3SHong Zhang 
3482b1cb36f3SHong Zhang  Collective on TS
3483b1cb36f3SHong Zhang 
3484b1cb36f3SHong Zhang  Input Arguments:
3485b1cb36f3SHong Zhang  .  ts - time stepping context
3486b1cb36f3SHong Zhang 
3487b1cb36f3SHong Zhang  Level: advanced
3488b1cb36f3SHong Zhang 
3489b1cb36f3SHong Zhang  Notes:
3490b1cb36f3SHong Zhang  This function cannot be called until TSStep() has been completed.
3491b1cb36f3SHong Zhang 
3492b1cb36f3SHong Zhang  .seealso: TSSolve(), TSAdjointCostIntegral()
3493b1cb36f3SHong Zhang  @*/
3494b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts)
3495b1cb36f3SHong Zhang {
3496b1cb36f3SHong Zhang     PetscErrorCode ierr;
3497b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3498b1cb36f3SHong 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);
3499b1cb36f3SHong Zhang     ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr);
3500b1cb36f3SHong Zhang     PetscFunctionReturn(0);
3501b1cb36f3SHong Zhang }
3502d67e68b7SBarry Smith 
350305175c85SJed Brown #undef __FUNCT__
3504d763cef2SBarry Smith #define __FUNCT__ "TSSolve"
3505d763cef2SBarry Smith /*@
3506d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
3507d763cef2SBarry Smith 
3508d763cef2SBarry Smith    Collective on TS
3509d763cef2SBarry Smith 
3510d763cef2SBarry Smith    Input Parameter:
3511d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
351263e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
351363e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
35145a3a76d0SJed Brown 
3515d763cef2SBarry Smith    Level: beginner
3516d763cef2SBarry Smith 
35175a3a76d0SJed Brown    Notes:
35185a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
35195a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
35205a3a76d0SJed Brown    stepped over the final time.
35215a3a76d0SJed Brown 
3522d763cef2SBarry Smith .keywords: TS, timestep, solve
3523d763cef2SBarry Smith 
352463e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
3525d763cef2SBarry Smith @*/
3526cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
3527d763cef2SBarry Smith {
3528b06615a5SLisandro Dalcin   Vec               solution;
3529d763cef2SBarry Smith   PetscErrorCode    ierr;
3530d763cef2SBarry Smith 
3531d763cef2SBarry Smith   PetscFunctionBegin;
3532d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3533f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3534feed9e9dSBarry Smith 
353549354f04SShri 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 */
3536b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
35370910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3538b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3539b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3540b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
35415a3a76d0SJed Brown     }
35420910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3543bbd56ea5SKarl Rupp   } else if (u) {
35440910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
35455a3a76d0SJed Brown   }
3546b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
354768bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3548a6772fa2SLisandro Dalcin 
3549a6772fa2SLisandro 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()");
3550a6772fa2SLisandro 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");
3551a6772fa2SLisandro Dalcin 
3552d763cef2SBarry Smith   /* reset time step and iteration counters */
3553193ac0bcSJed Brown   ts->steps             = 0;
35545ef26d82SJed Brown   ts->ksp_its           = 0;
35555ef26d82SJed Brown   ts->snes_its          = 0;
3556c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
3557c610991cSLisandro Dalcin   ts->reject            = 0;
3558193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
3559193ac0bcSJed Brown 
3560ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3561f05ece33SBarry Smith 
3562193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
3563193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
3564a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3565cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3566a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
3567*be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
3568db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3569db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3570cdf0de3dSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
35716427ac75SLisandro Dalcin     ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
35726427ac75SLisandro Dalcin 
3573e1a7a14fSJed Brown     while (!ts->reason) {
3574193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
35759687d888SLisandro Dalcin       if (!ts->steprollback) {
35769687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
35779687d888SLisandro Dalcin       }
3578193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
35799687d888SLisandro Dalcin       if (ts->vec_costintegral && ts->costintegralfwd) {
3580b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
3581b1cb36f3SHong Zhang       }
35826427ac75SLisandro Dalcin       ierr = TSEventHandler(ts);CHKERRQ(ierr);
35838392e04aSShri Abhyankar       if (!ts->steprollback) {
3584cdf0de3dSShri Abhyankar         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
35851eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
3586aeb4809dSShri Abhyankar       }
3587193ac0bcSJed Brown     }
358863e21af5SBarry Smith     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
35896427ac75SLisandro Dalcin 
359049354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
35910910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3592cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3593b06615a5SLisandro Dalcin       solution = u;
359463e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
35950574a7fbSJed Brown     } else {
3596ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3597cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3598b06615a5SLisandro Dalcin       solution = ts->vec_sol;
35990574a7fbSJed Brown     }
3600193ac0bcSJed Brown   }
3601d2daff3dSHong Zhang 
3602ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
360363e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
360456f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
3605ef222394SBarry Smith   if (ts->adjoint_solve) {
3606ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
36072b0a91c0SBarry Smith   }
3608d763cef2SBarry Smith   PetscFunctionReturn(0);
3609d763cef2SBarry Smith }
3610d763cef2SBarry Smith 
3611d763cef2SBarry Smith #undef __FUNCT__
3612b1cb36f3SHong Zhang #define __FUNCT__ "TSAdjointCostIntegral"
3613b1cb36f3SHong Zhang /*@
3614b1cb36f3SHong Zhang  TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run.
3615b1cb36f3SHong Zhang 
3616b1cb36f3SHong Zhang  Collective on TS
3617b1cb36f3SHong Zhang 
3618b1cb36f3SHong Zhang  Input Arguments:
3619b1cb36f3SHong Zhang  .  ts - time stepping context
3620b1cb36f3SHong Zhang 
3621b1cb36f3SHong Zhang  Level: advanced
3622b1cb36f3SHong Zhang 
3623b1cb36f3SHong Zhang  Notes:
3624b1cb36f3SHong Zhang  This function cannot be called until TSAdjointStep() has been completed.
3625b1cb36f3SHong Zhang 
3626b1cb36f3SHong Zhang  .seealso: TSAdjointSolve(), TSAdjointStep
3627b1cb36f3SHong Zhang  @*/
3628b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts)
3629b1cb36f3SHong Zhang {
3630b1cb36f3SHong Zhang     PetscErrorCode ierr;
3631b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3632b1cb36f3SHong 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);
3633b1cb36f3SHong Zhang     ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr);
3634b1cb36f3SHong Zhang     PetscFunctionReturn(0);
3635b1cb36f3SHong Zhang }
3636b1cb36f3SHong Zhang 
3637b1cb36f3SHong Zhang #undef __FUNCT__
3638c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve"
3639c88f2d44SBarry Smith /*@
3640c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
3641c88f2d44SBarry Smith 
3642c88f2d44SBarry Smith    Collective on TS
3643c88f2d44SBarry Smith 
3644c88f2d44SBarry Smith    Input Parameter:
36452c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
3646c88f2d44SBarry Smith 
3647e87fd094SBarry Smith    Options Database:
3648e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions
3649e87fd094SBarry Smith 
3650c88f2d44SBarry Smith    Level: intermediate
3651c88f2d44SBarry Smith 
3652c88f2d44SBarry Smith    Notes:
3653c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
3654c88f2d44SBarry Smith 
365573b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
365673b18844SBarry Smith 
3657c88f2d44SBarry Smith .keywords: TS, timestep, solve
3658c88f2d44SBarry Smith 
3659b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
3660c88f2d44SBarry Smith @*/
36612c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
3662c88f2d44SBarry Smith {
3663c88f2d44SBarry Smith   PetscErrorCode    ierr;
3664c88f2d44SBarry Smith 
3665c88f2d44SBarry Smith   PetscFunctionBegin;
3666c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3667c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
366868bece0bSHong Zhang 
3669c88f2d44SBarry Smith   /* reset time step and iteration counters */
3670c88f2d44SBarry Smith   ts->steps             = 0;
3671c88f2d44SBarry Smith   ts->ksp_its           = 0;
3672c88f2d44SBarry Smith   ts->snes_its          = 0;
3673c88f2d44SBarry Smith   ts->num_snes_failures = 0;
3674c88f2d44SBarry Smith   ts->reject            = 0;
3675c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
3676c88f2d44SBarry Smith 
367773b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
3678c88f2d44SBarry Smith 
367973b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3680c88f2d44SBarry Smith   while (!ts->reason) {
368155c52731SHong Zhang     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
36829110b2e7SHong Zhang     ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
36836427ac75SLisandro Dalcin     ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr);
3684616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
3685b1cb36f3SHong Zhang     if (ts->vec_costintegral && !ts->costintegralfwd) {
3686b1cb36f3SHong Zhang       ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr);
3687b1cb36f3SHong Zhang     }
3688c88f2d44SBarry Smith   }
368926656371SHong Zhang   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
369026656371SHong Zhang   ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
3691c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
3692e210cd0eSHong Zhang   ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr);
3693685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
3694c88f2d44SBarry Smith   PetscFunctionReturn(0);
3695c88f2d44SBarry Smith }
3696c88f2d44SBarry Smith 
3697c88f2d44SBarry Smith #undef __FUNCT__
3698d763cef2SBarry Smith #define __FUNCT__ "TSMonitor"
36997db568b7SBarry Smith /*@C
3700228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3701228d79bcSJed Brown 
3702228d79bcSJed Brown    Collective on TS
3703228d79bcSJed Brown 
3704228d79bcSJed Brown    Input Parameters:
3705228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3706228d79bcSJed Brown .  step - step number that has just completed
3707228d79bcSJed Brown .  ptime - model time of the state
37080910c330SBarry Smith -  u - state at the current model time
3709228d79bcSJed Brown 
3710228d79bcSJed Brown    Notes:
37117db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
37127db568b7SBarry Smith    Users would almost never call this routine directly.
3713228d79bcSJed Brown 
371463e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
371563e21af5SBarry Smith 
37167db568b7SBarry Smith    Level: developer
3717228d79bcSJed Brown 
3718228d79bcSJed Brown .keywords: TS, timestep
3719228d79bcSJed Brown @*/
37200910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3721d763cef2SBarry Smith {
3722d6152f81SLisandro Dalcin   DM             dm;
3723a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
3724d6152f81SLisandro Dalcin   PetscErrorCode ierr;
3725d763cef2SBarry Smith 
3726d763cef2SBarry Smith   PetscFunctionBegin;
3727b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3728b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
3729d6152f81SLisandro Dalcin 
3730d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
3731d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
3732d6152f81SLisandro Dalcin 
37335edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3734d763cef2SBarry Smith   for (i=0; i<n; i++) {
37350910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3736d763cef2SBarry Smith   }
37375edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3738d763cef2SBarry Smith   PetscFunctionReturn(0);
3739d763cef2SBarry Smith }
3740d763cef2SBarry Smith 
37419110b2e7SHong Zhang #undef __FUNCT__
37429110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitor"
37437db568b7SBarry Smith /*@C
37449110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
37459110b2e7SHong Zhang 
37469110b2e7SHong Zhang    Collective on TS
37479110b2e7SHong Zhang 
37489110b2e7SHong Zhang    Input Parameters:
37499110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
37509110b2e7SHong Zhang .  step - step number that has just completed
37519110b2e7SHong Zhang .  ptime - model time of the state
37529110b2e7SHong Zhang .  u - state at the current model time
37539110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
37549110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
37559110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
37569110b2e7SHong Zhang 
37579110b2e7SHong Zhang    Notes:
37587db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
37597db568b7SBarry Smith    Users would almost never call this routine directly.
37609110b2e7SHong Zhang 
37617db568b7SBarry Smith    Level: developer
37629110b2e7SHong Zhang 
37639110b2e7SHong Zhang .keywords: TS, timestep
37649110b2e7SHong Zhang @*/
37659110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
37669110b2e7SHong Zhang {
37679110b2e7SHong Zhang   PetscErrorCode ierr;
37689110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
37699110b2e7SHong Zhang 
37709110b2e7SHong Zhang   PetscFunctionBegin;
37719110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
37729110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
37739110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
37749110b2e7SHong Zhang   for (i=0; i<n; i++) {
37759110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
37769110b2e7SHong Zhang   }
37779110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
37789110b2e7SHong Zhang   PetscFunctionReturn(0);
37799110b2e7SHong Zhang }
37809110b2e7SHong Zhang 
3781d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
37824a2ae208SSatish Balay #undef __FUNCT__
3783a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
3784d763cef2SBarry Smith /*@C
37857db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
3786a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3787d763cef2SBarry Smith 
3788d763cef2SBarry Smith    Collective on TS
3789d763cef2SBarry Smith 
3790d763cef2SBarry Smith    Input Parameters:
3791d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3792d763cef2SBarry Smith .  label - the title to put in the title bar
37937c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3794a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3795a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3796d763cef2SBarry Smith 
3797d763cef2SBarry Smith    Output Parameter:
37980b039ecaSBarry Smith .  ctx - the context
3799d763cef2SBarry Smith 
3800d763cef2SBarry Smith    Options Database Key:
38014f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
38027db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
38037db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
38047db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
38057db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
3806b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
3807d763cef2SBarry Smith 
3808d763cef2SBarry Smith    Notes:
3809a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3810d763cef2SBarry Smith 
38117db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
38127db568b7SBarry Smith 
38137db568b7SBarry 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
38147db568b7SBarry 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
38157db568b7SBarry Smith    as the first argument.
38167db568b7SBarry Smith 
38177db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
38187db568b7SBarry Smith 
38197db568b7SBarry Smith 
3820d763cef2SBarry Smith    Level: intermediate
3821d763cef2SBarry Smith 
38227db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
3823d763cef2SBarry Smith 
38247db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
38257db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
38267db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
38277db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
38287db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
38297c922b88SBarry Smith 
3830d763cef2SBarry Smith @*/
3831a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3832d763cef2SBarry Smith {
38337f52daa2SLisandro Dalcin   PetscDraw      draw;
3834dfbe8321SBarry Smith   PetscErrorCode ierr;
3835d763cef2SBarry Smith 
3836d763cef2SBarry Smith   PetscFunctionBegin;
3837b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
38387f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
38397f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
38407f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
3841287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
38427f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
3843a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3844d763cef2SBarry Smith   PetscFunctionReturn(0);
3845d763cef2SBarry Smith }
3846d763cef2SBarry Smith 
38474a2ae208SSatish Balay #undef __FUNCT__
38484f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3849b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3850d763cef2SBarry Smith {
38510b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3852c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3853dfbe8321SBarry Smith   PetscErrorCode ierr;
3854d763cef2SBarry Smith 
3855d763cef2SBarry Smith   PetscFunctionBegin;
385663e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
3857b06615a5SLisandro Dalcin   if (!step) {
3858a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3859a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
38606934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr);
3861a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3862a9f9c1f6SBarry Smith   }
3863c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
38640b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3865b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
38660b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
38676934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
38683923b477SBarry Smith   }
3869d763cef2SBarry Smith   PetscFunctionReturn(0);
3870d763cef2SBarry Smith }
3871d763cef2SBarry Smith 
38724a2ae208SSatish Balay #undef __FUNCT__
3873a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3874d763cef2SBarry Smith /*@C
3875a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3876a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3877d763cef2SBarry Smith 
38780b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3879d763cef2SBarry Smith 
3880d763cef2SBarry Smith    Input Parameter:
38810b039ecaSBarry Smith .  ctx - the monitor context
3882d763cef2SBarry Smith 
3883d763cef2SBarry Smith    Level: intermediate
3884d763cef2SBarry Smith 
3885d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3886d763cef2SBarry Smith 
38874f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3888d763cef2SBarry Smith @*/
3889a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3890d763cef2SBarry Smith {
3891dfbe8321SBarry Smith   PetscErrorCode ierr;
3892d763cef2SBarry Smith 
3893d763cef2SBarry Smith   PetscFunctionBegin;
38947684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
38957684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
38967684fa3eSBarry Smith   }
38970b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
389831152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
3899387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
3900387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
3901387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
39020b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3903d763cef2SBarry Smith   PetscFunctionReturn(0);
3904d763cef2SBarry Smith }
3905d763cef2SBarry Smith 
39064a2ae208SSatish Balay #undef __FUNCT__
39074a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3908d763cef2SBarry Smith /*@
3909b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3910d763cef2SBarry Smith 
3911d763cef2SBarry Smith    Not Collective
3912d763cef2SBarry Smith 
3913d763cef2SBarry Smith    Input Parameter:
3914d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3915d763cef2SBarry Smith 
3916d763cef2SBarry Smith    Output Parameter:
391763e21af5SBarry Smith .  t  - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime().
3918d763cef2SBarry Smith 
3919d763cef2SBarry Smith    Level: beginner
3920d763cef2SBarry Smith 
3921b8123daeSJed Brown    Note:
3922b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
39239be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3924b8123daeSJed Brown 
392563e21af5SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime()
3926d763cef2SBarry Smith 
3927d763cef2SBarry Smith .keywords: TS, get, time
3928d763cef2SBarry Smith @*/
39297087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3930d763cef2SBarry Smith {
3931d763cef2SBarry Smith   PetscFunctionBegin;
39320700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3933f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3934d763cef2SBarry Smith   *t = ts->ptime;
3935d763cef2SBarry Smith   PetscFunctionReturn(0);
3936d763cef2SBarry Smith }
3937d763cef2SBarry Smith 
39384a2ae208SSatish Balay #undef __FUNCT__
3939e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3940e5e524a1SHong Zhang /*@
3941e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3942e5e524a1SHong Zhang 
3943e5e524a1SHong Zhang    Not Collective
3944e5e524a1SHong Zhang 
3945e5e524a1SHong Zhang    Input Parameter:
3946e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3947e5e524a1SHong Zhang 
3948e5e524a1SHong Zhang    Output Parameter:
3949e5e524a1SHong Zhang .  t  - the previous time
3950e5e524a1SHong Zhang 
3951e5e524a1SHong Zhang    Level: beginner
3952e5e524a1SHong Zhang 
3953e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3954e5e524a1SHong Zhang 
3955e5e524a1SHong Zhang .keywords: TS, get, time
3956e5e524a1SHong Zhang @*/
3957e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3958e5e524a1SHong Zhang {
3959e5e524a1SHong Zhang   PetscFunctionBegin;
3960e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3961e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3962e5e524a1SHong Zhang   *t = ts->ptime_prev;
3963e5e524a1SHong Zhang   PetscFunctionReturn(0);
3964e5e524a1SHong Zhang }
3965e5e524a1SHong Zhang 
3966e5e524a1SHong Zhang #undef __FUNCT__
39676a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
39686a4d4014SLisandro Dalcin /*@
39696a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
39706a4d4014SLisandro Dalcin 
39713f9fe445SBarry Smith    Logically Collective on TS
39726a4d4014SLisandro Dalcin 
39736a4d4014SLisandro Dalcin    Input Parameters:
39746a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
39756a4d4014SLisandro Dalcin -  time - the time
39766a4d4014SLisandro Dalcin 
39776a4d4014SLisandro Dalcin    Level: intermediate
39786a4d4014SLisandro Dalcin 
39796a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
39806a4d4014SLisandro Dalcin 
39816a4d4014SLisandro Dalcin .keywords: TS, set, time
39826a4d4014SLisandro Dalcin @*/
39837087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
39846a4d4014SLisandro Dalcin {
39856a4d4014SLisandro Dalcin   PetscFunctionBegin;
39860700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3987c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
39886a4d4014SLisandro Dalcin   ts->ptime = t;
39896a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
39906a4d4014SLisandro Dalcin }
39916a4d4014SLisandro Dalcin 
39926a4d4014SLisandro Dalcin #undef __FUNCT__
39934a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3994d763cef2SBarry Smith /*@C
3995d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3996d763cef2SBarry Smith    TS options in the database.
3997d763cef2SBarry Smith 
39983f9fe445SBarry Smith    Logically Collective on TS
3999d763cef2SBarry Smith 
4000d763cef2SBarry Smith    Input Parameter:
4001d763cef2SBarry Smith +  ts     - The TS context
4002d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4003d763cef2SBarry Smith 
4004d763cef2SBarry Smith    Notes:
4005d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4006d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4007d763cef2SBarry Smith    hyphen.
4008d763cef2SBarry Smith 
4009d763cef2SBarry Smith    Level: advanced
4010d763cef2SBarry Smith 
4011d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
4012d763cef2SBarry Smith 
4013d763cef2SBarry Smith .seealso: TSSetFromOptions()
4014d763cef2SBarry Smith 
4015d763cef2SBarry Smith @*/
40167087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4017d763cef2SBarry Smith {
4018dfbe8321SBarry Smith   PetscErrorCode ierr;
4019089b2837SJed Brown   SNES           snes;
4020d763cef2SBarry Smith 
4021d763cef2SBarry Smith   PetscFunctionBegin;
40220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4023d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4024089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4025089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4026d763cef2SBarry Smith   PetscFunctionReturn(0);
4027d763cef2SBarry Smith }
4028d763cef2SBarry Smith 
4029d763cef2SBarry Smith 
40304a2ae208SSatish Balay #undef __FUNCT__
40314a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
4032d763cef2SBarry Smith /*@C
4033d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4034d763cef2SBarry Smith    TS options in the database.
4035d763cef2SBarry Smith 
40363f9fe445SBarry Smith    Logically Collective on TS
4037d763cef2SBarry Smith 
4038d763cef2SBarry Smith    Input Parameter:
4039d763cef2SBarry Smith +  ts     - The TS context
4040d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4041d763cef2SBarry Smith 
4042d763cef2SBarry Smith    Notes:
4043d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4044d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4045d763cef2SBarry Smith    hyphen.
4046d763cef2SBarry Smith 
4047d763cef2SBarry Smith    Level: advanced
4048d763cef2SBarry Smith 
4049d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
4050d763cef2SBarry Smith 
4051d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4052d763cef2SBarry Smith 
4053d763cef2SBarry Smith @*/
40547087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4055d763cef2SBarry Smith {
4056dfbe8321SBarry Smith   PetscErrorCode ierr;
4057089b2837SJed Brown   SNES           snes;
4058d763cef2SBarry Smith 
4059d763cef2SBarry Smith   PetscFunctionBegin;
40600700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4061d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4062089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4063089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4064d763cef2SBarry Smith   PetscFunctionReturn(0);
4065d763cef2SBarry Smith }
4066d763cef2SBarry Smith 
40674a2ae208SSatish Balay #undef __FUNCT__
40684a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
4069d763cef2SBarry Smith /*@C
4070d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4071d763cef2SBarry Smith    TS options in the database.
4072d763cef2SBarry Smith 
4073d763cef2SBarry Smith    Not Collective
4074d763cef2SBarry Smith 
4075d763cef2SBarry Smith    Input Parameter:
4076d763cef2SBarry Smith .  ts - The TS context
4077d763cef2SBarry Smith 
4078d763cef2SBarry Smith    Output Parameter:
4079d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4080d763cef2SBarry Smith 
4081d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
4082d763cef2SBarry Smith    sufficient length to hold the prefix.
4083d763cef2SBarry Smith 
4084d763cef2SBarry Smith    Level: intermediate
4085d763cef2SBarry Smith 
4086d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
4087d763cef2SBarry Smith 
4088d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4089d763cef2SBarry Smith @*/
40907087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4091d763cef2SBarry Smith {
4092dfbe8321SBarry Smith   PetscErrorCode ierr;
4093d763cef2SBarry Smith 
4094d763cef2SBarry Smith   PetscFunctionBegin;
40950700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
40964482741eSBarry Smith   PetscValidPointer(prefix,2);
4097d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4098d763cef2SBarry Smith   PetscFunctionReturn(0);
4099d763cef2SBarry Smith }
4100d763cef2SBarry Smith 
41014a2ae208SSatish Balay #undef __FUNCT__
41024a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
4103d763cef2SBarry Smith /*@C
4104d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4105d763cef2SBarry Smith 
4106d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4107d763cef2SBarry Smith 
4108d763cef2SBarry Smith    Input Parameter:
4109d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4110d763cef2SBarry Smith 
4111d763cef2SBarry Smith    Output Parameters:
4112e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4113e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4114e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4115e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4116d763cef2SBarry Smith 
41170298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
4118d763cef2SBarry Smith 
4119d763cef2SBarry Smith    Level: intermediate
4120d763cef2SBarry Smith 
412126d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
4122d763cef2SBarry Smith 
4123d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
4124d763cef2SBarry Smith @*/
4125e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4126d763cef2SBarry Smith {
4127089b2837SJed Brown   PetscErrorCode ierr;
4128089b2837SJed Brown   SNES           snes;
412924989b8cSPeter Brune   DM             dm;
4130089b2837SJed Brown 
4131d763cef2SBarry Smith   PetscFunctionBegin;
4132089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4133e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
413424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
413524989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4136d763cef2SBarry Smith   PetscFunctionReturn(0);
4137d763cef2SBarry Smith }
4138d763cef2SBarry Smith 
41391713a123SBarry Smith #undef __FUNCT__
41402eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
41412eca1d9cSJed Brown /*@C
41422eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
41432eca1d9cSJed Brown 
41442eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
41452eca1d9cSJed Brown 
41462eca1d9cSJed Brown    Input Parameter:
41472eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
41482eca1d9cSJed Brown 
41492eca1d9cSJed Brown    Output Parameters:
4150e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4151e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
41522eca1d9cSJed Brown .  f   - The function to compute the matrices
41532eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
41542eca1d9cSJed Brown 
41550298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
41562eca1d9cSJed Brown 
41572eca1d9cSJed Brown    Level: advanced
41582eca1d9cSJed Brown 
41592eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
41602eca1d9cSJed Brown 
41612eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
41622eca1d9cSJed Brown @*/
4163e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
41642eca1d9cSJed Brown {
4165089b2837SJed Brown   PetscErrorCode ierr;
4166089b2837SJed Brown   SNES           snes;
416724989b8cSPeter Brune   DM             dm;
41680910c330SBarry Smith 
41692eca1d9cSJed Brown   PetscFunctionBegin;
4170089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4171f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4172e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
417324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
417424989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
41752eca1d9cSJed Brown   PetscFunctionReturn(0);
41762eca1d9cSJed Brown }
41772eca1d9cSJed Brown 
41786083293cSBarry Smith 
41792eca1d9cSJed Brown #undef __FUNCT__
418083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
41811713a123SBarry Smith /*@C
418283a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
41831713a123SBarry Smith    VecView() for the solution at each timestep
41841713a123SBarry Smith 
41851713a123SBarry Smith    Collective on TS
41861713a123SBarry Smith 
41871713a123SBarry Smith    Input Parameters:
41881713a123SBarry Smith +  ts - the TS context
41891713a123SBarry Smith .  step - current time-step
4190142b95e3SSatish Balay .  ptime - current time
41910298fd71SBarry Smith -  dummy - either a viewer or NULL
41921713a123SBarry Smith 
419399fdda47SBarry Smith    Options Database:
419499fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
419599fdda47SBarry Smith 
4196387f4636SBarry 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
419799fdda47SBarry Smith        will look bad
419899fdda47SBarry Smith 
41991713a123SBarry Smith    Level: intermediate
42001713a123SBarry Smith 
42011713a123SBarry Smith .keywords: TS,  vector, monitor, view
42021713a123SBarry Smith 
4203a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
42041713a123SBarry Smith @*/
42050910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
42061713a123SBarry Smith {
4207dfbe8321SBarry Smith   PetscErrorCode   ierr;
420883a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4209473a3ab2SBarry Smith   PetscDraw        draw;
42101713a123SBarry Smith 
42111713a123SBarry Smith   PetscFunctionBegin;
42126083293cSBarry Smith   if (!step && ictx->showinitial) {
42136083293cSBarry Smith     if (!ictx->initialsolution) {
42140910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
42151713a123SBarry Smith     }
42160910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
42176083293cSBarry Smith   }
4218b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
42190dcf80beSBarry Smith 
42206083293cSBarry Smith   if (ictx->showinitial) {
42216083293cSBarry Smith     PetscReal pause;
42226083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
42236083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
42246083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
42256083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
42266083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
42276083293cSBarry Smith   }
42280910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4229473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
423051fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4231473a3ab2SBarry Smith     char      time[32];
4232473a3ab2SBarry Smith 
4233473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
423485b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4235473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4236473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
423751fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4238473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4239473a3ab2SBarry Smith   }
4240473a3ab2SBarry Smith 
42416083293cSBarry Smith   if (ictx->showinitial) {
42426083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
42436083293cSBarry Smith   }
42441713a123SBarry Smith   PetscFunctionReturn(0);
42451713a123SBarry Smith }
42461713a123SBarry Smith 
42472d5ee99bSBarry Smith #undef __FUNCT__
42489110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorDrawSensi"
42499110b2e7SHong Zhang /*@C
42509110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
42519110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
42529110b2e7SHong Zhang 
42539110b2e7SHong Zhang    Collective on TS
42549110b2e7SHong Zhang 
42559110b2e7SHong Zhang    Input Parameters:
42569110b2e7SHong Zhang +  ts - the TS context
42579110b2e7SHong Zhang .  step - current time-step
42589110b2e7SHong Zhang .  ptime - current time
42599110b2e7SHong Zhang .  u - current state
42609110b2e7SHong Zhang .  numcost - number of cost functions
42619110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
42629110b2e7SHong Zhang .  mu - sensitivities to parameters
42639110b2e7SHong Zhang -  dummy - either a viewer or NULL
42649110b2e7SHong Zhang 
42659110b2e7SHong Zhang    Level: intermediate
42669110b2e7SHong Zhang 
42679110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
42689110b2e7SHong Zhang 
42699110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
42709110b2e7SHong Zhang @*/
42719110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
42729110b2e7SHong Zhang {
42739110b2e7SHong Zhang   PetscErrorCode   ierr;
42749110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
42759110b2e7SHong Zhang   PetscDraw        draw;
4276a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
4277a0046e2cSSatish Balay   char             time[32];
42789110b2e7SHong Zhang 
42799110b2e7SHong Zhang   PetscFunctionBegin;
42809110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
42819110b2e7SHong Zhang 
42829110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
42839110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
42849110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
42859110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
42869110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
42879110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
42889110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
42899110b2e7SHong Zhang   PetscFunctionReturn(0);
42909110b2e7SHong Zhang }
42919110b2e7SHong Zhang 
42929110b2e7SHong Zhang #undef __FUNCT__
42932d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
42942d5ee99bSBarry Smith /*@C
42952d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
42962d5ee99bSBarry Smith 
42972d5ee99bSBarry Smith    Collective on TS
42982d5ee99bSBarry Smith 
42992d5ee99bSBarry Smith    Input Parameters:
43002d5ee99bSBarry Smith +  ts - the TS context
43012d5ee99bSBarry Smith .  step - current time-step
43022d5ee99bSBarry Smith .  ptime - current time
43032d5ee99bSBarry Smith -  dummy - either a viewer or NULL
43042d5ee99bSBarry Smith 
43052d5ee99bSBarry Smith    Level: intermediate
43062d5ee99bSBarry Smith 
43072d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
43082d5ee99bSBarry Smith 
43092d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
43102d5ee99bSBarry Smith @*/
43112d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
43122d5ee99bSBarry Smith {
43132d5ee99bSBarry Smith   PetscErrorCode    ierr;
43142d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
43152d5ee99bSBarry Smith   PetscDraw         draw;
43166934998bSLisandro Dalcin   PetscDrawAxis     axis;
43172d5ee99bSBarry Smith   PetscInt          n;
43182d5ee99bSBarry Smith   PetscMPIInt       size;
43196934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
43202d5ee99bSBarry Smith   char              time[32];
43212d5ee99bSBarry Smith   const PetscScalar *U;
43222d5ee99bSBarry Smith 
43232d5ee99bSBarry Smith   PetscFunctionBegin;
43246934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
43256934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
43262d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
43276934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
43282d5ee99bSBarry Smith 
43292d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
43306934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
43316934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
43326934998bSLisandro Dalcin   if (!step) {
43336934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
43346934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
43356934998bSLisandro Dalcin   }
43362d5ee99bSBarry Smith 
43372d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
43386934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
43396934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
4340a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
43416934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
43422d5ee99bSBarry Smith 
43436934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
43446934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
43452d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
43464b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
434785b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
43482d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
434951fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
43502d5ee99bSBarry Smith   }
43516934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
43522d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
43536934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
43542d5ee99bSBarry Smith   PetscFunctionReturn(0);
43552d5ee99bSBarry Smith }
43562d5ee99bSBarry Smith 
43571713a123SBarry Smith 
43586c699258SBarry Smith #undef __FUNCT__
435983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
43606083293cSBarry Smith /*@C
436183a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
43626083293cSBarry Smith 
43636083293cSBarry Smith    Collective on TS
43646083293cSBarry Smith 
43656083293cSBarry Smith    Input Parameters:
43666083293cSBarry Smith .    ctx - the monitor context
43676083293cSBarry Smith 
43686083293cSBarry Smith    Level: intermediate
43696083293cSBarry Smith 
43706083293cSBarry Smith .keywords: TS,  vector, monitor, view
43716083293cSBarry Smith 
437283a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
43736083293cSBarry Smith @*/
437483a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
43756083293cSBarry Smith {
43766083293cSBarry Smith   PetscErrorCode ierr;
43776083293cSBarry Smith 
43786083293cSBarry Smith   PetscFunctionBegin;
437983a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
438083a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
438183a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
43826083293cSBarry Smith   PetscFunctionReturn(0);
43836083293cSBarry Smith }
43846083293cSBarry Smith 
43856083293cSBarry Smith #undef __FUNCT__
438683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
43876083293cSBarry Smith /*@C
438883a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
43896083293cSBarry Smith 
43906083293cSBarry Smith    Collective on TS
43916083293cSBarry Smith 
43926083293cSBarry Smith    Input Parameter:
43936083293cSBarry Smith .    ts - time-step context
43946083293cSBarry Smith 
43956083293cSBarry Smith    Output Patameter:
43966083293cSBarry Smith .    ctx - the monitor context
43976083293cSBarry Smith 
439899fdda47SBarry Smith    Options Database:
439999fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
440099fdda47SBarry Smith 
44016083293cSBarry Smith    Level: intermediate
44026083293cSBarry Smith 
44036083293cSBarry Smith .keywords: TS,  vector, monitor, view
44046083293cSBarry Smith 
440583a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
44066083293cSBarry Smith @*/
440783a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
44086083293cSBarry Smith {
44096083293cSBarry Smith   PetscErrorCode   ierr;
44106083293cSBarry Smith 
44116083293cSBarry Smith   PetscFunctionBegin;
4412b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
441383a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4414e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4415bbd56ea5SKarl Rupp 
441683a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4417473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
4418c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4419473a3ab2SBarry Smith 
4420473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
4421c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
44226083293cSBarry Smith   PetscFunctionReturn(0);
44236083293cSBarry Smith }
44246083293cSBarry Smith 
44256083293cSBarry Smith #undef __FUNCT__
442683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
44273a471f94SBarry Smith /*@C
442883a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
44293a471f94SBarry Smith    VecView() for the error at each timestep
44303a471f94SBarry Smith 
44313a471f94SBarry Smith    Collective on TS
44323a471f94SBarry Smith 
44333a471f94SBarry Smith    Input Parameters:
44343a471f94SBarry Smith +  ts - the TS context
44353a471f94SBarry Smith .  step - current time-step
44363a471f94SBarry Smith .  ptime - current time
44370298fd71SBarry Smith -  dummy - either a viewer or NULL
44383a471f94SBarry Smith 
44393a471f94SBarry Smith    Level: intermediate
44403a471f94SBarry Smith 
44413a471f94SBarry Smith .keywords: TS,  vector, monitor, view
44423a471f94SBarry Smith 
44433a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
44443a471f94SBarry Smith @*/
44450910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
44463a471f94SBarry Smith {
44473a471f94SBarry Smith   PetscErrorCode   ierr;
444883a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
444983a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
44503a471f94SBarry Smith   Vec              work;
44513a471f94SBarry Smith 
44523a471f94SBarry Smith   PetscFunctionBegin;
4453b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
44540910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
44553a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
44560910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
44573a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
44583a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
44593a471f94SBarry Smith   PetscFunctionReturn(0);
44603a471f94SBarry Smith }
44613a471f94SBarry Smith 
4462af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
44633a471f94SBarry Smith #undef __FUNCT__
44646c699258SBarry Smith #define __FUNCT__ "TSSetDM"
44656c699258SBarry Smith /*@
44666c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
44676c699258SBarry Smith 
44683f9fe445SBarry Smith    Logically Collective on TS and DM
44696c699258SBarry Smith 
44706c699258SBarry Smith    Input Parameters:
44716c699258SBarry Smith +  ts - the preconditioner context
44726c699258SBarry Smith -  dm - the dm
44736c699258SBarry Smith 
44746c699258SBarry Smith    Level: intermediate
44756c699258SBarry Smith 
44766c699258SBarry Smith 
44776c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
44786c699258SBarry Smith @*/
44797087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
44806c699258SBarry Smith {
44816c699258SBarry Smith   PetscErrorCode ierr;
4482089b2837SJed Brown   SNES           snes;
4483942e3340SBarry Smith   DMTS           tsdm;
44846c699258SBarry Smith 
44856c699258SBarry Smith   PetscFunctionBegin;
44860700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
448770663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4488942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
44892a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4490942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4491942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
449224989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
449324989b8cSPeter Brune         tsdm->originaldm = dm;
449424989b8cSPeter Brune       }
449524989b8cSPeter Brune     }
44966bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
449724989b8cSPeter Brune   }
44986c699258SBarry Smith   ts->dm = dm;
4499bbd56ea5SKarl Rupp 
4500089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4501089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
45026c699258SBarry Smith   PetscFunctionReturn(0);
45036c699258SBarry Smith }
45046c699258SBarry Smith 
45056c699258SBarry Smith #undef __FUNCT__
45066c699258SBarry Smith #define __FUNCT__ "TSGetDM"
45076c699258SBarry Smith /*@
45086c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
45096c699258SBarry Smith 
45103f9fe445SBarry Smith    Not Collective
45116c699258SBarry Smith 
45126c699258SBarry Smith    Input Parameter:
45136c699258SBarry Smith . ts - the preconditioner context
45146c699258SBarry Smith 
45156c699258SBarry Smith    Output Parameter:
45166c699258SBarry Smith .  dm - the dm
45176c699258SBarry Smith 
45186c699258SBarry Smith    Level: intermediate
45196c699258SBarry Smith 
45206c699258SBarry Smith 
45216c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
45226c699258SBarry Smith @*/
45237087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
45246c699258SBarry Smith {
4525496e6a7aSJed Brown   PetscErrorCode ierr;
4526496e6a7aSJed Brown 
45276c699258SBarry Smith   PetscFunctionBegin;
45280700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4529496e6a7aSJed Brown   if (!ts->dm) {
4530ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4531496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4532496e6a7aSJed Brown   }
45336c699258SBarry Smith   *dm = ts->dm;
45346c699258SBarry Smith   PetscFunctionReturn(0);
45356c699258SBarry Smith }
45361713a123SBarry Smith 
45370f5c6efeSJed Brown #undef __FUNCT__
45380f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
45390f5c6efeSJed Brown /*@
45400f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
45410f5c6efeSJed Brown 
45423f9fe445SBarry Smith    Logically Collective on SNES
45430f5c6efeSJed Brown 
45440f5c6efeSJed Brown    Input Parameter:
4545d42a1c89SJed Brown + snes - nonlinear solver
45460910c330SBarry Smith . U - the current state at which to evaluate the residual
4547d42a1c89SJed Brown - ctx - user context, must be a TS
45480f5c6efeSJed Brown 
45490f5c6efeSJed Brown    Output Parameter:
45500f5c6efeSJed Brown . F - the nonlinear residual
45510f5c6efeSJed Brown 
45520f5c6efeSJed Brown    Notes:
45530f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
45540f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
45550f5c6efeSJed Brown 
45560f5c6efeSJed Brown    Level: advanced
45570f5c6efeSJed Brown 
45580f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
45590f5c6efeSJed Brown @*/
45600910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
45610f5c6efeSJed Brown {
45620f5c6efeSJed Brown   TS             ts = (TS)ctx;
45630f5c6efeSJed Brown   PetscErrorCode ierr;
45640f5c6efeSJed Brown 
45650f5c6efeSJed Brown   PetscFunctionBegin;
45660f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
45670910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
45680f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
45690f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
45700910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
45710f5c6efeSJed Brown   PetscFunctionReturn(0);
45720f5c6efeSJed Brown }
45730f5c6efeSJed Brown 
45740f5c6efeSJed Brown #undef __FUNCT__
45750f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
45760f5c6efeSJed Brown /*@
45770f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
45780f5c6efeSJed Brown 
45790f5c6efeSJed Brown    Collective on SNES
45800f5c6efeSJed Brown 
45810f5c6efeSJed Brown    Input Parameter:
45820f5c6efeSJed Brown + snes - nonlinear solver
45830910c330SBarry Smith . U - the current state at which to evaluate the residual
45840f5c6efeSJed Brown - ctx - user context, must be a TS
45850f5c6efeSJed Brown 
45860f5c6efeSJed Brown    Output Parameter:
45870f5c6efeSJed Brown + A - the Jacobian
45880f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
45890f5c6efeSJed Brown - flag - indicates any structure change in the matrix
45900f5c6efeSJed Brown 
45910f5c6efeSJed Brown    Notes:
45920f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
45930f5c6efeSJed Brown 
45940f5c6efeSJed Brown    Level: developer
45950f5c6efeSJed Brown 
45960f5c6efeSJed Brown .seealso: SNESSetJacobian()
45970f5c6efeSJed Brown @*/
4598d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
45990f5c6efeSJed Brown {
46000f5c6efeSJed Brown   TS             ts = (TS)ctx;
46010f5c6efeSJed Brown   PetscErrorCode ierr;
46020f5c6efeSJed Brown 
46030f5c6efeSJed Brown   PetscFunctionBegin;
46040f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
46050910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
46060f5c6efeSJed Brown   PetscValidPointer(A,3);
460794ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
46080f5c6efeSJed Brown   PetscValidPointer(B,4);
460994ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
46100f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4611d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
46120f5c6efeSJed Brown   PetscFunctionReturn(0);
46130f5c6efeSJed Brown }
4614325fc9f4SBarry Smith 
46150e4ef248SJed Brown #undef __FUNCT__
46160e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
46170e4ef248SJed Brown /*@C
46189ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
46190e4ef248SJed Brown 
46200e4ef248SJed Brown    Collective on TS
46210e4ef248SJed Brown 
46220e4ef248SJed Brown    Input Arguments:
46230e4ef248SJed Brown +  ts - time stepping context
46240e4ef248SJed Brown .  t - time at which to evaluate
46250910c330SBarry Smith .  U - state at which to evaluate
46260e4ef248SJed Brown -  ctx - context
46270e4ef248SJed Brown 
46280e4ef248SJed Brown    Output Arguments:
46290e4ef248SJed Brown .  F - right hand side
46300e4ef248SJed Brown 
46310e4ef248SJed Brown    Level: intermediate
46320e4ef248SJed Brown 
46330e4ef248SJed Brown    Notes:
46340e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
46350e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
46360e4ef248SJed Brown 
46370e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
46380e4ef248SJed Brown @*/
46390910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
46400e4ef248SJed Brown {
46410e4ef248SJed Brown   PetscErrorCode ierr;
46420e4ef248SJed Brown   Mat            Arhs,Brhs;
46430e4ef248SJed Brown 
46440e4ef248SJed Brown   PetscFunctionBegin;
46450e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4646d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
46470910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
46480e4ef248SJed Brown   PetscFunctionReturn(0);
46490e4ef248SJed Brown }
46500e4ef248SJed Brown 
46510e4ef248SJed Brown #undef __FUNCT__
46520e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
46530e4ef248SJed Brown /*@C
46540e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
46550e4ef248SJed Brown 
46560e4ef248SJed Brown    Collective on TS
46570e4ef248SJed Brown 
46580e4ef248SJed Brown    Input Arguments:
46590e4ef248SJed Brown +  ts - time stepping context
46600e4ef248SJed Brown .  t - time at which to evaluate
46610910c330SBarry Smith .  U - state at which to evaluate
46620e4ef248SJed Brown -  ctx - context
46630e4ef248SJed Brown 
46640e4ef248SJed Brown    Output Arguments:
46650e4ef248SJed Brown +  A - pointer to operator
46660e4ef248SJed Brown .  B - pointer to preconditioning matrix
46670e4ef248SJed Brown -  flg - matrix structure flag
46680e4ef248SJed Brown 
46690e4ef248SJed Brown    Level: intermediate
46700e4ef248SJed Brown 
46710e4ef248SJed Brown    Notes:
46720e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
46730e4ef248SJed Brown 
46740e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
46750e4ef248SJed Brown @*/
4676d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
46770e4ef248SJed Brown {
46780e4ef248SJed Brown   PetscFunctionBegin;
46790e4ef248SJed Brown   PetscFunctionReturn(0);
46800e4ef248SJed Brown }
46810e4ef248SJed Brown 
46820026cea9SSean Farley #undef __FUNCT__
46830026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
46840026cea9SSean Farley /*@C
46850026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
46860026cea9SSean Farley 
46870026cea9SSean Farley    Collective on TS
46880026cea9SSean Farley 
46890026cea9SSean Farley    Input Arguments:
46900026cea9SSean Farley +  ts - time stepping context
46910026cea9SSean Farley .  t - time at which to evaluate
46920910c330SBarry Smith .  U - state at which to evaluate
46930910c330SBarry Smith .  Udot - time derivative of state vector
46940026cea9SSean Farley -  ctx - context
46950026cea9SSean Farley 
46960026cea9SSean Farley    Output Arguments:
46970026cea9SSean Farley .  F - left hand side
46980026cea9SSean Farley 
46990026cea9SSean Farley    Level: intermediate
47000026cea9SSean Farley 
47010026cea9SSean Farley    Notes:
47020910c330SBarry 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
47030026cea9SSean Farley    user is required to write their own TSComputeIFunction.
47040026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
47050026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
47060026cea9SSean Farley 
47079ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
47089ae8fd06SBarry Smith 
47099ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
47100026cea9SSean Farley @*/
47110910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
47120026cea9SSean Farley {
47130026cea9SSean Farley   PetscErrorCode ierr;
47140026cea9SSean Farley   Mat            A,B;
47150026cea9SSean Farley 
47160026cea9SSean Farley   PetscFunctionBegin;
47170298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4718d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
47190910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
47200026cea9SSean Farley   PetscFunctionReturn(0);
47210026cea9SSean Farley }
47220026cea9SSean Farley 
47230026cea9SSean Farley #undef __FUNCT__
47240026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
47250026cea9SSean Farley /*@C
4726b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
47270026cea9SSean Farley 
47280026cea9SSean Farley    Collective on TS
47290026cea9SSean Farley 
47300026cea9SSean Farley    Input Arguments:
47310026cea9SSean Farley +  ts - time stepping context
47320026cea9SSean Farley .  t - time at which to evaluate
47330910c330SBarry Smith .  U - state at which to evaluate
47340910c330SBarry Smith .  Udot - time derivative of state vector
47350026cea9SSean Farley .  shift - shift to apply
47360026cea9SSean Farley -  ctx - context
47370026cea9SSean Farley 
47380026cea9SSean Farley    Output Arguments:
47390026cea9SSean Farley +  A - pointer to operator
47400026cea9SSean Farley .  B - pointer to preconditioning matrix
47410026cea9SSean Farley -  flg - matrix structure flag
47420026cea9SSean Farley 
4743b41af12eSJed Brown    Level: advanced
47440026cea9SSean Farley 
47450026cea9SSean Farley    Notes:
47460026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
47470026cea9SSean Farley 
4748b41af12eSJed Brown    It is only appropriate for problems of the form
4749b41af12eSJed Brown 
4750b41af12eSJed Brown $     M Udot = F(U,t)
4751b41af12eSJed Brown 
4752b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4753b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4754b41af12eSJed Brown   an implicit operator of the form
4755b41af12eSJed Brown 
4756b41af12eSJed Brown $    shift*M + J
4757b41af12eSJed Brown 
4758b41af12eSJed 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
4759b41af12eSJed Brown   a copy of M or reassemble it when requested.
4760b41af12eSJed Brown 
47610026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
47620026cea9SSean Farley @*/
4763d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
47640026cea9SSean Farley {
4765b41af12eSJed Brown   PetscErrorCode ierr;
4766b41af12eSJed Brown 
47670026cea9SSean Farley   PetscFunctionBegin;
476894ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4769b41af12eSJed Brown   ts->ijacobian.shift = shift;
47700026cea9SSean Farley   PetscFunctionReturn(0);
47710026cea9SSean Farley }
4772b41af12eSJed Brown 
4773e817cc15SEmil Constantinescu #undef __FUNCT__
4774e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
4775e817cc15SEmil Constantinescu /*@
4776e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4777e817cc15SEmil Constantinescu 
4778e817cc15SEmil Constantinescu    Not Collective
4779e817cc15SEmil Constantinescu 
4780e817cc15SEmil Constantinescu    Input Parameter:
4781e817cc15SEmil Constantinescu .  ts - the TS context
4782e817cc15SEmil Constantinescu 
4783e817cc15SEmil Constantinescu    Output Parameter:
47844e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4785e817cc15SEmil Constantinescu 
4786e817cc15SEmil Constantinescu    Level: beginner
4787e817cc15SEmil Constantinescu 
4788e817cc15SEmil Constantinescu .keywords: TS, equation type
4789e817cc15SEmil Constantinescu 
4790e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4791e817cc15SEmil Constantinescu @*/
4792e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4793e817cc15SEmil Constantinescu {
4794e817cc15SEmil Constantinescu   PetscFunctionBegin;
4795e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4796e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4797e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4798e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4799e817cc15SEmil Constantinescu }
4800e817cc15SEmil Constantinescu 
4801e817cc15SEmil Constantinescu #undef __FUNCT__
4802e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
4803e817cc15SEmil Constantinescu /*@
4804e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4805e817cc15SEmil Constantinescu 
4806e817cc15SEmil Constantinescu    Not Collective
4807e817cc15SEmil Constantinescu 
4808e817cc15SEmil Constantinescu    Input Parameter:
4809e817cc15SEmil Constantinescu +  ts - the TS context
48101297b224SEmil Constantinescu -  equation_type - see TSEquationType
4811e817cc15SEmil Constantinescu 
4812e817cc15SEmil Constantinescu    Level: advanced
4813e817cc15SEmil Constantinescu 
4814e817cc15SEmil Constantinescu .keywords: TS, equation type
4815e817cc15SEmil Constantinescu 
4816e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4817e817cc15SEmil Constantinescu @*/
4818e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4819e817cc15SEmil Constantinescu {
4820e817cc15SEmil Constantinescu   PetscFunctionBegin;
4821e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4822e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4823e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4824e817cc15SEmil Constantinescu }
48250026cea9SSean Farley 
48264af1b03aSJed Brown #undef __FUNCT__
48274af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
48284af1b03aSJed Brown /*@
48294af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
48304af1b03aSJed Brown 
48314af1b03aSJed Brown    Not Collective
48324af1b03aSJed Brown 
48334af1b03aSJed Brown    Input Parameter:
48344af1b03aSJed Brown .  ts - the TS context
48354af1b03aSJed Brown 
48364af1b03aSJed Brown    Output Parameter:
48374af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
48384af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
48394af1b03aSJed Brown 
4840487e0bb9SJed Brown    Level: beginner
48414af1b03aSJed Brown 
4842cd652676SJed Brown    Notes:
4843cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
48444af1b03aSJed Brown 
48454af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
48464af1b03aSJed Brown 
48474af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
48484af1b03aSJed Brown @*/
48494af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
48504af1b03aSJed Brown {
48514af1b03aSJed Brown   PetscFunctionBegin;
48524af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48534af1b03aSJed Brown   PetscValidPointer(reason,2);
48544af1b03aSJed Brown   *reason = ts->reason;
48554af1b03aSJed Brown   PetscFunctionReturn(0);
48564af1b03aSJed Brown }
48574af1b03aSJed Brown 
4858fb1732b5SBarry Smith #undef __FUNCT__
4859d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
4860d6ad946cSShri Abhyankar /*@
4861d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4862d6ad946cSShri Abhyankar 
4863d6ad946cSShri Abhyankar    Not Collective
4864d6ad946cSShri Abhyankar 
4865d6ad946cSShri Abhyankar    Input Parameter:
4866d6ad946cSShri Abhyankar +  ts - the TS context
4867d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4868d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4869d6ad946cSShri Abhyankar 
4870f5abba47SShri Abhyankar    Level: advanced
4871d6ad946cSShri Abhyankar 
4872d6ad946cSShri Abhyankar    Notes:
4873d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4874d6ad946cSShri Abhyankar 
4875d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4876d6ad946cSShri Abhyankar 
4877d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4878d6ad946cSShri Abhyankar @*/
4879d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4880d6ad946cSShri Abhyankar {
4881d6ad946cSShri Abhyankar   PetscFunctionBegin;
4882d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4883d6ad946cSShri Abhyankar   ts->reason = reason;
4884d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4885d6ad946cSShri Abhyankar }
4886d6ad946cSShri Abhyankar 
4887d6ad946cSShri Abhyankar #undef __FUNCT__
4888cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4889cc708dedSBarry Smith /*@
4890cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4891cc708dedSBarry Smith 
4892cc708dedSBarry Smith    Not Collective
4893cc708dedSBarry Smith 
4894cc708dedSBarry Smith    Input Parameter:
4895cc708dedSBarry Smith .  ts - the TS context
4896cc708dedSBarry Smith 
4897cc708dedSBarry Smith    Output Parameter:
489863e21af5SBarry Smith .  ftime - the final time. This time corresponds to the final time set with TSSetDuration()
4899cc708dedSBarry Smith 
4900487e0bb9SJed Brown    Level: beginner
4901cc708dedSBarry Smith 
4902cc708dedSBarry Smith    Notes:
4903cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4904cc708dedSBarry Smith 
4905cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4906cc708dedSBarry Smith 
4907cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4908cc708dedSBarry Smith @*/
4909cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4910cc708dedSBarry Smith {
4911cc708dedSBarry Smith   PetscFunctionBegin;
4912cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4913cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4914cc708dedSBarry Smith   *ftime = ts->solvetime;
4915cc708dedSBarry Smith   PetscFunctionReturn(0);
4916cc708dedSBarry Smith }
4917cc708dedSBarry Smith 
4918cc708dedSBarry Smith #undef __FUNCT__
49192c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps"
49202c18e0fdSBarry Smith /*@
49212c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
49222c18e0fdSBarry Smith 
49232c18e0fdSBarry Smith    Not Collective
49242c18e0fdSBarry Smith 
49252c18e0fdSBarry Smith    Input Parameter:
49262c18e0fdSBarry Smith .  ts - the TS context
49272c18e0fdSBarry Smith 
49282c18e0fdSBarry Smith    Output Parameter:
49292c18e0fdSBarry Smith .  steps - the number of steps
49302c18e0fdSBarry Smith 
49312c18e0fdSBarry Smith    Level: beginner
49322c18e0fdSBarry Smith 
49332c18e0fdSBarry Smith    Notes:
49342c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
49352c18e0fdSBarry Smith 
49362c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
49372c18e0fdSBarry Smith 
49382c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
49392c18e0fdSBarry Smith @*/
49402c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
49412c18e0fdSBarry Smith {
49422c18e0fdSBarry Smith   PetscFunctionBegin;
49432c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49442c18e0fdSBarry Smith   PetscValidPointer(steps,2);
49452c18e0fdSBarry Smith   *steps = ts->total_steps;
49462c18e0fdSBarry Smith   PetscFunctionReturn(0);
49472c18e0fdSBarry Smith }
49482c18e0fdSBarry Smith 
49492c18e0fdSBarry Smith #undef __FUNCT__
49505ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
49519f67acb7SJed Brown /*@
49525ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
49539f67acb7SJed Brown    used by the time integrator.
49549f67acb7SJed Brown 
49559f67acb7SJed Brown    Not Collective
49569f67acb7SJed Brown 
49579f67acb7SJed Brown    Input Parameter:
49589f67acb7SJed Brown .  ts - TS context
49599f67acb7SJed Brown 
49609f67acb7SJed Brown    Output Parameter:
49619f67acb7SJed Brown .  nits - number of nonlinear iterations
49629f67acb7SJed Brown 
49639f67acb7SJed Brown    Notes:
49649f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
49659f67acb7SJed Brown 
49669f67acb7SJed Brown    Level: intermediate
49679f67acb7SJed Brown 
49689f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
49699f67acb7SJed Brown 
49705ef26d82SJed Brown .seealso:  TSGetKSPIterations()
49719f67acb7SJed Brown @*/
49725ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
49739f67acb7SJed Brown {
49749f67acb7SJed Brown   PetscFunctionBegin;
49759f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49769f67acb7SJed Brown   PetscValidIntPointer(nits,2);
49775ef26d82SJed Brown   *nits = ts->snes_its;
49789f67acb7SJed Brown   PetscFunctionReturn(0);
49799f67acb7SJed Brown }
49809f67acb7SJed Brown 
49819f67acb7SJed Brown #undef __FUNCT__
49825ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
49839f67acb7SJed Brown /*@
49845ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
49859f67acb7SJed Brown    used by the time integrator.
49869f67acb7SJed Brown 
49879f67acb7SJed Brown    Not Collective
49889f67acb7SJed Brown 
49899f67acb7SJed Brown    Input Parameter:
49909f67acb7SJed Brown .  ts - TS context
49919f67acb7SJed Brown 
49929f67acb7SJed Brown    Output Parameter:
49939f67acb7SJed Brown .  lits - number of linear iterations
49949f67acb7SJed Brown 
49959f67acb7SJed Brown    Notes:
49969f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
49979f67acb7SJed Brown 
49989f67acb7SJed Brown    Level: intermediate
49999f67acb7SJed Brown 
50009f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
50019f67acb7SJed Brown 
50025ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
50039f67acb7SJed Brown @*/
50045ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
50059f67acb7SJed Brown {
50069f67acb7SJed Brown   PetscFunctionBegin;
50079f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
50089f67acb7SJed Brown   PetscValidIntPointer(lits,2);
50095ef26d82SJed Brown   *lits = ts->ksp_its;
50109f67acb7SJed Brown   PetscFunctionReturn(0);
50119f67acb7SJed Brown }
50129f67acb7SJed Brown 
50139f67acb7SJed Brown #undef __FUNCT__
5014cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
5015cef5090cSJed Brown /*@
5016cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5017cef5090cSJed Brown 
5018cef5090cSJed Brown    Not Collective
5019cef5090cSJed Brown 
5020cef5090cSJed Brown    Input Parameter:
5021cef5090cSJed Brown .  ts - TS context
5022cef5090cSJed Brown 
5023cef5090cSJed Brown    Output Parameter:
5024cef5090cSJed Brown .  rejects - number of steps rejected
5025cef5090cSJed Brown 
5026cef5090cSJed Brown    Notes:
5027cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5028cef5090cSJed Brown 
5029cef5090cSJed Brown    Level: intermediate
5030cef5090cSJed Brown 
5031cef5090cSJed Brown .keywords: TS, get, number
5032cef5090cSJed Brown 
50335ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5034cef5090cSJed Brown @*/
5035cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5036cef5090cSJed Brown {
5037cef5090cSJed Brown   PetscFunctionBegin;
5038cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5039cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5040cef5090cSJed Brown   *rejects = ts->reject;
5041cef5090cSJed Brown   PetscFunctionReturn(0);
5042cef5090cSJed Brown }
5043cef5090cSJed Brown 
5044cef5090cSJed Brown #undef __FUNCT__
5045cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
5046cef5090cSJed Brown /*@
5047cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5048cef5090cSJed Brown 
5049cef5090cSJed Brown    Not Collective
5050cef5090cSJed Brown 
5051cef5090cSJed Brown    Input Parameter:
5052cef5090cSJed Brown .  ts - TS context
5053cef5090cSJed Brown 
5054cef5090cSJed Brown    Output Parameter:
5055cef5090cSJed Brown .  fails - number of failed nonlinear solves
5056cef5090cSJed Brown 
5057cef5090cSJed Brown    Notes:
5058cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5059cef5090cSJed Brown 
5060cef5090cSJed Brown    Level: intermediate
5061cef5090cSJed Brown 
5062cef5090cSJed Brown .keywords: TS, get, number
5063cef5090cSJed Brown 
50645ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5065cef5090cSJed Brown @*/
5066cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5067cef5090cSJed Brown {
5068cef5090cSJed Brown   PetscFunctionBegin;
5069cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5070cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5071cef5090cSJed Brown   *fails = ts->num_snes_failures;
5072cef5090cSJed Brown   PetscFunctionReturn(0);
5073cef5090cSJed Brown }
5074cef5090cSJed Brown 
5075cef5090cSJed Brown #undef __FUNCT__
5076cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
5077cef5090cSJed Brown /*@
5078cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5079cef5090cSJed Brown 
5080cef5090cSJed Brown    Not Collective
5081cef5090cSJed Brown 
5082cef5090cSJed Brown    Input Parameter:
5083cef5090cSJed Brown +  ts - TS context
5084cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5085cef5090cSJed Brown 
5086cef5090cSJed Brown    Notes:
5087cef5090cSJed Brown    The counter is reset to zero for each step
5088cef5090cSJed Brown 
5089cef5090cSJed Brown    Options Database Key:
5090cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5091cef5090cSJed Brown 
5092cef5090cSJed Brown    Level: intermediate
5093cef5090cSJed Brown 
5094cef5090cSJed Brown .keywords: TS, set, maximum, number
5095cef5090cSJed Brown 
50965ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5097cef5090cSJed Brown @*/
5098cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5099cef5090cSJed Brown {
5100cef5090cSJed Brown   PetscFunctionBegin;
5101cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5102cef5090cSJed Brown   ts->max_reject = rejects;
5103cef5090cSJed Brown   PetscFunctionReturn(0);
5104cef5090cSJed Brown }
5105cef5090cSJed Brown 
5106cef5090cSJed Brown #undef __FUNCT__
5107cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
5108cef5090cSJed Brown /*@
5109cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5110cef5090cSJed Brown 
5111cef5090cSJed Brown    Not Collective
5112cef5090cSJed Brown 
5113cef5090cSJed Brown    Input Parameter:
5114cef5090cSJed Brown +  ts - TS context
5115cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5116cef5090cSJed Brown 
5117cef5090cSJed Brown    Notes:
5118cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5119cef5090cSJed Brown 
5120cef5090cSJed Brown    Options Database Key:
5121cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5122cef5090cSJed Brown 
5123cef5090cSJed Brown    Level: intermediate
5124cef5090cSJed Brown 
5125cef5090cSJed Brown .keywords: TS, set, maximum, number
5126cef5090cSJed Brown 
51275ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5128cef5090cSJed Brown @*/
5129cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5130cef5090cSJed Brown {
5131cef5090cSJed Brown   PetscFunctionBegin;
5132cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5133cef5090cSJed Brown   ts->max_snes_failures = fails;
5134cef5090cSJed Brown   PetscFunctionReturn(0);
5135cef5090cSJed Brown }
5136cef5090cSJed Brown 
5137cef5090cSJed Brown #undef __FUNCT__
51384e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
5139cef5090cSJed Brown /*@
5140cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5141cef5090cSJed Brown 
5142cef5090cSJed Brown    Not Collective
5143cef5090cSJed Brown 
5144cef5090cSJed Brown    Input Parameter:
5145cef5090cSJed Brown +  ts - TS context
5146cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5147cef5090cSJed Brown 
5148cef5090cSJed Brown    Options Database Key:
5149cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5150cef5090cSJed Brown 
5151cef5090cSJed Brown    Level: intermediate
5152cef5090cSJed Brown 
5153cef5090cSJed Brown .keywords: TS, set, error
5154cef5090cSJed Brown 
51555ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5156cef5090cSJed Brown @*/
5157cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5158cef5090cSJed Brown {
5159cef5090cSJed Brown   PetscFunctionBegin;
5160cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5161cef5090cSJed Brown   ts->errorifstepfailed = err;
5162cef5090cSJed Brown   PetscFunctionReturn(0);
5163cef5090cSJed Brown }
5164cef5090cSJed Brown 
5165cef5090cSJed Brown #undef __FUNCT__
5166fde5950dSBarry Smith #define __FUNCT__ "TSMonitorSolution"
5167fb1732b5SBarry Smith /*@C
5168fde5950dSBarry 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
5169fb1732b5SBarry Smith 
5170fb1732b5SBarry Smith    Collective on TS
5171fb1732b5SBarry Smith 
5172fb1732b5SBarry Smith    Input Parameters:
5173fb1732b5SBarry Smith +  ts - the TS context
5174fb1732b5SBarry Smith .  step - current time-step
5175fb1732b5SBarry Smith .  ptime - current time
51760910c330SBarry Smith .  u - current state
5177721cd6eeSBarry Smith -  vf - viewer and its format
5178fb1732b5SBarry Smith 
5179fb1732b5SBarry Smith    Level: intermediate
5180fb1732b5SBarry Smith 
5181fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
5182fb1732b5SBarry Smith 
5183fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5184fb1732b5SBarry Smith @*/
5185721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5186fb1732b5SBarry Smith {
5187fb1732b5SBarry Smith   PetscErrorCode ierr;
5188fb1732b5SBarry Smith 
5189fb1732b5SBarry Smith   PetscFunctionBegin;
5190721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5191721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5192721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5193ed81e22dSJed Brown   PetscFunctionReturn(0);
5194ed81e22dSJed Brown }
5195ed81e22dSJed Brown 
5196ed81e22dSJed Brown #undef __FUNCT__
5197ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
5198ed81e22dSJed Brown /*@C
5199ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5200ed81e22dSJed Brown 
5201ed81e22dSJed Brown    Collective on TS
5202ed81e22dSJed Brown 
5203ed81e22dSJed Brown    Input Parameters:
5204ed81e22dSJed Brown +  ts - the TS context
5205ed81e22dSJed Brown .  step - current time-step
5206ed81e22dSJed Brown .  ptime - current time
52070910c330SBarry Smith .  u - current state
5208ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5209ed81e22dSJed Brown 
5210ed81e22dSJed Brown    Level: intermediate
5211ed81e22dSJed Brown 
5212ed81e22dSJed Brown    Notes:
5213ed81e22dSJed 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.
5214ed81e22dSJed Brown    These are named according to the file name template.
5215ed81e22dSJed Brown 
5216ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5217ed81e22dSJed Brown 
5218ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5219ed81e22dSJed Brown 
5220ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5221ed81e22dSJed Brown @*/
52220910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5223ed81e22dSJed Brown {
5224ed81e22dSJed Brown   PetscErrorCode ierr;
5225ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5226ed81e22dSJed Brown   PetscViewer    viewer;
5227ed81e22dSJed Brown 
5228ed81e22dSJed Brown   PetscFunctionBegin;
522963e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
52308caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5231ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
52320910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5233ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5234ed81e22dSJed Brown   PetscFunctionReturn(0);
5235ed81e22dSJed Brown }
5236ed81e22dSJed Brown 
5237ed81e22dSJed Brown #undef __FUNCT__
5238ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
5239ed81e22dSJed Brown /*@C
5240ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5241ed81e22dSJed Brown 
5242ed81e22dSJed Brown    Collective on TS
5243ed81e22dSJed Brown 
5244ed81e22dSJed Brown    Input Parameters:
5245ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5246ed81e22dSJed Brown 
5247ed81e22dSJed Brown    Level: intermediate
5248ed81e22dSJed Brown 
5249ed81e22dSJed Brown    Note:
5250ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5251ed81e22dSJed Brown 
5252ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5253ed81e22dSJed Brown 
5254ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5255ed81e22dSJed Brown @*/
5256ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5257ed81e22dSJed Brown {
5258ed81e22dSJed Brown   PetscErrorCode ierr;
5259ed81e22dSJed Brown 
5260ed81e22dSJed Brown   PetscFunctionBegin;
5261ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5262fb1732b5SBarry Smith   PetscFunctionReturn(0);
5263fb1732b5SBarry Smith }
5264fb1732b5SBarry Smith 
526584df9cb4SJed Brown #undef __FUNCT__
5266552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
526784df9cb4SJed Brown /*@
5268552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
526984df9cb4SJed Brown 
5270ed81e22dSJed Brown    Collective on TS if controller has not been created yet
527184df9cb4SJed Brown 
527284df9cb4SJed Brown    Input Arguments:
5273ed81e22dSJed Brown .  ts - time stepping context
527484df9cb4SJed Brown 
527584df9cb4SJed Brown    Output Arguments:
5276ed81e22dSJed Brown .  adapt - adaptive controller
527784df9cb4SJed Brown 
527884df9cb4SJed Brown    Level: intermediate
527984df9cb4SJed Brown 
5280ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
528184df9cb4SJed Brown @*/
5282552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
528384df9cb4SJed Brown {
528484df9cb4SJed Brown   PetscErrorCode ierr;
528584df9cb4SJed Brown 
528684df9cb4SJed Brown   PetscFunctionBegin;
528784df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5288bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
528984df9cb4SJed Brown   if (!ts->adapt) {
5290ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
52913bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
52921c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
529384df9cb4SJed Brown   }
5294bec58848SLisandro Dalcin   *adapt = ts->adapt;
529584df9cb4SJed Brown   PetscFunctionReturn(0);
529684df9cb4SJed Brown }
5297d6ebe24aSShri Abhyankar 
5298d6ebe24aSShri Abhyankar #undef __FUNCT__
52991c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
53001c3436cfSJed Brown /*@
53011c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
53021c3436cfSJed Brown 
53031c3436cfSJed Brown    Logically Collective
53041c3436cfSJed Brown 
53051c3436cfSJed Brown    Input Arguments:
53061c3436cfSJed Brown +  ts - time integration context
53071c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
53080298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
53091c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
53100298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
53111c3436cfSJed Brown 
5312a3cdaa26SBarry Smith    Options Database keys:
5313a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5314a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5315a3cdaa26SBarry Smith 
53163ff766beSShri Abhyankar    Notes:
53173ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
53183ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
53193ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
53203ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
53213ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
53223ff766beSShri Abhyankar    differential variables.
53233ff766beSShri Abhyankar 
53241c3436cfSJed Brown    Level: beginner
53251c3436cfSJed Brown 
5326c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
53271c3436cfSJed Brown @*/
53281c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
53291c3436cfSJed Brown {
53301c3436cfSJed Brown   PetscErrorCode ierr;
53311c3436cfSJed Brown 
53321c3436cfSJed Brown   PetscFunctionBegin;
5333c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
53341c3436cfSJed Brown   if (vatol) {
53351c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
53361c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
53371c3436cfSJed Brown     ts->vatol = vatol;
53381c3436cfSJed Brown   }
5339c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
53401c3436cfSJed Brown   if (vrtol) {
53411c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
53421c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
53431c3436cfSJed Brown     ts->vrtol = vrtol;
53441c3436cfSJed Brown   }
53451c3436cfSJed Brown   PetscFunctionReturn(0);
53461c3436cfSJed Brown }
53471c3436cfSJed Brown 
53481c3436cfSJed Brown #undef __FUNCT__
5349c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
5350c5033834SJed Brown /*@
5351c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5352c5033834SJed Brown 
5353c5033834SJed Brown    Logically Collective
5354c5033834SJed Brown 
5355c5033834SJed Brown    Input Arguments:
5356c5033834SJed Brown .  ts - time integration context
5357c5033834SJed Brown 
5358c5033834SJed Brown    Output Arguments:
53590298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
53600298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
53610298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
53620298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5363c5033834SJed Brown 
5364c5033834SJed Brown    Level: beginner
5365c5033834SJed Brown 
5366c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5367c5033834SJed Brown @*/
5368c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5369c5033834SJed Brown {
5370c5033834SJed Brown   PetscFunctionBegin;
5371c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5372c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5373c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5374c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5375c5033834SJed Brown   PetscFunctionReturn(0);
5376c5033834SJed Brown }
5377c5033834SJed Brown 
5378c5033834SJed Brown #undef __FUNCT__
53799c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNorm2"
53809c6b16b5SShri Abhyankar /*@
5381a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
53829c6b16b5SShri Abhyankar 
53839c6b16b5SShri Abhyankar    Collective on TS
53849c6b16b5SShri Abhyankar 
53859c6b16b5SShri Abhyankar    Input Arguments:
53869c6b16b5SShri Abhyankar +  ts - time stepping context
5387a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5388a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
53899c6b16b5SShri Abhyankar 
53909c6b16b5SShri Abhyankar    Output Arguments:
53919c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
53929c6b16b5SShri Abhyankar 
53939c6b16b5SShri Abhyankar    Level: developer
53949c6b16b5SShri Abhyankar 
5395deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
53969c6b16b5SShri Abhyankar @*/
5397a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm)
53989c6b16b5SShri Abhyankar {
53999c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
54009c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
54019c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
54029c6b16b5SShri Abhyankar   PetscReal         sum,gsum;
54039c6b16b5SShri Abhyankar   PetscReal         tol;
54049c6b16b5SShri Abhyankar 
54059c6b16b5SShri Abhyankar   PetscFunctionBegin;
54069c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5407a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5408a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5409a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5410a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5411a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5412a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5413a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
54149c6b16b5SShri Abhyankar 
54159c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
54169c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
54179c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
54189c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
54199c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
54209c6b16b5SShri Abhyankar   sum  = 0.;
54219c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
54229c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
54239c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54249c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54259c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
54269c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54279c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
54289c6b16b5SShri Abhyankar     }
54299c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54309c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54319c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
54329c6b16b5SShri Abhyankar     const PetscScalar *atol;
54339c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54349c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
54359c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54369c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
54379c6b16b5SShri Abhyankar     }
54389c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54399c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
54409c6b16b5SShri Abhyankar     const PetscScalar *rtol;
54419c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54429c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
54439c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54449c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
54459c6b16b5SShri Abhyankar     }
54469c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54479c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
54489c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
54499c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54509c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
54519c6b16b5SShri Abhyankar     }
54529c6b16b5SShri Abhyankar   }
54539c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
54549c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
54559c6b16b5SShri Abhyankar 
5456b2566f29SBarry Smith   ierr  = MPIU_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
54579c6b16b5SShri Abhyankar   *norm = PetscSqrtReal(gsum / N);
54589c6b16b5SShri Abhyankar 
54599c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
54609c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
54619c6b16b5SShri Abhyankar }
54629c6b16b5SShri Abhyankar 
54639c6b16b5SShri Abhyankar #undef __FUNCT__
54649c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNormInfinity"
54659c6b16b5SShri Abhyankar /*@
5466a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
54679c6b16b5SShri Abhyankar 
54689c6b16b5SShri Abhyankar    Collective on TS
54699c6b16b5SShri Abhyankar 
54709c6b16b5SShri Abhyankar    Input Arguments:
54719c6b16b5SShri Abhyankar +  ts - time stepping context
5472a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5473a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
54749c6b16b5SShri Abhyankar 
54759c6b16b5SShri Abhyankar    Output Arguments:
54769c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
54779c6b16b5SShri Abhyankar 
54789c6b16b5SShri Abhyankar    Level: developer
54799c6b16b5SShri Abhyankar 
5480deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
54819c6b16b5SShri Abhyankar @*/
5482a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm)
54839c6b16b5SShri Abhyankar {
54849c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
54859c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart,k;
54869c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
54879c6b16b5SShri Abhyankar   PetscReal         max,gmax;
54889c6b16b5SShri Abhyankar   PetscReal         tol;
54899c6b16b5SShri Abhyankar 
54909c6b16b5SShri Abhyankar   PetscFunctionBegin;
54919c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5492a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5493a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5494a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5495a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5496a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5497a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5498a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
54999c6b16b5SShri Abhyankar 
55009c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
55019c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
55029c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
55039c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
55049c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
55059c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
55069c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
55079c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
55089c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
55099c6b16b5SShri Abhyankar     k = 0;
55109c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
55119c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
55129c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
55139c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55149c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
55159c6b16b5SShri Abhyankar     }
55169c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
55179c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
55189c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
55199c6b16b5SShri Abhyankar     const PetscScalar *atol;
55209c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
55219c6b16b5SShri Abhyankar     k = 0;
55229c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
55239c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
55249c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
55259c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55269c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
55279c6b16b5SShri Abhyankar     }
55289c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
55299c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
55309c6b16b5SShri Abhyankar     const PetscScalar *rtol;
55319c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
55329c6b16b5SShri Abhyankar     k = 0;
55339c6b16b5SShri Abhyankar     tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
55349c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
55359c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
55369c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55379c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
55389c6b16b5SShri Abhyankar     }
55399c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
55409c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
55419c6b16b5SShri Abhyankar     k = 0;
55429c6b16b5SShri Abhyankar     tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
55439c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
55449c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
55459c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55469c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
55479c6b16b5SShri Abhyankar     }
55489c6b16b5SShri Abhyankar   }
55499c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
55509c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
55519c6b16b5SShri Abhyankar 
5552b2566f29SBarry Smith   ierr  = MPIU_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
55539c6b16b5SShri Abhyankar   *norm = gmax;
55549c6b16b5SShri Abhyankar 
55559c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
55569c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
55579c6b16b5SShri Abhyankar }
55589c6b16b5SShri Abhyankar 
55599c6b16b5SShri Abhyankar #undef __FUNCT__
55607619abb3SShri #define __FUNCT__ "TSErrorWeightedNorm"
55611c3436cfSJed Brown /*@
5562a4868fbcSLisandro Dalcin    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors
55631c3436cfSJed Brown 
55641c3436cfSJed Brown    Collective on TS
55651c3436cfSJed Brown 
55661c3436cfSJed Brown    Input Arguments:
55671c3436cfSJed Brown +  ts - time stepping context
5568a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5569a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
5570a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
55717619abb3SShri 
55721c3436cfSJed Brown    Output Arguments:
55731c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
55741c3436cfSJed Brown 
5575a4868fbcSLisandro Dalcin 
5576a4868fbcSLisandro Dalcin    Options Database Keys:
5577a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5578a4868fbcSLisandro Dalcin 
55791c3436cfSJed Brown    Level: developer
55801c3436cfSJed Brown 
5581deea92deSShri .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
55821c3436cfSJed Brown @*/
5583a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm)
55841c3436cfSJed Brown {
55858beabaa1SBarry Smith   PetscErrorCode ierr;
55861c3436cfSJed Brown 
55871c3436cfSJed Brown   PetscFunctionBegin;
5588a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
5589a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNorm2(ts,U,Y,norm);CHKERRQ(ierr);
5590a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
5591a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm);CHKERRQ(ierr);
5592a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
55931c3436cfSJed Brown   PetscFunctionReturn(0);
55941c3436cfSJed Brown }
55951c3436cfSJed Brown 
55961c3436cfSJed Brown #undef __FUNCT__
55978d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
55988d59e960SJed Brown /*@
55998d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
56008d59e960SJed Brown 
56018d59e960SJed Brown    Logically Collective on TS
56028d59e960SJed Brown 
56038d59e960SJed Brown    Input Arguments:
56048d59e960SJed Brown +  ts - time stepping context
56058d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
56068d59e960SJed Brown 
56078d59e960SJed Brown    Note:
56088d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
56098d59e960SJed Brown 
56108d59e960SJed Brown    Level: intermediate
56118d59e960SJed Brown 
56128d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
56138d59e960SJed Brown @*/
56148d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
56158d59e960SJed Brown {
56168d59e960SJed Brown   PetscFunctionBegin;
56178d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
56188d59e960SJed Brown   ts->cfltime_local = cfltime;
56198d59e960SJed Brown   ts->cfltime       = -1.;
56208d59e960SJed Brown   PetscFunctionReturn(0);
56218d59e960SJed Brown }
56228d59e960SJed Brown 
56238d59e960SJed Brown #undef __FUNCT__
56248d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
56258d59e960SJed Brown /*@
56268d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
56278d59e960SJed Brown 
56288d59e960SJed Brown    Collective on TS
56298d59e960SJed Brown 
56308d59e960SJed Brown    Input Arguments:
56318d59e960SJed Brown .  ts - time stepping context
56328d59e960SJed Brown 
56338d59e960SJed Brown    Output Arguments:
56348d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
56358d59e960SJed Brown 
56368d59e960SJed Brown    Level: advanced
56378d59e960SJed Brown 
56388d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
56398d59e960SJed Brown @*/
56408d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
56418d59e960SJed Brown {
56428d59e960SJed Brown   PetscErrorCode ierr;
56438d59e960SJed Brown 
56448d59e960SJed Brown   PetscFunctionBegin;
56458d59e960SJed Brown   if (ts->cfltime < 0) {
5646b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
56478d59e960SJed Brown   }
56488d59e960SJed Brown   *cfltime = ts->cfltime;
56498d59e960SJed Brown   PetscFunctionReturn(0);
56508d59e960SJed Brown }
56518d59e960SJed Brown 
56528d59e960SJed Brown #undef __FUNCT__
5653d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
5654d6ebe24aSShri Abhyankar /*@
5655d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5656d6ebe24aSShri Abhyankar 
5657d6ebe24aSShri Abhyankar    Input Parameters:
5658d6ebe24aSShri Abhyankar .  ts   - the TS context.
5659d6ebe24aSShri Abhyankar .  xl   - lower bound.
5660d6ebe24aSShri Abhyankar .  xu   - upper bound.
5661d6ebe24aSShri Abhyankar 
5662d6ebe24aSShri Abhyankar    Notes:
5663d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
5664e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
5665d6ebe24aSShri Abhyankar 
56662bd2b0e6SSatish Balay    Level: advanced
56672bd2b0e6SSatish Balay 
5668d6ebe24aSShri Abhyankar @*/
5669d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5670d6ebe24aSShri Abhyankar {
5671d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
5672d6ebe24aSShri Abhyankar   SNES           snes;
5673d6ebe24aSShri Abhyankar 
5674d6ebe24aSShri Abhyankar   PetscFunctionBegin;
5675d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5676d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
5677d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
5678d6ebe24aSShri Abhyankar }
5679d6ebe24aSShri Abhyankar 
5680325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
5681c6db04a5SJed Brown #include <mex.h>
5682325fc9f4SBarry Smith 
5683325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
5684325fc9f4SBarry Smith 
5685325fc9f4SBarry Smith #undef __FUNCT__
5686325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
5687325fc9f4SBarry Smith /*
5688325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
5689325fc9f4SBarry Smith                          TSSetFunctionMatlab().
5690325fc9f4SBarry Smith 
5691325fc9f4SBarry Smith    Collective on TS
5692325fc9f4SBarry Smith 
5693325fc9f4SBarry Smith    Input Parameters:
5694325fc9f4SBarry Smith +  snes - the TS context
56950910c330SBarry Smith -  u - input vector
5696325fc9f4SBarry Smith 
5697325fc9f4SBarry Smith    Output Parameter:
5698325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
5699325fc9f4SBarry Smith 
5700325fc9f4SBarry Smith    Notes:
5701325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
5702325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
5703325fc9f4SBarry Smith    themselves.
5704325fc9f4SBarry Smith 
5705325fc9f4SBarry Smith    Level: developer
5706325fc9f4SBarry Smith 
5707325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5708325fc9f4SBarry Smith 
5709325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5710325fc9f4SBarry Smith */
57110910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
5712325fc9f4SBarry Smith {
5713325fc9f4SBarry Smith   PetscErrorCode  ierr;
5714325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5715325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
5716325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
5717325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
5718325fc9f4SBarry Smith 
5719325fc9f4SBarry Smith   PetscFunctionBegin;
5720325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
57210910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
57220910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
5723325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
57240910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
5725325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
5726325fc9f4SBarry Smith 
5727325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
57280910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
57290910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
57300910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
5731bbd56ea5SKarl Rupp 
5732325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5733325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
5734325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5735325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5736325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
5737325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
5738325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
5739325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
5740325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5741325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5742325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5743325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5744325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5745325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5746325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5747325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5748325fc9f4SBarry Smith   PetscFunctionReturn(0);
5749325fc9f4SBarry Smith }
5750325fc9f4SBarry Smith 
5751325fc9f4SBarry Smith 
5752325fc9f4SBarry Smith #undef __FUNCT__
5753325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
5754325fc9f4SBarry Smith /*
5755325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
5756325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
5757e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
5758325fc9f4SBarry Smith 
5759325fc9f4SBarry Smith    Logically Collective on TS
5760325fc9f4SBarry Smith 
5761325fc9f4SBarry Smith    Input Parameters:
5762325fc9f4SBarry Smith +  ts - the TS context
5763325fc9f4SBarry Smith -  func - function evaluation routine
5764325fc9f4SBarry Smith 
5765325fc9f4SBarry Smith    Calling sequence of func:
57660910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
5767325fc9f4SBarry Smith 
5768325fc9f4SBarry Smith    Level: beginner
5769325fc9f4SBarry Smith 
5770325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5771325fc9f4SBarry Smith 
5772325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5773325fc9f4SBarry Smith */
5774cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
5775325fc9f4SBarry Smith {
5776325fc9f4SBarry Smith   PetscErrorCode  ierr;
5777325fc9f4SBarry Smith   TSMatlabContext *sctx;
5778325fc9f4SBarry Smith 
5779325fc9f4SBarry Smith   PetscFunctionBegin;
5780325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5781325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5782325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5783325fc9f4SBarry Smith   /*
5784325fc9f4SBarry Smith      This should work, but it doesn't
5785325fc9f4SBarry Smith   sctx->ctx = ctx;
5786325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5787325fc9f4SBarry Smith   */
5788325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5789bbd56ea5SKarl Rupp 
57900298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
5791325fc9f4SBarry Smith   PetscFunctionReturn(0);
5792325fc9f4SBarry Smith }
5793325fc9f4SBarry Smith 
5794325fc9f4SBarry Smith #undef __FUNCT__
5795325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
5796325fc9f4SBarry Smith /*
5797325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
5798325fc9f4SBarry Smith                          TSSetJacobianMatlab().
5799325fc9f4SBarry Smith 
5800325fc9f4SBarry Smith    Collective on TS
5801325fc9f4SBarry Smith 
5802325fc9f4SBarry Smith    Input Parameters:
5803cdcf91faSSean Farley +  ts - the TS context
58040910c330SBarry Smith .  u - input vector
5805325fc9f4SBarry Smith .  A, B - the matrices
5806325fc9f4SBarry Smith -  ctx - user context
5807325fc9f4SBarry Smith 
5808325fc9f4SBarry Smith    Level: developer
5809325fc9f4SBarry Smith 
5810325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5811325fc9f4SBarry Smith 
5812325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5813325fc9f4SBarry Smith @*/
5814f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
5815325fc9f4SBarry Smith {
5816325fc9f4SBarry Smith   PetscErrorCode  ierr;
5817325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5818325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
5819325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
5820325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
5821325fc9f4SBarry Smith 
5822325fc9f4SBarry Smith   PetscFunctionBegin;
5823cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
58240910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5825325fc9f4SBarry Smith 
58260910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
5827325fc9f4SBarry Smith 
5828cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
58290910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
58300910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
58310910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
58320910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
5833bbd56ea5SKarl Rupp 
5834325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5835325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
5836325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5837325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5838325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
5839325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
5840325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
5841325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
5842325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
5843325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
5844325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5845325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5846325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5847325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5848325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5849325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5850325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5851325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
5852325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
5853325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5854325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
5855325fc9f4SBarry Smith   PetscFunctionReturn(0);
5856325fc9f4SBarry Smith }
5857325fc9f4SBarry Smith 
5858325fc9f4SBarry Smith 
5859325fc9f4SBarry Smith #undef __FUNCT__
5860325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
5861325fc9f4SBarry Smith /*
5862325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
5863e3c5b3baSBarry 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
5864325fc9f4SBarry Smith 
5865325fc9f4SBarry Smith    Logically Collective on TS
5866325fc9f4SBarry Smith 
5867325fc9f4SBarry Smith    Input Parameters:
5868cdcf91faSSean Farley +  ts - the TS context
5869325fc9f4SBarry Smith .  A,B - Jacobian matrices
5870325fc9f4SBarry Smith .  func - function evaluation routine
5871325fc9f4SBarry Smith -  ctx - user context
5872325fc9f4SBarry Smith 
5873325fc9f4SBarry Smith    Calling sequence of func:
58740910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
5875325fc9f4SBarry Smith 
5876325fc9f4SBarry Smith 
5877325fc9f4SBarry Smith    Level: developer
5878325fc9f4SBarry Smith 
5879325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5880325fc9f4SBarry Smith 
5881325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5882325fc9f4SBarry Smith */
5883cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
5884325fc9f4SBarry Smith {
5885325fc9f4SBarry Smith   PetscErrorCode  ierr;
5886325fc9f4SBarry Smith   TSMatlabContext *sctx;
5887325fc9f4SBarry Smith 
5888325fc9f4SBarry Smith   PetscFunctionBegin;
5889325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5890325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5891325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5892325fc9f4SBarry Smith   /*
5893325fc9f4SBarry Smith      This should work, but it doesn't
5894325fc9f4SBarry Smith   sctx->ctx = ctx;
5895325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5896325fc9f4SBarry Smith   */
5897325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5898bbd56ea5SKarl Rupp 
5899cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
5900325fc9f4SBarry Smith   PetscFunctionReturn(0);
5901325fc9f4SBarry Smith }
5902325fc9f4SBarry Smith 
5903b5b1a830SBarry Smith #undef __FUNCT__
5904b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
5905b5b1a830SBarry Smith /*
5906b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
5907b5b1a830SBarry Smith 
5908b5b1a830SBarry Smith    Collective on TS
5909b5b1a830SBarry Smith 
5910b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5911b5b1a830SBarry Smith @*/
59120910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
5913b5b1a830SBarry Smith {
5914b5b1a830SBarry Smith   PetscErrorCode  ierr;
5915b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5916a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
5917b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
5918b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
5919b5b1a830SBarry Smith 
5920b5b1a830SBarry Smith   PetscFunctionBegin;
5921cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
59220910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
5923b5b1a830SBarry Smith 
5924cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
59250910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5926bbd56ea5SKarl Rupp 
5927b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5928b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
5929b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
5930b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
5931b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
5932b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
5933b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
5934b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5935b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
5936b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
5937b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
5938b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
5939b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
5940b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
5941b5b1a830SBarry Smith   PetscFunctionReturn(0);
5942b5b1a830SBarry Smith }
5943b5b1a830SBarry Smith 
5944b5b1a830SBarry Smith 
5945b5b1a830SBarry Smith #undef __FUNCT__
5946b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
5947b5b1a830SBarry Smith /*
5948b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
5949b5b1a830SBarry Smith 
5950b5b1a830SBarry Smith    Level: developer
5951b5b1a830SBarry Smith 
5952b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
5953b5b1a830SBarry Smith 
5954b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5955b5b1a830SBarry Smith */
5956cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
5957b5b1a830SBarry Smith {
5958b5b1a830SBarry Smith   PetscErrorCode  ierr;
5959b5b1a830SBarry Smith   TSMatlabContext *sctx;
5960b5b1a830SBarry Smith 
5961b5b1a830SBarry Smith   PetscFunctionBegin;
5962b5b1a830SBarry Smith   /* currently sctx is memory bleed */
5963b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5964b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5965b5b1a830SBarry Smith   /*
5966b5b1a830SBarry Smith      This should work, but it doesn't
5967b5b1a830SBarry Smith   sctx->ctx = ctx;
5968b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5969b5b1a830SBarry Smith   */
5970b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5971bbd56ea5SKarl Rupp 
59720298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5973b5b1a830SBarry Smith   PetscFunctionReturn(0);
5974b5b1a830SBarry Smith }
5975325fc9f4SBarry Smith #endif
5976b3603a34SBarry Smith 
5977b3603a34SBarry Smith #undef __FUNCT__
59784f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
5979b3603a34SBarry Smith /*@C
59804f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5981b3603a34SBarry Smith        in a time based line graph
5982b3603a34SBarry Smith 
5983b3603a34SBarry Smith    Collective on TS
5984b3603a34SBarry Smith 
5985b3603a34SBarry Smith    Input Parameters:
5986b3603a34SBarry Smith +  ts - the TS context
5987b3603a34SBarry Smith .  step - current time-step
5988b3603a34SBarry Smith .  ptime - current time
59897db568b7SBarry Smith .  u - current solution
59907db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
5991b3603a34SBarry Smith 
5992b3d3934dSBarry Smith    Options Database:
59939ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
5994b3d3934dSBarry Smith 
5995b3603a34SBarry Smith    Level: intermediate
5996b3603a34SBarry Smith 
59976934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component solutions in a separate window
5998b3603a34SBarry Smith 
5999b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
6000b3603a34SBarry Smith 
60017db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
60027db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
60037db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
60047db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
6005b3603a34SBarry Smith @*/
60067db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6007b3603a34SBarry Smith {
6008b3603a34SBarry Smith   PetscErrorCode    ierr;
60097db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
6010b3603a34SBarry Smith   const PetscScalar *yy;
601180666b62SBarry Smith   Vec               v;
6012b3603a34SBarry Smith 
6013b3603a34SBarry Smith   PetscFunctionBegin;
601463e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
601558ff32f7SBarry Smith   if (!step) {
6016a9f9c1f6SBarry Smith     PetscDrawAxis axis;
60176934998bSLisandro Dalcin     PetscInt      dim;
6018a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6019a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
6020387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
6021387f4636SBarry Smith       char      **displaynames;
6022387f4636SBarry Smith       PetscBool flg;
6023387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6024387f4636SBarry Smith       ierr = PetscMalloc((dim+1)*sizeof(char*),&displaynames);CHKERRQ(ierr);
6025387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
6026c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
6027387f4636SBarry Smith       if (flg) {
6028a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
6029387f4636SBarry Smith       }
6030387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
6031387f4636SBarry Smith     }
6032387f4636SBarry Smith     if (ctx->displaynames) {
6033387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
6034387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
6035387f4636SBarry Smith     } else if (ctx->names) {
60360910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
60370b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6038387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
6039b0bc92c6SBarry Smith     } else {
6040b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6041b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6042387f4636SBarry Smith     }
60430b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
604458ff32f7SBarry Smith   }
60456934998bSLisandro Dalcin 
60466934998bSLisandro Dalcin   if (!ctx->transform) v = u;
60476934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
604880666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
60496934998bSLisandro Dalcin   if (ctx->displaynames) {
60506934998bSLisandro Dalcin     PetscInt i;
60516934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
60526934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
60536934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
60546934998bSLisandro Dalcin   } else {
6055e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6056e3efe391SJed Brown     PetscInt  i,n;
60576934998bSLisandro Dalcin     PetscReal *yreal;
605880666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
6059785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6060e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
60610b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6062e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6063e3efe391SJed Brown #else
60640b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6065e3efe391SJed Brown #endif
606680666b62SBarry Smith   }
60676934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
60686934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
60696934998bSLisandro Dalcin 
6070b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
60710b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
60726934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
60733923b477SBarry Smith   }
6074b3603a34SBarry Smith   PetscFunctionReturn(0);
6075b3603a34SBarry Smith }
6076b3603a34SBarry Smith 
6077387f4636SBarry Smith 
6078b3603a34SBarry Smith #undef __FUNCT__
607931152f8aSBarry Smith #define __FUNCT__ "TSMonitorLGSetVariableNames"
6080b037adc7SBarry Smith /*@C
608131152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6082b037adc7SBarry Smith 
6083b037adc7SBarry Smith    Collective on TS
6084b037adc7SBarry Smith 
6085b037adc7SBarry Smith    Input Parameters:
6086b037adc7SBarry Smith +  ts - the TS context
6087b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
6088b037adc7SBarry Smith 
6089b037adc7SBarry Smith    Level: intermediate
6090b037adc7SBarry Smith 
60917db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
60927db568b7SBarry Smith 
6093b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
6094b037adc7SBarry Smith 
6095a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
6096b037adc7SBarry Smith @*/
609731152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
6098b037adc7SBarry Smith {
6099b037adc7SBarry Smith   PetscErrorCode    ierr;
6100b037adc7SBarry Smith   PetscInt          i;
6101b037adc7SBarry Smith 
6102b037adc7SBarry Smith   PetscFunctionBegin;
6103b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6104b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
61055537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
6106b3d3934dSBarry Smith       break;
6107b3d3934dSBarry Smith     }
6108b3d3934dSBarry Smith   }
6109b3d3934dSBarry Smith   PetscFunctionReturn(0);
6110b3d3934dSBarry Smith }
6111b3d3934dSBarry Smith 
6112b3d3934dSBarry Smith #undef __FUNCT__
6113e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetVariableNames"
6114e673d494SBarry Smith /*@C
6115e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6116e673d494SBarry Smith 
6117e673d494SBarry Smith    Collective on TS
6118e673d494SBarry Smith 
6119e673d494SBarry Smith    Input Parameters:
6120e673d494SBarry Smith +  ts - the TS context
6121e673d494SBarry Smith -  names - the names of the components, final string must be NULL
6122e673d494SBarry Smith 
6123e673d494SBarry Smith    Level: intermediate
6124e673d494SBarry Smith 
6125e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6126e673d494SBarry Smith 
6127a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
6128e673d494SBarry Smith @*/
6129e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
6130e673d494SBarry Smith {
6131e673d494SBarry Smith   PetscErrorCode    ierr;
6132e673d494SBarry Smith 
6133e673d494SBarry Smith   PetscFunctionBegin;
6134e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
6135e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
6136e673d494SBarry Smith   PetscFunctionReturn(0);
6137e673d494SBarry Smith }
6138e673d494SBarry Smith 
6139e673d494SBarry Smith #undef __FUNCT__
6140b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorLGGetVariableNames"
6141b3d3934dSBarry Smith /*@C
6142b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
6143b3d3934dSBarry Smith 
6144b3d3934dSBarry Smith    Collective on TS
6145b3d3934dSBarry Smith 
6146b3d3934dSBarry Smith    Input Parameter:
6147b3d3934dSBarry Smith .  ts - the TS context
6148b3d3934dSBarry Smith 
6149b3d3934dSBarry Smith    Output Parameter:
6150b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
6151b3d3934dSBarry Smith 
6152b3d3934dSBarry Smith    Level: intermediate
6153b3d3934dSBarry Smith 
61547db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
61557db568b7SBarry Smith 
6156b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6157b3d3934dSBarry Smith 
6158b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6159b3d3934dSBarry Smith @*/
6160b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
6161b3d3934dSBarry Smith {
6162b3d3934dSBarry Smith   PetscInt       i;
6163b3d3934dSBarry Smith 
6164b3d3934dSBarry Smith   PetscFunctionBegin;
6165b3d3934dSBarry Smith   *names = NULL;
6166b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6167b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
61685537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
6169b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
6170b3d3934dSBarry Smith       break;
6171387f4636SBarry Smith     }
6172387f4636SBarry Smith   }
6173387f4636SBarry Smith   PetscFunctionReturn(0);
6174387f4636SBarry Smith }
6175387f4636SBarry Smith 
6176387f4636SBarry Smith #undef __FUNCT__
6177a66092f1SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables"
6178a66092f1SBarry Smith /*@C
6179a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
6180a66092f1SBarry Smith 
6181a66092f1SBarry Smith    Collective on TS
6182a66092f1SBarry Smith 
6183a66092f1SBarry Smith    Input Parameters:
6184a66092f1SBarry Smith +  ctx - the TSMonitorLG context
6185a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
6186a66092f1SBarry Smith 
6187a66092f1SBarry Smith    Level: intermediate
6188a66092f1SBarry Smith 
6189a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
6190a66092f1SBarry Smith 
6191a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6192a66092f1SBarry Smith @*/
6193a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6194a66092f1SBarry Smith {
6195a66092f1SBarry Smith   PetscInt          j = 0,k;
6196a66092f1SBarry Smith   PetscErrorCode    ierr;
6197a66092f1SBarry Smith 
6198a66092f1SBarry Smith   PetscFunctionBegin;
6199a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6200a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6201a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6202a66092f1SBarry Smith   while (displaynames[j]) j++;
6203a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6204a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6205a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6206a66092f1SBarry Smith   j = 0;
6207a66092f1SBarry Smith   while (displaynames[j]) {
6208a66092f1SBarry Smith     k = 0;
6209a66092f1SBarry Smith     while (ctx->names[k]) {
6210a66092f1SBarry Smith       PetscBool flg;
6211a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6212a66092f1SBarry Smith       if (flg) {
6213a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6214a66092f1SBarry Smith         break;
6215a66092f1SBarry Smith       }
6216a66092f1SBarry Smith       k++;
6217a66092f1SBarry Smith     }
6218a66092f1SBarry Smith     j++;
6219a66092f1SBarry Smith   }
6220a66092f1SBarry Smith   PetscFunctionReturn(0);
6221a66092f1SBarry Smith }
6222a66092f1SBarry Smith 
6223a66092f1SBarry Smith 
6224a66092f1SBarry Smith #undef __FUNCT__
6225387f4636SBarry Smith #define __FUNCT__ "TSMonitorLGSetDisplayVariables"
6226387f4636SBarry Smith /*@C
6227387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6228387f4636SBarry Smith 
6229387f4636SBarry Smith    Collective on TS
6230387f4636SBarry Smith 
6231387f4636SBarry Smith    Input Parameters:
6232387f4636SBarry Smith +  ts - the TS context
6233387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
6234387f4636SBarry Smith 
62357db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
62367db568b7SBarry Smith 
6237387f4636SBarry Smith    Level: intermediate
6238387f4636SBarry Smith 
6239387f4636SBarry Smith .keywords: TS,  vector, monitor, view
6240387f4636SBarry Smith 
6241387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6242387f4636SBarry Smith @*/
6243387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6244387f4636SBarry Smith {
6245a66092f1SBarry Smith   PetscInt          i;
6246387f4636SBarry Smith   PetscErrorCode    ierr;
6247387f4636SBarry Smith 
6248387f4636SBarry Smith   PetscFunctionBegin;
6249387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6250387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
62515537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6252b3d3934dSBarry Smith       break;
6253b037adc7SBarry Smith     }
6254b037adc7SBarry Smith   }
6255b037adc7SBarry Smith   PetscFunctionReturn(0);
6256b037adc7SBarry Smith }
6257b037adc7SBarry Smith 
6258b037adc7SBarry Smith #undef __FUNCT__
625980666b62SBarry Smith #define __FUNCT__ "TSMonitorLGSetTransform"
626080666b62SBarry Smith /*@C
626180666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
626280666b62SBarry Smith 
626380666b62SBarry Smith    Collective on TS
626480666b62SBarry Smith 
626580666b62SBarry Smith    Input Parameters:
626680666b62SBarry Smith +  ts - the TS context
626780666b62SBarry Smith .  transform - the transform function
62687684fa3eSBarry Smith .  destroy - function to destroy the optional context
626980666b62SBarry Smith -  ctx - optional context used by transform function
627080666b62SBarry Smith 
62717db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
62727db568b7SBarry Smith 
627380666b62SBarry Smith    Level: intermediate
627480666b62SBarry Smith 
627580666b62SBarry Smith .keywords: TS,  vector, monitor, view
627680666b62SBarry Smith 
6277a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
627880666b62SBarry Smith @*/
62797684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
628080666b62SBarry Smith {
628180666b62SBarry Smith   PetscInt          i;
6282a66092f1SBarry Smith   PetscErrorCode    ierr;
628380666b62SBarry Smith 
628480666b62SBarry Smith   PetscFunctionBegin;
628580666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
628680666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
62875537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
628880666b62SBarry Smith     }
628980666b62SBarry Smith   }
629080666b62SBarry Smith   PetscFunctionReturn(0);
629180666b62SBarry Smith }
629280666b62SBarry Smith 
629380666b62SBarry Smith #undef __FUNCT__
6294e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetTransform"
6295e673d494SBarry Smith /*@C
6296e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6297e673d494SBarry Smith 
6298e673d494SBarry Smith    Collective on TSLGCtx
6299e673d494SBarry Smith 
6300e673d494SBarry Smith    Input Parameters:
6301e673d494SBarry Smith +  ts - the TS context
6302e673d494SBarry Smith .  transform - the transform function
63037684fa3eSBarry Smith .  destroy - function to destroy the optional context
6304e673d494SBarry Smith -  ctx - optional context used by transform function
6305e673d494SBarry Smith 
6306e673d494SBarry Smith    Level: intermediate
6307e673d494SBarry Smith 
6308e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6309e673d494SBarry Smith 
6310a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6311e673d494SBarry Smith @*/
63127684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6313e673d494SBarry Smith {
6314e673d494SBarry Smith   PetscFunctionBegin;
6315e673d494SBarry Smith   ctx->transform    = transform;
63167684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6317e673d494SBarry Smith   ctx->transformctx = tctx;
6318e673d494SBarry Smith   PetscFunctionReturn(0);
6319e673d494SBarry Smith }
6320e673d494SBarry Smith 
6321b3603a34SBarry Smith #undef __FUNCT__
63224f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
6323ef20d060SBarry Smith /*@C
63244f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
6325ef20d060SBarry Smith        in a time based line graph
6326ef20d060SBarry Smith 
6327ef20d060SBarry Smith    Collective on TS
6328ef20d060SBarry Smith 
6329ef20d060SBarry Smith    Input Parameters:
6330ef20d060SBarry Smith +  ts - the TS context
6331ef20d060SBarry Smith .  step - current time-step
6332ef20d060SBarry Smith .  ptime - current time
63337db568b7SBarry Smith .  u - current solution
63347db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6335ef20d060SBarry Smith 
6336ef20d060SBarry Smith    Level: intermediate
6337ef20d060SBarry Smith 
63386934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component errors in a separate window
6339abd5a294SJed Brown 
6340abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6341abd5a294SJed Brown 
6342abd5a294SJed Brown    Options Database Keys:
63434f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6344ef20d060SBarry Smith 
6345ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
6346ef20d060SBarry Smith 
6347abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6348ef20d060SBarry Smith @*/
63490910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6350ef20d060SBarry Smith {
6351ef20d060SBarry Smith   PetscErrorCode    ierr;
63520b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6353ef20d060SBarry Smith   const PetscScalar *yy;
6354ef20d060SBarry Smith   Vec               y;
6355ef20d060SBarry Smith 
6356ef20d060SBarry Smith   PetscFunctionBegin;
6357a9f9c1f6SBarry Smith   if (!step) {
6358a9f9c1f6SBarry Smith     PetscDrawAxis axis;
63596934998bSLisandro Dalcin     PetscInt      dim;
6360a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
63611ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
63620910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6363a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6364a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6365a9f9c1f6SBarry Smith   }
63660910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6367ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
63680910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6369ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6370e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6371e3efe391SJed Brown   {
6372e3efe391SJed Brown     PetscReal *yreal;
6373e3efe391SJed Brown     PetscInt  i,n;
6374e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6375785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6376e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
63770b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6378e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6379e3efe391SJed Brown   }
6380e3efe391SJed Brown #else
63810b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6382e3efe391SJed Brown #endif
6383ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6384ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6385b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
63860b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
63876934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
63883923b477SBarry Smith   }
6389ef20d060SBarry Smith   PetscFunctionReturn(0);
6390ef20d060SBarry Smith }
6391ef20d060SBarry Smith 
6392201da799SBarry Smith #undef __FUNCT__
6393201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
6394201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6395201da799SBarry Smith {
6396201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6397201da799SBarry Smith   PetscReal      x   = ptime,y;
6398201da799SBarry Smith   PetscErrorCode ierr;
6399201da799SBarry Smith   PetscInt       its;
6400201da799SBarry Smith 
6401201da799SBarry Smith   PetscFunctionBegin;
640263e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
6403201da799SBarry Smith   if (!n) {
6404201da799SBarry Smith     PetscDrawAxis axis;
6405201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6406201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
6407201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6408201da799SBarry Smith     ctx->snes_its = 0;
6409201da799SBarry Smith   }
6410201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
6411201da799SBarry Smith   y    = its - ctx->snes_its;
6412201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
64133fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6414201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
64156934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
6416201da799SBarry Smith   }
6417201da799SBarry Smith   ctx->snes_its = its;
6418201da799SBarry Smith   PetscFunctionReturn(0);
6419201da799SBarry Smith }
6420201da799SBarry Smith 
6421201da799SBarry Smith #undef __FUNCT__
6422201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
6423201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6424201da799SBarry Smith {
6425201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6426201da799SBarry Smith   PetscReal      x   = ptime,y;
6427201da799SBarry Smith   PetscErrorCode ierr;
6428201da799SBarry Smith   PetscInt       its;
6429201da799SBarry Smith 
6430201da799SBarry Smith   PetscFunctionBegin;
643163e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
6432201da799SBarry Smith   if (!n) {
6433201da799SBarry Smith     PetscDrawAxis axis;
6434201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6435201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
6436201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6437201da799SBarry Smith     ctx->ksp_its = 0;
6438201da799SBarry Smith   }
6439201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
6440201da799SBarry Smith   y    = its - ctx->ksp_its;
6441201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
644299fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6443201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
64446934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
6445201da799SBarry Smith   }
6446201da799SBarry Smith   ctx->ksp_its = its;
6447201da799SBarry Smith   PetscFunctionReturn(0);
6448201da799SBarry Smith }
6449f9c1d6abSBarry Smith 
6450f9c1d6abSBarry Smith #undef __FUNCT__
6451f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
6452f9c1d6abSBarry Smith /*@
6453f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
6454f9c1d6abSBarry Smith 
6455f9c1d6abSBarry Smith    Collective on TS and Vec
6456f9c1d6abSBarry Smith 
6457f9c1d6abSBarry Smith    Input Parameters:
6458f9c1d6abSBarry Smith +  ts - the TS context
6459f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
6460f9c1d6abSBarry Smith 
6461f9c1d6abSBarry Smith    Output Parameters:
6462f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
6463f9c1d6abSBarry Smith 
6464f9c1d6abSBarry Smith    Level: developer
6465f9c1d6abSBarry Smith 
6466f9c1d6abSBarry Smith .keywords: TS, compute
6467f9c1d6abSBarry Smith 
6468f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
6469f9c1d6abSBarry Smith @*/
6470f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
6471f9c1d6abSBarry Smith {
6472f9c1d6abSBarry Smith   PetscErrorCode ierr;
6473f9c1d6abSBarry Smith 
6474f9c1d6abSBarry Smith   PetscFunctionBegin;
6475f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6476ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
6477f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
6478f9c1d6abSBarry Smith   PetscFunctionReturn(0);
6479f9c1d6abSBarry Smith }
648024655328SShri 
6481b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
6482b3d3934dSBarry Smith #undef __FUNCT__
6483b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxCreate"
6484b3d3934dSBarry Smith /*@C
6485b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
6486b3d3934dSBarry Smith 
6487b3d3934dSBarry Smith    Collective on TS
6488b3d3934dSBarry Smith 
6489b3d3934dSBarry Smith    Input Parameters:
6490b3d3934dSBarry Smith .  ts  - the ODE solver object
6491b3d3934dSBarry Smith 
6492b3d3934dSBarry Smith    Output Parameter:
6493b3d3934dSBarry Smith .  ctx - the context
6494b3d3934dSBarry Smith 
6495b3d3934dSBarry Smith    Level: intermediate
6496b3d3934dSBarry Smith 
6497b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
6498b3d3934dSBarry Smith 
6499b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
6500b3d3934dSBarry Smith 
6501b3d3934dSBarry Smith @*/
6502b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
6503b3d3934dSBarry Smith {
6504b3d3934dSBarry Smith   PetscErrorCode ierr;
6505b3d3934dSBarry Smith 
6506b3d3934dSBarry Smith   PetscFunctionBegin;
6507a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
6508b3d3934dSBarry Smith   PetscFunctionReturn(0);
6509b3d3934dSBarry Smith }
6510b3d3934dSBarry Smith 
6511b3d3934dSBarry Smith #undef __FUNCT__
6512b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelope"
6513b3d3934dSBarry Smith /*@C
6514b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
6515b3d3934dSBarry Smith 
6516b3d3934dSBarry Smith    Collective on TS
6517b3d3934dSBarry Smith 
6518b3d3934dSBarry Smith    Input Parameters:
6519b3d3934dSBarry Smith +  ts - the TS context
6520b3d3934dSBarry Smith .  step - current time-step
6521b3d3934dSBarry Smith .  ptime - current time
65227db568b7SBarry Smith .  u  - current solution
65237db568b7SBarry Smith -  dctx - the envelope context
6524b3d3934dSBarry Smith 
6525b3d3934dSBarry Smith    Options Database:
6526b3d3934dSBarry Smith .  -ts_monitor_envelope
6527b3d3934dSBarry Smith 
6528b3d3934dSBarry Smith    Level: intermediate
6529b3d3934dSBarry Smith 
6530b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
6531b3d3934dSBarry Smith 
6532b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6533b3d3934dSBarry Smith 
65347db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
6535b3d3934dSBarry Smith @*/
65367db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6537b3d3934dSBarry Smith {
6538b3d3934dSBarry Smith   PetscErrorCode       ierr;
65397db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
6540b3d3934dSBarry Smith 
6541b3d3934dSBarry Smith   PetscFunctionBegin;
6542b3d3934dSBarry Smith   if (!ctx->max) {
6543b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
6544b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
6545b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
6546b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
6547b3d3934dSBarry Smith   } else {
6548b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
6549b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
6550b3d3934dSBarry Smith   }
6551b3d3934dSBarry Smith   PetscFunctionReturn(0);
6552b3d3934dSBarry Smith }
6553b3d3934dSBarry Smith 
6554b3d3934dSBarry Smith 
6555b3d3934dSBarry Smith #undef __FUNCT__
6556b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeGetBounds"
6557b3d3934dSBarry Smith /*@C
6558b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
6559b3d3934dSBarry Smith 
6560b3d3934dSBarry Smith    Collective on TS
6561b3d3934dSBarry Smith 
6562b3d3934dSBarry Smith    Input Parameter:
6563b3d3934dSBarry Smith .  ts - the TS context
6564b3d3934dSBarry Smith 
6565b3d3934dSBarry Smith    Output Parameter:
6566b3d3934dSBarry Smith +  max - the maximum values
6567b3d3934dSBarry Smith -  min - the minimum values
6568b3d3934dSBarry Smith 
65697db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
65707db568b7SBarry Smith 
6571b3d3934dSBarry Smith    Level: intermediate
6572b3d3934dSBarry Smith 
6573b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6574b3d3934dSBarry Smith 
6575b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6576b3d3934dSBarry Smith @*/
6577b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
6578b3d3934dSBarry Smith {
6579b3d3934dSBarry Smith   PetscInt i;
6580b3d3934dSBarry Smith 
6581b3d3934dSBarry Smith   PetscFunctionBegin;
6582b3d3934dSBarry Smith   if (max) *max = NULL;
6583b3d3934dSBarry Smith   if (min) *min = NULL;
6584b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6585b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
65865537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
6587b3d3934dSBarry Smith       if (max) *max = ctx->max;
6588b3d3934dSBarry Smith       if (min) *min = ctx->min;
6589b3d3934dSBarry Smith       break;
6590b3d3934dSBarry Smith     }
6591b3d3934dSBarry Smith   }
6592b3d3934dSBarry Smith   PetscFunctionReturn(0);
6593b3d3934dSBarry Smith }
6594b3d3934dSBarry Smith 
6595b3d3934dSBarry Smith #undef __FUNCT__
6596b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy"
6597b3d3934dSBarry Smith /*@C
6598b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
6599b3d3934dSBarry Smith 
6600b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
6601b3d3934dSBarry Smith 
6602b3d3934dSBarry Smith    Input Parameter:
6603b3d3934dSBarry Smith .  ctx - the monitor context
6604b3d3934dSBarry Smith 
6605b3d3934dSBarry Smith    Level: intermediate
6606b3d3934dSBarry Smith 
6607b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
6608b3d3934dSBarry Smith 
66097db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
6610b3d3934dSBarry Smith @*/
6611b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
6612b3d3934dSBarry Smith {
6613b3d3934dSBarry Smith   PetscErrorCode ierr;
6614b3d3934dSBarry Smith 
6615b3d3934dSBarry Smith   PetscFunctionBegin;
6616b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
6617b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
6618b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
6619b3d3934dSBarry Smith   PetscFunctionReturn(0);
6620b3d3934dSBarry Smith }
6621f2dee214SBarry Smith 
662224655328SShri #undef __FUNCT__
662324655328SShri #define __FUNCT__ "TSRollBack"
662424655328SShri /*@
662524655328SShri    TSRollBack - Rolls back one time step
662624655328SShri 
662724655328SShri    Collective on TS
662824655328SShri 
662924655328SShri    Input Parameter:
663024655328SShri .  ts - the TS context obtained from TSCreate()
663124655328SShri 
663224655328SShri    Level: advanced
663324655328SShri 
663424655328SShri .keywords: TS, timestep, rollback
663524655328SShri 
663624655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
663724655328SShri @*/
663824655328SShri PetscErrorCode  TSRollBack(TS ts)
663924655328SShri {
664024655328SShri   PetscErrorCode ierr;
664124655328SShri 
664224655328SShri   PetscFunctionBegin;
664324655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6644b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
664524655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
664624655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
664724655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
664824655328SShri   ts->ptime = ts->ptime_prev;
6649*be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
6650*be5899b3SLisandro Dalcin   ts->steps--; ts->total_steps--;
6651b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
665224655328SShri   PetscFunctionReturn(0);
665324655328SShri }
6654aeb4809dSShri Abhyankar 
6655ff22ae23SHong Zhang #undef __FUNCT__
6656ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
6657ff22ae23SHong Zhang /*@
6658ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
6659ff22ae23SHong Zhang 
6660ff22ae23SHong Zhang    Input Parameter:
6661ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
6662ff22ae23SHong Zhang 
6663ff22ae23SHong Zhang    Level: advanced
6664ff22ae23SHong Zhang 
6665ff22ae23SHong Zhang .keywords: TS, getstages
6666ff22ae23SHong Zhang 
6667ff22ae23SHong Zhang .seealso: TSCreate()
6668ff22ae23SHong Zhang @*/
6669ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
6670ff22ae23SHong Zhang {
6671ff22ae23SHong Zhang   PetscErrorCode ierr;
6672ff22ae23SHong Zhang 
6673ff22ae23SHong Zhang   PetscFunctionBegin;
6674ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6675ff22ae23SHong Zhang   PetscValidPointer(ns,2);
6676ff22ae23SHong Zhang 
6677ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
6678ff22ae23SHong Zhang   else {
6679ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
6680ff22ae23SHong Zhang   }
6681ff22ae23SHong Zhang   PetscFunctionReturn(0);
6682ff22ae23SHong Zhang }
6683ff22ae23SHong Zhang 
6684847ff0e1SMatthew G. Knepley #undef __FUNCT__
6685847ff0e1SMatthew G. Knepley #define __FUNCT__ "TSComputeIJacobianDefaultColor"
6686847ff0e1SMatthew G. Knepley /*@C
6687847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
6688847ff0e1SMatthew G. Knepley 
6689847ff0e1SMatthew G. Knepley   Collective on SNES
6690847ff0e1SMatthew G. Knepley 
6691847ff0e1SMatthew G. Knepley   Input Parameters:
6692847ff0e1SMatthew G. Knepley + ts - the TS context
6693847ff0e1SMatthew G. Knepley . t - current timestep
6694847ff0e1SMatthew G. Knepley . U - state vector
6695847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
6696847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
6697847ff0e1SMatthew G. Knepley - ctx - an optional user context
6698847ff0e1SMatthew G. Knepley 
6699847ff0e1SMatthew G. Knepley   Output Parameters:
6700847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
6701847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
6702847ff0e1SMatthew G. Knepley 
6703847ff0e1SMatthew G. Knepley   Level: intermediate
6704847ff0e1SMatthew G. Knepley 
6705847ff0e1SMatthew G. Knepley   Notes:
6706847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
6707847ff0e1SMatthew G. Knepley 
6708847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
6709847ff0e1SMatthew G. Knepley 
6710847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
6711847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
6712847ff0e1SMatthew G. Knepley 
6713847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
6714847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
6715847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
6716847ff0e1SMatthew G. Knepley 
6717847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
6718847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
6719847ff0e1SMatthew G. Knepley @*/
6720847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
6721847ff0e1SMatthew G. Knepley {
6722847ff0e1SMatthew G. Knepley   SNES           snes;
6723847ff0e1SMatthew G. Knepley   MatFDColoring  color;
6724847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
6725847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
6726847ff0e1SMatthew G. Knepley 
6727847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
6728c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
6729847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
6730847ff0e1SMatthew G. Knepley   if (!color) {
6731847ff0e1SMatthew G. Knepley     DM         dm;
6732847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
6733847ff0e1SMatthew G. Knepley 
6734847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
6735847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
6736847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
6737847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
6738847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6739847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6740847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6741847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6742847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6743847ff0e1SMatthew G. Knepley     } else {
6744847ff0e1SMatthew G. Knepley       MatColoring mc;
6745847ff0e1SMatthew G. Knepley 
6746847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
6747847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
6748847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
6749847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
6750847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
6751847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
6752847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6753847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6754847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6755847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6756847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6757847ff0e1SMatthew G. Knepley     }
6758847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
6759847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
6760847ff0e1SMatthew G. Knepley   }
6761847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
6762847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
6763847ff0e1SMatthew G. Knepley   if (J != B) {
6764847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6765847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6766847ff0e1SMatthew G. Knepley   }
6767847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
6768847ff0e1SMatthew G. Knepley }
676993b34091SDebojyoti Ghosh 
677093b34091SDebojyoti Ghosh #undef __FUNCT__
6771cb9d8021SPierre Barbier de Reuille #define __FUNCT__ "TSSetFunctionDomainError"
6772cb9d8021SPierre Barbier de Reuille /*@
6773cb9d8021SPierre Barbier de Reuille     TSSetFunctionDomainError - Set the function testing if the current state vector is valid
6774cb9d8021SPierre Barbier de Reuille 
6775cb9d8021SPierre Barbier de Reuille     Input Parameters:
6776cb9d8021SPierre Barbier de Reuille     ts - the TS context
6777cb9d8021SPierre Barbier de Reuille     func - function called within TSFunctionDomainError
6778cb9d8021SPierre Barbier de Reuille 
6779cb9d8021SPierre Barbier de Reuille     Level: intermediate
6780cb9d8021SPierre Barbier de Reuille 
6781cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain
6782cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
6783cb9d8021SPierre Barbier de Reuille @*/
6784cb9d8021SPierre Barbier de Reuille 
6785d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
6786cb9d8021SPierre Barbier de Reuille {
6787cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
6788cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6789cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
6790cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
6791cb9d8021SPierre Barbier de Reuille }
6792cb9d8021SPierre Barbier de Reuille 
6793cb9d8021SPierre Barbier de Reuille #undef __FUNCT__
6794cb9d8021SPierre Barbier de Reuille #define __FUNCT__ "TSFunctionDomainError"
6795cb9d8021SPierre Barbier de Reuille /*@
6796cb9d8021SPierre Barbier de Reuille     TSFunctionDomainError - Check if the current state is valid
6797cb9d8021SPierre Barbier de Reuille 
6798cb9d8021SPierre Barbier de Reuille     Input Parameters:
6799cb9d8021SPierre Barbier de Reuille     ts - the TS context
6800cb9d8021SPierre Barbier de Reuille     stagetime - time of the simulation
6801d183316bSPierre Barbier de Reuille     Y - state vector to check.
6802cb9d8021SPierre Barbier de Reuille 
6803cb9d8021SPierre Barbier de Reuille     Output Parameter:
6804cb9d8021SPierre Barbier de Reuille     accept - Set to PETSC_FALSE if the current state vector is valid.
6805cb9d8021SPierre Barbier de Reuille 
6806cb9d8021SPierre Barbier de Reuille     Note:
6807cb9d8021SPierre Barbier de Reuille     This function should be used to ensure the state is in a valid part of the space.
6808cb9d8021SPierre Barbier de Reuille     For example, one can ensure here all values are positive.
680996a0c994SBarry Smith 
681096a0c994SBarry Smith     Level: advanced
6811cb9d8021SPierre Barbier de Reuille @*/
6812d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
6813cb9d8021SPierre Barbier de Reuille {
6814cb9d8021SPierre Barbier de Reuille   PetscErrorCode ierr;
6815cb9d8021SPierre Barbier de Reuille 
6816cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
6817cb9d8021SPierre Barbier de Reuille 
6818cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6819cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
6820cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
6821d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
6822cb9d8021SPierre Barbier de Reuille   }
6823cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
6824cb9d8021SPierre Barbier de Reuille }
68251ceb14c0SBarry Smith 
68261ceb14c0SBarry Smith #undef  __FUNCT__
6827e5168f73SEmil Constantinescu #define __FUNCT__ "TSClone"
682893b34091SDebojyoti Ghosh /*@C
6829e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
683093b34091SDebojyoti Ghosh 
683193b34091SDebojyoti Ghosh   Collective on MPI_Comm
683293b34091SDebojyoti Ghosh 
683393b34091SDebojyoti Ghosh   Input Parameter:
683493b34091SDebojyoti Ghosh . tsin    - The input TS
683593b34091SDebojyoti Ghosh 
683693b34091SDebojyoti Ghosh   Output Parameter:
6837e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
683893b34091SDebojyoti Ghosh 
68395eca1a21SEmil Constantinescu   Notes:
68405eca1a21SEmil 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.
68415eca1a21SEmil Constantinescu 
6842baa10174SEmil 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);
68435eca1a21SEmil Constantinescu 
68445eca1a21SEmil Constantinescu   Level: developer
684593b34091SDebojyoti Ghosh 
6846e5168f73SEmil Constantinescu .keywords: TS, clone
6847e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
684893b34091SDebojyoti Ghosh @*/
6849baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
685093b34091SDebojyoti Ghosh {
685193b34091SDebojyoti Ghosh   TS             t;
685293b34091SDebojyoti Ghosh   PetscErrorCode ierr;
6853dc846ba4SSatish Balay   SNES           snes_start;
6854dc846ba4SSatish Balay   DM             dm;
6855dc846ba4SSatish Balay   TSType         type;
685693b34091SDebojyoti Ghosh 
685793b34091SDebojyoti Ghosh   PetscFunctionBegin;
685893b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
685993b34091SDebojyoti Ghosh   *tsout = NULL;
686093b34091SDebojyoti Ghosh 
68617a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
686293b34091SDebojyoti Ghosh 
686393b34091SDebojyoti Ghosh   /* General TS description */
686493b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
686593b34091SDebojyoti Ghosh   t->setupcalled       = 0;
686693b34091SDebojyoti Ghosh   t->ksp_its           = 0;
686793b34091SDebojyoti Ghosh   t->snes_its          = 0;
686893b34091SDebojyoti Ghosh   t->nwork             = 0;
686993b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
687093b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
687193b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
687293b34091SDebojyoti Ghosh 
687334561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
687434561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
6875d15a3a53SEmil Constantinescu 
687693b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
687793b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
687893b34091SDebojyoti Ghosh 
687993b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
688051699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
688193b34091SDebojyoti Ghosh 
688293b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
688393b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
688493b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
688593b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
688693b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
688793b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
688893b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
688993b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
689093b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
689193b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
689293b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
689393b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
689493b34091SDebojyoti Ghosh 
689593b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
689693b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
689793b34091SDebojyoti Ghosh 
689893b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
689993b34091SDebojyoti Ghosh 
690093b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
690193b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
690293b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
690393b34091SDebojyoti Ghosh 
690493b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
690593b34091SDebojyoti Ghosh 
69060d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
69070d4fed19SBarry Smith     PetscInt i;
69080d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
69090d4fed19SBarry Smith     for (i=0; i<10; i++) {
69100d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
69110d4fed19SBarry Smith     }
69120d4fed19SBarry Smith   }
691393b34091SDebojyoti Ghosh   *tsout = t;
691493b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
691593b34091SDebojyoti Ghosh }
6916