xref: /petsc/src/ts/interface/ts.c (revision 96a0c9949c19278363492ba7462c3ac2a88a3ed1)
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 
1249354f04SShri Abhyankar const char *const TSExactFinalTimeOptions[] = {"STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0};
1349354f04SShri Abhyankar 
142d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx {
152d5ee99bSBarry Smith   PetscViewer   viewer;
164b363babSBarry Smith   PetscDrawAxis axis;
172d5ee99bSBarry Smith   Vec           initialsolution;
182d5ee99bSBarry Smith   PetscBool     showinitial;
192d5ee99bSBarry Smith   PetscInt      howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
202d5ee99bSBarry Smith   PetscBool     showtimestepandtime;
212d5ee99bSBarry Smith   int           color;
222d5ee99bSBarry Smith };
232d5ee99bSBarry Smith 
24bdad233fSMatthew Knepley #undef __FUNCT__
25fde5950dSBarry Smith #define __FUNCT__ "TSMonitorSetFromOptions"
26fde5950dSBarry Smith /*@C
27fde5950dSBarry Smith    TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
28fde5950dSBarry Smith 
29fde5950dSBarry Smith    Collective on TS
30fde5950dSBarry Smith 
31fde5950dSBarry Smith    Input Parameters:
32fde5950dSBarry Smith +  ts - TS object you wish to monitor
33fde5950dSBarry Smith .  name - the monitor type one is seeking
34fde5950dSBarry Smith .  help - message indicating what monitoring is done
35fde5950dSBarry Smith .  manual - manual page for the monitor
36fde5950dSBarry Smith .  monitor - the monitor function
37fde5950dSBarry 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
38fde5950dSBarry Smith 
39fde5950dSBarry Smith    Level: developer
40fde5950dSBarry Smith 
41fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
42fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
43fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
44fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
45fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
46fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
47fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
48fde5950dSBarry Smith @*/
49fde5950dSBarry Smith PetscErrorCode  TSMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),PetscErrorCode (*monitorsetup)(TS,PetscViewer))
50fde5950dSBarry Smith {
51fde5950dSBarry Smith   PetscErrorCode    ierr;
52fde5950dSBarry Smith   PetscViewer       viewer;
53fde5950dSBarry Smith   PetscViewerFormat format;
54fde5950dSBarry Smith   PetscBool         flg;
55fde5950dSBarry Smith 
56fde5950dSBarry Smith   PetscFunctionBegin;
57fde5950dSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
58fde5950dSBarry Smith   if (flg) {
59fde5950dSBarry Smith     ierr = PetscViewerSetFormat(viewer,format);CHKERRQ(ierr);
60fde5950dSBarry Smith     if (monitorsetup) {
61fde5950dSBarry Smith       ierr = (*monitorsetup)(ts,viewer);CHKERRQ(ierr);
62fde5950dSBarry Smith     }
63fde5950dSBarry Smith     ierr = TSMonitorSet(ts,monitor,viewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);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 @*/
93fde5950dSBarry Smith PetscErrorCode  TSAdjointMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),PetscErrorCode (*monitorsetup)(TS,PetscViewer))
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) {
103fde5950dSBarry Smith     ierr = PetscViewerSetFormat(viewer,format);CHKERRQ(ierr);
104fde5950dSBarry Smith     if (monitorsetup) {
105fde5950dSBarry Smith       ierr = (*monitorsetup)(ts,viewer);CHKERRQ(ierr);
106fde5950dSBarry Smith     }
107fde5950dSBarry Smith     ierr = TSAdjointMonitorSet(ts,monitor,viewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
108fde5950dSBarry Smith   }
109fde5950dSBarry Smith   PetscFunctionReturn(0);
110fde5950dSBarry Smith }
111fde5950dSBarry Smith 
112fde5950dSBarry Smith #undef __FUNCT__
113bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions"
114bdad233fSMatthew Knepley /*@
115bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
116bdad233fSMatthew Knepley 
117bdad233fSMatthew Knepley    Collective on TS
118bdad233fSMatthew Knepley 
119bdad233fSMatthew Knepley    Input Parameter:
120bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
121bdad233fSMatthew Knepley 
122bdad233fSMatthew Knepley    Options Database Keys:
1234d91e141SJed Brown +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP
124ef222394SBarry Smith .  -ts_save_trajectory - checkpoint the solution at each time-step
1253e4cdcaaSBarry Smith .  -ts_max_steps <maxsteps> - maximum number of time-steps to take
1263e4cdcaaSBarry Smith .  -ts_final_time <time> - maximum time to compute to
1273e4cdcaaSBarry Smith .  -ts_dt <dt> - initial time step
128a3cdaa26SBarry 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
129a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
130a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
131a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
132a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
133a3cdaa26SBarry Smith .  -ts_atol <atol> Absolute tolerance for local truncation error
134ef222394SBarry Smith .  -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
135847ff0e1SMatthew G. Knepley .  -ts_fd_color - Use finite differences with coloring to compute IJacobian
136bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
137de06c3feSJed Brown .  -ts_monitor_lg_timestep - Monitor timestep size graphically
138de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
139de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
140de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
141de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
142de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
143de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
1443e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
1453e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
146fde5950dSBarry Smith .  -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep
147b3d3934dSBarry Smith .  -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts
148110eb670SHong Zhang .  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
149110eb670SHong Zhang .  -ts_adjoint_monitor - print information at each adjoint time step
15053ea634cSHong Zhang -  -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically
15153ea634cSHong Zhang 
15291b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
153bdad233fSMatthew Knepley 
154bdad233fSMatthew Knepley    Level: beginner
155bdad233fSMatthew Knepley 
156bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
157bdad233fSMatthew Knepley 
158a313700dSBarry Smith .seealso: TSGetType()
159bdad233fSMatthew Knepley @*/
1607087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
161bdad233fSMatthew Knepley {
162bc952696SBarry Smith   PetscBool              opt,flg,tflg;
163dfbe8321SBarry Smith   PetscErrorCode         ierr;
164eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
165089b2837SJed Brown   SNES                   snes;
1661c3436cfSJed Brown   TSAdapt                adapt;
16731748224SBarry Smith   PetscReal              time_step;
16849354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
169d1212d36SBarry Smith   char                   dir[16];
1706991f827SBarry Smith   const char             *defaultType;
1716991f827SBarry Smith   char                   typeName[256];
172bdad233fSMatthew Knepley 
173bdad233fSMatthew Knepley   PetscFunctionBegin;
1740700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1753194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
1766991f827SBarry Smith   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
1776991f827SBarry Smith   else defaultType = TSEULER;
1786991f827SBarry Smith 
1796991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
1806991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr);
1816991f827SBarry Smith   if (opt) {
1826991f827SBarry Smith     ierr = TSSetType(ts, typeName);CHKERRQ(ierr);
1836991f827SBarry Smith   } else {
1846991f827SBarry Smith     ierr = TSSetType(ts, defaultType);CHKERRQ(ierr);
1856991f827SBarry Smith   }
186bdad233fSMatthew Knepley 
187bdad233fSMatthew Knepley   /* Handle generic TS options */
1880298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1890298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
1900298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
19131748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
19231748224SBarry Smith   if (flg) {
19331748224SBarry Smith     ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
19431748224SBarry Smith   }
19549354f04SShri 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);
19649354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
1970298fd71SBarry 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);
1980298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
1990298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
2000298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
2010298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
202bdad233fSMatthew Knepley 
20356f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
20456f85f32SBarry Smith   {
20556f85f32SBarry Smith   PetscBool set;
20656f85f32SBarry Smith   flg  = PETSC_FALSE;
20756f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
20856f85f32SBarry Smith   if (set) {
20956f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
21056f85f32SBarry Smith   }
21156f85f32SBarry Smith   }
21256f85f32SBarry Smith #endif
21356f85f32SBarry Smith 
214bdad233fSMatthew Knepley   /* Monitor options */
215fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr);
216fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr);
217fde5950dSBarry Smith   ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);CHKERRQ(ierr);
218fde5950dSBarry Smith 
2195180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
2205180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
2215180491cSLisandro Dalcin 
2224f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
223a7cc72afSBarry Smith   if (opt) {
2240b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2253923b477SBarry Smith     PetscInt       howoften = 1;
226a80ad3e0SBarry Smith 
2270298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2287f52daa2SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2294f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
230b3603a34SBarry Smith   }
2314f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
232b3603a34SBarry Smith   if (opt) {
2330b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2343923b477SBarry Smith     PetscInt       howoften = 1;
235b3603a34SBarry Smith 
2360298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
23722d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
2384f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
239bdad233fSMatthew Knepley   }
2404f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
241ef20d060SBarry Smith   if (opt) {
2420b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2433923b477SBarry Smith     PetscInt       howoften = 1;
244ef20d060SBarry Smith 
2450298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
24622d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
2474f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
248ef20d060SBarry Smith   }
249201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
250201da799SBarry Smith   if (opt) {
251201da799SBarry Smith     TSMonitorLGCtx ctx;
252201da799SBarry Smith     PetscInt       howoften = 1;
253201da799SBarry Smith 
2540298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2557f52daa2SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
256201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
257201da799SBarry Smith   }
258201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
259201da799SBarry Smith   if (opt) {
260201da799SBarry Smith     TSMonitorLGCtx ctx;
261201da799SBarry Smith     PetscInt       howoften = 1;
262201da799SBarry Smith 
2630298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2647f52daa2SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
265201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
266201da799SBarry Smith   }
2678189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
2688189c53fSBarry Smith   if (opt) {
2698189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2708189c53fSBarry Smith     PetscInt          howoften = 1;
2718189c53fSBarry Smith 
2720298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
27322d28d08SBarry Smith     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
2748189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
2758189c53fSBarry Smith   }
276ef20d060SBarry Smith   opt  = PETSC_FALSE;
2770dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
278a7cc72afSBarry Smith   if (opt) {
27983a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
28083a4ac43SBarry Smith     PetscInt         howoften = 1;
281a80ad3e0SBarry Smith 
2820298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
283ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
28483a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
285bdad233fSMatthew Knepley   }
286fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2879110b2e7SHong Zhang   ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr);
2889110b2e7SHong Zhang   if (opt) {
2899110b2e7SHong Zhang     TSMonitorDrawCtx ctx;
2909110b2e7SHong Zhang     PetscInt         howoften = 1;
2919110b2e7SHong Zhang 
2929110b2e7SHong Zhang     ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr);
2939110b2e7SHong Zhang     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
2949110b2e7SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2959110b2e7SHong Zhang   }
2969110b2e7SHong Zhang   opt  = PETSC_FALSE;
2972d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
2982d5ee99bSBarry Smith   if (opt) {
2992d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
3002d5ee99bSBarry Smith     PetscReal        bounds[4];
3012d5ee99bSBarry Smith     PetscInt         n = 4;
3022d5ee99bSBarry Smith     PetscDraw        draw;
3032d5ee99bSBarry Smith 
3042d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
3052d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
3062d5ee99bSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr);
3072d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
3082d5ee99bSBarry Smith     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
3094b363babSBarry Smith     ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr);
3104b363babSBarry Smith     ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
311f54adfc0SBarry Smith     ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
3124b363babSBarry Smith     ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr);
31307995780SPeter Brune     /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */
3142d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3152d5ee99bSBarry Smith   }
3162d5ee99bSBarry Smith   opt  = PETSC_FALSE;
3170dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
3183a471f94SBarry Smith   if (opt) {
31983a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
32083a4ac43SBarry Smith     PetscInt         howoften = 1;
3213a471f94SBarry Smith 
3220298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
323ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
32483a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3253a471f94SBarry Smith   }
326fde5950dSBarry Smith 
327ed81e22dSJed Brown   opt  = PETSC_FALSE;
32891b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
329ed81e22dSJed Brown   if (flg) {
330ed81e22dSJed Brown     const char *ptr,*ptr2;
331ed81e22dSJed Brown     char       *filetemplate;
332ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
333ed81e22dSJed Brown     /* Do some cursory validation of the input. */
334ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
335ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
336ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
337ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
338ce94432eSBarry Smith       if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03D.vts");
339ed81e22dSJed Brown       if (ptr2) break;
340ed81e22dSJed Brown     }
341ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
342ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
343ed81e22dSJed Brown   }
344bdad233fSMatthew Knepley 
345d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
346d1212d36SBarry Smith   if (flg) {
347d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
348d1212d36SBarry Smith     int                  ray = 0;
349d1212d36SBarry Smith     DMDADirection        ddir;
350d1212d36SBarry Smith     DM                   da;
351d1212d36SBarry Smith     PetscMPIInt          rank;
352d1212d36SBarry Smith 
353ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
354d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
355d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
356ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
357d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
358d1212d36SBarry Smith 
359d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
360b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
361d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
362d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
363ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
364d1212d36SBarry Smith     if (!rank) {
365d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
366d1212d36SBarry Smith     }
36751b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
368d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
369d1212d36SBarry Smith   }
37051b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
37151b4a12fSMatthew G. Knepley   if (flg) {
37251b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
37351b4a12fSMatthew G. Knepley     int                 ray = 0;
37451b4a12fSMatthew G. Knepley     DMDADirection       ddir;
37551b4a12fSMatthew G. Knepley     DM                  da;
37651b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
377d1212d36SBarry Smith 
37851b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
37951b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
38051b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
38151b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
38251b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3831c3436cfSJed Brown 
38451b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
385b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
38651b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
38751b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
38851b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
38951b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
39051b4a12fSMatthew G. Knepley   }
391a7a1495cSBarry Smith 
392b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
393b3d3934dSBarry Smith   if (opt) {
394b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
395b3d3934dSBarry Smith 
396b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
397b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
398b3d3934dSBarry Smith   }
399b3d3934dSBarry Smith 
400847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
401847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
402847ff0e1SMatthew G. Knepley   if (flg) {
403847ff0e1SMatthew G. Knepley     DM   dm;
404847ff0e1SMatthew G. Knepley     DMTS tdm;
405847ff0e1SMatthew G. Knepley 
406847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
407847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
408847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
409847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
410847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
411847ff0e1SMatthew G. Knepley   }
412847ff0e1SMatthew G. Knepley 
4137781c08eSBarry Smith   /*
4147781c08eSBarry Smith      This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui
4157781c08eSBarry Smith      will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin()
4167781c08eSBarry Smith   */
417552698daSJed Brown   ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
418e55864a3SBarry Smith   ierr = TSAdaptSetFromOptions(PetscOptionsObject,adapt);CHKERRQ(ierr);
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 */
42668bece0bSHong Zhang   if (ts->trajectory) tflg = PETSC_TRUE;
42768bece0bSHong Zhang   else tflg = PETSC_FALSE;
42868bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
42968bece0bSHong Zhang   if (tflg) {
43068bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
43168bece0bSHong Zhang   }
43268bece0bSHong Zhang   if (ts->adjoint_solve) tflg = PETSC_TRUE;
43368bece0bSHong Zhang   else tflg = PETSC_FALSE;
43468bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
43568bece0bSHong Zhang   if (flg) {
43668bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
43768bece0bSHong Zhang     ts->adjoint_solve = tflg;
43868bece0bSHong Zhang   }
43968bece0bSHong Zhang   if (ts->trajectory) {
44068bece0bSHong Zhang     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
44168bece0bSHong Zhang   }
442d763cef2SBarry Smith 
443d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
4440633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
445fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
446d763cef2SBarry Smith 
4476991f827SBarry Smith   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4486991f827SBarry Smith   if (snes) {
4496991f827SBarry Smith     if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
45049c41c37SLisandro Dalcin     ierr = SNESSetFromOptions(snes);CHKERRQ(ierr);
451d763cef2SBarry Smith   }
45268bece0bSHong Zhang 
453d763cef2SBarry Smith   PetscFunctionReturn(0);
454d763cef2SBarry Smith }
455d763cef2SBarry Smith 
456d763cef2SBarry Smith #undef __FUNCT__
457bc952696SBarry Smith #define __FUNCT__ "TSSetSaveTrajectory"
458d2daff3dSHong Zhang /*@
459bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
460d2daff3dSHong Zhang 
461d2daff3dSHong Zhang    Collective on TS
462d2daff3dSHong Zhang 
463d2daff3dSHong Zhang    Input Parameters:
464bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
465bc952696SBarry Smith 
46668bece0bSHong Zhang Note: This routine should be called after all TS options have been set
467d2daff3dSHong Zhang 
468d2daff3dSHong Zhang    Level: intermediate
469d2daff3dSHong Zhang 
470bc952696SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve()
471d2daff3dSHong Zhang 
472bc952696SBarry Smith .keywords: TS, set, checkpoint,
473d2daff3dSHong Zhang @*/
474bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
475d2daff3dSHong Zhang {
476bc952696SBarry Smith   PetscErrorCode ierr;
477bc952696SBarry Smith 
478d2daff3dSHong Zhang   PetscFunctionBegin;
479d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
480bc952696SBarry Smith   if (!ts->trajectory) {
481bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
482972caf09SHong Zhang     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
483bc952696SBarry Smith   }
484d2daff3dSHong Zhang   PetscFunctionReturn(0);
485d2daff3dSHong Zhang }
486d2daff3dSHong Zhang 
487a7a1495cSBarry Smith #undef __FUNCT__
488a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
489a7a1495cSBarry Smith /*@
490a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
491a7a1495cSBarry Smith       set with TSSetRHSJacobian().
492a7a1495cSBarry Smith 
493a7a1495cSBarry Smith    Collective on TS and Vec
494a7a1495cSBarry Smith 
495a7a1495cSBarry Smith    Input Parameters:
496316643e7SJed Brown +  ts - the TS context
497a7a1495cSBarry Smith .  t - current timestep
4980910c330SBarry Smith -  U - input vector
499a7a1495cSBarry Smith 
500a7a1495cSBarry Smith    Output Parameters:
501a7a1495cSBarry Smith +  A - Jacobian matrix
502a7a1495cSBarry Smith .  B - optional preconditioning matrix
503a7a1495cSBarry Smith -  flag - flag indicating matrix structure
504a7a1495cSBarry Smith 
505a7a1495cSBarry Smith    Notes:
506a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
507a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
508a7a1495cSBarry Smith 
50994b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
510a7a1495cSBarry Smith    flag parameter.
511a7a1495cSBarry Smith 
512a7a1495cSBarry Smith    Level: developer
513a7a1495cSBarry Smith 
514a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
515a7a1495cSBarry Smith 
51694b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
517a7a1495cSBarry Smith @*/
518d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
519a7a1495cSBarry Smith {
520dfbe8321SBarry Smith   PetscErrorCode ierr;
521270bf2e7SJed Brown   PetscObjectState Ustate;
52224989b8cSPeter Brune   DM             dm;
523942e3340SBarry Smith   DMTS           tsdm;
52424989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
52524989b8cSPeter Brune   void           *ctx;
52624989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
527b2df71adSDebojyoti Ghosh   TSRHSFunction  rhsfunction;
528a7a1495cSBarry Smith 
529a7a1495cSBarry Smith   PetscFunctionBegin;
5300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5310910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5320910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
53324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
534942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
53524989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
5360298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
537b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
53859e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
539b2df71adSDebojyoti Ghosh   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
5400e4ef248SJed Brown     PetscFunctionReturn(0);
541f8ede8e7SJed Brown   }
542d90be118SSean Farley 
543ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
544d90be118SSean Farley 
545e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
54694ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
54794ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
54894ab13aaSBarry Smith     if (A != B) {
54994ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
55094ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
551e1244c69SJed Brown     }
552e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
553e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
554e1244c69SJed Brown   }
555e1244c69SJed Brown 
55624989b8cSPeter Brune   if (rhsjacobianfunc) {
5576cd88445SBarry Smith     PetscBool missing;
55894ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
559a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
560d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
561a7a1495cSBarry Smith     PetscStackPop;
56294ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
5636cd88445SBarry Smith     if (A) {
5646cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
5656cd88445SBarry 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");
5666cd88445SBarry Smith     }
5676cd88445SBarry Smith     if (B && B != A) {
5686cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
5696cd88445SBarry 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");
5706cd88445SBarry Smith     }
571ef66eb69SBarry Smith   } else {
57294ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
57394ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
574ef66eb69SBarry Smith   }
5750e4ef248SJed Brown   ts->rhsjacobian.time       = t;
5760910c330SBarry Smith   ts->rhsjacobian.X          = U;
57759e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
578a7a1495cSBarry Smith   PetscFunctionReturn(0);
579a7a1495cSBarry Smith }
580a7a1495cSBarry Smith 
5814a2ae208SSatish Balay #undef __FUNCT__
5824a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
583316643e7SJed Brown /*@
584d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
585d763cef2SBarry Smith 
586316643e7SJed Brown    Collective on TS and Vec
587316643e7SJed Brown 
588316643e7SJed Brown    Input Parameters:
589316643e7SJed Brown +  ts - the TS context
590316643e7SJed Brown .  t - current time
5910910c330SBarry Smith -  U - state vector
592316643e7SJed Brown 
593316643e7SJed Brown    Output Parameter:
594316643e7SJed Brown .  y - right hand side
595316643e7SJed Brown 
596316643e7SJed Brown    Note:
597316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
598316643e7SJed Brown    is used internally within the nonlinear solvers.
599316643e7SJed Brown 
600316643e7SJed Brown    Level: developer
601316643e7SJed Brown 
602316643e7SJed Brown .keywords: TS, compute
603316643e7SJed Brown 
604316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
605316643e7SJed Brown @*/
6060910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
607d763cef2SBarry Smith {
608dfbe8321SBarry Smith   PetscErrorCode ierr;
60924989b8cSPeter Brune   TSRHSFunction  rhsfunction;
61024989b8cSPeter Brune   TSIFunction    ifunction;
61124989b8cSPeter Brune   void           *ctx;
61224989b8cSPeter Brune   DM             dm;
61324989b8cSPeter Brune 
614d763cef2SBarry Smith   PetscFunctionBegin;
6150700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6160910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6170700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
61824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
61924989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
6200298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
621d763cef2SBarry Smith 
622ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
623d763cef2SBarry Smith 
6240910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
62524989b8cSPeter Brune   if (rhsfunction) {
626d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
6270910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
628d763cef2SBarry Smith     PetscStackPop;
629214bc6a2SJed Brown   } else {
630214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
631b2cd27e8SJed Brown   }
63244a41b28SSean Farley 
6330910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
634d763cef2SBarry Smith   PetscFunctionReturn(0);
635d763cef2SBarry Smith }
636d763cef2SBarry Smith 
6374a2ae208SSatish Balay #undef __FUNCT__
638ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
639ef20d060SBarry Smith /*@
640ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
641ef20d060SBarry Smith 
642ef20d060SBarry Smith    Collective on TS and Vec
643ef20d060SBarry Smith 
644ef20d060SBarry Smith    Input Parameters:
645ef20d060SBarry Smith +  ts - the TS context
646ef20d060SBarry Smith -  t - current time
647ef20d060SBarry Smith 
648ef20d060SBarry Smith    Output Parameter:
6490910c330SBarry Smith .  U - the solution
650ef20d060SBarry Smith 
651ef20d060SBarry Smith    Note:
652ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
653ef20d060SBarry Smith    is used internally within the nonlinear solvers.
654ef20d060SBarry Smith 
655ef20d060SBarry Smith    Level: developer
656ef20d060SBarry Smith 
657ef20d060SBarry Smith .keywords: TS, compute
658ef20d060SBarry Smith 
659abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
660ef20d060SBarry Smith @*/
6610910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
662ef20d060SBarry Smith {
663ef20d060SBarry Smith   PetscErrorCode     ierr;
664ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
665ef20d060SBarry Smith   void               *ctx;
666ef20d060SBarry Smith   DM                 dm;
667ef20d060SBarry Smith 
668ef20d060SBarry Smith   PetscFunctionBegin;
669ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6700910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
671ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
672ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
673ef20d060SBarry Smith 
674ef20d060SBarry Smith   if (solutionfunction) {
6759b7cd975SBarry Smith     PetscStackPush("TS user solution function");
6760910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
677ef20d060SBarry Smith     PetscStackPop;
678ef20d060SBarry Smith   }
679ef20d060SBarry Smith   PetscFunctionReturn(0);
680ef20d060SBarry Smith }
6819b7cd975SBarry Smith #undef __FUNCT__
6829b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
6839b7cd975SBarry Smith /*@
6849b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
6859b7cd975SBarry Smith 
6869b7cd975SBarry Smith    Collective on TS and Vec
6879b7cd975SBarry Smith 
6889b7cd975SBarry Smith    Input Parameters:
6899b7cd975SBarry Smith +  ts - the TS context
6909b7cd975SBarry Smith -  t - current time
6919b7cd975SBarry Smith 
6929b7cd975SBarry Smith    Output Parameter:
6939b7cd975SBarry Smith .  U - the function value
6949b7cd975SBarry Smith 
6959b7cd975SBarry Smith    Note:
6969b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
6979b7cd975SBarry Smith    is used internally within the nonlinear solvers.
6989b7cd975SBarry Smith 
6999b7cd975SBarry Smith    Level: developer
7009b7cd975SBarry Smith 
7019b7cd975SBarry Smith .keywords: TS, compute
7029b7cd975SBarry Smith 
7039b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7049b7cd975SBarry Smith @*/
7059b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7069b7cd975SBarry Smith {
7079b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7089b7cd975SBarry Smith   void               *ctx;
7099b7cd975SBarry Smith   DM                 dm;
7109b7cd975SBarry Smith 
7119b7cd975SBarry Smith   PetscFunctionBegin;
7129b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7139b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7149b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7159b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7169b7cd975SBarry Smith 
7179b7cd975SBarry Smith   if (forcing) {
7189b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
7199b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
7209b7cd975SBarry Smith     PetscStackPop;
7219b7cd975SBarry Smith   }
7229b7cd975SBarry Smith   PetscFunctionReturn(0);
7239b7cd975SBarry Smith }
724ef20d060SBarry Smith 
725ef20d060SBarry Smith #undef __FUNCT__
726214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
727214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
728214bc6a2SJed Brown {
7292dd45cf8SJed Brown   Vec            F;
730214bc6a2SJed Brown   PetscErrorCode ierr;
731214bc6a2SJed Brown 
732214bc6a2SJed Brown   PetscFunctionBegin;
7330298fd71SBarry Smith   *Frhs = NULL;
7340298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
735214bc6a2SJed Brown   if (!ts->Frhs) {
7362dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
737214bc6a2SJed Brown   }
738214bc6a2SJed Brown   *Frhs = ts->Frhs;
739214bc6a2SJed Brown   PetscFunctionReturn(0);
740214bc6a2SJed Brown }
741214bc6a2SJed Brown 
742214bc6a2SJed Brown #undef __FUNCT__
743214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
744214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
745214bc6a2SJed Brown {
746214bc6a2SJed Brown   Mat            A,B;
7472dd45cf8SJed Brown   PetscErrorCode ierr;
748214bc6a2SJed Brown 
749214bc6a2SJed Brown   PetscFunctionBegin;
750c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
751c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
7520298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
753214bc6a2SJed Brown   if (Arhs) {
754214bc6a2SJed Brown     if (!ts->Arhs) {
755214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
756214bc6a2SJed Brown     }
757214bc6a2SJed Brown     *Arhs = ts->Arhs;
758214bc6a2SJed Brown   }
759214bc6a2SJed Brown   if (Brhs) {
760214bc6a2SJed Brown     if (!ts->Brhs) {
761bdb70873SJed Brown       if (A != B) {
762214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
763bdb70873SJed Brown       } else {
764bdb70873SJed Brown         ts->Brhs = ts->Arhs;
765bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
766bdb70873SJed Brown       }
767214bc6a2SJed Brown     }
768214bc6a2SJed Brown     *Brhs = ts->Brhs;
769214bc6a2SJed Brown   }
770214bc6a2SJed Brown   PetscFunctionReturn(0);
771214bc6a2SJed Brown }
772214bc6a2SJed Brown 
773214bc6a2SJed Brown #undef __FUNCT__
774316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
775316643e7SJed Brown /*@
7760910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
777316643e7SJed Brown 
778316643e7SJed Brown    Collective on TS and Vec
779316643e7SJed Brown 
780316643e7SJed Brown    Input Parameters:
781316643e7SJed Brown +  ts - the TS context
782316643e7SJed Brown .  t - current time
7830910c330SBarry Smith .  U - state vector
7840910c330SBarry Smith .  Udot - time derivative of state vector
785214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
786316643e7SJed Brown 
787316643e7SJed Brown    Output Parameter:
788316643e7SJed Brown .  Y - right hand side
789316643e7SJed Brown 
790316643e7SJed Brown    Note:
791316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
792316643e7SJed Brown    is used internally within the nonlinear solvers.
793316643e7SJed Brown 
794316643e7SJed Brown    If the user did did not write their equations in implicit form, this
795316643e7SJed Brown    function recasts them in implicit form.
796316643e7SJed Brown 
797316643e7SJed Brown    Level: developer
798316643e7SJed Brown 
799316643e7SJed Brown .keywords: TS, compute
800316643e7SJed Brown 
801316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
802316643e7SJed Brown @*/
8030910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
804316643e7SJed Brown {
805316643e7SJed Brown   PetscErrorCode ierr;
80624989b8cSPeter Brune   TSIFunction    ifunction;
80724989b8cSPeter Brune   TSRHSFunction  rhsfunction;
80824989b8cSPeter Brune   void           *ctx;
80924989b8cSPeter Brune   DM             dm;
810316643e7SJed Brown 
811316643e7SJed Brown   PetscFunctionBegin;
8120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8130910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8140910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
8150700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
816316643e7SJed Brown 
81724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
81824989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
8190298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
82024989b8cSPeter Brune 
821ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
822d90be118SSean Farley 
8230910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
82424989b8cSPeter Brune   if (ifunction) {
825316643e7SJed Brown     PetscStackPush("TS user implicit function");
8260910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
827316643e7SJed Brown     PetscStackPop;
828214bc6a2SJed Brown   }
829214bc6a2SJed Brown   if (imex) {
83024989b8cSPeter Brune     if (!ifunction) {
8310910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
8322dd45cf8SJed Brown     }
83324989b8cSPeter Brune   } else if (rhsfunction) {
83424989b8cSPeter Brune     if (ifunction) {
835214bc6a2SJed Brown       Vec Frhs;
836214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
8370910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
838214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
8392dd45cf8SJed Brown     } else {
8400910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
8410910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
842316643e7SJed Brown     }
8434a6899ffSJed Brown   }
8440910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
845316643e7SJed Brown   PetscFunctionReturn(0);
846316643e7SJed Brown }
847316643e7SJed Brown 
848316643e7SJed Brown #undef __FUNCT__
849316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
850316643e7SJed Brown /*@
851316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
852316643e7SJed Brown 
853316643e7SJed Brown    Collective on TS and Vec
854316643e7SJed Brown 
855316643e7SJed Brown    Input
856316643e7SJed Brown       Input Parameters:
857316643e7SJed Brown +  ts - the TS context
858316643e7SJed Brown .  t - current timestep
8590910c330SBarry Smith .  U - state vector
8600910c330SBarry Smith .  Udot - time derivative of state vector
861214bc6a2SJed Brown .  shift - shift to apply, see note below
862214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
863316643e7SJed Brown 
864316643e7SJed Brown    Output Parameters:
865316643e7SJed Brown +  A - Jacobian matrix
866316643e7SJed Brown .  B - optional preconditioning matrix
867316643e7SJed Brown -  flag - flag indicating matrix structure
868316643e7SJed Brown 
869316643e7SJed Brown    Notes:
8700910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
871316643e7SJed Brown 
8720910c330SBarry Smith    dF/dU + shift*dF/dUdot
873316643e7SJed Brown 
874316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
875316643e7SJed Brown    is used internally within the nonlinear solvers.
876316643e7SJed Brown 
877316643e7SJed Brown    Level: developer
878316643e7SJed Brown 
879316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
880316643e7SJed Brown 
881316643e7SJed Brown .seealso:  TSSetIJacobian()
88263495f91SJed Brown @*/
883d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
884316643e7SJed Brown {
885316643e7SJed Brown   PetscErrorCode ierr;
88624989b8cSPeter Brune   TSIJacobian    ijacobian;
88724989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
88824989b8cSPeter Brune   DM             dm;
88924989b8cSPeter Brune   void           *ctx;
890316643e7SJed Brown 
891316643e7SJed Brown   PetscFunctionBegin;
8920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8930910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8940910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
895316643e7SJed Brown   PetscValidPointer(A,6);
89694ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
897316643e7SJed Brown   PetscValidPointer(B,7);
89894ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
89924989b8cSPeter Brune 
90024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
90124989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
9020298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
90324989b8cSPeter Brune 
904ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
905316643e7SJed Brown 
90694ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
90724989b8cSPeter Brune   if (ijacobian) {
9086cd88445SBarry Smith     PetscBool missing;
909316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
910d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
911316643e7SJed Brown     PetscStackPop;
9126cd88445SBarry Smith     if (A) {
9136cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
9146cd88445SBarry 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");
9156cd88445SBarry Smith     }
9166cd88445SBarry Smith     if (B && B != A) {
9176cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
9186cd88445SBarry 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");
9196cd88445SBarry Smith     }
9204a6899ffSJed Brown   }
921214bc6a2SJed Brown   if (imex) {
922b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
92394ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
92494ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
92594ab13aaSBarry Smith       if (A != B) {
92694ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
92794ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
928214bc6a2SJed Brown       }
929214bc6a2SJed Brown     }
930214bc6a2SJed Brown   } else {
931e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
932e1244c69SJed Brown     if (rhsjacobian) {
933bd373395SBarry Smith       if (ijacobian) {
934214bc6a2SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
935bd373395SBarry Smith       } else {
936bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
937214bc6a2SJed Brown       }
938d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
939e1244c69SJed Brown     }
94094ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
941e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
942e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
94394ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
94494ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
94594ab13aaSBarry Smith       if (A != B) {
94694ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
94794ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
948316643e7SJed Brown       }
949e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
950e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
951e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
95294ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
95394ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
95494ab13aaSBarry Smith         if (A != B) {
95594ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
95694ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
957214bc6a2SJed Brown         }
958316643e7SJed Brown       }
95994ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
96094ab13aaSBarry Smith       if (A != B) {
96194ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
962316643e7SJed Brown       }
963316643e7SJed Brown     }
964316643e7SJed Brown   }
96594ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
966316643e7SJed Brown   PetscFunctionReturn(0);
967316643e7SJed Brown }
968316643e7SJed Brown 
969316643e7SJed Brown #undef __FUNCT__
9704a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
971d763cef2SBarry Smith /*@C
972d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
973b5abc632SBarry Smith     where U_t = G(t,u).
974d763cef2SBarry Smith 
9753f9fe445SBarry Smith     Logically Collective on TS
976d763cef2SBarry Smith 
977d763cef2SBarry Smith     Input Parameters:
978d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
9790298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
980d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
981d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
9820298fd71SBarry Smith           function evaluation routine (may be NULL)
983d763cef2SBarry Smith 
984d763cef2SBarry Smith     Calling sequence of func:
98587828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
986d763cef2SBarry Smith 
987d763cef2SBarry Smith +   t - current timestep
988d763cef2SBarry Smith .   u - input vector
989d763cef2SBarry Smith .   F - function vector
990d763cef2SBarry Smith -   ctx - [optional] user-defined function context
991d763cef2SBarry Smith 
992d763cef2SBarry Smith     Level: beginner
993d763cef2SBarry Smith 
9942bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
9952bbac0d3SBarry Smith 
996d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
997d763cef2SBarry Smith 
998ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
999d763cef2SBarry Smith @*/
1000089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
1001d763cef2SBarry Smith {
1002089b2837SJed Brown   PetscErrorCode ierr;
1003089b2837SJed Brown   SNES           snes;
10040298fd71SBarry Smith   Vec            ralloc = NULL;
100524989b8cSPeter Brune   DM             dm;
1006d763cef2SBarry Smith 
1007089b2837SJed Brown   PetscFunctionBegin;
10080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1009ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
101024989b8cSPeter Brune 
101124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
101224989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1013089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1014e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1015e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1016e856ceecSJed Brown     r    = ralloc;
1017e856ceecSJed Brown   }
1018089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1019e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1020d763cef2SBarry Smith   PetscFunctionReturn(0);
1021d763cef2SBarry Smith }
1022d763cef2SBarry Smith 
10234a2ae208SSatish Balay #undef __FUNCT__
1024ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
1025ef20d060SBarry Smith /*@C
1026abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1027ef20d060SBarry Smith 
1028ef20d060SBarry Smith     Logically Collective on TS
1029ef20d060SBarry Smith 
1030ef20d060SBarry Smith     Input Parameters:
1031ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1032ef20d060SBarry Smith .   f - routine for evaluating the solution
1033ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
10340298fd71SBarry Smith           function evaluation routine (may be NULL)
1035ef20d060SBarry Smith 
1036ef20d060SBarry Smith     Calling sequence of func:
1037ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
1038ef20d060SBarry Smith 
1039ef20d060SBarry Smith +   t - current timestep
1040ef20d060SBarry Smith .   u - output vector
1041ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1042ef20d060SBarry Smith 
1043abd5a294SJed Brown     Notes:
1044abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1045abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1046abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1047abd5a294SJed Brown 
10484f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1049abd5a294SJed Brown 
1050ef20d060SBarry Smith     Level: beginner
1051ef20d060SBarry Smith 
1052ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1053ef20d060SBarry Smith 
10549b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
1055ef20d060SBarry Smith @*/
1056ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1057ef20d060SBarry Smith {
1058ef20d060SBarry Smith   PetscErrorCode ierr;
1059ef20d060SBarry Smith   DM             dm;
1060ef20d060SBarry Smith 
1061ef20d060SBarry Smith   PetscFunctionBegin;
1062ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1063ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1064ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1065ef20d060SBarry Smith   PetscFunctionReturn(0);
1066ef20d060SBarry Smith }
1067ef20d060SBarry Smith 
1068ef20d060SBarry Smith #undef __FUNCT__
10699b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
10709b7cd975SBarry Smith /*@C
10719b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
10729b7cd975SBarry Smith 
10739b7cd975SBarry Smith     Logically Collective on TS
10749b7cd975SBarry Smith 
10759b7cd975SBarry Smith     Input Parameters:
10769b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
10779b7cd975SBarry Smith .   f - routine for evaluating the forcing function
10789b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
10790298fd71SBarry Smith           function evaluation routine (may be NULL)
10809b7cd975SBarry Smith 
10819b7cd975SBarry Smith     Calling sequence of func:
10829b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
10839b7cd975SBarry Smith 
10849b7cd975SBarry Smith +   t - current timestep
10859b7cd975SBarry Smith .   u - output vector
10869b7cd975SBarry Smith -   ctx - [optional] user-defined function context
10879b7cd975SBarry Smith 
10889b7cd975SBarry Smith     Notes:
10899b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
10909b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
10919b7cd975SBarry Smith 
10929b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
10939b7cd975SBarry Smith 
10949b7cd975SBarry Smith     Level: beginner
10959b7cd975SBarry Smith 
10969b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
10979b7cd975SBarry Smith 
10989b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
10999b7cd975SBarry Smith @*/
11009b7cd975SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
11019b7cd975SBarry Smith {
11029b7cd975SBarry Smith   PetscErrorCode ierr;
11039b7cd975SBarry Smith   DM             dm;
11049b7cd975SBarry Smith 
11059b7cd975SBarry Smith   PetscFunctionBegin;
11069b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
11079b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
11089b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
11099b7cd975SBarry Smith   PetscFunctionReturn(0);
11109b7cd975SBarry Smith }
11119b7cd975SBarry Smith 
11129b7cd975SBarry Smith #undef __FUNCT__
11134a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
1114d763cef2SBarry Smith /*@C
1115f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1116b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1117d763cef2SBarry Smith 
11183f9fe445SBarry Smith    Logically Collective on TS
1119d763cef2SBarry Smith 
1120d763cef2SBarry Smith    Input Parameters:
1121d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1122e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1123e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1124d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1125d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
11260298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1127d763cef2SBarry Smith 
1128f7ab8db6SBarry Smith    Calling sequence of f:
1129ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1130d763cef2SBarry Smith 
1131d763cef2SBarry Smith +  t - current timestep
1132d763cef2SBarry Smith .  u - input vector
1133e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1134e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1135d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1136d763cef2SBarry Smith 
11376cd88445SBarry Smith    Notes:
11386cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
11396cd88445SBarry Smith 
11406cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1141ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1142d763cef2SBarry Smith 
1143d763cef2SBarry Smith    Level: beginner
1144d763cef2SBarry Smith 
1145d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1146d763cef2SBarry Smith 
1147ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1148d763cef2SBarry Smith 
1149d763cef2SBarry Smith @*/
1150e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1151d763cef2SBarry Smith {
1152277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1153089b2837SJed Brown   SNES           snes;
115424989b8cSPeter Brune   DM             dm;
115524989b8cSPeter Brune   TSIJacobian    ijacobian;
1156277b19d0SLisandro Dalcin 
1157d763cef2SBarry Smith   PetscFunctionBegin;
11580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1159e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1160e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1161e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1162e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1163d763cef2SBarry Smith 
116424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
116524989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1166e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1167e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1168e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1169e1244c69SJed Brown   }
11700298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1171089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11725f659677SPeter Brune   if (!ijacobian) {
1173e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
11740e4ef248SJed Brown   }
1175e5d3d808SBarry Smith   if (Amat) {
1176e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
11770e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1178bbd56ea5SKarl Rupp 
1179e5d3d808SBarry Smith     ts->Arhs = Amat;
11800e4ef248SJed Brown   }
1181e5d3d808SBarry Smith   if (Pmat) {
1182e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
11830e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1184bbd56ea5SKarl Rupp 
1185e5d3d808SBarry Smith     ts->Brhs = Pmat;
11860e4ef248SJed Brown   }
1187d763cef2SBarry Smith   PetscFunctionReturn(0);
1188d763cef2SBarry Smith }
1189d763cef2SBarry Smith 
1190316643e7SJed Brown 
1191316643e7SJed Brown #undef __FUNCT__
1192316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1193316643e7SJed Brown /*@C
1194b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1195316643e7SJed Brown 
11963f9fe445SBarry Smith    Logically Collective on TS
1197316643e7SJed Brown 
1198316643e7SJed Brown    Input Parameters:
1199316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
12000298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1201316643e7SJed Brown .  f   - the function evaluation routine
12020298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1203316643e7SJed Brown 
1204316643e7SJed Brown    Calling sequence of f:
1205316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1206316643e7SJed Brown 
1207316643e7SJed Brown +  t   - time at step/stage being solved
1208316643e7SJed Brown .  u   - state vector
1209316643e7SJed Brown .  u_t - time derivative of state vector
1210316643e7SJed Brown .  F   - function vector
1211316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1212316643e7SJed Brown 
1213316643e7SJed Brown    Important:
12142bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1215316643e7SJed Brown 
1216316643e7SJed Brown    Level: beginner
1217316643e7SJed Brown 
1218316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1219316643e7SJed Brown 
1220d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1221316643e7SJed Brown @*/
1222089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1223316643e7SJed Brown {
1224089b2837SJed Brown   PetscErrorCode ierr;
1225089b2837SJed Brown   SNES           snes;
12260298fd71SBarry Smith   Vec            resalloc = NULL;
122724989b8cSPeter Brune   DM             dm;
1228316643e7SJed Brown 
1229316643e7SJed Brown   PetscFunctionBegin;
12300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1231ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
123224989b8cSPeter Brune 
123324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
123424989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
123524989b8cSPeter Brune 
1236089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1237e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
1238e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1239e856ceecSJed Brown     res  = resalloc;
1240e856ceecSJed Brown   }
1241089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1242e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1243089b2837SJed Brown   PetscFunctionReturn(0);
1244089b2837SJed Brown }
1245089b2837SJed Brown 
1246089b2837SJed Brown #undef __FUNCT__
1247089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1248089b2837SJed Brown /*@C
1249089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1250089b2837SJed Brown 
1251089b2837SJed Brown    Not Collective
1252089b2837SJed Brown 
1253089b2837SJed Brown    Input Parameter:
1254089b2837SJed Brown .  ts - the TS context
1255089b2837SJed Brown 
1256089b2837SJed Brown    Output Parameter:
12570298fd71SBarry Smith +  r - vector to hold residual (or NULL)
12580298fd71SBarry Smith .  func - the function to compute residual (or NULL)
12590298fd71SBarry Smith -  ctx - the function context (or NULL)
1260089b2837SJed Brown 
1261089b2837SJed Brown    Level: advanced
1262089b2837SJed Brown 
1263089b2837SJed Brown .keywords: TS, nonlinear, get, function
1264089b2837SJed Brown 
1265089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1266089b2837SJed Brown @*/
1267089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1268089b2837SJed Brown {
1269089b2837SJed Brown   PetscErrorCode ierr;
1270089b2837SJed Brown   SNES           snes;
127124989b8cSPeter Brune   DM             dm;
1272089b2837SJed Brown 
1273089b2837SJed Brown   PetscFunctionBegin;
1274089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1275089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12760298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
127724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
127824989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1279089b2837SJed Brown   PetscFunctionReturn(0);
1280089b2837SJed Brown }
1281089b2837SJed Brown 
1282089b2837SJed Brown #undef __FUNCT__
1283089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1284089b2837SJed Brown /*@C
1285089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1286089b2837SJed Brown 
1287089b2837SJed Brown    Not Collective
1288089b2837SJed Brown 
1289089b2837SJed Brown    Input Parameter:
1290089b2837SJed Brown .  ts - the TS context
1291089b2837SJed Brown 
1292089b2837SJed Brown    Output Parameter:
12930298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
12940298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
12950298fd71SBarry Smith -  ctx - the function context (or NULL)
1296089b2837SJed Brown 
1297089b2837SJed Brown    Level: advanced
1298089b2837SJed Brown 
1299089b2837SJed Brown .keywords: TS, nonlinear, get, function
1300089b2837SJed Brown 
13012bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1302089b2837SJed Brown @*/
1303089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1304089b2837SJed Brown {
1305089b2837SJed Brown   PetscErrorCode ierr;
1306089b2837SJed Brown   SNES           snes;
130724989b8cSPeter Brune   DM             dm;
1308089b2837SJed Brown 
1309089b2837SJed Brown   PetscFunctionBegin;
1310089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1311089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13120298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
131324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
131424989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1315316643e7SJed Brown   PetscFunctionReturn(0);
1316316643e7SJed Brown }
1317316643e7SJed Brown 
1318316643e7SJed Brown #undef __FUNCT__
1319316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1320316643e7SJed Brown /*@C
1321a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1322ae8867d6SBarry Smith         provided with TSSetIFunction().
1323316643e7SJed Brown 
13243f9fe445SBarry Smith    Logically Collective on TS
1325316643e7SJed Brown 
1326316643e7SJed Brown    Input Parameters:
1327316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1328e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1329e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1330316643e7SJed Brown .  f   - the Jacobian evaluation routine
13310298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1332316643e7SJed Brown 
1333316643e7SJed Brown    Calling sequence of f:
1334ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1335316643e7SJed Brown 
1336316643e7SJed Brown +  t    - time at step/stage being solved
13371b4a444bSJed Brown .  U    - state vector
13381b4a444bSJed Brown .  U_t  - time derivative of state vector
1339316643e7SJed Brown .  a    - shift
1340e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1341e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1342316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1343316643e7SJed Brown 
1344316643e7SJed Brown    Notes:
1345e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1346316643e7SJed Brown 
1347895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1348895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1349895c21f2SBarry Smith 
1350a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1351b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1352a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1353a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1354a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1355a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1356a4f0a591SBarry Smith 
13576cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
13586cd88445SBarry Smith 
13596cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1360ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1361ca5f011dSBarry Smith 
1362316643e7SJed Brown    Level: beginner
1363316643e7SJed Brown 
1364316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1365316643e7SJed Brown 
1366ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1367316643e7SJed Brown 
1368316643e7SJed Brown @*/
1369e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1370316643e7SJed Brown {
1371316643e7SJed Brown   PetscErrorCode ierr;
1372089b2837SJed Brown   SNES           snes;
137324989b8cSPeter Brune   DM             dm;
1374316643e7SJed Brown 
1375316643e7SJed Brown   PetscFunctionBegin;
13760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1377e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1378e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1379e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1380e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
138124989b8cSPeter Brune 
138224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
138324989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
138424989b8cSPeter Brune 
1385089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1386e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1387316643e7SJed Brown   PetscFunctionReturn(0);
1388316643e7SJed Brown }
1389316643e7SJed Brown 
13904a2ae208SSatish Balay #undef __FUNCT__
1391e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1392e1244c69SJed Brown /*@
1393e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1394e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1395e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1396e1244c69SJed Brown    not been changed by the TS.
1397e1244c69SJed Brown 
1398e1244c69SJed Brown    Logically Collective
1399e1244c69SJed Brown 
1400e1244c69SJed Brown    Input Arguments:
1401e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1402e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1403e1244c69SJed Brown 
1404e1244c69SJed Brown    Level: intermediate
1405e1244c69SJed Brown 
1406e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1407e1244c69SJed Brown @*/
1408e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1409e1244c69SJed Brown {
1410e1244c69SJed Brown   PetscFunctionBegin;
1411e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1412e1244c69SJed Brown   PetscFunctionReturn(0);
1413e1244c69SJed Brown }
1414e1244c69SJed Brown 
1415e1244c69SJed Brown #undef __FUNCT__
141655849f57SBarry Smith #define __FUNCT__ "TSLoad"
141755849f57SBarry Smith /*@C
141855849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
141955849f57SBarry Smith 
142055849f57SBarry Smith   Collective on PetscViewer
142155849f57SBarry Smith 
142255849f57SBarry Smith   Input Parameters:
142355849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
142455849f57SBarry Smith            some related function before a call to TSLoad().
142555849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
142655849f57SBarry Smith 
142755849f57SBarry Smith    Level: intermediate
142855849f57SBarry Smith 
142955849f57SBarry Smith   Notes:
143055849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
143155849f57SBarry Smith 
143255849f57SBarry Smith   Notes for advanced users:
143355849f57SBarry Smith   Most users should not need to know the details of the binary storage
143455849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
143555849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
143655849f57SBarry Smith   format is
143755849f57SBarry Smith .vb
143855849f57SBarry Smith      has not yet been determined
143955849f57SBarry Smith .ve
144055849f57SBarry Smith 
144155849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
144255849f57SBarry Smith @*/
1443f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
144455849f57SBarry Smith {
144555849f57SBarry Smith   PetscErrorCode ierr;
144655849f57SBarry Smith   PetscBool      isbinary;
144755849f57SBarry Smith   PetscInt       classid;
144855849f57SBarry Smith   char           type[256];
14492d53ad75SBarry Smith   DMTS           sdm;
1450ad6bc421SBarry Smith   DM             dm;
145155849f57SBarry Smith 
145255849f57SBarry Smith   PetscFunctionBegin;
1453f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
145455849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
145555849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
145655849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
145755849f57SBarry Smith 
1458060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1459ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1460060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1461f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1462f2c2a1b9SBarry Smith   if (ts->ops->load) {
1463f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1464f2c2a1b9SBarry Smith   }
1465ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1466ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1467ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1468f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1469f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
14702d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14712d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
147255849f57SBarry Smith   PetscFunctionReturn(0);
147355849f57SBarry Smith }
147455849f57SBarry Smith 
14759804daf3SBarry Smith #include <petscdraw.h>
1476e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1477e04113cfSBarry Smith #include <petscviewersaws.h>
1478f05ece33SBarry Smith #endif
147955849f57SBarry Smith #undef __FUNCT__
14804a2ae208SSatish Balay #define __FUNCT__ "TSView"
14817e2c5f70SBarry Smith /*@C
1482d763cef2SBarry Smith     TSView - Prints the TS data structure.
1483d763cef2SBarry Smith 
14844c49b128SBarry Smith     Collective on TS
1485d763cef2SBarry Smith 
1486d763cef2SBarry Smith     Input Parameters:
1487d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1488d763cef2SBarry Smith -   viewer - visualization context
1489d763cef2SBarry Smith 
1490d763cef2SBarry Smith     Options Database Key:
1491d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1492d763cef2SBarry Smith 
1493d763cef2SBarry Smith     Notes:
1494d763cef2SBarry Smith     The available visualization contexts include
1495b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1496b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1497d763cef2SBarry Smith          output where only the first processor opens
1498d763cef2SBarry Smith          the file.  All other processors send their
1499d763cef2SBarry Smith          data to the first processor to print.
1500d763cef2SBarry Smith 
1501d763cef2SBarry Smith     The user can open an alternative visualization context with
1502b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1503d763cef2SBarry Smith 
1504d763cef2SBarry Smith     Level: beginner
1505d763cef2SBarry Smith 
1506d763cef2SBarry Smith .keywords: TS, timestep, view
1507d763cef2SBarry Smith 
1508b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1509d763cef2SBarry Smith @*/
15107087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1511d763cef2SBarry Smith {
1512dfbe8321SBarry Smith   PetscErrorCode ierr;
151319fd82e9SBarry Smith   TSType         type;
15142b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
15152d53ad75SBarry Smith   DMTS           sdm;
1516e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1517536b137fSBarry Smith   PetscBool      issaws;
1518f05ece33SBarry Smith #endif
1519d763cef2SBarry Smith 
1520d763cef2SBarry Smith   PetscFunctionBegin;
15210700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
15223050cee2SBarry Smith   if (!viewer) {
1523ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
15243050cee2SBarry Smith   }
15250700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1526c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1527fd16b177SBarry Smith 
1528251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1529251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
153055849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
15312b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1532e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1533536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1534f05ece33SBarry Smith #endif
153532077d6dSBarry Smith   if (iascii) {
1536dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
153777431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
15387c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1539d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
15405ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1541c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1542d763cef2SBarry Smith     }
15435ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1544193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
15452d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
15462d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1547d52bd9f3SBarry Smith     if (ts->ops->view) {
1548d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1549d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1550d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1551d52bd9f3SBarry Smith     }
15520f5bd95cSBarry Smith   } else if (isstring) {
1553a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1554b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
155555849f57SBarry Smith   } else if (isbinary) {
155655849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
155755849f57SBarry Smith     MPI_Comm    comm;
155855849f57SBarry Smith     PetscMPIInt rank;
155955849f57SBarry Smith     char        type[256];
156055849f57SBarry Smith 
156155849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
156255849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
156355849f57SBarry Smith     if (!rank) {
156455849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
156555849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
156655849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
156755849f57SBarry Smith     }
156855849f57SBarry Smith     if (ts->ops->view) {
156955849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
157055849f57SBarry Smith     }
1571f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1572f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
15732d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
15742d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
15752b0a91c0SBarry Smith   } else if (isdraw) {
15762b0a91c0SBarry Smith     PetscDraw draw;
15772b0a91c0SBarry Smith     char      str[36];
157889fd9fafSBarry Smith     PetscReal x,y,bottom,h;
15792b0a91c0SBarry Smith 
15802b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
15812b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
15822b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
15832b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
158451fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
158589fd9fafSBarry Smith     bottom = y - h;
15862b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
15872b0a91c0SBarry Smith     if (ts->ops->view) {
15882b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
15892b0a91c0SBarry Smith     }
15902b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1591e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1592536b137fSBarry Smith   } else if (issaws) {
1593d45a07a7SBarry Smith     PetscMPIInt rank;
15942657e9d9SBarry Smith     const char  *name;
15952657e9d9SBarry Smith 
15962657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1597d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1598d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1599d45a07a7SBarry Smith       char       dir[1024];
1600d45a07a7SBarry Smith 
1601e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1602a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
16032657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
16042657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
16052657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1606d763cef2SBarry Smith     }
16070acecf5bSBarry Smith     if (ts->ops->view) {
16080acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
16090acecf5bSBarry Smith     }
1610f05ece33SBarry Smith #endif
1611f05ece33SBarry Smith   }
1612f05ece33SBarry Smith 
1613b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1614251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1615b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1616d763cef2SBarry Smith   PetscFunctionReturn(0);
1617d763cef2SBarry Smith }
1618d763cef2SBarry Smith 
1619d763cef2SBarry Smith 
16204a2ae208SSatish Balay #undef __FUNCT__
16214a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1622b07ff414SBarry Smith /*@
1623d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1624d763cef2SBarry Smith    the timesteppers.
1625d763cef2SBarry Smith 
16263f9fe445SBarry Smith    Logically Collective on TS
1627d763cef2SBarry Smith 
1628d763cef2SBarry Smith    Input Parameters:
1629d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1630d763cef2SBarry Smith -  usrP - optional user context
1631d763cef2SBarry Smith 
1632daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
1633daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
1634daf670e6SBarry Smith 
1635d763cef2SBarry Smith    Level: intermediate
1636d763cef2SBarry Smith 
1637d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1638d763cef2SBarry Smith 
1639d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1640d763cef2SBarry Smith @*/
16417087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1642d763cef2SBarry Smith {
1643d763cef2SBarry Smith   PetscFunctionBegin;
16440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1645d763cef2SBarry Smith   ts->user = usrP;
1646d763cef2SBarry Smith   PetscFunctionReturn(0);
1647d763cef2SBarry Smith }
1648d763cef2SBarry Smith 
16494a2ae208SSatish Balay #undef __FUNCT__
16504a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1651b07ff414SBarry Smith /*@
1652d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1653d763cef2SBarry Smith     timestepper.
1654d763cef2SBarry Smith 
1655d763cef2SBarry Smith     Not Collective
1656d763cef2SBarry Smith 
1657d763cef2SBarry Smith     Input Parameter:
1658d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1659d763cef2SBarry Smith 
1660d763cef2SBarry Smith     Output Parameter:
1661d763cef2SBarry Smith .   usrP - user context
1662d763cef2SBarry Smith 
1663daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
1664daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
1665daf670e6SBarry Smith 
1666d763cef2SBarry Smith     Level: intermediate
1667d763cef2SBarry Smith 
1668d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1669d763cef2SBarry Smith 
1670d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1671d763cef2SBarry Smith @*/
1672e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1673d763cef2SBarry Smith {
1674d763cef2SBarry Smith   PetscFunctionBegin;
16750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1676e71120c6SJed Brown   *(void**)usrP = ts->user;
1677d763cef2SBarry Smith   PetscFunctionReturn(0);
1678d763cef2SBarry Smith }
1679d763cef2SBarry Smith 
16804a2ae208SSatish Balay #undef __FUNCT__
16814a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1682d763cef2SBarry Smith /*@
1683b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1684d763cef2SBarry Smith 
1685d763cef2SBarry Smith    Not Collective
1686d763cef2SBarry Smith 
1687d763cef2SBarry Smith    Input Parameter:
1688d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1689d763cef2SBarry Smith 
1690d763cef2SBarry Smith    Output Parameter:
1691b8123daeSJed Brown .  iter - number of steps completed so far
1692d763cef2SBarry Smith 
1693d763cef2SBarry Smith    Level: intermediate
1694d763cef2SBarry Smith 
1695d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
16969be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1697d763cef2SBarry Smith @*/
16987087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1699d763cef2SBarry Smith {
1700d763cef2SBarry Smith   PetscFunctionBegin;
17010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
17024482741eSBarry Smith   PetscValidIntPointer(iter,2);
1703d763cef2SBarry Smith   *iter = ts->steps;
1704d763cef2SBarry Smith   PetscFunctionReturn(0);
1705d763cef2SBarry Smith }
1706d763cef2SBarry Smith 
17074a2ae208SSatish Balay #undef __FUNCT__
17084a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1709d763cef2SBarry Smith /*@
1710d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1711d763cef2SBarry Smith    as well as the initial time.
1712d763cef2SBarry Smith 
17133f9fe445SBarry Smith    Logically Collective on TS
1714d763cef2SBarry Smith 
1715d763cef2SBarry Smith    Input Parameters:
1716d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1717d763cef2SBarry Smith .  initial_time - the initial time
1718d763cef2SBarry Smith -  time_step - the size of the timestep
1719d763cef2SBarry Smith 
1720d763cef2SBarry Smith    Level: intermediate
1721d763cef2SBarry Smith 
1722d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1723d763cef2SBarry Smith 
1724d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1725d763cef2SBarry Smith @*/
17267087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1727d763cef2SBarry Smith {
1728e144a568SJed Brown   PetscErrorCode ierr;
1729e144a568SJed Brown 
1730d763cef2SBarry Smith   PetscFunctionBegin;
17310700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1732e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1733d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1734d763cef2SBarry Smith   PetscFunctionReturn(0);
1735d763cef2SBarry Smith }
1736d763cef2SBarry Smith 
17374a2ae208SSatish Balay #undef __FUNCT__
17384a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1739d763cef2SBarry Smith /*@
1740d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1741d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1742d763cef2SBarry Smith 
17433f9fe445SBarry Smith    Logically Collective on TS
1744d763cef2SBarry Smith 
1745d763cef2SBarry Smith    Input Parameters:
1746d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1747d763cef2SBarry Smith -  time_step - the size of the timestep
1748d763cef2SBarry Smith 
1749d763cef2SBarry Smith    Level: intermediate
1750d763cef2SBarry Smith 
1751d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1752d763cef2SBarry Smith 
1753d763cef2SBarry Smith .keywords: TS, set, timestep
1754d763cef2SBarry Smith @*/
17557087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1756d763cef2SBarry Smith {
1757d763cef2SBarry Smith   PetscFunctionBegin;
17580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1759c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1760d763cef2SBarry Smith   ts->time_step      = time_step;
176131748224SBarry Smith   ts->time_step_orig = time_step;
1762d763cef2SBarry Smith   PetscFunctionReturn(0);
1763d763cef2SBarry Smith }
1764d763cef2SBarry Smith 
17654a2ae208SSatish Balay #undef __FUNCT__
1766a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1767a43b19c4SJed Brown /*@
176849354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
176949354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
177049354f04SShri Abhyankar      or just return at the final time TS computed.
1771a43b19c4SJed Brown 
1772a43b19c4SJed Brown   Logically Collective on TS
1773a43b19c4SJed Brown 
1774a43b19c4SJed Brown    Input Parameter:
1775a43b19c4SJed Brown +   ts - the time-step context
177649354f04SShri Abhyankar -   eftopt - exact final time option
1777a43b19c4SJed Brown 
1778a43b19c4SJed Brown    Level: beginner
1779a43b19c4SJed Brown 
1780a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1781a43b19c4SJed Brown @*/
178249354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1783a43b19c4SJed Brown {
1784a43b19c4SJed Brown   PetscFunctionBegin;
1785a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
178649354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
178749354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1788a43b19c4SJed Brown   PetscFunctionReturn(0);
1789a43b19c4SJed Brown }
1790a43b19c4SJed Brown 
1791a43b19c4SJed Brown #undef __FUNCT__
17924a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1793d763cef2SBarry Smith /*@
1794d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1795d763cef2SBarry Smith 
1796d763cef2SBarry Smith    Not Collective
1797d763cef2SBarry Smith 
1798d763cef2SBarry Smith    Input Parameter:
1799d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1800d763cef2SBarry Smith 
1801d763cef2SBarry Smith    Output Parameter:
1802d763cef2SBarry Smith .  dt - the current timestep size
1803d763cef2SBarry Smith 
1804d763cef2SBarry Smith    Level: intermediate
1805d763cef2SBarry Smith 
1806d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1807d763cef2SBarry Smith 
1808d763cef2SBarry Smith .keywords: TS, get, timestep
1809d763cef2SBarry Smith @*/
18107087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1811d763cef2SBarry Smith {
1812d763cef2SBarry Smith   PetscFunctionBegin;
18130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1814f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1815d763cef2SBarry Smith   *dt = ts->time_step;
1816d763cef2SBarry Smith   PetscFunctionReturn(0);
1817d763cef2SBarry Smith }
1818d763cef2SBarry Smith 
18194a2ae208SSatish Balay #undef __FUNCT__
18204a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1821d8e5e3e6SSatish Balay /*@
1822d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1823d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1824d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1825d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1826d763cef2SBarry Smith 
1827d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1828d763cef2SBarry Smith 
1829d763cef2SBarry Smith    Input Parameter:
1830d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1831d763cef2SBarry Smith 
1832d763cef2SBarry Smith    Output Parameter:
1833d763cef2SBarry Smith .  v - the vector containing the solution
1834d763cef2SBarry Smith 
1835d763cef2SBarry Smith    Level: intermediate
1836d763cef2SBarry Smith 
1837d763cef2SBarry Smith .seealso: TSGetTimeStep()
1838d763cef2SBarry Smith 
1839d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1840d763cef2SBarry Smith @*/
18417087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1842d763cef2SBarry Smith {
1843d763cef2SBarry Smith   PetscFunctionBegin;
18440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
18454482741eSBarry Smith   PetscValidPointer(v,2);
18468737fe31SLisandro Dalcin   *v = ts->vec_sol;
1847d763cef2SBarry Smith   PetscFunctionReturn(0);
1848d763cef2SBarry Smith }
1849d763cef2SBarry Smith 
1850c235aa8dSHong Zhang #undef __FUNCT__
1851dfb21088SHong Zhang #define __FUNCT__ "TSGetCostGradients"
1852c235aa8dSHong Zhang /*@
1853dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
1854c235aa8dSHong Zhang 
1855c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
1856c235aa8dSHong Zhang 
1857c235aa8dSHong Zhang    Input Parameter:
1858c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
1859c235aa8dSHong Zhang 
1860c235aa8dSHong Zhang    Output Parameter:
1861abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
1862abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
1863c235aa8dSHong Zhang 
1864c235aa8dSHong Zhang    Level: intermediate
1865c235aa8dSHong Zhang 
1866c235aa8dSHong Zhang .seealso: TSGetTimeStep()
1867c235aa8dSHong Zhang 
1868c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
1869c235aa8dSHong Zhang @*/
1870dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
1871c235aa8dSHong Zhang {
1872c235aa8dSHong Zhang   PetscFunctionBegin;
1873c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1874abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
1875abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
1876abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
1877c235aa8dSHong Zhang   PetscFunctionReturn(0);
1878c235aa8dSHong Zhang }
1879c235aa8dSHong Zhang 
1880bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
18814a2ae208SSatish Balay #undef __FUNCT__
1882bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1883d8e5e3e6SSatish Balay /*@
1884bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1885d763cef2SBarry Smith 
1886bdad233fSMatthew Knepley   Not collective
1887d763cef2SBarry Smith 
1888bdad233fSMatthew Knepley   Input Parameters:
1889bdad233fSMatthew Knepley + ts   - The TS
1890bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1891d763cef2SBarry Smith .vb
18920910c330SBarry Smith          U_t - A U = 0      (linear)
18930910c330SBarry Smith          U_t - A(t) U = 0   (linear)
18940910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1895d763cef2SBarry Smith .ve
1896d763cef2SBarry Smith 
1897d763cef2SBarry Smith    Level: beginner
1898d763cef2SBarry Smith 
1899bdad233fSMatthew Knepley .keywords: TS, problem type
1900bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1901d763cef2SBarry Smith @*/
19027087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1903a7cc72afSBarry Smith {
19049e2a6581SJed Brown   PetscErrorCode ierr;
19059e2a6581SJed Brown 
1906d763cef2SBarry Smith   PetscFunctionBegin;
19070700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1908bdad233fSMatthew Knepley   ts->problem_type = type;
19099e2a6581SJed Brown   if (type == TS_LINEAR) {
19109e2a6581SJed Brown     SNES snes;
19119e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
19129e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
19139e2a6581SJed Brown   }
1914d763cef2SBarry Smith   PetscFunctionReturn(0);
1915d763cef2SBarry Smith }
1916d763cef2SBarry Smith 
1917bdad233fSMatthew Knepley #undef __FUNCT__
1918bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1919bdad233fSMatthew Knepley /*@C
1920bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1921bdad233fSMatthew Knepley 
1922bdad233fSMatthew Knepley   Not collective
1923bdad233fSMatthew Knepley 
1924bdad233fSMatthew Knepley   Input Parameter:
1925bdad233fSMatthew Knepley . ts   - The TS
1926bdad233fSMatthew Knepley 
1927bdad233fSMatthew Knepley   Output Parameter:
1928bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1929bdad233fSMatthew Knepley .vb
1930089b2837SJed Brown          M U_t = A U
1931089b2837SJed Brown          M(t) U_t = A(t) U
1932b5abc632SBarry Smith          F(t,U,U_t)
1933bdad233fSMatthew Knepley .ve
1934bdad233fSMatthew Knepley 
1935bdad233fSMatthew Knepley    Level: beginner
1936bdad233fSMatthew Knepley 
1937bdad233fSMatthew Knepley .keywords: TS, problem type
1938bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1939bdad233fSMatthew Knepley @*/
19407087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1941a7cc72afSBarry Smith {
1942bdad233fSMatthew Knepley   PetscFunctionBegin;
19430700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
19444482741eSBarry Smith   PetscValidIntPointer(type,2);
1945bdad233fSMatthew Knepley   *type = ts->problem_type;
1946bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1947bdad233fSMatthew Knepley }
1948d763cef2SBarry Smith 
19494a2ae208SSatish Balay #undef __FUNCT__
19504a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1951d763cef2SBarry Smith /*@
1952d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1953d763cef2SBarry Smith    of a timestepper.
1954d763cef2SBarry Smith 
1955d763cef2SBarry Smith    Collective on TS
1956d763cef2SBarry Smith 
1957d763cef2SBarry Smith    Input Parameter:
1958d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1959d763cef2SBarry Smith 
1960d763cef2SBarry Smith    Notes:
1961d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1962d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1963d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1964d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1965d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1966d763cef2SBarry Smith 
1967d763cef2SBarry Smith    Level: advanced
1968d763cef2SBarry Smith 
1969d763cef2SBarry Smith .keywords: TS, timestep, setup
1970d763cef2SBarry Smith 
1971d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1972d763cef2SBarry Smith @*/
19737087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1974d763cef2SBarry Smith {
1975dfbe8321SBarry Smith   PetscErrorCode ierr;
19766c6b9e74SPeter Brune   DM             dm;
19776c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1978d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
19796c6b9e74SPeter Brune   TSIJacobian    ijac;
19806c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1981d763cef2SBarry Smith 
1982d763cef2SBarry Smith   PetscFunctionBegin;
19830700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1984277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1985277b19d0SLisandro Dalcin 
19862c18e0fdSBarry Smith   ts->total_steps = 0;
19877adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
19889596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1989d763cef2SBarry Smith   }
1990277b19d0SLisandro Dalcin 
1991277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1992277b19d0SLisandro Dalcin 
19931c3436cfSJed Brown 
1994552698daSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
1995277b19d0SLisandro Dalcin 
1996e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
1997e1244c69SJed Brown     Mat Amat,Pmat;
1998e1244c69SJed Brown     SNES snes;
1999e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2000e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2001e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2002e1244c69SJed Brown      * have displaced the RHS matrix */
2003e1244c69SJed Brown     if (Amat == ts->Arhs) {
2004e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2005e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2006e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2007e1244c69SJed Brown     }
2008e1244c69SJed Brown     if (Pmat == ts->Brhs) {
2009e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2010e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2011e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2012e1244c69SJed Brown     }
2013e1244c69SJed Brown   }
2014277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2015000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2016277b19d0SLisandro Dalcin   }
2017277b19d0SLisandro Dalcin 
20186c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
20196c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
20206c6b9e74SPeter Brune    */
20216c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
20220298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
20236c6b9e74SPeter Brune   if (!func) {
20246c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
20256c6b9e74SPeter Brune   }
20266c6b9e74SPeter Brune   /* if the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it.
20276c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
20286c6b9e74SPeter Brune    */
20290298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
20300298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
20310298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
20326c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
20336c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
20346c6b9e74SPeter Brune   }
2035277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2036277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2037277b19d0SLisandro Dalcin }
2038277b19d0SLisandro Dalcin 
2039277b19d0SLisandro Dalcin #undef __FUNCT__
2040f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp"
2041f6a906c0SBarry Smith /*@
2042f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
2043f6a906c0SBarry Smith    of an adjoint solver
2044f6a906c0SBarry Smith 
2045f6a906c0SBarry Smith    Collective on TS
2046f6a906c0SBarry Smith 
2047f6a906c0SBarry Smith    Input Parameter:
2048f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
2049f6a906c0SBarry Smith 
2050f6a906c0SBarry Smith    Level: advanced
2051f6a906c0SBarry Smith 
2052f6a906c0SBarry Smith .keywords: TS, timestep, setup
2053f6a906c0SBarry Smith 
2054947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
2055f6a906c0SBarry Smith @*/
2056f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
2057f6a906c0SBarry Smith {
2058f6a906c0SBarry Smith   PetscErrorCode ierr;
2059f6a906c0SBarry Smith 
2060f6a906c0SBarry Smith   PetscFunctionBegin;
2061f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2062f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
2063dfb21088SHong Zhang   if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
2064d8151eeaSBarry Smith 
2065947abb85SHong Zhang   if (ts->vec_costintegral) { /* if there is integral in the cost function*/
2066d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2067d8151eeaSBarry Smith     if (ts->vecs_sensip){
2068d8151eeaSBarry Smith       ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2069d8151eeaSBarry Smith     }
2070947abb85SHong Zhang   }
2071d8151eeaSBarry Smith 
207242f2b339SBarry Smith   if (ts->ops->adjointsetup) {
207342f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
2074f6a906c0SBarry Smith   }
2075f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
2076f6a906c0SBarry Smith   PetscFunctionReturn(0);
2077f6a906c0SBarry Smith }
2078f6a906c0SBarry Smith 
2079f6a906c0SBarry Smith #undef __FUNCT__
2080277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
2081277b19d0SLisandro Dalcin /*@
2082277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2083277b19d0SLisandro Dalcin 
2084277b19d0SLisandro Dalcin    Collective on TS
2085277b19d0SLisandro Dalcin 
2086277b19d0SLisandro Dalcin    Input Parameter:
2087277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2088277b19d0SLisandro Dalcin 
2089277b19d0SLisandro Dalcin    Level: beginner
2090277b19d0SLisandro Dalcin 
2091277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2092277b19d0SLisandro Dalcin 
2093277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2094277b19d0SLisandro Dalcin @*/
2095277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2096277b19d0SLisandro Dalcin {
2097277b19d0SLisandro Dalcin   PetscErrorCode ierr;
2098277b19d0SLisandro Dalcin 
2099277b19d0SLisandro Dalcin   PetscFunctionBegin;
2100277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2101b18ea86cSHong Zhang 
2102277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2103277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2104277b19d0SLisandro Dalcin   }
2105277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2106e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2107bbd56ea5SKarl Rupp 
21084e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
21094e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2110214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
21116bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2112e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2113e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
211438637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2115bbd56ea5SKarl Rupp 
2116947abb85SHong Zhang  if (ts->vec_costintegral) {
2117d8151eeaSBarry Smith     ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2118d8151eeaSBarry Smith     if (ts->vecs_drdp){
2119d8151eeaSBarry Smith       ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2120d8151eeaSBarry Smith     }
2121947abb85SHong Zhang   }
2122d8151eeaSBarry Smith   ts->vecs_sensi  = NULL;
2123d8151eeaSBarry Smith   ts->vecs_sensip = NULL;
2124ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
21252c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
212636eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2127277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2128d763cef2SBarry Smith   PetscFunctionReturn(0);
2129d763cef2SBarry Smith }
2130d763cef2SBarry Smith 
21314a2ae208SSatish Balay #undef __FUNCT__
21324a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
2133d8e5e3e6SSatish Balay /*@
2134d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2135d763cef2SBarry Smith    with TSCreate().
2136d763cef2SBarry Smith 
2137d763cef2SBarry Smith    Collective on TS
2138d763cef2SBarry Smith 
2139d763cef2SBarry Smith    Input Parameter:
2140d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2141d763cef2SBarry Smith 
2142d763cef2SBarry Smith    Level: beginner
2143d763cef2SBarry Smith 
2144d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2145d763cef2SBarry Smith 
2146d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2147d763cef2SBarry Smith @*/
21486bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2149d763cef2SBarry Smith {
21506849ba73SBarry Smith   PetscErrorCode ierr;
2151d763cef2SBarry Smith 
2152d763cef2SBarry Smith   PetscFunctionBegin;
21536bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
21546bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
21556bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2156d763cef2SBarry Smith 
21576bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2158277b19d0SLisandro Dalcin 
2159e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2160e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
21616bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
21626d4c513bSLisandro Dalcin 
2163bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2164bc952696SBarry Smith 
216584df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
2166aeb4809dSShri Abhyankar   if ((*ts)->event) {
2167aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
2168aeb4809dSShri Abhyankar   }
21696bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
21706bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
21716bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
21720dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
21736d4c513bSLisandro Dalcin 
2174a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2175d763cef2SBarry Smith   PetscFunctionReturn(0);
2176d763cef2SBarry Smith }
2177d763cef2SBarry Smith 
21784a2ae208SSatish Balay #undef __FUNCT__
21794a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2180d8e5e3e6SSatish Balay /*@
2181d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2182d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2183d763cef2SBarry Smith 
2184d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2185d763cef2SBarry Smith 
2186d763cef2SBarry Smith    Input Parameter:
2187d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2188d763cef2SBarry Smith 
2189d763cef2SBarry Smith    Output Parameter:
2190d763cef2SBarry Smith .  snes - the nonlinear solver context
2191d763cef2SBarry Smith 
2192d763cef2SBarry Smith    Notes:
2193d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2194d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
219594b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2196d763cef2SBarry Smith 
2197d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
21980298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2199d763cef2SBarry Smith 
2200d763cef2SBarry Smith    Level: beginner
2201d763cef2SBarry Smith 
2202d763cef2SBarry Smith .keywords: timestep, get, SNES
2203d763cef2SBarry Smith @*/
22047087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2205d763cef2SBarry Smith {
2206d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2207d372ba47SLisandro Dalcin 
2208d763cef2SBarry Smith   PetscFunctionBegin;
22090700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22104482741eSBarry Smith   PetscValidPointer(snes,2);
2211d372ba47SLisandro Dalcin   if (!ts->snes) {
2212ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
22130298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
22143bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2215d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2216496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
22179e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
22189e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
22199e2a6581SJed Brown     }
2220d372ba47SLisandro Dalcin   }
2221d763cef2SBarry Smith   *snes = ts->snes;
2222d763cef2SBarry Smith   PetscFunctionReturn(0);
2223d763cef2SBarry Smith }
2224d763cef2SBarry Smith 
22254a2ae208SSatish Balay #undef __FUNCT__
2226deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2227deb2cd25SJed Brown /*@
2228deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2229deb2cd25SJed Brown 
2230deb2cd25SJed Brown    Collective
2231deb2cd25SJed Brown 
2232deb2cd25SJed Brown    Input Parameter:
2233deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2234deb2cd25SJed Brown -  snes - the nonlinear solver context
2235deb2cd25SJed Brown 
2236deb2cd25SJed Brown    Notes:
2237deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2238deb2cd25SJed Brown 
2239deb2cd25SJed Brown    Level: developer
2240deb2cd25SJed Brown 
2241deb2cd25SJed Brown .keywords: timestep, set, SNES
2242deb2cd25SJed Brown @*/
2243deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2244deb2cd25SJed Brown {
2245deb2cd25SJed Brown   PetscErrorCode ierr;
2246d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2247deb2cd25SJed Brown 
2248deb2cd25SJed Brown   PetscFunctionBegin;
2249deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2250deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2251deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2252deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2253bbd56ea5SKarl Rupp 
2254deb2cd25SJed Brown   ts->snes = snes;
2255bbd56ea5SKarl Rupp 
22560298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
22570298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2258740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
22590298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2260740132f1SEmil Constantinescu   }
2261deb2cd25SJed Brown   PetscFunctionReturn(0);
2262deb2cd25SJed Brown }
2263deb2cd25SJed Brown 
2264deb2cd25SJed Brown #undef __FUNCT__
226594b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2266d8e5e3e6SSatish Balay /*@
226794b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2268d763cef2SBarry Smith    a TS (timestepper) context.
2269d763cef2SBarry Smith 
227094b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2271d763cef2SBarry Smith 
2272d763cef2SBarry Smith    Input Parameter:
2273d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2274d763cef2SBarry Smith 
2275d763cef2SBarry Smith    Output Parameter:
227694b7f48cSBarry Smith .  ksp - the nonlinear solver context
2277d763cef2SBarry Smith 
2278d763cef2SBarry Smith    Notes:
227994b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2280d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2281d763cef2SBarry Smith    KSP and PC contexts as well.
2282d763cef2SBarry Smith 
228394b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
22840298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2285d763cef2SBarry Smith 
2286d763cef2SBarry Smith    Level: beginner
2287d763cef2SBarry Smith 
228894b7f48cSBarry Smith .keywords: timestep, get, KSP
2289d763cef2SBarry Smith @*/
22907087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2291d763cef2SBarry Smith {
2292d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2293089b2837SJed Brown   SNES           snes;
2294d372ba47SLisandro Dalcin 
2295d763cef2SBarry Smith   PetscFunctionBegin;
22960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22974482741eSBarry Smith   PetscValidPointer(ksp,2);
229817186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2299e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2300089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2301089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2302d763cef2SBarry Smith   PetscFunctionReturn(0);
2303d763cef2SBarry Smith }
2304d763cef2SBarry Smith 
2305d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2306d763cef2SBarry Smith 
23074a2ae208SSatish Balay #undef __FUNCT__
2308adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2309adb62b0dSMatthew Knepley /*@
2310adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2311adb62b0dSMatthew Knepley    maximum time for iteration.
2312adb62b0dSMatthew Knepley 
23133f9fe445SBarry Smith    Not Collective
2314adb62b0dSMatthew Knepley 
2315adb62b0dSMatthew Knepley    Input Parameters:
2316adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
23170298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
23180298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2319adb62b0dSMatthew Knepley 
2320adb62b0dSMatthew Knepley    Level: intermediate
2321adb62b0dSMatthew Knepley 
2322adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2323adb62b0dSMatthew Knepley @*/
23247087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2325adb62b0dSMatthew Knepley {
2326adb62b0dSMatthew Knepley   PetscFunctionBegin;
23270700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2328abc0a331SBarry Smith   if (maxsteps) {
23294482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2330adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2331adb62b0dSMatthew Knepley   }
2332abc0a331SBarry Smith   if (maxtime) {
23334482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2334adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2335adb62b0dSMatthew Knepley   }
2336adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2337adb62b0dSMatthew Knepley }
2338adb62b0dSMatthew Knepley 
2339adb62b0dSMatthew Knepley #undef __FUNCT__
23404a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2341d763cef2SBarry Smith /*@
2342d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2343d763cef2SBarry Smith    maximum time for iteration.
2344d763cef2SBarry Smith 
23453f9fe445SBarry Smith    Logically Collective on TS
2346d763cef2SBarry Smith 
2347d763cef2SBarry Smith    Input Parameters:
2348d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2349d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2350d763cef2SBarry Smith -  maxtime - final time to iterate to
2351d763cef2SBarry Smith 
2352d763cef2SBarry Smith    Options Database Keys:
2353d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
23543bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2355d763cef2SBarry Smith 
2356d763cef2SBarry Smith    Notes:
2357d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2358d763cef2SBarry Smith 
2359d763cef2SBarry Smith    Level: intermediate
2360d763cef2SBarry Smith 
2361d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2362a43b19c4SJed Brown 
2363a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2364d763cef2SBarry Smith @*/
23657087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2366d763cef2SBarry Smith {
2367d763cef2SBarry Smith   PetscFunctionBegin;
23680700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2369c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2370c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
237139b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
237239b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2373d763cef2SBarry Smith   PetscFunctionReturn(0);
2374d763cef2SBarry Smith }
2375d763cef2SBarry Smith 
23764a2ae208SSatish Balay #undef __FUNCT__
23774a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2378d763cef2SBarry Smith /*@
2379d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2380d763cef2SBarry Smith    for use by the TS routines.
2381d763cef2SBarry Smith 
23823f9fe445SBarry Smith    Logically Collective on TS and Vec
2383d763cef2SBarry Smith 
2384d763cef2SBarry Smith    Input Parameters:
2385d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
23860910c330SBarry Smith -  u - the solution vector
2387d763cef2SBarry Smith 
2388d763cef2SBarry Smith    Level: beginner
2389d763cef2SBarry Smith 
2390d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2391d763cef2SBarry Smith @*/
23920910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2393d763cef2SBarry Smith {
23948737fe31SLisandro Dalcin   PetscErrorCode ierr;
2395496e6a7aSJed Brown   DM             dm;
23968737fe31SLisandro Dalcin 
2397d763cef2SBarry Smith   PetscFunctionBegin;
23980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
23990910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
24000910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
24016bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2402bbd56ea5SKarl Rupp 
24030910c330SBarry Smith   ts->vec_sol = u;
2404bbd56ea5SKarl Rupp 
2405496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
24060910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2407d763cef2SBarry Smith   PetscFunctionReturn(0);
2408d763cef2SBarry Smith }
2409d763cef2SBarry Smith 
2410e74ef692SMatthew Knepley #undef __FUNCT__
241173b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps"
241273b18844SBarry Smith /*@
241373b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
241473b18844SBarry Smith 
241573b18844SBarry Smith    Logically Collective on TS
241673b18844SBarry Smith 
241773b18844SBarry Smith    Input Parameters:
241873b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
241973b18844SBarry Smith .  steps - number of steps to use
242073b18844SBarry Smith 
242173b18844SBarry Smith    Level: intermediate
242273b18844SBarry Smith 
242373b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
242473b18844SBarry Smith           so as to integrate back to less than the original timestep
242573b18844SBarry Smith 
242673b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
242773b18844SBarry Smith 
242873b18844SBarry Smith .seealso: TSSetExactFinalTime()
242973b18844SBarry Smith @*/
243073b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
243173b18844SBarry Smith {
243273b18844SBarry Smith   PetscFunctionBegin;
243373b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
243473b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
243573b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
243673b18844SBarry 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");
243773b18844SBarry Smith   ts->adjoint_max_steps = steps;
243873b18844SBarry Smith   PetscFunctionReturn(0);
243973b18844SBarry Smith }
244073b18844SBarry Smith 
244173b18844SBarry Smith #undef __FUNCT__
2442dfb21088SHong Zhang #define __FUNCT__ "TSSetCostGradients"
2443c235aa8dSHong Zhang /*@
2444dfb21088SHong 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
24450cf82b59SBarry Smith       for use by the TSAdjoint routines.
2446c235aa8dSHong Zhang 
2447c235aa8dSHong Zhang    Logically Collective on TS and Vec
2448c235aa8dSHong Zhang 
2449c235aa8dSHong Zhang    Input Parameters:
2450c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2451abc2977eSBarry 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
2452abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2453c235aa8dSHong Zhang 
2454c235aa8dSHong Zhang    Level: beginner
2455c235aa8dSHong Zhang 
2456abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
24570cf82b59SBarry Smith 
2458c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2459c235aa8dSHong Zhang @*/
2460dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
2461c235aa8dSHong Zhang {
2462c235aa8dSHong Zhang   PetscFunctionBegin;
2463c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2464abc2977eSBarry Smith   PetscValidPointer(lambda,2);
2465abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
2466abc2977eSBarry Smith   ts->vecs_sensip = mu;
2467dfb21088SHong 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");
2468abc2977eSBarry Smith   ts->numcost  = numcost;
2469ad8e2604SHong Zhang   PetscFunctionReturn(0);
2470ad8e2604SHong Zhang }
2471ad8e2604SHong Zhang 
2472ad8e2604SHong Zhang #undef __FUNCT__
24735bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian"
2474ad8e2604SHong Zhang /*@C
24750cf82b59SBarry 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.
2476ad8e2604SHong Zhang 
2477ad8e2604SHong Zhang   Logically Collective on TS
2478ad8e2604SHong Zhang 
2479ad8e2604SHong Zhang   Input Parameters:
2480ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2481ad8e2604SHong Zhang - func - The function
2482ad8e2604SHong Zhang 
2483ad8e2604SHong Zhang   Calling sequence of func:
24840cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
248505755b9cSHong Zhang +   t - current timestep
24860cf82b59SBarry Smith .   y - input vector (current ODE solution)
248705755b9cSHong Zhang .   A - output matrix
248805755b9cSHong Zhang -   ctx - [optional] user-defined function context
2489ad8e2604SHong Zhang 
2490ad8e2604SHong Zhang   Level: intermediate
2491ad8e2604SHong Zhang 
24920cf82b59SBarry 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
24930cf82b59SBarry Smith 
2494ad8e2604SHong Zhang .keywords: TS, sensitivity
2495ad8e2604SHong Zhang .seealso:
2496ad8e2604SHong Zhang @*/
24975bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2498ad8e2604SHong Zhang {
2499ad8e2604SHong Zhang   PetscErrorCode ierr;
2500ad8e2604SHong Zhang 
2501ad8e2604SHong Zhang   PetscFunctionBegin;
2502ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2503ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2504ad8e2604SHong Zhang 
2505ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2506ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2507ad8e2604SHong Zhang   if(Amat) {
2508ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2509ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2510ad8e2604SHong Zhang     ts->Jacp = Amat;
2511ad8e2604SHong Zhang   }
2512ad8e2604SHong Zhang   PetscFunctionReturn(0);
2513ad8e2604SHong Zhang }
2514ad8e2604SHong Zhang 
2515ad8e2604SHong Zhang #undef __FUNCT__
25165bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian"
25170cf82b59SBarry Smith /*@C
25185bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2519ad8e2604SHong Zhang 
2520ad8e2604SHong Zhang   Collective on TS
2521ad8e2604SHong Zhang 
2522ad8e2604SHong Zhang   Input Parameters:
2523ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2524ad8e2604SHong Zhang 
2525ad8e2604SHong Zhang   Level: developer
2526ad8e2604SHong Zhang 
2527ad8e2604SHong Zhang .keywords: TS, sensitivity
25285bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
2529ad8e2604SHong Zhang @*/
25305bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2531ad8e2604SHong Zhang {
2532ad8e2604SHong Zhang   PetscErrorCode ierr;
2533ad8e2604SHong Zhang 
2534ad8e2604SHong Zhang   PetscFunctionBegin;
2535ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2536ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2537ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2538ad8e2604SHong Zhang 
2539ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2540ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2541ad8e2604SHong Zhang   PetscStackPop;
2542c235aa8dSHong Zhang   PetscFunctionReturn(0);
2543c235aa8dSHong Zhang }
2544c235aa8dSHong Zhang 
2545c235aa8dSHong Zhang #undef __FUNCT__
2546dfb21088SHong Zhang #define __FUNCT__ "TSSetCostIntegrand"
25476fd0887fSHong Zhang /*@C
2548dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
25496fd0887fSHong Zhang 
25506fd0887fSHong Zhang     Logically Collective on TS
25516fd0887fSHong Zhang 
25526fd0887fSHong Zhang     Input Parameters:
25536fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
2554abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
25550cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
2556b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2557b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
2558b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
25596fd0887fSHong Zhang 
25600cf82b59SBarry Smith     Calling sequence of rf:
25610cf82b59SBarry Smith $     rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
25626fd0887fSHong Zhang 
25636fd0887fSHong Zhang +   t - current timestep
25640cf82b59SBarry Smith .   y - input vector
25650cf82b59SBarry Smith .   f - function result; one vector entry for each cost function
25666fd0887fSHong Zhang -   ctx - [optional] user-defined function context
25676fd0887fSHong Zhang 
2568b612ec54SBarry Smith    Calling sequence of drdyf:
25690cf82b59SBarry Smith $    PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
2570b612ec54SBarry Smith 
2571b612ec54SBarry Smith    Calling sequence of drdpf:
25720cf82b59SBarry Smith $    PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
2573b612ec54SBarry Smith 
2574b612ec54SBarry Smith     Level: intermediate
25756fd0887fSHong Zhang 
2576abc2977eSBarry Smith     Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions
25770cf82b59SBarry Smith 
25786fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
25796fd0887fSHong Zhang 
2580dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
25816fd0887fSHong Zhang @*/
2582dfb21088SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost, PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
2583d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
2584d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),void *ctx)
25856fd0887fSHong Zhang {
25866fd0887fSHong Zhang   PetscErrorCode ierr;
25876fd0887fSHong Zhang 
25886fd0887fSHong Zhang   PetscFunctionBegin;
25896fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2590dfb21088SHong 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()");
2591c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
25926fd0887fSHong Zhang 
2593abc2977eSBarry Smith   ierr                 = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
25942c39e106SBarry Smith   ierr                 = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
25950cf82b59SBarry Smith   ts->costintegrand    = rf;
259605755b9cSHong Zhang   ts->costintegrandctx = ctx;
2597b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
2598b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
25996fd0887fSHong Zhang   PetscFunctionReturn(0);
26006fd0887fSHong Zhang }
26016fd0887fSHong Zhang 
26026fd0887fSHong Zhang #undef __FUNCT__
2603dfb21088SHong Zhang #define __FUNCT__ "TSGetCostIntegral"
260436eaed60SHong Zhang /*@
2605dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
260636eaed60SHong Zhang    It is valid to call the routine after a backward run.
260736eaed60SHong Zhang 
260836eaed60SHong Zhang    Not Collective
260936eaed60SHong Zhang 
261036eaed60SHong Zhang    Input Parameter:
261136eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
261236eaed60SHong Zhang 
261336eaed60SHong Zhang    Output Parameter:
26142c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
261536eaed60SHong Zhang 
261636eaed60SHong Zhang    Level: intermediate
261736eaed60SHong Zhang 
2618dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
261936eaed60SHong Zhang 
262036eaed60SHong Zhang .keywords: TS, sensitivity analysis
262136eaed60SHong Zhang @*/
2622dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
262336eaed60SHong Zhang {
262436eaed60SHong Zhang   PetscFunctionBegin;
262536eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
262636eaed60SHong Zhang   PetscValidPointer(v,2);
26272c39e106SBarry Smith   *v = ts->vec_costintegral;
262836eaed60SHong Zhang   PetscFunctionReturn(0);
262936eaed60SHong Zhang }
263036eaed60SHong Zhang 
263136eaed60SHong Zhang #undef __FUNCT__
2632d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand"
26336fd0887fSHong Zhang /*@
26342c39e106SBarry Smith    TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
26356fd0887fSHong Zhang 
26366fd0887fSHong Zhang    Input Parameters:
26376fd0887fSHong Zhang +  ts - the TS context
26386fd0887fSHong Zhang .  t - current time
26390cf82b59SBarry Smith -  y - state vector, i.e. current solution
26406fd0887fSHong Zhang 
26416fd0887fSHong Zhang    Output Parameter:
2642abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
26436fd0887fSHong Zhang 
26446fd0887fSHong Zhang    Note:
26456fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
26466fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
26476fd0887fSHong Zhang 
26486fd0887fSHong Zhang    Level: developer
26496fd0887fSHong Zhang 
26506fd0887fSHong Zhang .keywords: TS, compute
26516fd0887fSHong Zhang 
2652dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
26536fd0887fSHong Zhang @*/
26540cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
26556fd0887fSHong Zhang {
26566fd0887fSHong Zhang   PetscErrorCode ierr;
26576fd0887fSHong Zhang 
26586fd0887fSHong Zhang   PetscFunctionBegin;
26596fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
26600cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
26616fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
26626fd0887fSHong Zhang 
26630cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
2664e4680132SHong Zhang   if (ts->costintegrand) {
2665e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
26660cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
26676fd0887fSHong Zhang     PetscStackPop;
26686fd0887fSHong Zhang   } else {
26696fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
26706fd0887fSHong Zhang   }
26716fd0887fSHong Zhang 
26720cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
26736fd0887fSHong Zhang   PetscFunctionReturn(0);
26746fd0887fSHong Zhang }
26756fd0887fSHong Zhang 
26766fd0887fSHong Zhang #undef __FUNCT__
2677d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction"
267805755b9cSHong Zhang /*@
2679d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
268005755b9cSHong Zhang 
268105755b9cSHong Zhang   Collective on TS
268205755b9cSHong Zhang 
268305755b9cSHong Zhang   Input Parameters:
268405755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
268505755b9cSHong Zhang 
268605755b9cSHong Zhang   Notes:
2687d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
268805755b9cSHong Zhang   so most users would not generally call this routine themselves.
268905755b9cSHong Zhang 
269005755b9cSHong Zhang   Level: developer
269105755b9cSHong Zhang 
269205755b9cSHong Zhang .keywords: TS, sensitivity
2693d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
269405755b9cSHong Zhang @*/
26950cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
269605755b9cSHong Zhang {
269705755b9cSHong Zhang   PetscErrorCode ierr;
269805755b9cSHong Zhang 
269905755b9cSHong Zhang   PetscFunctionBegin;
270005755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27010cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
270205755b9cSHong Zhang 
270305755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
27040cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
270505755b9cSHong Zhang   PetscStackPop;
270605755b9cSHong Zhang   PetscFunctionReturn(0);
270705755b9cSHong Zhang }
270805755b9cSHong Zhang 
270905755b9cSHong Zhang #undef __FUNCT__
2710d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction"
271105755b9cSHong Zhang /*@
2712d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
271305755b9cSHong Zhang 
271405755b9cSHong Zhang   Collective on TS
271505755b9cSHong Zhang 
271605755b9cSHong Zhang   Input Parameters:
271705755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
271805755b9cSHong Zhang 
271905755b9cSHong Zhang   Notes:
272005755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
272105755b9cSHong Zhang   so most users would not generally call this routine themselves.
272205755b9cSHong Zhang 
272305755b9cSHong Zhang   Level: developer
272405755b9cSHong Zhang 
272505755b9cSHong Zhang .keywords: TS, sensitivity
2726d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
272705755b9cSHong Zhang @*/
27280cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
272905755b9cSHong Zhang {
273005755b9cSHong Zhang   PetscErrorCode ierr;
273105755b9cSHong Zhang 
273205755b9cSHong Zhang   PetscFunctionBegin;
273305755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27340cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
273505755b9cSHong Zhang 
273605755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
27370cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
273805755b9cSHong Zhang   PetscStackPop;
273905755b9cSHong Zhang   PetscFunctionReturn(0);
274005755b9cSHong Zhang }
274105755b9cSHong Zhang 
274205755b9cSHong Zhang #undef __FUNCT__
2743e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2744ac226902SBarry Smith /*@C
2745000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
27463f2090d5SJed Brown   called once at the beginning of each time step.
2747000e7ae3SMatthew Knepley 
27483f9fe445SBarry Smith   Logically Collective on TS
2749000e7ae3SMatthew Knepley 
2750000e7ae3SMatthew Knepley   Input Parameters:
2751000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2752000e7ae3SMatthew Knepley - func - The function
2753000e7ae3SMatthew Knepley 
2754000e7ae3SMatthew Knepley   Calling sequence of func:
2755000e7ae3SMatthew Knepley . func (TS ts);
2756000e7ae3SMatthew Knepley 
2757000e7ae3SMatthew Knepley   Level: intermediate
2758000e7ae3SMatthew Knepley 
2759b8123daeSJed Brown   Note:
2760b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2761b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2762b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2763b8123daeSJed Brown 
2764000e7ae3SMatthew Knepley .keywords: TS, timestep
27659be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2766000e7ae3SMatthew Knepley @*/
27677087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2768000e7ae3SMatthew Knepley {
2769000e7ae3SMatthew Knepley   PetscFunctionBegin;
27700700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2771ae60f76fSBarry Smith   ts->prestep = func;
2772000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2773000e7ae3SMatthew Knepley }
2774000e7ae3SMatthew Knepley 
2775e74ef692SMatthew Knepley #undef __FUNCT__
27763f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
277709ee8438SJed Brown /*@
27783f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
27793f2090d5SJed Brown 
27803f2090d5SJed Brown   Collective on TS
27813f2090d5SJed Brown 
27823f2090d5SJed Brown   Input Parameters:
27833f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
27843f2090d5SJed Brown 
27853f2090d5SJed Brown   Notes:
27863f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
27873f2090d5SJed Brown   so most users would not generally call this routine themselves.
27883f2090d5SJed Brown 
27893f2090d5SJed Brown   Level: developer
27903f2090d5SJed Brown 
27913f2090d5SJed Brown .keywords: TS, timestep
27929be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
27933f2090d5SJed Brown @*/
27947087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
27953f2090d5SJed Brown {
27963f2090d5SJed Brown   PetscErrorCode ierr;
27973f2090d5SJed Brown 
27983f2090d5SJed Brown   PetscFunctionBegin;
27990700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2800ae60f76fSBarry Smith   if (ts->prestep) {
2801ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2802312ce896SJed Brown   }
28033f2090d5SJed Brown   PetscFunctionReturn(0);
28043f2090d5SJed Brown }
28053f2090d5SJed Brown 
28063f2090d5SJed Brown #undef __FUNCT__
2807b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2808b8123daeSJed Brown /*@C
2809b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2810b8123daeSJed Brown   called once at the beginning of each stage.
2811b8123daeSJed Brown 
2812b8123daeSJed Brown   Logically Collective on TS
2813b8123daeSJed Brown 
2814b8123daeSJed Brown   Input Parameters:
2815b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2816b8123daeSJed Brown - func - The function
2817b8123daeSJed Brown 
2818b8123daeSJed Brown   Calling sequence of func:
2819b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2820b8123daeSJed Brown 
2821b8123daeSJed Brown   Level: intermediate
2822b8123daeSJed Brown 
2823b8123daeSJed Brown   Note:
2824b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2825b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2826b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2827b8123daeSJed Brown 
2828b8123daeSJed Brown .keywords: TS, timestep
28299be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2830b8123daeSJed Brown @*/
2831b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2832b8123daeSJed Brown {
2833b8123daeSJed Brown   PetscFunctionBegin;
2834b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2835ae60f76fSBarry Smith   ts->prestage = func;
2836b8123daeSJed Brown   PetscFunctionReturn(0);
2837b8123daeSJed Brown }
2838b8123daeSJed Brown 
2839b8123daeSJed Brown #undef __FUNCT__
28409be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
28419be3e283SDebojyoti Ghosh /*@C
28429be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
28439be3e283SDebojyoti Ghosh   called once at the end of each stage.
28449be3e283SDebojyoti Ghosh 
28459be3e283SDebojyoti Ghosh   Logically Collective on TS
28469be3e283SDebojyoti Ghosh 
28479be3e283SDebojyoti Ghosh   Input Parameters:
28489be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
28499be3e283SDebojyoti Ghosh - func - The function
28509be3e283SDebojyoti Ghosh 
28519be3e283SDebojyoti Ghosh   Calling sequence of func:
28529be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
28539be3e283SDebojyoti Ghosh 
28549be3e283SDebojyoti Ghosh   Level: intermediate
28559be3e283SDebojyoti Ghosh 
28569be3e283SDebojyoti Ghosh   Note:
28579be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
28589be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
28599be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
28609be3e283SDebojyoti Ghosh 
28619be3e283SDebojyoti Ghosh .keywords: TS, timestep
28629be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
28639be3e283SDebojyoti Ghosh @*/
28649be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
28659be3e283SDebojyoti Ghosh {
28669be3e283SDebojyoti Ghosh   PetscFunctionBegin;
28679be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
28689be3e283SDebojyoti Ghosh   ts->poststage = func;
28699be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
28709be3e283SDebojyoti Ghosh }
28719be3e283SDebojyoti Ghosh 
28729be3e283SDebojyoti Ghosh #undef __FUNCT__
2873b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2874b8123daeSJed Brown /*@
2875b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2876b8123daeSJed Brown 
2877b8123daeSJed Brown   Collective on TS
2878b8123daeSJed Brown 
2879b8123daeSJed Brown   Input Parameters:
2880b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
28819be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2882b8123daeSJed Brown 
2883b8123daeSJed Brown   Notes:
2884b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2885b8123daeSJed Brown   most users would not generally call this routine themselves.
2886b8123daeSJed Brown 
2887b8123daeSJed Brown   Level: developer
2888b8123daeSJed Brown 
2889b8123daeSJed Brown .keywords: TS, timestep
28909be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2891b8123daeSJed Brown @*/
2892b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2893b8123daeSJed Brown {
2894b8123daeSJed Brown   PetscErrorCode ierr;
2895b8123daeSJed Brown 
2896b8123daeSJed Brown   PetscFunctionBegin;
2897b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2898ae60f76fSBarry Smith   if (ts->prestage) {
2899ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2900b8123daeSJed Brown   }
2901b8123daeSJed Brown   PetscFunctionReturn(0);
2902b8123daeSJed Brown }
2903b8123daeSJed Brown 
2904b8123daeSJed Brown #undef __FUNCT__
29059be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
29069be3e283SDebojyoti Ghosh /*@
29079be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
29089be3e283SDebojyoti Ghosh 
29099be3e283SDebojyoti Ghosh   Collective on TS
29109be3e283SDebojyoti Ghosh 
29119be3e283SDebojyoti Ghosh   Input Parameters:
29129be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
29139be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
29149be3e283SDebojyoti Ghosh   stageindex  - Stage number
29159be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
29169be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
29179be3e283SDebojyoti Ghosh 
29189be3e283SDebojyoti Ghosh   Notes:
29199be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
29209be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
29219be3e283SDebojyoti Ghosh 
29229be3e283SDebojyoti Ghosh   Level: developer
29239be3e283SDebojyoti Ghosh 
29249be3e283SDebojyoti Ghosh .keywords: TS, timestep
29259be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
29269be3e283SDebojyoti Ghosh @*/
29279be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
29289be3e283SDebojyoti Ghosh {
29299be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
29309be3e283SDebojyoti Ghosh 
29319be3e283SDebojyoti Ghosh   PetscFunctionBegin;
29329be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29334beae5d8SLisandro Dalcin   if (ts->poststage) {
29349be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
29359be3e283SDebojyoti Ghosh   }
29369be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
29379be3e283SDebojyoti Ghosh }
29389be3e283SDebojyoti Ghosh 
29399be3e283SDebojyoti Ghosh #undef __FUNCT__
2940e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2941ac226902SBarry Smith /*@C
2942000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
29433f2090d5SJed Brown   called once at the end of each time step.
2944000e7ae3SMatthew Knepley 
29453f9fe445SBarry Smith   Logically Collective on TS
2946000e7ae3SMatthew Knepley 
2947000e7ae3SMatthew Knepley   Input Parameters:
2948000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2949000e7ae3SMatthew Knepley - func - The function
2950000e7ae3SMatthew Knepley 
2951000e7ae3SMatthew Knepley   Calling sequence of func:
2952b8123daeSJed Brown $ func (TS ts);
2953000e7ae3SMatthew Knepley 
2954000e7ae3SMatthew Knepley   Level: intermediate
2955000e7ae3SMatthew Knepley 
2956000e7ae3SMatthew Knepley .keywords: TS, timestep
2957b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2958000e7ae3SMatthew Knepley @*/
29597087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2960000e7ae3SMatthew Knepley {
2961000e7ae3SMatthew Knepley   PetscFunctionBegin;
29620700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2963ae60f76fSBarry Smith   ts->poststep = func;
2964000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2965000e7ae3SMatthew Knepley }
2966000e7ae3SMatthew Knepley 
2967e74ef692SMatthew Knepley #undef __FUNCT__
29683f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
296909ee8438SJed Brown /*@
29703f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
29713f2090d5SJed Brown 
29723f2090d5SJed Brown   Collective on TS
29733f2090d5SJed Brown 
29743f2090d5SJed Brown   Input Parameters:
29753f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
29763f2090d5SJed Brown 
29773f2090d5SJed Brown   Notes:
29783f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
29793f2090d5SJed Brown   so most users would not generally call this routine themselves.
29803f2090d5SJed Brown 
29813f2090d5SJed Brown   Level: developer
29823f2090d5SJed Brown 
29833f2090d5SJed Brown .keywords: TS, timestep
29843f2090d5SJed Brown @*/
29857087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
29863f2090d5SJed Brown {
29873f2090d5SJed Brown   PetscErrorCode ierr;
29883f2090d5SJed Brown 
29893f2090d5SJed Brown   PetscFunctionBegin;
29900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2991ae60f76fSBarry Smith   if (ts->poststep) {
2992ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
299372ac3e02SJed Brown   }
29943f2090d5SJed Brown   PetscFunctionReturn(0);
29953f2090d5SJed Brown }
29963f2090d5SJed Brown 
2997d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2998d763cef2SBarry Smith 
29994a2ae208SSatish Balay #undef __FUNCT__
3000a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
3001d763cef2SBarry Smith /*@C
3002a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3003d763cef2SBarry Smith    timestep to display the iteration's  progress.
3004d763cef2SBarry Smith 
30053f9fe445SBarry Smith    Logically Collective on TS
3006d763cef2SBarry Smith 
3007d763cef2SBarry Smith    Input Parameters:
3008d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3009e213d8f1SJed Brown .  monitor - monitoring routine
3010329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
30110298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3012b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
30130298fd71SBarry Smith           (may be NULL)
3014d763cef2SBarry Smith 
3015e213d8f1SJed Brown    Calling sequence of monitor:
30160910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3017d763cef2SBarry Smith 
3018d763cef2SBarry Smith +    ts - the TS context
301988c05cc5SBarry Smith .    steps - iteration number (after the final time step the monitor routine is called with a step of -1, this is at the final time which may have
302088c05cc5SBarry Smith                                been interpolated to)
30211f06c33eSBarry Smith .    time - current time
30220910c330SBarry Smith .    u - current iterate
3023d763cef2SBarry Smith -    mctx - [optional] monitoring context
3024d763cef2SBarry Smith 
3025d763cef2SBarry Smith    Notes:
3026d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3027d763cef2SBarry Smith    already has been loaded.
3028d763cef2SBarry Smith 
3029025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
3030025f1a04SBarry Smith 
3031d763cef2SBarry Smith    Level: intermediate
3032d763cef2SBarry Smith 
3033d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3034d763cef2SBarry Smith 
3035a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3036d763cef2SBarry Smith @*/
3037c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3038d763cef2SBarry Smith {
3039d763cef2SBarry Smith   PetscFunctionBegin;
30400700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
304117186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3042d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
30438704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3044d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3045d763cef2SBarry Smith   PetscFunctionReturn(0);
3046d763cef2SBarry Smith }
3047d763cef2SBarry Smith 
30484a2ae208SSatish Balay #undef __FUNCT__
3049a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
3050d763cef2SBarry Smith /*@C
3051a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3052d763cef2SBarry Smith 
30533f9fe445SBarry Smith    Logically Collective on TS
3054d763cef2SBarry Smith 
3055d763cef2SBarry Smith    Input Parameters:
3056d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3057d763cef2SBarry Smith 
3058d763cef2SBarry Smith    Notes:
3059d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3060d763cef2SBarry Smith 
3061d763cef2SBarry Smith    Level: intermediate
3062d763cef2SBarry Smith 
3063d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3064d763cef2SBarry Smith 
3065a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3066d763cef2SBarry Smith @*/
30677087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3068d763cef2SBarry Smith {
3069d952e501SBarry Smith   PetscErrorCode ierr;
3070d952e501SBarry Smith   PetscInt       i;
3071d952e501SBarry Smith 
3072d763cef2SBarry Smith   PetscFunctionBegin;
30730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3074d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
30758704b422SBarry Smith     if (ts->monitordestroy[i]) {
30768704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3077d952e501SBarry Smith     }
3078d952e501SBarry Smith   }
3079d763cef2SBarry Smith   ts->numbermonitors = 0;
3080d763cef2SBarry Smith   PetscFunctionReturn(0);
3081d763cef2SBarry Smith }
3082d763cef2SBarry Smith 
30834a2ae208SSatish Balay #undef __FUNCT__
3084a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
3085d8e5e3e6SSatish Balay /*@
3086a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
30875516499fSSatish Balay 
30885516499fSSatish Balay    Level: intermediate
308941251cbbSSatish Balay 
30905516499fSSatish Balay .keywords: TS, set, monitor
30915516499fSSatish Balay 
309241251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
309341251cbbSSatish Balay @*/
3094649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
3095d763cef2SBarry Smith {
3096dfbe8321SBarry Smith   PetscErrorCode ierr;
30974d4332d5SBarry Smith   PetscViewer    viewer =  (PetscViewer) dummy;
3098d132466eSBarry Smith 
3099d763cef2SBarry Smith   PetscFunctionBegin;
31004d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3101649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
31028392e04aSShri 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);
3103649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3104d763cef2SBarry Smith   PetscFunctionReturn(0);
3105d763cef2SBarry Smith }
3106d763cef2SBarry Smith 
31074a2ae208SSatish Balay #undef __FUNCT__
31089110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorSet"
31099110b2e7SHong Zhang /*@C
31109110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
31119110b2e7SHong Zhang    timestep to display the iteration's  progress.
31129110b2e7SHong Zhang 
31139110b2e7SHong Zhang    Logically Collective on TS
31149110b2e7SHong Zhang 
31159110b2e7SHong Zhang    Input Parameters:
31169110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
31179110b2e7SHong Zhang .  adjointmonitor - monitoring routine
31189110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
31199110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
31209110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
31219110b2e7SHong Zhang           (may be NULL)
31229110b2e7SHong Zhang 
31239110b2e7SHong Zhang    Calling sequence of monitor:
31249110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
31259110b2e7SHong Zhang 
31269110b2e7SHong Zhang +    ts - the TS context
31279110b2e7SHong 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
31289110b2e7SHong Zhang                                been interpolated to)
31299110b2e7SHong Zhang .    time - current time
31309110b2e7SHong Zhang .    u - current iterate
31319110b2e7SHong Zhang .    numcost - number of cost functionos
31329110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
31339110b2e7SHong Zhang .    mu - sensitivities to parameters
31349110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
31359110b2e7SHong Zhang 
31369110b2e7SHong Zhang    Notes:
31379110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
31389110b2e7SHong Zhang    already has been loaded.
31399110b2e7SHong Zhang 
31409110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
31419110b2e7SHong Zhang 
31429110b2e7SHong Zhang    Level: intermediate
31439110b2e7SHong Zhang 
31449110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
31459110b2e7SHong Zhang 
31469110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
31479110b2e7SHong Zhang @*/
31489110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
31499110b2e7SHong Zhang {
31509110b2e7SHong Zhang   PetscFunctionBegin;
31519110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31529110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
31539110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
31549110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
31559110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
31569110b2e7SHong Zhang   PetscFunctionReturn(0);
31579110b2e7SHong Zhang }
31589110b2e7SHong Zhang 
31599110b2e7SHong Zhang #undef __FUNCT__
31609110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorCancel"
31619110b2e7SHong Zhang /*@C
31629110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
31639110b2e7SHong Zhang 
31649110b2e7SHong Zhang    Logically Collective on TS
31659110b2e7SHong Zhang 
31669110b2e7SHong Zhang    Input Parameters:
31679110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
31689110b2e7SHong Zhang 
31699110b2e7SHong Zhang    Notes:
31709110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
31719110b2e7SHong Zhang 
31729110b2e7SHong Zhang    Level: intermediate
31739110b2e7SHong Zhang 
31749110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
31759110b2e7SHong Zhang 
31769110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
31779110b2e7SHong Zhang @*/
31789110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
31799110b2e7SHong Zhang {
31809110b2e7SHong Zhang   PetscErrorCode ierr;
31819110b2e7SHong Zhang   PetscInt       i;
31829110b2e7SHong Zhang 
31839110b2e7SHong Zhang   PetscFunctionBegin;
31849110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31859110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
31869110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
31879110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
31889110b2e7SHong Zhang     }
31899110b2e7SHong Zhang   }
31909110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
31919110b2e7SHong Zhang   PetscFunctionReturn(0);
31929110b2e7SHong Zhang }
31939110b2e7SHong Zhang 
31949110b2e7SHong Zhang #undef __FUNCT__
3195110eb670SHong Zhang #define __FUNCT__ "TSAdjointMonitorDefault"
3196110eb670SHong Zhang /*@
3197110eb670SHong Zhang    TSAdjointMonitorDefault - Sets the Default monitor
3198110eb670SHong Zhang 
3199110eb670SHong Zhang    Level: intermediate
3200110eb670SHong Zhang 
3201110eb670SHong Zhang .keywords: TS, set, monitor
3202110eb670SHong Zhang 
3203110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
3204110eb670SHong Zhang @*/
3205110eb670SHong Zhang PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
3206110eb670SHong Zhang {
3207110eb670SHong Zhang   PetscErrorCode ierr;
3208110eb670SHong Zhang   PetscViewer    viewer =  (PetscViewer) dummy;
3209110eb670SHong Zhang 
3210110eb670SHong Zhang   PetscFunctionBegin;
3211110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3212110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3213110eb670SHong 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);
3214110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3215110eb670SHong Zhang   PetscFunctionReturn(0);
3216110eb670SHong Zhang }
3217110eb670SHong Zhang 
3218110eb670SHong Zhang #undef __FUNCT__
3219cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
3220cd652676SJed Brown /*@
3221cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
3222cd652676SJed Brown 
3223cd652676SJed Brown    Logically Collective on TS
3224cd652676SJed Brown 
3225cd652676SJed Brown    Input Argument:
3226cd652676SJed Brown .  ts - time stepping context
3227cd652676SJed Brown 
3228cd652676SJed Brown    Output Argument:
3229cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
3230cd652676SJed Brown 
3231cd652676SJed Brown    Level: intermediate
3232cd652676SJed Brown 
3233cd652676SJed Brown .keywords: TS, set
3234cd652676SJed Brown 
3235cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
3236cd652676SJed Brown @*/
3237cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
3238cd652676SJed Brown {
3239cd652676SJed Brown   PetscFunctionBegin;
3240cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3241cd652676SJed Brown   ts->retain_stages = flg;
3242cd652676SJed Brown   PetscFunctionReturn(0);
3243cd652676SJed Brown }
3244cd652676SJed Brown 
3245cd652676SJed Brown #undef __FUNCT__
3246cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
3247cd652676SJed Brown /*@
3248cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3249cd652676SJed Brown 
3250cd652676SJed Brown    Collective on TS
3251cd652676SJed Brown 
3252cd652676SJed Brown    Input Argument:
3253cd652676SJed Brown +  ts - time stepping context
3254cd652676SJed Brown -  t - time to interpolate to
3255cd652676SJed Brown 
3256cd652676SJed Brown    Output Argument:
32570910c330SBarry Smith .  U - state at given time
3258cd652676SJed Brown 
3259cd652676SJed Brown    Notes:
3260cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
3261cd652676SJed Brown 
3262cd652676SJed Brown    Level: intermediate
3263cd652676SJed Brown 
3264cd652676SJed Brown    Developer Notes:
3265cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3266cd652676SJed Brown 
3267cd652676SJed Brown .keywords: TS, set
3268cd652676SJed Brown 
3269cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
3270cd652676SJed Brown @*/
32710910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3272cd652676SJed Brown {
3273cd652676SJed Brown   PetscErrorCode ierr;
3274cd652676SJed Brown 
3275cd652676SJed Brown   PetscFunctionBegin;
3276cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3277b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
32786712e2f1SBarry Smith   if (t < ts->ptime - ts->time_step_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)(ts->ptime-ts->time_step_prev),(double)ts->ptime);
3279ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
32800910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3281cd652676SJed Brown   PetscFunctionReturn(0);
3282cd652676SJed Brown }
3283cd652676SJed Brown 
3284cd652676SJed Brown #undef __FUNCT__
32854a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3286d763cef2SBarry Smith /*@
32876d9e5789SSean Farley    TSStep - Steps one time step
3288d763cef2SBarry Smith 
3289d763cef2SBarry Smith    Collective on TS
3290d763cef2SBarry Smith 
3291d763cef2SBarry Smith    Input Parameter:
3292d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3293d763cef2SBarry Smith 
329427829d71SBarry Smith    Level: developer
3295d763cef2SBarry Smith 
3296b8123daeSJed Brown    Notes:
329727829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
329827829d71SBarry Smith 
3299b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3300b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3301b8123daeSJed Brown 
330225cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
330325cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
330425cb2221SBarry Smith 
3305d763cef2SBarry Smith .keywords: TS, timestep, solve
3306d763cef2SBarry Smith 
33079be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3308d763cef2SBarry Smith @*/
3309193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3310d763cef2SBarry Smith {
33112fb8446cSMatthew G. Knepley   DM               dm;
3312dfbe8321SBarry Smith   PetscErrorCode   ierr;
3313fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3314d763cef2SBarry Smith 
3315d763cef2SBarry Smith   PetscFunctionBegin;
33160700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3317fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3318fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3319fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3320fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3321fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3322fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3323302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
3324fffbeea8SBarry Smith 
33252fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3326d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
332768bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3328d405a339SMatthew Knepley 
3329362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
333024655328SShri   ts->ptime_prev = ts->ptime;
3331cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3332bbd56ea5SKarl Rupp 
3333e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3334d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3335193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3336d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3337bbd56ea5SKarl Rupp 
333824655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3339cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3340362cd11cSLisandro Dalcin 
3341362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3342cef5090cSJed Brown     if (ts->errorifstepfailed) {
334308c7845fSBarry 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]);
334408c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3345d2daff3dSHong Zhang     }
334608c7845fSBarry Smith   } else if (!ts->reason) {
334708c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
334808c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
334908c7845fSBarry Smith   }
33502c18e0fdSBarry Smith   ts->total_steps++;
33518392e04aSShri Abhyankar   ts->steprollback = PETSC_FALSE;
335208c7845fSBarry Smith   PetscFunctionReturn(0);
335308c7845fSBarry Smith }
335408c7845fSBarry Smith 
335508c7845fSBarry Smith #undef __FUNCT__
335608c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep"
335708c7845fSBarry Smith /*@
3358b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
335908c7845fSBarry Smith 
336008c7845fSBarry Smith    Collective on TS
336108c7845fSBarry Smith 
336208c7845fSBarry Smith    Input Parameter:
336308c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
336408c7845fSBarry Smith 
33656a4d4014SLisandro Dalcin    Level: intermediate
33666a4d4014SLisandro Dalcin 
3367b957a604SHong Zhang .keywords: TS, adjoint, step
33686a4d4014SLisandro Dalcin 
3369b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
33706a4d4014SLisandro Dalcin @*/
337108c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
33726a4d4014SLisandro Dalcin {
337308c7845fSBarry Smith   DM               dm;
33746a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
33756a4d4014SLisandro Dalcin 
33766a4d4014SLisandro Dalcin   PetscFunctionBegin;
33774a2ae208SSatish Balay   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
337808c7845fSBarry Smith   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
337908c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3380d763cef2SBarry Smith 
3381d763cef2SBarry Smith   ts->reason = TS_CONVERGED_ITERATING;
338208c7845fSBarry Smith   ts->ptime_prev = ts->ptime;
338308c7845fSBarry Smith   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3384685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts, "-ts_view_solution");CHKERRQ(ierr);
3385d763cef2SBarry Smith 
33868d0ad7a8SHong Zhang   ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
338742f2b339SBarry 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);
338842f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
33898d0ad7a8SHong Zhang   ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
3390d763cef2SBarry Smith 
3391cef5090cSJed Brown   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3392cef5090cSJed Brown   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3393362cd11cSLisandro Dalcin 
3394362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3395cef5090cSJed Brown     if (ts->errorifstepfailed) {
33966c4ed002SBarry 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]);
33976c4ed002SBarry 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]);
33986c4ed002SBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3399cef5090cSJed Brown     }
3400362cd11cSLisandro Dalcin   } else if (!ts->reason) {
340173b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3402db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time)         ts->reason = TS_CONVERGED_TIME;
3403362cd11cSLisandro Dalcin   }
34042c18e0fdSBarry Smith   ts->total_steps--;
3405d763cef2SBarry Smith   PetscFunctionReturn(0);
3406d763cef2SBarry Smith }
3407d763cef2SBarry Smith 
3408d763cef2SBarry Smith #undef __FUNCT__
340905175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
341005175c85SJed Brown /*@
341105175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
341205175c85SJed Brown 
34131c3436cfSJed Brown    Collective on TS
341405175c85SJed Brown 
341505175c85SJed Brown    Input Arguments:
34161c3436cfSJed Brown +  ts - time stepping context
34171c3436cfSJed Brown .  order - desired order of accuracy
34180298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
341905175c85SJed Brown 
342005175c85SJed Brown    Output Arguments:
34210910c330SBarry Smith .  U - state at the end of the current step
342205175c85SJed Brown 
342305175c85SJed Brown    Level: advanced
342405175c85SJed Brown 
3425108c343cSJed Brown    Notes:
3426108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3427108c343cSJed 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.
3428108c343cSJed Brown 
34291c3436cfSJed Brown .seealso: TSStep(), TSAdapt
343005175c85SJed Brown @*/
34310910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
343205175c85SJed Brown {
343305175c85SJed Brown   PetscErrorCode ierr;
343405175c85SJed Brown 
343505175c85SJed Brown   PetscFunctionBegin;
343605175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
343705175c85SJed Brown   PetscValidType(ts,1);
34380910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3439ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
34400910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
344105175c85SJed Brown   PetscFunctionReturn(0);
344205175c85SJed Brown }
344305175c85SJed Brown 
3444d67e68b7SBarry Smith 
344505175c85SJed Brown #undef __FUNCT__
3446d763cef2SBarry Smith #define __FUNCT__ "TSSolve"
3447d763cef2SBarry Smith /*@
3448d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
3449d763cef2SBarry Smith 
3450d763cef2SBarry Smith    Collective on TS
3451d763cef2SBarry Smith 
3452d763cef2SBarry Smith    Input Parameter:
3453d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3454cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
34555a3a76d0SJed Brown 
3456d763cef2SBarry Smith    Level: beginner
3457d763cef2SBarry Smith 
34585a3a76d0SJed Brown    Notes:
34595a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
34605a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
34615a3a76d0SJed Brown    stepped over the final time.
34625a3a76d0SJed Brown 
3463d763cef2SBarry Smith .keywords: TS, timestep, solve
3464d763cef2SBarry Smith 
3465d763cef2SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep()
3466d763cef2SBarry Smith @*/
3467cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
3468d763cef2SBarry Smith {
3469b06615a5SLisandro Dalcin   Vec               solution;
3470d763cef2SBarry Smith   PetscErrorCode    ierr;
3471d763cef2SBarry Smith 
3472d763cef2SBarry Smith   PetscFunctionBegin;
3473d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3474f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
347549354f04SShri 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 */
3476b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
34770910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3478b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3479b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3480b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
34815a3a76d0SJed Brown     }
34820910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3483bbd56ea5SKarl Rupp   } else if (u) {
34840910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
34855a3a76d0SJed Brown   }
3486b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
348768bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3488d763cef2SBarry Smith   /* reset time step and iteration counters */
3489193ac0bcSJed Brown   ts->steps             = 0;
34905ef26d82SJed Brown   ts->ksp_its           = 0;
34915ef26d82SJed Brown   ts->snes_its          = 0;
3492c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
3493c610991cSLisandro Dalcin   ts->reject            = 0;
3494193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
3495193ac0bcSJed Brown 
3496ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3497ec8db0baSMatthew G. Knepley   {
3498ec8db0baSMatthew G. Knepley     DM dm;
3499ec8db0baSMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3500ec8db0baSMatthew G. Knepley     ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3501ec8db0baSMatthew G. Knepley   }
3502f05ece33SBarry Smith 
3503193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
3504193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
35050910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
3506cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3507193ac0bcSJed Brown   } else {
3508d763cef2SBarry Smith     /* steps the requested number of timesteps. */
3509db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3510db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3511cdf0de3dSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
351211b05f00SHong Zhang     if (ts->vec_costintegral) ts->costintegralfwd=PETSC_TRUE;
35136fea3669SShri Abhyankar     if(ts->event) {
35146fea3669SShri Abhyankar       ierr = TSEventMonitorInitialize(ts);CHKERRQ(ierr);
35156fea3669SShri Abhyankar     }
3516e1a7a14fSJed Brown     while (!ts->reason) {
3517193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3518193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
3519aeb4809dSShri Abhyankar       if (ts->event) {
3520aeb4809dSShri Abhyankar 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
35211eda64f1SShri Abhyankar       }
35228392e04aSShri Abhyankar       if(!ts->steprollback) {
3523cdf0de3dSShri Abhyankar 	ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
35241eda64f1SShri Abhyankar 	ierr = TSPostStep(ts);CHKERRQ(ierr);
3525aeb4809dSShri Abhyankar       }
3526193ac0bcSJed Brown     }
352749354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
35280910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3529cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3530b06615a5SLisandro Dalcin       solution = u;
35310574a7fbSJed Brown     } else {
3532ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3533cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3534b06615a5SLisandro Dalcin       solution = ts->vec_sol;
35350574a7fbSJed Brown     }
3536b06615a5SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
3537685405a1SBarry Smith     ierr = VecViewFromOptions(solution,(PetscObject) ts,"-ts_view_solution");CHKERRQ(ierr);
3538193ac0bcSJed Brown   }
3539d2daff3dSHong Zhang 
3540ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
3541dc1cb503SEmil Constantinescu   ierr = VecViewFromOptions(ts->vec_sol,NULL,"-ts_view_solution");CHKERRQ(ierr);
354256f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
3543ef222394SBarry Smith   if (ts->adjoint_solve) {
3544ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
35452b0a91c0SBarry Smith   }
3546d763cef2SBarry Smith   PetscFunctionReturn(0);
3547d763cef2SBarry Smith }
3548d763cef2SBarry Smith 
3549d763cef2SBarry Smith #undef __FUNCT__
3550c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve"
3551c88f2d44SBarry Smith /*@
3552c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
3553c88f2d44SBarry Smith 
3554c88f2d44SBarry Smith    Collective on TS
3555c88f2d44SBarry Smith 
3556c88f2d44SBarry Smith    Input Parameter:
35572c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
3558c88f2d44SBarry Smith 
3559e87fd094SBarry Smith    Options Database:
3560e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions
3561e87fd094SBarry Smith 
3562c88f2d44SBarry Smith    Level: intermediate
3563c88f2d44SBarry Smith 
3564c88f2d44SBarry Smith    Notes:
3565c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
3566c88f2d44SBarry Smith 
356773b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
356873b18844SBarry Smith 
3569c88f2d44SBarry Smith .keywords: TS, timestep, solve
3570c88f2d44SBarry Smith 
3571b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
3572c88f2d44SBarry Smith @*/
35732c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
3574c88f2d44SBarry Smith {
3575c88f2d44SBarry Smith   PetscErrorCode    ierr;
3576c88f2d44SBarry Smith 
3577c88f2d44SBarry Smith   PetscFunctionBegin;
3578c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3579c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
358068bece0bSHong Zhang 
3581c88f2d44SBarry Smith   /* reset time step and iteration counters */
3582c88f2d44SBarry Smith   ts->steps             = 0;
3583c88f2d44SBarry Smith   ts->ksp_its           = 0;
3584c88f2d44SBarry Smith   ts->snes_its          = 0;
3585c88f2d44SBarry Smith   ts->num_snes_failures = 0;
3586c88f2d44SBarry Smith   ts->reject            = 0;
3587c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
3588c88f2d44SBarry Smith 
358973b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
3590c88f2d44SBarry Smith 
359173b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3592c88f2d44SBarry Smith   while (!ts->reason) {
359355c52731SHong Zhang     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
35949110b2e7SHong Zhang     ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
3595c88f2d44SBarry Smith     if (ts->event) {
3596d0578d90SShri Abhyankar       ierr = TSAdjointEventMonitor(ts);CHKERRQ(ierr);
3597d0578d90SShri Abhyankar     }
3598616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
3599c88f2d44SBarry Smith   }
360026656371SHong Zhang   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
360126656371SHong Zhang   ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
3602c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
3603685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
3604c88f2d44SBarry Smith   PetscFunctionReturn(0);
3605c88f2d44SBarry Smith }
3606c88f2d44SBarry Smith 
3607c88f2d44SBarry Smith #undef __FUNCT__
3608d763cef2SBarry Smith #define __FUNCT__ "TSMonitor"
36097db568b7SBarry Smith /*@C
3610228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3611228d79bcSJed Brown 
3612228d79bcSJed Brown    Collective on TS
3613228d79bcSJed Brown 
3614228d79bcSJed Brown    Input Parameters:
3615228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3616228d79bcSJed Brown .  step - step number that has just completed
3617228d79bcSJed Brown .  ptime - model time of the state
36180910c330SBarry Smith -  u - state at the current model time
3619228d79bcSJed Brown 
3620228d79bcSJed Brown    Notes:
36217db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
36227db568b7SBarry Smith    Users would almost never call this routine directly.
3623228d79bcSJed Brown 
36247db568b7SBarry Smith    Level: developer
3625228d79bcSJed Brown 
3626228d79bcSJed Brown .keywords: TS, timestep
3627228d79bcSJed Brown @*/
36280910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3629d763cef2SBarry Smith {
36306849ba73SBarry Smith   PetscErrorCode ierr;
3631a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
3632d763cef2SBarry Smith 
3633d763cef2SBarry Smith   PetscFunctionBegin;
3634b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3635b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
36365edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3637d763cef2SBarry Smith   for (i=0; i<n; i++) {
36380910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3639d763cef2SBarry Smith   }
36405edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3641d763cef2SBarry Smith   PetscFunctionReturn(0);
3642d763cef2SBarry Smith }
3643d763cef2SBarry Smith 
36449110b2e7SHong Zhang #undef __FUNCT__
36459110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitor"
36467db568b7SBarry Smith /*@C
36479110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
36489110b2e7SHong Zhang 
36499110b2e7SHong Zhang    Collective on TS
36509110b2e7SHong Zhang 
36519110b2e7SHong Zhang    Input Parameters:
36529110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
36539110b2e7SHong Zhang .  step - step number that has just completed
36549110b2e7SHong Zhang .  ptime - model time of the state
36559110b2e7SHong Zhang .  u - state at the current model time
36569110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
36579110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
36589110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
36599110b2e7SHong Zhang 
36609110b2e7SHong Zhang    Notes:
36617db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
36627db568b7SBarry Smith    Users would almost never call this routine directly.
36639110b2e7SHong Zhang 
36647db568b7SBarry Smith    Level: developer
36659110b2e7SHong Zhang 
36669110b2e7SHong Zhang .keywords: TS, timestep
36679110b2e7SHong Zhang @*/
36689110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
36699110b2e7SHong Zhang {
36709110b2e7SHong Zhang   PetscErrorCode ierr;
36719110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
36729110b2e7SHong Zhang 
36739110b2e7SHong Zhang   PetscFunctionBegin;
36749110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
36759110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
36769110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
36779110b2e7SHong Zhang   for (i=0; i<n; i++) {
36789110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
36799110b2e7SHong Zhang   }
36809110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
36819110b2e7SHong Zhang   PetscFunctionReturn(0);
36829110b2e7SHong Zhang }
36839110b2e7SHong Zhang 
3684d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
36854a2ae208SSatish Balay #undef __FUNCT__
3686a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
3687d763cef2SBarry Smith /*@C
36887db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
3689a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3690d763cef2SBarry Smith 
3691d763cef2SBarry Smith    Collective on TS
3692d763cef2SBarry Smith 
3693d763cef2SBarry Smith    Input Parameters:
3694d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3695d763cef2SBarry Smith .  label - the title to put in the title bar
36967c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3697a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3698a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3699d763cef2SBarry Smith 
3700d763cef2SBarry Smith    Output Parameter:
37010b039ecaSBarry Smith .  ctx - the context
3702d763cef2SBarry Smith 
3703d763cef2SBarry Smith    Options Database Key:
37044f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
37057db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
37067db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
37077db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
37087db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
3709b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
3710d763cef2SBarry Smith 
3711d763cef2SBarry Smith    Notes:
3712a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3713d763cef2SBarry Smith 
37147db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
37157db568b7SBarry Smith 
37167db568b7SBarry 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
37177db568b7SBarry 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
37187db568b7SBarry Smith    as the first argument.
37197db568b7SBarry Smith 
37207db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
37217db568b7SBarry Smith 
37227db568b7SBarry Smith 
3723d763cef2SBarry Smith    Level: intermediate
3724d763cef2SBarry Smith 
37257db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
3726d763cef2SBarry Smith 
37277db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
37287db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
37297db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
37307db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
37317db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
37327c922b88SBarry Smith 
3733d763cef2SBarry Smith @*/
3734a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3735d763cef2SBarry Smith {
37367f52daa2SLisandro Dalcin   PetscDraw      draw;
3737dfbe8321SBarry Smith   PetscErrorCode ierr;
3738d763cef2SBarry Smith 
3739d763cef2SBarry Smith   PetscFunctionBegin;
3740b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
37417f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
37427f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
37437f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
3744b6fe0379SLisandro Dalcin   ierr = PetscDrawLGSetUseMarkers((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3745287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
37467f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
3747a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3748d763cef2SBarry Smith   PetscFunctionReturn(0);
3749d763cef2SBarry Smith }
3750d763cef2SBarry Smith 
37514a2ae208SSatish Balay #undef __FUNCT__
37524f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3753b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3754d763cef2SBarry Smith {
37550b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3756c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3757dfbe8321SBarry Smith   PetscErrorCode ierr;
3758d763cef2SBarry Smith 
3759d763cef2SBarry Smith   PetscFunctionBegin;
3760b06615a5SLisandro Dalcin   if (!step) {
3761a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3762a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
3763a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
3764a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3765a9f9c1f6SBarry Smith   }
3766c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
37670b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3768b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
37690b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
37703923b477SBarry Smith   }
3771d763cef2SBarry Smith   PetscFunctionReturn(0);
3772d763cef2SBarry Smith }
3773d763cef2SBarry Smith 
37744a2ae208SSatish Balay #undef __FUNCT__
3775a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3776d763cef2SBarry Smith /*@C
3777a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3778a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3779d763cef2SBarry Smith 
37800b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3781d763cef2SBarry Smith 
3782d763cef2SBarry Smith    Input Parameter:
37830b039ecaSBarry Smith .  ctx - the monitor context
3784d763cef2SBarry Smith 
3785d763cef2SBarry Smith    Level: intermediate
3786d763cef2SBarry Smith 
3787d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3788d763cef2SBarry Smith 
37894f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3790d763cef2SBarry Smith @*/
3791a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3792d763cef2SBarry Smith {
3793dfbe8321SBarry Smith   PetscErrorCode ierr;
3794d763cef2SBarry Smith 
3795d763cef2SBarry Smith   PetscFunctionBegin;
37967684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
37977684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
37987684fa3eSBarry Smith   }
37990b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
380031152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
3801387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
3802387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
3803387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
38040b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3805d763cef2SBarry Smith   PetscFunctionReturn(0);
3806d763cef2SBarry Smith }
3807d763cef2SBarry Smith 
38084a2ae208SSatish Balay #undef __FUNCT__
38094a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3810d763cef2SBarry Smith /*@
3811b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3812d763cef2SBarry Smith 
3813d763cef2SBarry Smith    Not Collective
3814d763cef2SBarry Smith 
3815d763cef2SBarry Smith    Input Parameter:
3816d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3817d763cef2SBarry Smith 
3818d763cef2SBarry Smith    Output Parameter:
3819d763cef2SBarry Smith .  t  - the current time
3820d763cef2SBarry Smith 
3821d763cef2SBarry Smith    Level: beginner
3822d763cef2SBarry Smith 
3823b8123daeSJed Brown    Note:
3824b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
38259be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3826b8123daeSJed Brown 
3827d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3828d763cef2SBarry Smith 
3829d763cef2SBarry Smith .keywords: TS, get, time
3830d763cef2SBarry Smith @*/
38317087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3832d763cef2SBarry Smith {
3833d763cef2SBarry Smith   PetscFunctionBegin;
38340700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3835f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3836d763cef2SBarry Smith   *t = ts->ptime;
3837d763cef2SBarry Smith   PetscFunctionReturn(0);
3838d763cef2SBarry Smith }
3839d763cef2SBarry Smith 
38404a2ae208SSatish Balay #undef __FUNCT__
3841e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3842e5e524a1SHong Zhang /*@
3843e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3844e5e524a1SHong Zhang 
3845e5e524a1SHong Zhang    Not Collective
3846e5e524a1SHong Zhang 
3847e5e524a1SHong Zhang    Input Parameter:
3848e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3849e5e524a1SHong Zhang 
3850e5e524a1SHong Zhang    Output Parameter:
3851e5e524a1SHong Zhang .  t  - the previous time
3852e5e524a1SHong Zhang 
3853e5e524a1SHong Zhang    Level: beginner
3854e5e524a1SHong Zhang 
3855e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3856e5e524a1SHong Zhang 
3857e5e524a1SHong Zhang .keywords: TS, get, time
3858e5e524a1SHong Zhang @*/
3859e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3860e5e524a1SHong Zhang {
3861e5e524a1SHong Zhang   PetscFunctionBegin;
3862e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3863e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3864e5e524a1SHong Zhang   *t = ts->ptime_prev;
3865e5e524a1SHong Zhang   PetscFunctionReturn(0);
3866e5e524a1SHong Zhang }
3867e5e524a1SHong Zhang 
3868e5e524a1SHong Zhang #undef __FUNCT__
38696a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
38706a4d4014SLisandro Dalcin /*@
38716a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
38726a4d4014SLisandro Dalcin 
38733f9fe445SBarry Smith    Logically Collective on TS
38746a4d4014SLisandro Dalcin 
38756a4d4014SLisandro Dalcin    Input Parameters:
38766a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
38776a4d4014SLisandro Dalcin -  time - the time
38786a4d4014SLisandro Dalcin 
38796a4d4014SLisandro Dalcin    Level: intermediate
38806a4d4014SLisandro Dalcin 
38816a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
38826a4d4014SLisandro Dalcin 
38836a4d4014SLisandro Dalcin .keywords: TS, set, time
38846a4d4014SLisandro Dalcin @*/
38857087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
38866a4d4014SLisandro Dalcin {
38876a4d4014SLisandro Dalcin   PetscFunctionBegin;
38880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3889c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
38906a4d4014SLisandro Dalcin   ts->ptime = t;
38916a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
38926a4d4014SLisandro Dalcin }
38936a4d4014SLisandro Dalcin 
38946a4d4014SLisandro Dalcin #undef __FUNCT__
38954a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3896d763cef2SBarry Smith /*@C
3897d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3898d763cef2SBarry Smith    TS options in the database.
3899d763cef2SBarry Smith 
39003f9fe445SBarry Smith    Logically Collective on TS
3901d763cef2SBarry Smith 
3902d763cef2SBarry Smith    Input Parameter:
3903d763cef2SBarry Smith +  ts     - The TS context
3904d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3905d763cef2SBarry Smith 
3906d763cef2SBarry Smith    Notes:
3907d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3908d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3909d763cef2SBarry Smith    hyphen.
3910d763cef2SBarry Smith 
3911d763cef2SBarry Smith    Level: advanced
3912d763cef2SBarry Smith 
3913d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
3914d763cef2SBarry Smith 
3915d763cef2SBarry Smith .seealso: TSSetFromOptions()
3916d763cef2SBarry Smith 
3917d763cef2SBarry Smith @*/
39187087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3919d763cef2SBarry Smith {
3920dfbe8321SBarry Smith   PetscErrorCode ierr;
3921089b2837SJed Brown   SNES           snes;
3922d763cef2SBarry Smith 
3923d763cef2SBarry Smith   PetscFunctionBegin;
39240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3925d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3926089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3927089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3928d763cef2SBarry Smith   PetscFunctionReturn(0);
3929d763cef2SBarry Smith }
3930d763cef2SBarry Smith 
3931d763cef2SBarry Smith 
39324a2ae208SSatish Balay #undef __FUNCT__
39334a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
3934d763cef2SBarry Smith /*@C
3935d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3936d763cef2SBarry Smith    TS options in the database.
3937d763cef2SBarry Smith 
39383f9fe445SBarry Smith    Logically Collective on TS
3939d763cef2SBarry Smith 
3940d763cef2SBarry Smith    Input Parameter:
3941d763cef2SBarry Smith +  ts     - The TS context
3942d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3943d763cef2SBarry Smith 
3944d763cef2SBarry Smith    Notes:
3945d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3946d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3947d763cef2SBarry Smith    hyphen.
3948d763cef2SBarry Smith 
3949d763cef2SBarry Smith    Level: advanced
3950d763cef2SBarry Smith 
3951d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
3952d763cef2SBarry Smith 
3953d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
3954d763cef2SBarry Smith 
3955d763cef2SBarry Smith @*/
39567087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3957d763cef2SBarry Smith {
3958dfbe8321SBarry Smith   PetscErrorCode ierr;
3959089b2837SJed Brown   SNES           snes;
3960d763cef2SBarry Smith 
3961d763cef2SBarry Smith   PetscFunctionBegin;
39620700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3963d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3964089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3965089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3966d763cef2SBarry Smith   PetscFunctionReturn(0);
3967d763cef2SBarry Smith }
3968d763cef2SBarry Smith 
39694a2ae208SSatish Balay #undef __FUNCT__
39704a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
3971d763cef2SBarry Smith /*@C
3972d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
3973d763cef2SBarry Smith    TS options in the database.
3974d763cef2SBarry Smith 
3975d763cef2SBarry Smith    Not Collective
3976d763cef2SBarry Smith 
3977d763cef2SBarry Smith    Input Parameter:
3978d763cef2SBarry Smith .  ts - The TS context
3979d763cef2SBarry Smith 
3980d763cef2SBarry Smith    Output Parameter:
3981d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
3982d763cef2SBarry Smith 
3983d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
3984d763cef2SBarry Smith    sufficient length to hold the prefix.
3985d763cef2SBarry Smith 
3986d763cef2SBarry Smith    Level: intermediate
3987d763cef2SBarry Smith 
3988d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
3989d763cef2SBarry Smith 
3990d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
3991d763cef2SBarry Smith @*/
39927087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3993d763cef2SBarry Smith {
3994dfbe8321SBarry Smith   PetscErrorCode ierr;
3995d763cef2SBarry Smith 
3996d763cef2SBarry Smith   PetscFunctionBegin;
39970700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
39984482741eSBarry Smith   PetscValidPointer(prefix,2);
3999d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4000d763cef2SBarry Smith   PetscFunctionReturn(0);
4001d763cef2SBarry Smith }
4002d763cef2SBarry Smith 
40034a2ae208SSatish Balay #undef __FUNCT__
40044a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
4005d763cef2SBarry Smith /*@C
4006d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4007d763cef2SBarry Smith 
4008d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4009d763cef2SBarry Smith 
4010d763cef2SBarry Smith    Input Parameter:
4011d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4012d763cef2SBarry Smith 
4013d763cef2SBarry Smith    Output Parameters:
4014e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4015e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4016e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4017e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4018d763cef2SBarry Smith 
40190298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
4020d763cef2SBarry Smith 
4021d763cef2SBarry Smith    Level: intermediate
4022d763cef2SBarry Smith 
402326d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
4024d763cef2SBarry Smith 
4025d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
4026d763cef2SBarry Smith @*/
4027e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4028d763cef2SBarry Smith {
4029089b2837SJed Brown   PetscErrorCode ierr;
4030089b2837SJed Brown   SNES           snes;
403124989b8cSPeter Brune   DM             dm;
4032089b2837SJed Brown 
4033d763cef2SBarry Smith   PetscFunctionBegin;
4034089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4035e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
403624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
403724989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4038d763cef2SBarry Smith   PetscFunctionReturn(0);
4039d763cef2SBarry Smith }
4040d763cef2SBarry Smith 
40411713a123SBarry Smith #undef __FUNCT__
40422eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
40432eca1d9cSJed Brown /*@C
40442eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
40452eca1d9cSJed Brown 
40462eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
40472eca1d9cSJed Brown 
40482eca1d9cSJed Brown    Input Parameter:
40492eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
40502eca1d9cSJed Brown 
40512eca1d9cSJed Brown    Output Parameters:
4052e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4053e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
40542eca1d9cSJed Brown .  f   - The function to compute the matrices
40552eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
40562eca1d9cSJed Brown 
40570298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
40582eca1d9cSJed Brown 
40592eca1d9cSJed Brown    Level: advanced
40602eca1d9cSJed Brown 
40612eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
40622eca1d9cSJed Brown 
40632eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
40642eca1d9cSJed Brown @*/
4065e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
40662eca1d9cSJed Brown {
4067089b2837SJed Brown   PetscErrorCode ierr;
4068089b2837SJed Brown   SNES           snes;
406924989b8cSPeter Brune   DM             dm;
40700910c330SBarry Smith 
40712eca1d9cSJed Brown   PetscFunctionBegin;
4072089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4073f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4074e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
407524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
407624989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
40772eca1d9cSJed Brown   PetscFunctionReturn(0);
40782eca1d9cSJed Brown }
40792eca1d9cSJed Brown 
40806083293cSBarry Smith 
40812eca1d9cSJed Brown #undef __FUNCT__
408283a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
40831713a123SBarry Smith /*@C
408483a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
40851713a123SBarry Smith    VecView() for the solution at each timestep
40861713a123SBarry Smith 
40871713a123SBarry Smith    Collective on TS
40881713a123SBarry Smith 
40891713a123SBarry Smith    Input Parameters:
40901713a123SBarry Smith +  ts - the TS context
40911713a123SBarry Smith .  step - current time-step
4092142b95e3SSatish Balay .  ptime - current time
40930298fd71SBarry Smith -  dummy - either a viewer or NULL
40941713a123SBarry Smith 
409599fdda47SBarry Smith    Options Database:
409699fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
409799fdda47SBarry Smith 
4098387f4636SBarry 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
409999fdda47SBarry Smith        will look bad
410099fdda47SBarry Smith 
41011713a123SBarry Smith    Level: intermediate
41021713a123SBarry Smith 
41031713a123SBarry Smith .keywords: TS,  vector, monitor, view
41041713a123SBarry Smith 
4105a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
41061713a123SBarry Smith @*/
41070910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
41081713a123SBarry Smith {
4109dfbe8321SBarry Smith   PetscErrorCode   ierr;
411083a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4111473a3ab2SBarry Smith   PetscDraw        draw;
41121713a123SBarry Smith 
41131713a123SBarry Smith   PetscFunctionBegin;
41146083293cSBarry Smith   if (!step && ictx->showinitial) {
41156083293cSBarry Smith     if (!ictx->initialsolution) {
41160910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
41171713a123SBarry Smith     }
41180910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
41196083293cSBarry Smith   }
4120b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
41210dcf80beSBarry Smith 
41226083293cSBarry Smith   if (ictx->showinitial) {
41236083293cSBarry Smith     PetscReal pause;
41246083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
41256083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
41266083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
41276083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
41286083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
41296083293cSBarry Smith   }
41300910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4131473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
413251fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4133473a3ab2SBarry Smith     char      time[32];
4134473a3ab2SBarry Smith 
4135473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
413685b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4137473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4138473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
413951fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4140473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4141473a3ab2SBarry Smith   }
4142473a3ab2SBarry Smith 
41436083293cSBarry Smith   if (ictx->showinitial) {
41446083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
41456083293cSBarry Smith   }
41461713a123SBarry Smith   PetscFunctionReturn(0);
41471713a123SBarry Smith }
41481713a123SBarry Smith 
41492d5ee99bSBarry Smith #undef __FUNCT__
41509110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorDrawSensi"
41519110b2e7SHong Zhang /*@C
41529110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
41539110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
41549110b2e7SHong Zhang 
41559110b2e7SHong Zhang    Collective on TS
41569110b2e7SHong Zhang 
41579110b2e7SHong Zhang    Input Parameters:
41589110b2e7SHong Zhang +  ts - the TS context
41599110b2e7SHong Zhang .  step - current time-step
41609110b2e7SHong Zhang .  ptime - current time
41619110b2e7SHong Zhang .  u - current state
41629110b2e7SHong Zhang .  numcost - number of cost functions
41639110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
41649110b2e7SHong Zhang .  mu - sensitivities to parameters
41659110b2e7SHong Zhang -  dummy - either a viewer or NULL
41669110b2e7SHong Zhang 
41679110b2e7SHong Zhang    Level: intermediate
41689110b2e7SHong Zhang 
41699110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
41709110b2e7SHong Zhang 
41719110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
41729110b2e7SHong Zhang @*/
41739110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
41749110b2e7SHong Zhang {
41759110b2e7SHong Zhang   PetscErrorCode   ierr;
41769110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
41779110b2e7SHong Zhang   PetscDraw        draw;
4178a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
4179a0046e2cSSatish Balay   char             time[32];
41809110b2e7SHong Zhang 
41819110b2e7SHong Zhang   PetscFunctionBegin;
41829110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
41839110b2e7SHong Zhang 
41849110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
41859110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
41869110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
41879110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
41889110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
41899110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
41909110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
41919110b2e7SHong Zhang 
41929110b2e7SHong Zhang   PetscFunctionReturn(0);
41939110b2e7SHong Zhang }
41949110b2e7SHong Zhang 
41959110b2e7SHong Zhang #undef __FUNCT__
41962d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
41972d5ee99bSBarry Smith /*@C
41982d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
41992d5ee99bSBarry Smith 
42002d5ee99bSBarry Smith    Collective on TS
42012d5ee99bSBarry Smith 
42022d5ee99bSBarry Smith    Input Parameters:
42032d5ee99bSBarry Smith +  ts - the TS context
42042d5ee99bSBarry Smith .  step - current time-step
42052d5ee99bSBarry Smith .  ptime - current time
42062d5ee99bSBarry Smith -  dummy - either a viewer or NULL
42072d5ee99bSBarry Smith 
42082d5ee99bSBarry Smith    Level: intermediate
42092d5ee99bSBarry Smith 
42102d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
42112d5ee99bSBarry Smith 
42122d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
42132d5ee99bSBarry Smith @*/
42142d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
42152d5ee99bSBarry Smith {
42162d5ee99bSBarry Smith   PetscErrorCode    ierr;
42172d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
42182d5ee99bSBarry Smith   PetscDraw         draw;
42192d5ee99bSBarry Smith   MPI_Comm          comm;
42202d5ee99bSBarry Smith   PetscInt          n;
42212d5ee99bSBarry Smith   PetscMPIInt       size;
422251fa3d41SBarry Smith   PetscReal         xl,yl,xr,yr,h;
42232d5ee99bSBarry Smith   char              time[32];
42242d5ee99bSBarry Smith   const PetscScalar *U;
42252d5ee99bSBarry Smith 
42262d5ee99bSBarry Smith   PetscFunctionBegin;
42272d5ee99bSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
42282d5ee99bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
42292d5ee99bSBarry Smith   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
42302d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
42312d5ee99bSBarry Smith   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
42322d5ee99bSBarry Smith 
42332d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
42342d5ee99bSBarry Smith 
42352d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
42364b363babSBarry Smith   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
4237ba5783adSMatthew G Knepley   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
4238a4494fc1SBarry Smith       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
4239a4494fc1SBarry Smith       PetscFunctionReturn(0);
4240a4494fc1SBarry Smith   }
42412d5ee99bSBarry Smith   if (!step) ictx->color++;
42422d5ee99bSBarry Smith   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
42432d5ee99bSBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
42442d5ee99bSBarry Smith 
42452d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
42464b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
424785b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
42482d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
424951fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
42502d5ee99bSBarry Smith   }
42512d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
42522d5ee99bSBarry Smith   PetscFunctionReturn(0);
42532d5ee99bSBarry Smith }
42542d5ee99bSBarry Smith 
42551713a123SBarry Smith 
42566c699258SBarry Smith #undef __FUNCT__
425783a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
42586083293cSBarry Smith /*@C
425983a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
42606083293cSBarry Smith 
42616083293cSBarry Smith    Collective on TS
42626083293cSBarry Smith 
42636083293cSBarry Smith    Input Parameters:
42646083293cSBarry Smith .    ctx - the monitor context
42656083293cSBarry Smith 
42666083293cSBarry Smith    Level: intermediate
42676083293cSBarry Smith 
42686083293cSBarry Smith .keywords: TS,  vector, monitor, view
42696083293cSBarry Smith 
427083a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
42716083293cSBarry Smith @*/
427283a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
42736083293cSBarry Smith {
42746083293cSBarry Smith   PetscErrorCode ierr;
42756083293cSBarry Smith 
42766083293cSBarry Smith   PetscFunctionBegin;
42774b363babSBarry Smith   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
427883a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
427983a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
428083a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
42816083293cSBarry Smith   PetscFunctionReturn(0);
42826083293cSBarry Smith }
42836083293cSBarry Smith 
42846083293cSBarry Smith #undef __FUNCT__
428583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
42866083293cSBarry Smith /*@C
428783a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
42886083293cSBarry Smith 
42896083293cSBarry Smith    Collective on TS
42906083293cSBarry Smith 
42916083293cSBarry Smith    Input Parameter:
42926083293cSBarry Smith .    ts - time-step context
42936083293cSBarry Smith 
42946083293cSBarry Smith    Output Patameter:
42956083293cSBarry Smith .    ctx - the monitor context
42966083293cSBarry Smith 
429799fdda47SBarry Smith    Options Database:
429899fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
429999fdda47SBarry Smith 
43006083293cSBarry Smith    Level: intermediate
43016083293cSBarry Smith 
43026083293cSBarry Smith .keywords: TS,  vector, monitor, view
43036083293cSBarry Smith 
430483a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
43056083293cSBarry Smith @*/
430683a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
43076083293cSBarry Smith {
43086083293cSBarry Smith   PetscErrorCode   ierr;
43096083293cSBarry Smith 
43106083293cSBarry Smith   PetscFunctionBegin;
4311b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
431283a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4313e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4314bbd56ea5SKarl Rupp 
431583a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4316473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
4317c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4318473a3ab2SBarry Smith 
4319473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
4320c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
43212d5ee99bSBarry Smith   (*ctx)->color = PETSC_DRAW_WHITE;
43226083293cSBarry Smith   PetscFunctionReturn(0);
43236083293cSBarry Smith }
43246083293cSBarry Smith 
43256083293cSBarry Smith #undef __FUNCT__
432683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
43273a471f94SBarry Smith /*@C
432883a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
43293a471f94SBarry Smith    VecView() for the error at each timestep
43303a471f94SBarry Smith 
43313a471f94SBarry Smith    Collective on TS
43323a471f94SBarry Smith 
43333a471f94SBarry Smith    Input Parameters:
43343a471f94SBarry Smith +  ts - the TS context
43353a471f94SBarry Smith .  step - current time-step
43363a471f94SBarry Smith .  ptime - current time
43370298fd71SBarry Smith -  dummy - either a viewer or NULL
43383a471f94SBarry Smith 
43393a471f94SBarry Smith    Level: intermediate
43403a471f94SBarry Smith 
43413a471f94SBarry Smith .keywords: TS,  vector, monitor, view
43423a471f94SBarry Smith 
43433a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
43443a471f94SBarry Smith @*/
43450910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
43463a471f94SBarry Smith {
43473a471f94SBarry Smith   PetscErrorCode   ierr;
434883a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
434983a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
43503a471f94SBarry Smith   Vec              work;
43513a471f94SBarry Smith 
43523a471f94SBarry Smith   PetscFunctionBegin;
4353b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
43540910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
43553a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
43560910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
43573a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
43583a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
43593a471f94SBarry Smith   PetscFunctionReturn(0);
43603a471f94SBarry Smith }
43613a471f94SBarry Smith 
4362af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
43633a471f94SBarry Smith #undef __FUNCT__
43646c699258SBarry Smith #define __FUNCT__ "TSSetDM"
43656c699258SBarry Smith /*@
43666c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
43676c699258SBarry Smith 
43683f9fe445SBarry Smith    Logically Collective on TS and DM
43696c699258SBarry Smith 
43706c699258SBarry Smith    Input Parameters:
43716c699258SBarry Smith +  ts - the preconditioner context
43726c699258SBarry Smith -  dm - the dm
43736c699258SBarry Smith 
43746c699258SBarry Smith    Level: intermediate
43756c699258SBarry Smith 
43766c699258SBarry Smith 
43776c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
43786c699258SBarry Smith @*/
43797087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
43806c699258SBarry Smith {
43816c699258SBarry Smith   PetscErrorCode ierr;
4382089b2837SJed Brown   SNES           snes;
4383942e3340SBarry Smith   DMTS           tsdm;
43846c699258SBarry Smith 
43856c699258SBarry Smith   PetscFunctionBegin;
43860700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
438770663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4388942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
43892a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4390942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4391942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
439224989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
439324989b8cSPeter Brune         tsdm->originaldm = dm;
439424989b8cSPeter Brune       }
439524989b8cSPeter Brune     }
43966bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
439724989b8cSPeter Brune   }
43986c699258SBarry Smith   ts->dm = dm;
4399bbd56ea5SKarl Rupp 
4400089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4401089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
44026c699258SBarry Smith   PetscFunctionReturn(0);
44036c699258SBarry Smith }
44046c699258SBarry Smith 
44056c699258SBarry Smith #undef __FUNCT__
44066c699258SBarry Smith #define __FUNCT__ "TSGetDM"
44076c699258SBarry Smith /*@
44086c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
44096c699258SBarry Smith 
44103f9fe445SBarry Smith    Not Collective
44116c699258SBarry Smith 
44126c699258SBarry Smith    Input Parameter:
44136c699258SBarry Smith . ts - the preconditioner context
44146c699258SBarry Smith 
44156c699258SBarry Smith    Output Parameter:
44166c699258SBarry Smith .  dm - the dm
44176c699258SBarry Smith 
44186c699258SBarry Smith    Level: intermediate
44196c699258SBarry Smith 
44206c699258SBarry Smith 
44216c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
44226c699258SBarry Smith @*/
44237087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
44246c699258SBarry Smith {
4425496e6a7aSJed Brown   PetscErrorCode ierr;
4426496e6a7aSJed Brown 
44276c699258SBarry Smith   PetscFunctionBegin;
44280700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4429496e6a7aSJed Brown   if (!ts->dm) {
4430ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4431496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4432496e6a7aSJed Brown   }
44336c699258SBarry Smith   *dm = ts->dm;
44346c699258SBarry Smith   PetscFunctionReturn(0);
44356c699258SBarry Smith }
44361713a123SBarry Smith 
44370f5c6efeSJed Brown #undef __FUNCT__
44380f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
44390f5c6efeSJed Brown /*@
44400f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
44410f5c6efeSJed Brown 
44423f9fe445SBarry Smith    Logically Collective on SNES
44430f5c6efeSJed Brown 
44440f5c6efeSJed Brown    Input Parameter:
4445d42a1c89SJed Brown + snes - nonlinear solver
44460910c330SBarry Smith . U - the current state at which to evaluate the residual
4447d42a1c89SJed Brown - ctx - user context, must be a TS
44480f5c6efeSJed Brown 
44490f5c6efeSJed Brown    Output Parameter:
44500f5c6efeSJed Brown . F - the nonlinear residual
44510f5c6efeSJed Brown 
44520f5c6efeSJed Brown    Notes:
44530f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
44540f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
44550f5c6efeSJed Brown 
44560f5c6efeSJed Brown    Level: advanced
44570f5c6efeSJed Brown 
44580f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
44590f5c6efeSJed Brown @*/
44600910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
44610f5c6efeSJed Brown {
44620f5c6efeSJed Brown   TS             ts = (TS)ctx;
44630f5c6efeSJed Brown   PetscErrorCode ierr;
44640f5c6efeSJed Brown 
44650f5c6efeSJed Brown   PetscFunctionBegin;
44660f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
44670910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
44680f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
44690f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
44700910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
44710f5c6efeSJed Brown   PetscFunctionReturn(0);
44720f5c6efeSJed Brown }
44730f5c6efeSJed Brown 
44740f5c6efeSJed Brown #undef __FUNCT__
44750f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
44760f5c6efeSJed Brown /*@
44770f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
44780f5c6efeSJed Brown 
44790f5c6efeSJed Brown    Collective on SNES
44800f5c6efeSJed Brown 
44810f5c6efeSJed Brown    Input Parameter:
44820f5c6efeSJed Brown + snes - nonlinear solver
44830910c330SBarry Smith . U - the current state at which to evaluate the residual
44840f5c6efeSJed Brown - ctx - user context, must be a TS
44850f5c6efeSJed Brown 
44860f5c6efeSJed Brown    Output Parameter:
44870f5c6efeSJed Brown + A - the Jacobian
44880f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
44890f5c6efeSJed Brown - flag - indicates any structure change in the matrix
44900f5c6efeSJed Brown 
44910f5c6efeSJed Brown    Notes:
44920f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
44930f5c6efeSJed Brown 
44940f5c6efeSJed Brown    Level: developer
44950f5c6efeSJed Brown 
44960f5c6efeSJed Brown .seealso: SNESSetJacobian()
44970f5c6efeSJed Brown @*/
4498d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
44990f5c6efeSJed Brown {
45000f5c6efeSJed Brown   TS             ts = (TS)ctx;
45010f5c6efeSJed Brown   PetscErrorCode ierr;
45020f5c6efeSJed Brown 
45030f5c6efeSJed Brown   PetscFunctionBegin;
45040f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
45050910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
45060f5c6efeSJed Brown   PetscValidPointer(A,3);
450794ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
45080f5c6efeSJed Brown   PetscValidPointer(B,4);
450994ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
45100f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4511d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
45120f5c6efeSJed Brown   PetscFunctionReturn(0);
45130f5c6efeSJed Brown }
4514325fc9f4SBarry Smith 
45150e4ef248SJed Brown #undef __FUNCT__
45160e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
45170e4ef248SJed Brown /*@C
45189ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
45190e4ef248SJed Brown 
45200e4ef248SJed Brown    Collective on TS
45210e4ef248SJed Brown 
45220e4ef248SJed Brown    Input Arguments:
45230e4ef248SJed Brown +  ts - time stepping context
45240e4ef248SJed Brown .  t - time at which to evaluate
45250910c330SBarry Smith .  U - state at which to evaluate
45260e4ef248SJed Brown -  ctx - context
45270e4ef248SJed Brown 
45280e4ef248SJed Brown    Output Arguments:
45290e4ef248SJed Brown .  F - right hand side
45300e4ef248SJed Brown 
45310e4ef248SJed Brown    Level: intermediate
45320e4ef248SJed Brown 
45330e4ef248SJed Brown    Notes:
45340e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
45350e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
45360e4ef248SJed Brown 
45370e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
45380e4ef248SJed Brown @*/
45390910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
45400e4ef248SJed Brown {
45410e4ef248SJed Brown   PetscErrorCode ierr;
45420e4ef248SJed Brown   Mat            Arhs,Brhs;
45430e4ef248SJed Brown 
45440e4ef248SJed Brown   PetscFunctionBegin;
45450e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4546d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
45470910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
45480e4ef248SJed Brown   PetscFunctionReturn(0);
45490e4ef248SJed Brown }
45500e4ef248SJed Brown 
45510e4ef248SJed Brown #undef __FUNCT__
45520e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
45530e4ef248SJed Brown /*@C
45540e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
45550e4ef248SJed Brown 
45560e4ef248SJed Brown    Collective on TS
45570e4ef248SJed Brown 
45580e4ef248SJed Brown    Input Arguments:
45590e4ef248SJed Brown +  ts - time stepping context
45600e4ef248SJed Brown .  t - time at which to evaluate
45610910c330SBarry Smith .  U - state at which to evaluate
45620e4ef248SJed Brown -  ctx - context
45630e4ef248SJed Brown 
45640e4ef248SJed Brown    Output Arguments:
45650e4ef248SJed Brown +  A - pointer to operator
45660e4ef248SJed Brown .  B - pointer to preconditioning matrix
45670e4ef248SJed Brown -  flg - matrix structure flag
45680e4ef248SJed Brown 
45690e4ef248SJed Brown    Level: intermediate
45700e4ef248SJed Brown 
45710e4ef248SJed Brown    Notes:
45720e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
45730e4ef248SJed Brown 
45740e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
45750e4ef248SJed Brown @*/
4576d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
45770e4ef248SJed Brown {
45780e4ef248SJed Brown   PetscFunctionBegin;
45790e4ef248SJed Brown   PetscFunctionReturn(0);
45800e4ef248SJed Brown }
45810e4ef248SJed Brown 
45820026cea9SSean Farley #undef __FUNCT__
45830026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
45840026cea9SSean Farley /*@C
45850026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
45860026cea9SSean Farley 
45870026cea9SSean Farley    Collective on TS
45880026cea9SSean Farley 
45890026cea9SSean Farley    Input Arguments:
45900026cea9SSean Farley +  ts - time stepping context
45910026cea9SSean Farley .  t - time at which to evaluate
45920910c330SBarry Smith .  U - state at which to evaluate
45930910c330SBarry Smith .  Udot - time derivative of state vector
45940026cea9SSean Farley -  ctx - context
45950026cea9SSean Farley 
45960026cea9SSean Farley    Output Arguments:
45970026cea9SSean Farley .  F - left hand side
45980026cea9SSean Farley 
45990026cea9SSean Farley    Level: intermediate
46000026cea9SSean Farley 
46010026cea9SSean Farley    Notes:
46020910c330SBarry 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
46030026cea9SSean Farley    user is required to write their own TSComputeIFunction.
46040026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
46050026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
46060026cea9SSean Farley 
46079ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
46089ae8fd06SBarry Smith 
46099ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
46100026cea9SSean Farley @*/
46110910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
46120026cea9SSean Farley {
46130026cea9SSean Farley   PetscErrorCode ierr;
46140026cea9SSean Farley   Mat            A,B;
46150026cea9SSean Farley 
46160026cea9SSean Farley   PetscFunctionBegin;
46170298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4618d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
46190910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
46200026cea9SSean Farley   PetscFunctionReturn(0);
46210026cea9SSean Farley }
46220026cea9SSean Farley 
46230026cea9SSean Farley #undef __FUNCT__
46240026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
46250026cea9SSean Farley /*@C
4626b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
46270026cea9SSean Farley 
46280026cea9SSean Farley    Collective on TS
46290026cea9SSean Farley 
46300026cea9SSean Farley    Input Arguments:
46310026cea9SSean Farley +  ts - time stepping context
46320026cea9SSean Farley .  t - time at which to evaluate
46330910c330SBarry Smith .  U - state at which to evaluate
46340910c330SBarry Smith .  Udot - time derivative of state vector
46350026cea9SSean Farley .  shift - shift to apply
46360026cea9SSean Farley -  ctx - context
46370026cea9SSean Farley 
46380026cea9SSean Farley    Output Arguments:
46390026cea9SSean Farley +  A - pointer to operator
46400026cea9SSean Farley .  B - pointer to preconditioning matrix
46410026cea9SSean Farley -  flg - matrix structure flag
46420026cea9SSean Farley 
4643b41af12eSJed Brown    Level: advanced
46440026cea9SSean Farley 
46450026cea9SSean Farley    Notes:
46460026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
46470026cea9SSean Farley 
4648b41af12eSJed Brown    It is only appropriate for problems of the form
4649b41af12eSJed Brown 
4650b41af12eSJed Brown $     M Udot = F(U,t)
4651b41af12eSJed Brown 
4652b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4653b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4654b41af12eSJed Brown   an implicit operator of the form
4655b41af12eSJed Brown 
4656b41af12eSJed Brown $    shift*M + J
4657b41af12eSJed Brown 
4658b41af12eSJed 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
4659b41af12eSJed Brown   a copy of M or reassemble it when requested.
4660b41af12eSJed Brown 
46610026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
46620026cea9SSean Farley @*/
4663d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
46640026cea9SSean Farley {
4665b41af12eSJed Brown   PetscErrorCode ierr;
4666b41af12eSJed Brown 
46670026cea9SSean Farley   PetscFunctionBegin;
466894ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4669b41af12eSJed Brown   ts->ijacobian.shift = shift;
46700026cea9SSean Farley   PetscFunctionReturn(0);
46710026cea9SSean Farley }
4672b41af12eSJed Brown 
4673e817cc15SEmil Constantinescu #undef __FUNCT__
4674e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
4675e817cc15SEmil Constantinescu /*@
4676e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4677e817cc15SEmil Constantinescu 
4678e817cc15SEmil Constantinescu    Not Collective
4679e817cc15SEmil Constantinescu 
4680e817cc15SEmil Constantinescu    Input Parameter:
4681e817cc15SEmil Constantinescu .  ts - the TS context
4682e817cc15SEmil Constantinescu 
4683e817cc15SEmil Constantinescu    Output Parameter:
46844e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4685e817cc15SEmil Constantinescu 
4686e817cc15SEmil Constantinescu    Level: beginner
4687e817cc15SEmil Constantinescu 
4688e817cc15SEmil Constantinescu .keywords: TS, equation type
4689e817cc15SEmil Constantinescu 
4690e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4691e817cc15SEmil Constantinescu @*/
4692e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4693e817cc15SEmil Constantinescu {
4694e817cc15SEmil Constantinescu   PetscFunctionBegin;
4695e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4696e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4697e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4698e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4699e817cc15SEmil Constantinescu }
4700e817cc15SEmil Constantinescu 
4701e817cc15SEmil Constantinescu #undef __FUNCT__
4702e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
4703e817cc15SEmil Constantinescu /*@
4704e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4705e817cc15SEmil Constantinescu 
4706e817cc15SEmil Constantinescu    Not Collective
4707e817cc15SEmil Constantinescu 
4708e817cc15SEmil Constantinescu    Input Parameter:
4709e817cc15SEmil Constantinescu +  ts - the TS context
47101297b224SEmil Constantinescu -  equation_type - see TSEquationType
4711e817cc15SEmil Constantinescu 
4712e817cc15SEmil Constantinescu    Level: advanced
4713e817cc15SEmil Constantinescu 
4714e817cc15SEmil Constantinescu .keywords: TS, equation type
4715e817cc15SEmil Constantinescu 
4716e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4717e817cc15SEmil Constantinescu @*/
4718e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4719e817cc15SEmil Constantinescu {
4720e817cc15SEmil Constantinescu   PetscFunctionBegin;
4721e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4722e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4723e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4724e817cc15SEmil Constantinescu }
47250026cea9SSean Farley 
47264af1b03aSJed Brown #undef __FUNCT__
47274af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
47284af1b03aSJed Brown /*@
47294af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
47304af1b03aSJed Brown 
47314af1b03aSJed Brown    Not Collective
47324af1b03aSJed Brown 
47334af1b03aSJed Brown    Input Parameter:
47344af1b03aSJed Brown .  ts - the TS context
47354af1b03aSJed Brown 
47364af1b03aSJed Brown    Output Parameter:
47374af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
47384af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
47394af1b03aSJed Brown 
4740487e0bb9SJed Brown    Level: beginner
47414af1b03aSJed Brown 
4742cd652676SJed Brown    Notes:
4743cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
47444af1b03aSJed Brown 
47454af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
47464af1b03aSJed Brown 
47474af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
47484af1b03aSJed Brown @*/
47494af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
47504af1b03aSJed Brown {
47514af1b03aSJed Brown   PetscFunctionBegin;
47524af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
47534af1b03aSJed Brown   PetscValidPointer(reason,2);
47544af1b03aSJed Brown   *reason = ts->reason;
47554af1b03aSJed Brown   PetscFunctionReturn(0);
47564af1b03aSJed Brown }
47574af1b03aSJed Brown 
4758fb1732b5SBarry Smith #undef __FUNCT__
4759d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
4760d6ad946cSShri Abhyankar /*@
4761d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4762d6ad946cSShri Abhyankar 
4763d6ad946cSShri Abhyankar    Not Collective
4764d6ad946cSShri Abhyankar 
4765d6ad946cSShri Abhyankar    Input Parameter:
4766d6ad946cSShri Abhyankar +  ts - the TS context
4767d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4768d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4769d6ad946cSShri Abhyankar 
4770f5abba47SShri Abhyankar    Level: advanced
4771d6ad946cSShri Abhyankar 
4772d6ad946cSShri Abhyankar    Notes:
4773d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4774d6ad946cSShri Abhyankar 
4775d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4776d6ad946cSShri Abhyankar 
4777d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4778d6ad946cSShri Abhyankar @*/
4779d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4780d6ad946cSShri Abhyankar {
4781d6ad946cSShri Abhyankar   PetscFunctionBegin;
4782d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4783d6ad946cSShri Abhyankar   ts->reason = reason;
4784d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4785d6ad946cSShri Abhyankar }
4786d6ad946cSShri Abhyankar 
4787d6ad946cSShri Abhyankar #undef __FUNCT__
4788cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4789cc708dedSBarry Smith /*@
4790cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4791cc708dedSBarry Smith 
4792cc708dedSBarry Smith    Not Collective
4793cc708dedSBarry Smith 
4794cc708dedSBarry Smith    Input Parameter:
4795cc708dedSBarry Smith .  ts - the TS context
4796cc708dedSBarry Smith 
4797cc708dedSBarry Smith    Output Parameter:
4798cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4799cc708dedSBarry Smith 
4800487e0bb9SJed Brown    Level: beginner
4801cc708dedSBarry Smith 
4802cc708dedSBarry Smith    Notes:
4803cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4804cc708dedSBarry Smith 
4805cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4806cc708dedSBarry Smith 
4807cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4808cc708dedSBarry Smith @*/
4809cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4810cc708dedSBarry Smith {
4811cc708dedSBarry Smith   PetscFunctionBegin;
4812cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4813cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4814cc708dedSBarry Smith   *ftime = ts->solvetime;
4815cc708dedSBarry Smith   PetscFunctionReturn(0);
4816cc708dedSBarry Smith }
4817cc708dedSBarry Smith 
4818cc708dedSBarry Smith #undef __FUNCT__
48192c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps"
48202c18e0fdSBarry Smith /*@
48212c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
48222c18e0fdSBarry Smith 
48232c18e0fdSBarry Smith    Not Collective
48242c18e0fdSBarry Smith 
48252c18e0fdSBarry Smith    Input Parameter:
48262c18e0fdSBarry Smith .  ts - the TS context
48272c18e0fdSBarry Smith 
48282c18e0fdSBarry Smith    Output Parameter:
48292c18e0fdSBarry Smith .  steps - the number of steps
48302c18e0fdSBarry Smith 
48312c18e0fdSBarry Smith    Level: beginner
48322c18e0fdSBarry Smith 
48332c18e0fdSBarry Smith    Notes:
48342c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
48352c18e0fdSBarry Smith 
48362c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
48372c18e0fdSBarry Smith 
48382c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
48392c18e0fdSBarry Smith @*/
48402c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
48412c18e0fdSBarry Smith {
48422c18e0fdSBarry Smith   PetscFunctionBegin;
48432c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48442c18e0fdSBarry Smith   PetscValidPointer(steps,2);
48452c18e0fdSBarry Smith   *steps = ts->total_steps;
48462c18e0fdSBarry Smith   PetscFunctionReturn(0);
48472c18e0fdSBarry Smith }
48482c18e0fdSBarry Smith 
48492c18e0fdSBarry Smith #undef __FUNCT__
48505ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
48519f67acb7SJed Brown /*@
48525ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
48539f67acb7SJed Brown    used by the time integrator.
48549f67acb7SJed Brown 
48559f67acb7SJed Brown    Not Collective
48569f67acb7SJed Brown 
48579f67acb7SJed Brown    Input Parameter:
48589f67acb7SJed Brown .  ts - TS context
48599f67acb7SJed Brown 
48609f67acb7SJed Brown    Output Parameter:
48619f67acb7SJed Brown .  nits - number of nonlinear iterations
48629f67acb7SJed Brown 
48639f67acb7SJed Brown    Notes:
48649f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
48659f67acb7SJed Brown 
48669f67acb7SJed Brown    Level: intermediate
48679f67acb7SJed Brown 
48689f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
48699f67acb7SJed Brown 
48705ef26d82SJed Brown .seealso:  TSGetKSPIterations()
48719f67acb7SJed Brown @*/
48725ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
48739f67acb7SJed Brown {
48749f67acb7SJed Brown   PetscFunctionBegin;
48759f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48769f67acb7SJed Brown   PetscValidIntPointer(nits,2);
48775ef26d82SJed Brown   *nits = ts->snes_its;
48789f67acb7SJed Brown   PetscFunctionReturn(0);
48799f67acb7SJed Brown }
48809f67acb7SJed Brown 
48819f67acb7SJed Brown #undef __FUNCT__
48825ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
48839f67acb7SJed Brown /*@
48845ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
48859f67acb7SJed Brown    used by the time integrator.
48869f67acb7SJed Brown 
48879f67acb7SJed Brown    Not Collective
48889f67acb7SJed Brown 
48899f67acb7SJed Brown    Input Parameter:
48909f67acb7SJed Brown .  ts - TS context
48919f67acb7SJed Brown 
48929f67acb7SJed Brown    Output Parameter:
48939f67acb7SJed Brown .  lits - number of linear iterations
48949f67acb7SJed Brown 
48959f67acb7SJed Brown    Notes:
48969f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
48979f67acb7SJed Brown 
48989f67acb7SJed Brown    Level: intermediate
48999f67acb7SJed Brown 
49009f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
49019f67acb7SJed Brown 
49025ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
49039f67acb7SJed Brown @*/
49045ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
49059f67acb7SJed Brown {
49069f67acb7SJed Brown   PetscFunctionBegin;
49079f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49089f67acb7SJed Brown   PetscValidIntPointer(lits,2);
49095ef26d82SJed Brown   *lits = ts->ksp_its;
49109f67acb7SJed Brown   PetscFunctionReturn(0);
49119f67acb7SJed Brown }
49129f67acb7SJed Brown 
49139f67acb7SJed Brown #undef __FUNCT__
4914cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
4915cef5090cSJed Brown /*@
4916cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
4917cef5090cSJed Brown 
4918cef5090cSJed Brown    Not Collective
4919cef5090cSJed Brown 
4920cef5090cSJed Brown    Input Parameter:
4921cef5090cSJed Brown .  ts - TS context
4922cef5090cSJed Brown 
4923cef5090cSJed Brown    Output Parameter:
4924cef5090cSJed Brown .  rejects - number of steps rejected
4925cef5090cSJed Brown 
4926cef5090cSJed Brown    Notes:
4927cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4928cef5090cSJed Brown 
4929cef5090cSJed Brown    Level: intermediate
4930cef5090cSJed Brown 
4931cef5090cSJed Brown .keywords: TS, get, number
4932cef5090cSJed Brown 
49335ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4934cef5090cSJed Brown @*/
4935cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4936cef5090cSJed Brown {
4937cef5090cSJed Brown   PetscFunctionBegin;
4938cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4939cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
4940cef5090cSJed Brown   *rejects = ts->reject;
4941cef5090cSJed Brown   PetscFunctionReturn(0);
4942cef5090cSJed Brown }
4943cef5090cSJed Brown 
4944cef5090cSJed Brown #undef __FUNCT__
4945cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
4946cef5090cSJed Brown /*@
4947cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
4948cef5090cSJed Brown 
4949cef5090cSJed Brown    Not Collective
4950cef5090cSJed Brown 
4951cef5090cSJed Brown    Input Parameter:
4952cef5090cSJed Brown .  ts - TS context
4953cef5090cSJed Brown 
4954cef5090cSJed Brown    Output Parameter:
4955cef5090cSJed Brown .  fails - number of failed nonlinear solves
4956cef5090cSJed Brown 
4957cef5090cSJed Brown    Notes:
4958cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4959cef5090cSJed Brown 
4960cef5090cSJed Brown    Level: intermediate
4961cef5090cSJed Brown 
4962cef5090cSJed Brown .keywords: TS, get, number
4963cef5090cSJed Brown 
49645ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4965cef5090cSJed Brown @*/
4966cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4967cef5090cSJed Brown {
4968cef5090cSJed Brown   PetscFunctionBegin;
4969cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4970cef5090cSJed Brown   PetscValidIntPointer(fails,2);
4971cef5090cSJed Brown   *fails = ts->num_snes_failures;
4972cef5090cSJed Brown   PetscFunctionReturn(0);
4973cef5090cSJed Brown }
4974cef5090cSJed Brown 
4975cef5090cSJed Brown #undef __FUNCT__
4976cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
4977cef5090cSJed Brown /*@
4978cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4979cef5090cSJed Brown 
4980cef5090cSJed Brown    Not Collective
4981cef5090cSJed Brown 
4982cef5090cSJed Brown    Input Parameter:
4983cef5090cSJed Brown +  ts - TS context
4984cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4985cef5090cSJed Brown 
4986cef5090cSJed Brown    Notes:
4987cef5090cSJed Brown    The counter is reset to zero for each step
4988cef5090cSJed Brown 
4989cef5090cSJed Brown    Options Database Key:
4990cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4991cef5090cSJed Brown 
4992cef5090cSJed Brown    Level: intermediate
4993cef5090cSJed Brown 
4994cef5090cSJed Brown .keywords: TS, set, maximum, number
4995cef5090cSJed Brown 
49965ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4997cef5090cSJed Brown @*/
4998cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4999cef5090cSJed Brown {
5000cef5090cSJed Brown   PetscFunctionBegin;
5001cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5002cef5090cSJed Brown   ts->max_reject = rejects;
5003cef5090cSJed Brown   PetscFunctionReturn(0);
5004cef5090cSJed Brown }
5005cef5090cSJed Brown 
5006cef5090cSJed Brown #undef __FUNCT__
5007cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
5008cef5090cSJed Brown /*@
5009cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5010cef5090cSJed Brown 
5011cef5090cSJed Brown    Not Collective
5012cef5090cSJed Brown 
5013cef5090cSJed Brown    Input Parameter:
5014cef5090cSJed Brown +  ts - TS context
5015cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5016cef5090cSJed Brown 
5017cef5090cSJed Brown    Notes:
5018cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5019cef5090cSJed Brown 
5020cef5090cSJed Brown    Options Database Key:
5021cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5022cef5090cSJed Brown 
5023cef5090cSJed Brown    Level: intermediate
5024cef5090cSJed Brown 
5025cef5090cSJed Brown .keywords: TS, set, maximum, number
5026cef5090cSJed Brown 
50275ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5028cef5090cSJed Brown @*/
5029cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5030cef5090cSJed Brown {
5031cef5090cSJed Brown   PetscFunctionBegin;
5032cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5033cef5090cSJed Brown   ts->max_snes_failures = fails;
5034cef5090cSJed Brown   PetscFunctionReturn(0);
5035cef5090cSJed Brown }
5036cef5090cSJed Brown 
5037cef5090cSJed Brown #undef __FUNCT__
50384e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
5039cef5090cSJed Brown /*@
5040cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5041cef5090cSJed Brown 
5042cef5090cSJed Brown    Not Collective
5043cef5090cSJed Brown 
5044cef5090cSJed Brown    Input Parameter:
5045cef5090cSJed Brown +  ts - TS context
5046cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5047cef5090cSJed Brown 
5048cef5090cSJed Brown    Options Database Key:
5049cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5050cef5090cSJed Brown 
5051cef5090cSJed Brown    Level: intermediate
5052cef5090cSJed Brown 
5053cef5090cSJed Brown .keywords: TS, set, error
5054cef5090cSJed Brown 
50555ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5056cef5090cSJed Brown @*/
5057cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5058cef5090cSJed Brown {
5059cef5090cSJed Brown   PetscFunctionBegin;
5060cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5061cef5090cSJed Brown   ts->errorifstepfailed = err;
5062cef5090cSJed Brown   PetscFunctionReturn(0);
5063cef5090cSJed Brown }
5064cef5090cSJed Brown 
5065cef5090cSJed Brown #undef __FUNCT__
5066fde5950dSBarry Smith #define __FUNCT__ "TSMonitorSolution"
5067fb1732b5SBarry Smith /*@C
5068fde5950dSBarry 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
5069fb1732b5SBarry Smith 
5070fb1732b5SBarry Smith    Collective on TS
5071fb1732b5SBarry Smith 
5072fb1732b5SBarry Smith    Input Parameters:
5073fb1732b5SBarry Smith +  ts - the TS context
5074fb1732b5SBarry Smith .  step - current time-step
5075fb1732b5SBarry Smith .  ptime - current time
50760910c330SBarry Smith .  u - current state
5077fb1732b5SBarry Smith -  viewer - binary viewer
5078fb1732b5SBarry Smith 
5079fb1732b5SBarry Smith    Level: intermediate
5080fb1732b5SBarry Smith 
5081fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
5082fb1732b5SBarry Smith 
5083fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5084fb1732b5SBarry Smith @*/
5085fde5950dSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
5086fb1732b5SBarry Smith {
5087fb1732b5SBarry Smith   PetscErrorCode ierr;
5088ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
5089fb1732b5SBarry Smith 
5090fb1732b5SBarry Smith   PetscFunctionBegin;
50910910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
5092ed81e22dSJed Brown   PetscFunctionReturn(0);
5093ed81e22dSJed Brown }
5094ed81e22dSJed Brown 
5095ed81e22dSJed Brown #undef __FUNCT__
5096ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
5097ed81e22dSJed Brown /*@C
5098ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5099ed81e22dSJed Brown 
5100ed81e22dSJed Brown    Collective on TS
5101ed81e22dSJed Brown 
5102ed81e22dSJed Brown    Input Parameters:
5103ed81e22dSJed Brown +  ts - the TS context
5104ed81e22dSJed Brown .  step - current time-step
5105ed81e22dSJed Brown .  ptime - current time
51060910c330SBarry Smith .  u - current state
5107ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5108ed81e22dSJed Brown 
5109ed81e22dSJed Brown    Level: intermediate
5110ed81e22dSJed Brown 
5111ed81e22dSJed Brown    Notes:
5112ed81e22dSJed 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.
5113ed81e22dSJed Brown    These are named according to the file name template.
5114ed81e22dSJed Brown 
5115ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5116ed81e22dSJed Brown 
5117ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5118ed81e22dSJed Brown 
5119ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5120ed81e22dSJed Brown @*/
51210910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5122ed81e22dSJed Brown {
5123ed81e22dSJed Brown   PetscErrorCode ierr;
5124ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5125ed81e22dSJed Brown   PetscViewer    viewer;
5126ed81e22dSJed Brown 
5127ed81e22dSJed Brown   PetscFunctionBegin;
51288caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5129ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
51300910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5131ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5132ed81e22dSJed Brown   PetscFunctionReturn(0);
5133ed81e22dSJed Brown }
5134ed81e22dSJed Brown 
5135ed81e22dSJed Brown #undef __FUNCT__
5136ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
5137ed81e22dSJed Brown /*@C
5138ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5139ed81e22dSJed Brown 
5140ed81e22dSJed Brown    Collective on TS
5141ed81e22dSJed Brown 
5142ed81e22dSJed Brown    Input Parameters:
5143ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5144ed81e22dSJed Brown 
5145ed81e22dSJed Brown    Level: intermediate
5146ed81e22dSJed Brown 
5147ed81e22dSJed Brown    Note:
5148ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5149ed81e22dSJed Brown 
5150ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5151ed81e22dSJed Brown 
5152ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5153ed81e22dSJed Brown @*/
5154ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5155ed81e22dSJed Brown {
5156ed81e22dSJed Brown   PetscErrorCode ierr;
5157ed81e22dSJed Brown 
5158ed81e22dSJed Brown   PetscFunctionBegin;
5159ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5160fb1732b5SBarry Smith   PetscFunctionReturn(0);
5161fb1732b5SBarry Smith }
5162fb1732b5SBarry Smith 
516384df9cb4SJed Brown #undef __FUNCT__
5164552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
516584df9cb4SJed Brown /*@
5166552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
516784df9cb4SJed Brown 
5168ed81e22dSJed Brown    Collective on TS if controller has not been created yet
516984df9cb4SJed Brown 
517084df9cb4SJed Brown    Input Arguments:
5171ed81e22dSJed Brown .  ts - time stepping context
517284df9cb4SJed Brown 
517384df9cb4SJed Brown    Output Arguments:
5174ed81e22dSJed Brown .  adapt - adaptive controller
517584df9cb4SJed Brown 
517684df9cb4SJed Brown    Level: intermediate
517784df9cb4SJed Brown 
5178ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
517984df9cb4SJed Brown @*/
5180552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
518184df9cb4SJed Brown {
518284df9cb4SJed Brown   PetscErrorCode ierr;
518384df9cb4SJed Brown 
518484df9cb4SJed Brown   PetscFunctionBegin;
518584df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
518684df9cb4SJed Brown   PetscValidPointer(adapt,2);
518784df9cb4SJed Brown   if (!ts->adapt) {
5188ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
51893bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
51901c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
519184df9cb4SJed Brown   }
519284df9cb4SJed Brown   *adapt = ts->adapt;
519384df9cb4SJed Brown   PetscFunctionReturn(0);
519484df9cb4SJed Brown }
5195d6ebe24aSShri Abhyankar 
5196d6ebe24aSShri Abhyankar #undef __FUNCT__
51971c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
51981c3436cfSJed Brown /*@
51991c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
52001c3436cfSJed Brown 
52011c3436cfSJed Brown    Logically Collective
52021c3436cfSJed Brown 
52031c3436cfSJed Brown    Input Arguments:
52041c3436cfSJed Brown +  ts - time integration context
52051c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
52060298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
52071c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
52080298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
52091c3436cfSJed Brown 
5210a3cdaa26SBarry Smith    Options Database keys:
5211a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5212a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5213a3cdaa26SBarry Smith 
52143ff766beSShri Abhyankar    Notes:
52153ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
52163ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
52173ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
52183ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
52193ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
52203ff766beSShri Abhyankar    differential variables.
52213ff766beSShri Abhyankar 
52221c3436cfSJed Brown    Level: beginner
52231c3436cfSJed Brown 
5224c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
52251c3436cfSJed Brown @*/
52261c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
52271c3436cfSJed Brown {
52281c3436cfSJed Brown   PetscErrorCode ierr;
52291c3436cfSJed Brown 
52301c3436cfSJed Brown   PetscFunctionBegin;
5231c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
52321c3436cfSJed Brown   if (vatol) {
52331c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
52341c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
5235bbd56ea5SKarl Rupp 
52361c3436cfSJed Brown     ts->vatol = vatol;
52371c3436cfSJed Brown   }
5238c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
52391c3436cfSJed Brown   if (vrtol) {
52401c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
52411c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
5242bbd56ea5SKarl Rupp 
52431c3436cfSJed Brown     ts->vrtol = vrtol;
52441c3436cfSJed Brown   }
52451c3436cfSJed Brown   PetscFunctionReturn(0);
52461c3436cfSJed Brown }
52471c3436cfSJed Brown 
52481c3436cfSJed Brown #undef __FUNCT__
5249c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
5250c5033834SJed Brown /*@
5251c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5252c5033834SJed Brown 
5253c5033834SJed Brown    Logically Collective
5254c5033834SJed Brown 
5255c5033834SJed Brown    Input Arguments:
5256c5033834SJed Brown .  ts - time integration context
5257c5033834SJed Brown 
5258c5033834SJed Brown    Output Arguments:
52590298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
52600298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
52610298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
52620298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5263c5033834SJed Brown 
5264c5033834SJed Brown    Level: beginner
5265c5033834SJed Brown 
5266c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5267c5033834SJed Brown @*/
5268c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5269c5033834SJed Brown {
5270c5033834SJed Brown   PetscFunctionBegin;
5271c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5272c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5273c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5274c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5275c5033834SJed Brown   PetscFunctionReturn(0);
5276c5033834SJed Brown }
5277c5033834SJed Brown 
5278c5033834SJed Brown #undef __FUNCT__
52799c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNorm2"
52809c6b16b5SShri Abhyankar /*@
5281a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
52829c6b16b5SShri Abhyankar 
52839c6b16b5SShri Abhyankar    Collective on TS
52849c6b16b5SShri Abhyankar 
52859c6b16b5SShri Abhyankar    Input Arguments:
52869c6b16b5SShri Abhyankar +  ts - time stepping context
5287a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5288a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
52899c6b16b5SShri Abhyankar 
52909c6b16b5SShri Abhyankar    Output Arguments:
52919c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
52929c6b16b5SShri Abhyankar 
52939c6b16b5SShri Abhyankar    Level: developer
52949c6b16b5SShri Abhyankar 
5295deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
52969c6b16b5SShri Abhyankar @*/
5297a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm)
52989c6b16b5SShri Abhyankar {
52999c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
53009c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
53019c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
53029c6b16b5SShri Abhyankar   PetscReal         sum,gsum;
53039c6b16b5SShri Abhyankar   PetscReal         tol;
53049c6b16b5SShri Abhyankar 
53059c6b16b5SShri Abhyankar   PetscFunctionBegin;
53069c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5307a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5308a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5309a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5310a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5311a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5312a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5313a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
53149c6b16b5SShri Abhyankar 
53159c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
53169c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
53179c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
53189c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
53199c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
53209c6b16b5SShri Abhyankar   sum  = 0.;
53219c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
53229c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
53239c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53249c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53259c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
53269c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53279c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
53289c6b16b5SShri Abhyankar     }
53299c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53309c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53319c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
53329c6b16b5SShri Abhyankar     const PetscScalar *atol;
53339c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53349c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
53359c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53369c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
53379c6b16b5SShri Abhyankar     }
53389c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53399c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
53409c6b16b5SShri Abhyankar     const PetscScalar *rtol;
53419c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53429c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
53439c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53449c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
53459c6b16b5SShri Abhyankar     }
53469c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53479c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
53489c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
53499c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53509c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
53519c6b16b5SShri Abhyankar     }
53529c6b16b5SShri Abhyankar   }
53539c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
53549c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
53559c6b16b5SShri Abhyankar 
5356b2566f29SBarry Smith   ierr  = MPIU_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
53579c6b16b5SShri Abhyankar   *norm = PetscSqrtReal(gsum / N);
53589c6b16b5SShri Abhyankar 
53599c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
53609c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
53619c6b16b5SShri Abhyankar }
53629c6b16b5SShri Abhyankar 
53639c6b16b5SShri Abhyankar #undef __FUNCT__
53649c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNormInfinity"
53659c6b16b5SShri Abhyankar /*@
5366a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
53679c6b16b5SShri Abhyankar 
53689c6b16b5SShri Abhyankar    Collective on TS
53699c6b16b5SShri Abhyankar 
53709c6b16b5SShri Abhyankar    Input Arguments:
53719c6b16b5SShri Abhyankar +  ts - time stepping context
5372a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5373a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
53749c6b16b5SShri Abhyankar 
53759c6b16b5SShri Abhyankar    Output Arguments:
53769c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
53779c6b16b5SShri Abhyankar 
53789c6b16b5SShri Abhyankar    Level: developer
53799c6b16b5SShri Abhyankar 
5380deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
53819c6b16b5SShri Abhyankar @*/
5382a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm)
53839c6b16b5SShri Abhyankar {
53849c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
53859c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart,k;
53869c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
53879c6b16b5SShri Abhyankar   PetscReal         max,gmax;
53889c6b16b5SShri Abhyankar   PetscReal         tol;
53899c6b16b5SShri Abhyankar 
53909c6b16b5SShri Abhyankar   PetscFunctionBegin;
53919c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5392a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5393a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5394a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5395a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5396a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5397a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5398a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
53999c6b16b5SShri Abhyankar 
54009c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
54019c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
54029c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
54039c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
54049c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
54059c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
54069c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
54079c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54089c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54099c6b16b5SShri Abhyankar     k = 0;
54109c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
54119c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
54129c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
54139c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54149c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
54159c6b16b5SShri Abhyankar     }
54169c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54179c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54189c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
54199c6b16b5SShri Abhyankar     const PetscScalar *atol;
54209c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54219c6b16b5SShri Abhyankar     k = 0;
54229c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
54239c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
54249c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
54259c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54269c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
54279c6b16b5SShri Abhyankar     }
54289c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54299c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
54309c6b16b5SShri Abhyankar     const PetscScalar *rtol;
54319c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54329c6b16b5SShri Abhyankar     k = 0;
54339c6b16b5SShri Abhyankar     tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
54349c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
54359c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
54369c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54379c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
54389c6b16b5SShri Abhyankar     }
54399c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54409c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
54419c6b16b5SShri Abhyankar     k = 0;
54429c6b16b5SShri Abhyankar     tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
54439c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
54449c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
54459c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54469c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
54479c6b16b5SShri Abhyankar     }
54489c6b16b5SShri Abhyankar   }
54499c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
54509c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
54519c6b16b5SShri Abhyankar 
5452b2566f29SBarry Smith   ierr  = MPIU_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
54539c6b16b5SShri Abhyankar   *norm = gmax;
54549c6b16b5SShri Abhyankar 
54559c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
54569c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
54579c6b16b5SShri Abhyankar }
54589c6b16b5SShri Abhyankar 
54599c6b16b5SShri Abhyankar #undef __FUNCT__
54607619abb3SShri #define __FUNCT__ "TSErrorWeightedNorm"
54611c3436cfSJed Brown /*@
5462a4868fbcSLisandro Dalcin    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors
54631c3436cfSJed Brown 
54641c3436cfSJed Brown    Collective on TS
54651c3436cfSJed Brown 
54661c3436cfSJed Brown    Input Arguments:
54671c3436cfSJed Brown +  ts - time stepping context
5468a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5469a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
5470a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
54717619abb3SShri 
54721c3436cfSJed Brown    Output Arguments:
54731c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
54741c3436cfSJed Brown 
5475a4868fbcSLisandro Dalcin 
5476a4868fbcSLisandro Dalcin    Options Database Keys:
5477a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5478a4868fbcSLisandro Dalcin 
54791c3436cfSJed Brown    Level: developer
54801c3436cfSJed Brown 
5481deea92deSShri .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
54821c3436cfSJed Brown @*/
5483a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm)
54841c3436cfSJed Brown {
54858beabaa1SBarry Smith   PetscErrorCode ierr;
54861c3436cfSJed Brown 
54871c3436cfSJed Brown   PetscFunctionBegin;
5488a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
5489a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNorm2(ts,U,Y,norm);CHKERRQ(ierr);
5490a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
5491a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm);CHKERRQ(ierr);
5492a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
54931c3436cfSJed Brown   PetscFunctionReturn(0);
54941c3436cfSJed Brown }
54951c3436cfSJed Brown 
54961c3436cfSJed Brown #undef __FUNCT__
54978d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
54988d59e960SJed Brown /*@
54998d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
55008d59e960SJed Brown 
55018d59e960SJed Brown    Logically Collective on TS
55028d59e960SJed Brown 
55038d59e960SJed Brown    Input Arguments:
55048d59e960SJed Brown +  ts - time stepping context
55058d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
55068d59e960SJed Brown 
55078d59e960SJed Brown    Note:
55088d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
55098d59e960SJed Brown 
55108d59e960SJed Brown    Level: intermediate
55118d59e960SJed Brown 
55128d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
55138d59e960SJed Brown @*/
55148d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
55158d59e960SJed Brown {
55168d59e960SJed Brown   PetscFunctionBegin;
55178d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
55188d59e960SJed Brown   ts->cfltime_local = cfltime;
55198d59e960SJed Brown   ts->cfltime       = -1.;
55208d59e960SJed Brown   PetscFunctionReturn(0);
55218d59e960SJed Brown }
55228d59e960SJed Brown 
55238d59e960SJed Brown #undef __FUNCT__
55248d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
55258d59e960SJed Brown /*@
55268d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
55278d59e960SJed Brown 
55288d59e960SJed Brown    Collective on TS
55298d59e960SJed Brown 
55308d59e960SJed Brown    Input Arguments:
55318d59e960SJed Brown .  ts - time stepping context
55328d59e960SJed Brown 
55338d59e960SJed Brown    Output Arguments:
55348d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
55358d59e960SJed Brown 
55368d59e960SJed Brown    Level: advanced
55378d59e960SJed Brown 
55388d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
55398d59e960SJed Brown @*/
55408d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
55418d59e960SJed Brown {
55428d59e960SJed Brown   PetscErrorCode ierr;
55438d59e960SJed Brown 
55448d59e960SJed Brown   PetscFunctionBegin;
55458d59e960SJed Brown   if (ts->cfltime < 0) {
5546b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
55478d59e960SJed Brown   }
55488d59e960SJed Brown   *cfltime = ts->cfltime;
55498d59e960SJed Brown   PetscFunctionReturn(0);
55508d59e960SJed Brown }
55518d59e960SJed Brown 
55528d59e960SJed Brown #undef __FUNCT__
5553d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
5554d6ebe24aSShri Abhyankar /*@
5555d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5556d6ebe24aSShri Abhyankar 
5557d6ebe24aSShri Abhyankar    Input Parameters:
5558d6ebe24aSShri Abhyankar .  ts   - the TS context.
5559d6ebe24aSShri Abhyankar .  xl   - lower bound.
5560d6ebe24aSShri Abhyankar .  xu   - upper bound.
5561d6ebe24aSShri Abhyankar 
5562d6ebe24aSShri Abhyankar    Notes:
5563d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
5564e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
5565d6ebe24aSShri Abhyankar 
55662bd2b0e6SSatish Balay    Level: advanced
55672bd2b0e6SSatish Balay 
5568d6ebe24aSShri Abhyankar @*/
5569d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5570d6ebe24aSShri Abhyankar {
5571d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
5572d6ebe24aSShri Abhyankar   SNES           snes;
5573d6ebe24aSShri Abhyankar 
5574d6ebe24aSShri Abhyankar   PetscFunctionBegin;
5575d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5576d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
5577d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
5578d6ebe24aSShri Abhyankar }
5579d6ebe24aSShri Abhyankar 
5580325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
5581c6db04a5SJed Brown #include <mex.h>
5582325fc9f4SBarry Smith 
5583325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
5584325fc9f4SBarry Smith 
5585325fc9f4SBarry Smith #undef __FUNCT__
5586325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
5587325fc9f4SBarry Smith /*
5588325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
5589325fc9f4SBarry Smith                          TSSetFunctionMatlab().
5590325fc9f4SBarry Smith 
5591325fc9f4SBarry Smith    Collective on TS
5592325fc9f4SBarry Smith 
5593325fc9f4SBarry Smith    Input Parameters:
5594325fc9f4SBarry Smith +  snes - the TS context
55950910c330SBarry Smith -  u - input vector
5596325fc9f4SBarry Smith 
5597325fc9f4SBarry Smith    Output Parameter:
5598325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
5599325fc9f4SBarry Smith 
5600325fc9f4SBarry Smith    Notes:
5601325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
5602325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
5603325fc9f4SBarry Smith    themselves.
5604325fc9f4SBarry Smith 
5605325fc9f4SBarry Smith    Level: developer
5606325fc9f4SBarry Smith 
5607325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5608325fc9f4SBarry Smith 
5609325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5610325fc9f4SBarry Smith */
56110910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
5612325fc9f4SBarry Smith {
5613325fc9f4SBarry Smith   PetscErrorCode  ierr;
5614325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5615325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
5616325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
5617325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
5618325fc9f4SBarry Smith 
5619325fc9f4SBarry Smith   PetscFunctionBegin;
5620325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
56210910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
56220910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
5623325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
56240910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
5625325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
5626325fc9f4SBarry Smith 
5627325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
56280910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
56290910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
56300910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
5631bbd56ea5SKarl Rupp 
5632325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5633325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
5634325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5635325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5636325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
5637325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
5638325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
5639325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
5640325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5641325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5642325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5643325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5644325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5645325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5646325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5647325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5648325fc9f4SBarry Smith   PetscFunctionReturn(0);
5649325fc9f4SBarry Smith }
5650325fc9f4SBarry Smith 
5651325fc9f4SBarry Smith 
5652325fc9f4SBarry Smith #undef __FUNCT__
5653325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
5654325fc9f4SBarry Smith /*
5655325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
5656325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
5657e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
5658325fc9f4SBarry Smith 
5659325fc9f4SBarry Smith    Logically Collective on TS
5660325fc9f4SBarry Smith 
5661325fc9f4SBarry Smith    Input Parameters:
5662325fc9f4SBarry Smith +  ts - the TS context
5663325fc9f4SBarry Smith -  func - function evaluation routine
5664325fc9f4SBarry Smith 
5665325fc9f4SBarry Smith    Calling sequence of func:
56660910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
5667325fc9f4SBarry Smith 
5668325fc9f4SBarry Smith    Level: beginner
5669325fc9f4SBarry Smith 
5670325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5671325fc9f4SBarry Smith 
5672325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5673325fc9f4SBarry Smith */
5674cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
5675325fc9f4SBarry Smith {
5676325fc9f4SBarry Smith   PetscErrorCode  ierr;
5677325fc9f4SBarry Smith   TSMatlabContext *sctx;
5678325fc9f4SBarry Smith 
5679325fc9f4SBarry Smith   PetscFunctionBegin;
5680325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5681325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5682325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5683325fc9f4SBarry Smith   /*
5684325fc9f4SBarry Smith      This should work, but it doesn't
5685325fc9f4SBarry Smith   sctx->ctx = ctx;
5686325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5687325fc9f4SBarry Smith   */
5688325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5689bbd56ea5SKarl Rupp 
56900298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
5691325fc9f4SBarry Smith   PetscFunctionReturn(0);
5692325fc9f4SBarry Smith }
5693325fc9f4SBarry Smith 
5694325fc9f4SBarry Smith #undef __FUNCT__
5695325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
5696325fc9f4SBarry Smith /*
5697325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
5698325fc9f4SBarry Smith                          TSSetJacobianMatlab().
5699325fc9f4SBarry Smith 
5700325fc9f4SBarry Smith    Collective on TS
5701325fc9f4SBarry Smith 
5702325fc9f4SBarry Smith    Input Parameters:
5703cdcf91faSSean Farley +  ts - the TS context
57040910c330SBarry Smith .  u - input vector
5705325fc9f4SBarry Smith .  A, B - the matrices
5706325fc9f4SBarry Smith -  ctx - user context
5707325fc9f4SBarry Smith 
5708325fc9f4SBarry Smith    Level: developer
5709325fc9f4SBarry Smith 
5710325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5711325fc9f4SBarry Smith 
5712325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5713325fc9f4SBarry Smith @*/
5714f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
5715325fc9f4SBarry Smith {
5716325fc9f4SBarry Smith   PetscErrorCode  ierr;
5717325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5718325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
5719325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
5720325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
5721325fc9f4SBarry Smith 
5722325fc9f4SBarry Smith   PetscFunctionBegin;
5723cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
57240910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5725325fc9f4SBarry Smith 
57260910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
5727325fc9f4SBarry Smith 
5728cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
57290910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
57300910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
57310910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
57320910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
5733bbd56ea5SKarl Rupp 
5734325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5735325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
5736325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5737325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5738325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
5739325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
5740325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
5741325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
5742325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
5743325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
5744325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5745325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5746325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5747325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5748325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5749325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5750325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5751325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
5752325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
5753325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5754325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
5755325fc9f4SBarry Smith   PetscFunctionReturn(0);
5756325fc9f4SBarry Smith }
5757325fc9f4SBarry Smith 
5758325fc9f4SBarry Smith 
5759325fc9f4SBarry Smith #undef __FUNCT__
5760325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
5761325fc9f4SBarry Smith /*
5762325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
5763e3c5b3baSBarry 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
5764325fc9f4SBarry Smith 
5765325fc9f4SBarry Smith    Logically Collective on TS
5766325fc9f4SBarry Smith 
5767325fc9f4SBarry Smith    Input Parameters:
5768cdcf91faSSean Farley +  ts - the TS context
5769325fc9f4SBarry Smith .  A,B - Jacobian matrices
5770325fc9f4SBarry Smith .  func - function evaluation routine
5771325fc9f4SBarry Smith -  ctx - user context
5772325fc9f4SBarry Smith 
5773325fc9f4SBarry Smith    Calling sequence of func:
57740910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
5775325fc9f4SBarry Smith 
5776325fc9f4SBarry Smith 
5777325fc9f4SBarry Smith    Level: developer
5778325fc9f4SBarry Smith 
5779325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5780325fc9f4SBarry Smith 
5781325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5782325fc9f4SBarry Smith */
5783cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
5784325fc9f4SBarry Smith {
5785325fc9f4SBarry Smith   PetscErrorCode  ierr;
5786325fc9f4SBarry Smith   TSMatlabContext *sctx;
5787325fc9f4SBarry Smith 
5788325fc9f4SBarry Smith   PetscFunctionBegin;
5789325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5790325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5791325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5792325fc9f4SBarry Smith   /*
5793325fc9f4SBarry Smith      This should work, but it doesn't
5794325fc9f4SBarry Smith   sctx->ctx = ctx;
5795325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5796325fc9f4SBarry Smith   */
5797325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5798bbd56ea5SKarl Rupp 
5799cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
5800325fc9f4SBarry Smith   PetscFunctionReturn(0);
5801325fc9f4SBarry Smith }
5802325fc9f4SBarry Smith 
5803b5b1a830SBarry Smith #undef __FUNCT__
5804b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
5805b5b1a830SBarry Smith /*
5806b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
5807b5b1a830SBarry Smith 
5808b5b1a830SBarry Smith    Collective on TS
5809b5b1a830SBarry Smith 
5810b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5811b5b1a830SBarry Smith @*/
58120910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
5813b5b1a830SBarry Smith {
5814b5b1a830SBarry Smith   PetscErrorCode  ierr;
5815b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5816a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
5817b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
5818b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
5819b5b1a830SBarry Smith 
5820b5b1a830SBarry Smith   PetscFunctionBegin;
5821cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
58220910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
5823b5b1a830SBarry Smith 
5824cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
58250910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5826bbd56ea5SKarl Rupp 
5827b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5828b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
5829b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
5830b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
5831b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
5832b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
5833b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
5834b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5835b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
5836b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
5837b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
5838b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
5839b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
5840b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
5841b5b1a830SBarry Smith   PetscFunctionReturn(0);
5842b5b1a830SBarry Smith }
5843b5b1a830SBarry Smith 
5844b5b1a830SBarry Smith 
5845b5b1a830SBarry Smith #undef __FUNCT__
5846b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
5847b5b1a830SBarry Smith /*
5848b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
5849b5b1a830SBarry Smith 
5850b5b1a830SBarry Smith    Level: developer
5851b5b1a830SBarry Smith 
5852b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
5853b5b1a830SBarry Smith 
5854b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5855b5b1a830SBarry Smith */
5856cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
5857b5b1a830SBarry Smith {
5858b5b1a830SBarry Smith   PetscErrorCode  ierr;
5859b5b1a830SBarry Smith   TSMatlabContext *sctx;
5860b5b1a830SBarry Smith 
5861b5b1a830SBarry Smith   PetscFunctionBegin;
5862b5b1a830SBarry Smith   /* currently sctx is memory bleed */
5863b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5864b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5865b5b1a830SBarry Smith   /*
5866b5b1a830SBarry Smith      This should work, but it doesn't
5867b5b1a830SBarry Smith   sctx->ctx = ctx;
5868b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5869b5b1a830SBarry Smith   */
5870b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5871bbd56ea5SKarl Rupp 
58720298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5873b5b1a830SBarry Smith   PetscFunctionReturn(0);
5874b5b1a830SBarry Smith }
5875325fc9f4SBarry Smith #endif
5876b3603a34SBarry Smith 
5877b3603a34SBarry Smith #undef __FUNCT__
58784f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
5879b3603a34SBarry Smith /*@C
58804f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5881b3603a34SBarry Smith        in a time based line graph
5882b3603a34SBarry Smith 
5883b3603a34SBarry Smith    Collective on TS
5884b3603a34SBarry Smith 
5885b3603a34SBarry Smith    Input Parameters:
5886b3603a34SBarry Smith +  ts - the TS context
5887b3603a34SBarry Smith .  step - current time-step
5888b3603a34SBarry Smith .  ptime - current time
58897db568b7SBarry Smith .  u - current solution
58907db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
5891b3603a34SBarry Smith 
5892b3d3934dSBarry Smith    Options Database:
58939ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
5894b3d3934dSBarry Smith 
5895b3603a34SBarry Smith    Level: intermediate
5896b3603a34SBarry Smith 
58970b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
5898b3603a34SBarry Smith 
5899b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
5900b3603a34SBarry Smith 
59017db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
59027db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
59037db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
59047db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
5905b3603a34SBarry Smith @*/
59067db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
5907b3603a34SBarry Smith {
5908b3603a34SBarry Smith   PetscErrorCode    ierr;
59097db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
5910b3603a34SBarry Smith   const PetscScalar *yy;
591158ff32f7SBarry Smith   PetscInt          dim;
591280666b62SBarry Smith   Vec               v;
5913b3603a34SBarry Smith 
5914b3603a34SBarry Smith   PetscFunctionBegin;
591558ff32f7SBarry Smith   if (!step) {
5916a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5917a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5918a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
5919387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
5920387f4636SBarry Smith       char      **displaynames;
5921387f4636SBarry Smith       PetscBool flg;
5922387f4636SBarry Smith 
5923387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5924387f4636SBarry Smith       ierr = PetscMalloc((dim+1)*sizeof(char*),&displaynames);CHKERRQ(ierr);
5925387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
5926c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
5927387f4636SBarry Smith       if (flg) {
5928a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
5929387f4636SBarry Smith       }
5930387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
5931387f4636SBarry Smith     }
5932387f4636SBarry Smith     if (ctx->displaynames) {
5933387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
5934387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
5935387f4636SBarry Smith     } else if (ctx->names) {
59360910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
59370b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5938387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
5939b0bc92c6SBarry Smith     } else {
5940b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5941b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5942387f4636SBarry Smith     }
59430b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
594458ff32f7SBarry Smith   }
594580666b62SBarry Smith   if (ctx->transform) {
5946e673d494SBarry Smith     ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);
594780666b62SBarry Smith   } else {
594880666b62SBarry Smith     v = u;
594980666b62SBarry Smith   }
595080666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
5951e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5952e3efe391SJed Brown   {
5953e3efe391SJed Brown     PetscReal *yreal;
5954e3efe391SJed Brown     PetscInt  i,n;
595580666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
5956785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5957e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
59580b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5959e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5960e3efe391SJed Brown   }
5961e3efe391SJed Brown #else
5962387f4636SBarry Smith   if (ctx->displaynames) {
5963387f4636SBarry Smith     PetscInt i;
5964387f4636SBarry Smith     for (i=0; i<ctx->ndisplayvariables; i++) {
5965387f4636SBarry Smith       ctx->displayvalues[i] = yy[ctx->displayvariables[i]];
5966387f4636SBarry Smith     }
5967387f4636SBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
5968387f4636SBarry Smith   } else {
59690b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5970387f4636SBarry Smith   }
5971e3efe391SJed Brown #endif
597280666b62SBarry Smith   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
597380666b62SBarry Smith   if (ctx->transform) {
597480666b62SBarry Smith     ierr = VecDestroy(&v);CHKERRQ(ierr);
597580666b62SBarry Smith   }
5976b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
59770b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
59783923b477SBarry Smith   }
5979b3603a34SBarry Smith   PetscFunctionReturn(0);
5980b3603a34SBarry Smith }
5981b3603a34SBarry Smith 
5982387f4636SBarry Smith 
5983b3603a34SBarry Smith #undef __FUNCT__
598431152f8aSBarry Smith #define __FUNCT__ "TSMonitorLGSetVariableNames"
5985b037adc7SBarry Smith /*@C
598631152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
5987b037adc7SBarry Smith 
5988b037adc7SBarry Smith    Collective on TS
5989b037adc7SBarry Smith 
5990b037adc7SBarry Smith    Input Parameters:
5991b037adc7SBarry Smith +  ts - the TS context
5992b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
5993b037adc7SBarry Smith 
5994b037adc7SBarry Smith    Level: intermediate
5995b037adc7SBarry Smith 
59967db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
59977db568b7SBarry Smith 
5998b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
5999b037adc7SBarry Smith 
6000a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
6001b037adc7SBarry Smith @*/
600231152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
6003b037adc7SBarry Smith {
6004b037adc7SBarry Smith   PetscErrorCode    ierr;
6005b037adc7SBarry Smith   PetscInt          i;
6006b037adc7SBarry Smith 
6007b037adc7SBarry Smith   PetscFunctionBegin;
6008b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6009b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
60105537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
6011b3d3934dSBarry Smith       break;
6012b3d3934dSBarry Smith     }
6013b3d3934dSBarry Smith   }
6014b3d3934dSBarry Smith   PetscFunctionReturn(0);
6015b3d3934dSBarry Smith }
6016b3d3934dSBarry Smith 
6017b3d3934dSBarry Smith #undef __FUNCT__
6018e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetVariableNames"
6019e673d494SBarry Smith /*@C
6020e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6021e673d494SBarry Smith 
6022e673d494SBarry Smith    Collective on TS
6023e673d494SBarry Smith 
6024e673d494SBarry Smith    Input Parameters:
6025e673d494SBarry Smith +  ts - the TS context
6026e673d494SBarry Smith -  names - the names of the components, final string must be NULL
6027e673d494SBarry Smith 
6028e673d494SBarry Smith    Level: intermediate
6029e673d494SBarry Smith 
6030e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6031e673d494SBarry Smith 
6032a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
6033e673d494SBarry Smith @*/
6034e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
6035e673d494SBarry Smith {
6036e673d494SBarry Smith   PetscErrorCode    ierr;
6037e673d494SBarry Smith 
6038e673d494SBarry Smith   PetscFunctionBegin;
6039e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
6040e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
6041e673d494SBarry Smith   PetscFunctionReturn(0);
6042e673d494SBarry Smith }
6043e673d494SBarry Smith 
6044e673d494SBarry Smith #undef __FUNCT__
6045b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorLGGetVariableNames"
6046b3d3934dSBarry Smith /*@C
6047b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
6048b3d3934dSBarry Smith 
6049b3d3934dSBarry Smith    Collective on TS
6050b3d3934dSBarry Smith 
6051b3d3934dSBarry Smith    Input Parameter:
6052b3d3934dSBarry Smith .  ts - the TS context
6053b3d3934dSBarry Smith 
6054b3d3934dSBarry Smith    Output Parameter:
6055b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
6056b3d3934dSBarry Smith 
6057b3d3934dSBarry Smith    Level: intermediate
6058b3d3934dSBarry Smith 
60597db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
60607db568b7SBarry Smith 
6061b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6062b3d3934dSBarry Smith 
6063b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6064b3d3934dSBarry Smith @*/
6065b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
6066b3d3934dSBarry Smith {
6067b3d3934dSBarry Smith   PetscInt       i;
6068b3d3934dSBarry Smith 
6069b3d3934dSBarry Smith   PetscFunctionBegin;
6070b3d3934dSBarry Smith   *names = NULL;
6071b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6072b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
60735537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
6074b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
6075b3d3934dSBarry Smith       break;
6076387f4636SBarry Smith     }
6077387f4636SBarry Smith   }
6078387f4636SBarry Smith   PetscFunctionReturn(0);
6079387f4636SBarry Smith }
6080387f4636SBarry Smith 
6081387f4636SBarry Smith #undef __FUNCT__
6082a66092f1SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables"
6083a66092f1SBarry Smith /*@C
6084a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
6085a66092f1SBarry Smith 
6086a66092f1SBarry Smith    Collective on TS
6087a66092f1SBarry Smith 
6088a66092f1SBarry Smith    Input Parameters:
6089a66092f1SBarry Smith +  ctx - the TSMonitorLG context
6090a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
6091a66092f1SBarry Smith 
6092a66092f1SBarry Smith    Level: intermediate
6093a66092f1SBarry Smith 
6094a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
6095a66092f1SBarry Smith 
6096a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6097a66092f1SBarry Smith @*/
6098a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6099a66092f1SBarry Smith {
6100a66092f1SBarry Smith   PetscInt          j = 0,k;
6101a66092f1SBarry Smith   PetscErrorCode    ierr;
6102a66092f1SBarry Smith 
6103a66092f1SBarry Smith   PetscFunctionBegin;
6104a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6105a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6106a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6107a66092f1SBarry Smith   while (displaynames[j]) j++;
6108a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6109a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6110a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6111a66092f1SBarry Smith   j = 0;
6112a66092f1SBarry Smith   while (displaynames[j]) {
6113a66092f1SBarry Smith     k = 0;
6114a66092f1SBarry Smith     while (ctx->names[k]) {
6115a66092f1SBarry Smith       PetscBool flg;
6116a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6117a66092f1SBarry Smith       if (flg) {
6118a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6119a66092f1SBarry Smith         break;
6120a66092f1SBarry Smith       }
6121a66092f1SBarry Smith       k++;
6122a66092f1SBarry Smith     }
6123a66092f1SBarry Smith     j++;
6124a66092f1SBarry Smith   }
6125a66092f1SBarry Smith   PetscFunctionReturn(0);
6126a66092f1SBarry Smith }
6127a66092f1SBarry Smith 
6128a66092f1SBarry Smith 
6129a66092f1SBarry Smith #undef __FUNCT__
6130387f4636SBarry Smith #define __FUNCT__ "TSMonitorLGSetDisplayVariables"
6131387f4636SBarry Smith /*@C
6132387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6133387f4636SBarry Smith 
6134387f4636SBarry Smith    Collective on TS
6135387f4636SBarry Smith 
6136387f4636SBarry Smith    Input Parameters:
6137387f4636SBarry Smith +  ts - the TS context
6138387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
6139387f4636SBarry Smith 
61407db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
61417db568b7SBarry Smith 
6142387f4636SBarry Smith    Level: intermediate
6143387f4636SBarry Smith 
6144387f4636SBarry Smith .keywords: TS,  vector, monitor, view
6145387f4636SBarry Smith 
6146387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6147387f4636SBarry Smith @*/
6148387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6149387f4636SBarry Smith {
6150a66092f1SBarry Smith   PetscInt          i;
6151387f4636SBarry Smith   PetscErrorCode    ierr;
6152387f4636SBarry Smith 
6153387f4636SBarry Smith   PetscFunctionBegin;
6154387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6155387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
61565537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6157b3d3934dSBarry Smith       break;
6158b037adc7SBarry Smith     }
6159b037adc7SBarry Smith   }
6160b037adc7SBarry Smith   PetscFunctionReturn(0);
6161b037adc7SBarry Smith }
6162b037adc7SBarry Smith 
6163b037adc7SBarry Smith #undef __FUNCT__
616480666b62SBarry Smith #define __FUNCT__ "TSMonitorLGSetTransform"
616580666b62SBarry Smith /*@C
616680666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
616780666b62SBarry Smith 
616880666b62SBarry Smith    Collective on TS
616980666b62SBarry Smith 
617080666b62SBarry Smith    Input Parameters:
617180666b62SBarry Smith +  ts - the TS context
617280666b62SBarry Smith .  transform - the transform function
61737684fa3eSBarry Smith .  destroy - function to destroy the optional context
617480666b62SBarry Smith -  ctx - optional context used by transform function
617580666b62SBarry Smith 
61767db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
61777db568b7SBarry Smith 
617880666b62SBarry Smith    Level: intermediate
617980666b62SBarry Smith 
618080666b62SBarry Smith .keywords: TS,  vector, monitor, view
618180666b62SBarry Smith 
6182a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
618380666b62SBarry Smith @*/
61847684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
618580666b62SBarry Smith {
618680666b62SBarry Smith   PetscInt          i;
6187a66092f1SBarry Smith   PetscErrorCode    ierr;
618880666b62SBarry Smith 
618980666b62SBarry Smith   PetscFunctionBegin;
619080666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
619180666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
61925537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
619380666b62SBarry Smith     }
619480666b62SBarry Smith   }
619580666b62SBarry Smith   PetscFunctionReturn(0);
619680666b62SBarry Smith }
619780666b62SBarry Smith 
619880666b62SBarry Smith #undef __FUNCT__
6199e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetTransform"
6200e673d494SBarry Smith /*@C
6201e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6202e673d494SBarry Smith 
6203e673d494SBarry Smith    Collective on TSLGCtx
6204e673d494SBarry Smith 
6205e673d494SBarry Smith    Input Parameters:
6206e673d494SBarry Smith +  ts - the TS context
6207e673d494SBarry Smith .  transform - the transform function
62087684fa3eSBarry Smith .  destroy - function to destroy the optional context
6209e673d494SBarry Smith -  ctx - optional context used by transform function
6210e673d494SBarry Smith 
6211e673d494SBarry Smith    Level: intermediate
6212e673d494SBarry Smith 
6213e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6214e673d494SBarry Smith 
6215a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6216e673d494SBarry Smith @*/
62177684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6218e673d494SBarry Smith {
6219e673d494SBarry Smith   PetscFunctionBegin;
6220e673d494SBarry Smith   ctx->transform    = transform;
62217684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6222e673d494SBarry Smith   ctx->transformctx = tctx;
6223e673d494SBarry Smith   PetscFunctionReturn(0);
6224e673d494SBarry Smith }
6225e673d494SBarry Smith 
6226b3603a34SBarry Smith #undef __FUNCT__
62274f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
6228ef20d060SBarry Smith /*@C
62294f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
6230ef20d060SBarry Smith        in a time based line graph
6231ef20d060SBarry Smith 
6232ef20d060SBarry Smith    Collective on TS
6233ef20d060SBarry Smith 
6234ef20d060SBarry Smith    Input Parameters:
6235ef20d060SBarry Smith +  ts - the TS context
6236ef20d060SBarry Smith .  step - current time-step
6237ef20d060SBarry Smith .  ptime - current time
62387db568b7SBarry Smith .  u - current solution
62397db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6240ef20d060SBarry Smith 
6241ef20d060SBarry Smith    Level: intermediate
6242ef20d060SBarry Smith 
6243abd5a294SJed Brown    Notes:
6244abd5a294SJed Brown    Only for sequential solves.
6245abd5a294SJed Brown 
6246abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6247abd5a294SJed Brown 
6248abd5a294SJed Brown    Options Database Keys:
62494f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6250ef20d060SBarry Smith 
6251ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
6252ef20d060SBarry Smith 
6253abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6254ef20d060SBarry Smith @*/
62550910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6256ef20d060SBarry Smith {
6257ef20d060SBarry Smith   PetscErrorCode    ierr;
62580b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6259ef20d060SBarry Smith   const PetscScalar *yy;
6260ef20d060SBarry Smith   Vec               y;
6261a9f9c1f6SBarry Smith   PetscInt          dim;
6262ef20d060SBarry Smith 
6263ef20d060SBarry Smith   PetscFunctionBegin;
6264a9f9c1f6SBarry Smith   if (!step) {
6265a9f9c1f6SBarry Smith     PetscDrawAxis axis;
6266a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
62671ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
62680910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6269a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6270a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6271a9f9c1f6SBarry Smith   }
62720910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6273ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
62740910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6275ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6276e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6277e3efe391SJed Brown   {
6278e3efe391SJed Brown     PetscReal *yreal;
6279e3efe391SJed Brown     PetscInt  i,n;
6280e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6281785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6282e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
62830b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6284e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6285e3efe391SJed Brown   }
6286e3efe391SJed Brown #else
62870b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6288e3efe391SJed Brown #endif
6289ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6290ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6291b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
62920b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
62933923b477SBarry Smith   }
6294ef20d060SBarry Smith   PetscFunctionReturn(0);
6295ef20d060SBarry Smith }
6296ef20d060SBarry Smith 
6297201da799SBarry Smith #undef __FUNCT__
6298201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
6299201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6300201da799SBarry Smith {
6301201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6302201da799SBarry Smith   PetscReal      x   = ptime,y;
6303201da799SBarry Smith   PetscErrorCode ierr;
6304201da799SBarry Smith   PetscInt       its;
6305201da799SBarry Smith 
6306201da799SBarry Smith   PetscFunctionBegin;
6307201da799SBarry Smith   if (!n) {
6308201da799SBarry Smith     PetscDrawAxis axis;
6309bbd56ea5SKarl Rupp 
6310201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6311201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
6312201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6313bbd56ea5SKarl Rupp 
6314201da799SBarry Smith     ctx->snes_its = 0;
6315201da799SBarry Smith   }
6316201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
6317201da799SBarry Smith   y    = its - ctx->snes_its;
6318201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
63193fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6320201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
6321201da799SBarry Smith   }
6322201da799SBarry Smith   ctx->snes_its = its;
6323201da799SBarry Smith   PetscFunctionReturn(0);
6324201da799SBarry Smith }
6325201da799SBarry Smith 
6326201da799SBarry Smith #undef __FUNCT__
6327201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
6328201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6329201da799SBarry Smith {
6330201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6331201da799SBarry Smith   PetscReal      x   = ptime,y;
6332201da799SBarry Smith   PetscErrorCode ierr;
6333201da799SBarry Smith   PetscInt       its;
6334201da799SBarry Smith 
6335201da799SBarry Smith   PetscFunctionBegin;
6336201da799SBarry Smith   if (!n) {
6337201da799SBarry Smith     PetscDrawAxis axis;
6338bbd56ea5SKarl Rupp 
6339201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6340201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
6341201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6342bbd56ea5SKarl Rupp 
6343201da799SBarry Smith     ctx->ksp_its = 0;
6344201da799SBarry Smith   }
6345201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
6346201da799SBarry Smith   y    = its - ctx->ksp_its;
6347201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
634899fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6349201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
6350201da799SBarry Smith   }
6351201da799SBarry Smith   ctx->ksp_its = its;
6352201da799SBarry Smith   PetscFunctionReturn(0);
6353201da799SBarry Smith }
6354f9c1d6abSBarry Smith 
6355f9c1d6abSBarry Smith #undef __FUNCT__
6356f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
6357f9c1d6abSBarry Smith /*@
6358f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
6359f9c1d6abSBarry Smith 
6360f9c1d6abSBarry Smith    Collective on TS and Vec
6361f9c1d6abSBarry Smith 
6362f9c1d6abSBarry Smith    Input Parameters:
6363f9c1d6abSBarry Smith +  ts - the TS context
6364f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
6365f9c1d6abSBarry Smith 
6366f9c1d6abSBarry Smith    Output Parameters:
6367f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
6368f9c1d6abSBarry Smith 
6369f9c1d6abSBarry Smith    Level: developer
6370f9c1d6abSBarry Smith 
6371f9c1d6abSBarry Smith .keywords: TS, compute
6372f9c1d6abSBarry Smith 
6373f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
6374f9c1d6abSBarry Smith @*/
6375f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
6376f9c1d6abSBarry Smith {
6377f9c1d6abSBarry Smith   PetscErrorCode ierr;
6378f9c1d6abSBarry Smith 
6379f9c1d6abSBarry Smith   PetscFunctionBegin;
6380f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6381ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
6382f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
6383f9c1d6abSBarry Smith   PetscFunctionReturn(0);
6384f9c1d6abSBarry Smith }
638524655328SShri 
6386b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
6387b3d3934dSBarry Smith #undef __FUNCT__
6388b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxCreate"
6389b3d3934dSBarry Smith /*@C
6390b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
6391b3d3934dSBarry Smith 
6392b3d3934dSBarry Smith    Collective on TS
6393b3d3934dSBarry Smith 
6394b3d3934dSBarry Smith    Input Parameters:
6395b3d3934dSBarry Smith .  ts  - the ODE solver object
6396b3d3934dSBarry Smith 
6397b3d3934dSBarry Smith    Output Parameter:
6398b3d3934dSBarry Smith .  ctx - the context
6399b3d3934dSBarry Smith 
6400b3d3934dSBarry Smith    Level: intermediate
6401b3d3934dSBarry Smith 
6402b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
6403b3d3934dSBarry Smith 
6404b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
6405b3d3934dSBarry Smith 
6406b3d3934dSBarry Smith @*/
6407b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
6408b3d3934dSBarry Smith {
6409b3d3934dSBarry Smith   PetscErrorCode ierr;
6410b3d3934dSBarry Smith 
6411b3d3934dSBarry Smith   PetscFunctionBegin;
6412a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
6413b3d3934dSBarry Smith   PetscFunctionReturn(0);
6414b3d3934dSBarry Smith }
6415b3d3934dSBarry Smith 
6416b3d3934dSBarry Smith #undef __FUNCT__
6417b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelope"
6418b3d3934dSBarry Smith /*@C
6419b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
6420b3d3934dSBarry Smith 
6421b3d3934dSBarry Smith    Collective on TS
6422b3d3934dSBarry Smith 
6423b3d3934dSBarry Smith    Input Parameters:
6424b3d3934dSBarry Smith +  ts - the TS context
6425b3d3934dSBarry Smith .  step - current time-step
6426b3d3934dSBarry Smith .  ptime - current time
64277db568b7SBarry Smith .  u  - current solution
64287db568b7SBarry Smith -  dctx - the envelope context
6429b3d3934dSBarry Smith 
6430b3d3934dSBarry Smith    Options Database:
6431b3d3934dSBarry Smith .  -ts_monitor_envelope
6432b3d3934dSBarry Smith 
6433b3d3934dSBarry Smith    Level: intermediate
6434b3d3934dSBarry Smith 
6435b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
6436b3d3934dSBarry Smith 
6437b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6438b3d3934dSBarry Smith 
64397db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
6440b3d3934dSBarry Smith @*/
64417db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6442b3d3934dSBarry Smith {
6443b3d3934dSBarry Smith   PetscErrorCode       ierr;
64447db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
6445b3d3934dSBarry Smith 
6446b3d3934dSBarry Smith   PetscFunctionBegin;
6447b3d3934dSBarry Smith   if (!ctx->max) {
6448b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
6449b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
6450b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
6451b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
6452b3d3934dSBarry Smith   } else {
6453b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
6454b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
6455b3d3934dSBarry Smith   }
6456b3d3934dSBarry Smith   PetscFunctionReturn(0);
6457b3d3934dSBarry Smith }
6458b3d3934dSBarry Smith 
6459b3d3934dSBarry Smith 
6460b3d3934dSBarry Smith #undef __FUNCT__
6461b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeGetBounds"
6462b3d3934dSBarry Smith /*@C
6463b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
6464b3d3934dSBarry Smith 
6465b3d3934dSBarry Smith    Collective on TS
6466b3d3934dSBarry Smith 
6467b3d3934dSBarry Smith    Input Parameter:
6468b3d3934dSBarry Smith .  ts - the TS context
6469b3d3934dSBarry Smith 
6470b3d3934dSBarry Smith    Output Parameter:
6471b3d3934dSBarry Smith +  max - the maximum values
6472b3d3934dSBarry Smith -  min - the minimum values
6473b3d3934dSBarry Smith 
64747db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
64757db568b7SBarry Smith 
6476b3d3934dSBarry Smith    Level: intermediate
6477b3d3934dSBarry Smith 
6478b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6479b3d3934dSBarry Smith 
6480b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6481b3d3934dSBarry Smith @*/
6482b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
6483b3d3934dSBarry Smith {
6484b3d3934dSBarry Smith   PetscInt i;
6485b3d3934dSBarry Smith 
6486b3d3934dSBarry Smith   PetscFunctionBegin;
6487b3d3934dSBarry Smith   if (max) *max = NULL;
6488b3d3934dSBarry Smith   if (min) *min = NULL;
6489b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6490b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
64915537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
6492b3d3934dSBarry Smith       if (max) *max = ctx->max;
6493b3d3934dSBarry Smith       if (min) *min = ctx->min;
6494b3d3934dSBarry Smith       break;
6495b3d3934dSBarry Smith     }
6496b3d3934dSBarry Smith   }
6497b3d3934dSBarry Smith   PetscFunctionReturn(0);
6498b3d3934dSBarry Smith }
6499b3d3934dSBarry Smith 
6500b3d3934dSBarry Smith #undef __FUNCT__
6501b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy"
6502b3d3934dSBarry Smith /*@C
6503b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
6504b3d3934dSBarry Smith 
6505b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
6506b3d3934dSBarry Smith 
6507b3d3934dSBarry Smith    Input Parameter:
6508b3d3934dSBarry Smith .  ctx - the monitor context
6509b3d3934dSBarry Smith 
6510b3d3934dSBarry Smith    Level: intermediate
6511b3d3934dSBarry Smith 
6512b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
6513b3d3934dSBarry Smith 
65147db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
6515b3d3934dSBarry Smith @*/
6516b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
6517b3d3934dSBarry Smith {
6518b3d3934dSBarry Smith   PetscErrorCode ierr;
6519b3d3934dSBarry Smith 
6520b3d3934dSBarry Smith   PetscFunctionBegin;
6521b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
6522b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
6523b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
6524b3d3934dSBarry Smith   PetscFunctionReturn(0);
6525b3d3934dSBarry Smith }
6526f2dee214SBarry Smith 
652724655328SShri #undef __FUNCT__
652824655328SShri #define __FUNCT__ "TSRollBack"
652924655328SShri /*@
653024655328SShri    TSRollBack - Rolls back one time step
653124655328SShri 
653224655328SShri    Collective on TS
653324655328SShri 
653424655328SShri    Input Parameter:
653524655328SShri .  ts - the TS context obtained from TSCreate()
653624655328SShri 
653724655328SShri    Level: advanced
653824655328SShri 
653924655328SShri .keywords: TS, timestep, rollback
654024655328SShri 
654124655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
654224655328SShri @*/
654324655328SShri PetscErrorCode  TSRollBack(TS ts)
654424655328SShri {
654524655328SShri   PetscErrorCode ierr;
654624655328SShri 
654724655328SShri   PetscFunctionBegin;
654824655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
654924655328SShri 
655024655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
655124655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
655224655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
655324655328SShri   ts->ptime = ts->ptime_prev;
65548392e04aSShri Abhyankar   ts->steprollback = PETSC_TRUE; /* Flag to indicate that the step is rollbacked */
655524655328SShri   PetscFunctionReturn(0);
655624655328SShri }
6557aeb4809dSShri Abhyankar 
6558ff22ae23SHong Zhang #undef __FUNCT__
6559ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
6560ff22ae23SHong Zhang /*@
6561ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
6562ff22ae23SHong Zhang 
6563ff22ae23SHong Zhang    Input Parameter:
6564ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
6565ff22ae23SHong Zhang 
6566ff22ae23SHong Zhang    Level: advanced
6567ff22ae23SHong Zhang 
6568ff22ae23SHong Zhang .keywords: TS, getstages
6569ff22ae23SHong Zhang 
6570ff22ae23SHong Zhang .seealso: TSCreate()
6571ff22ae23SHong Zhang @*/
6572ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
6573ff22ae23SHong Zhang {
6574ff22ae23SHong Zhang   PetscErrorCode ierr;
6575ff22ae23SHong Zhang 
6576ff22ae23SHong Zhang   PetscFunctionBegin;
6577ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6578ff22ae23SHong Zhang   PetscValidPointer(ns,2);
6579ff22ae23SHong Zhang 
6580ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
6581ff22ae23SHong Zhang   else {
6582ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
6583ff22ae23SHong Zhang   }
6584ff22ae23SHong Zhang   PetscFunctionReturn(0);
6585ff22ae23SHong Zhang }
6586ff22ae23SHong Zhang 
6587847ff0e1SMatthew G. Knepley #undef __FUNCT__
6588847ff0e1SMatthew G. Knepley #define __FUNCT__ "TSComputeIJacobianDefaultColor"
6589847ff0e1SMatthew G. Knepley /*@C
6590847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
6591847ff0e1SMatthew G. Knepley 
6592847ff0e1SMatthew G. Knepley   Collective on SNES
6593847ff0e1SMatthew G. Knepley 
6594847ff0e1SMatthew G. Knepley   Input Parameters:
6595847ff0e1SMatthew G. Knepley + ts - the TS context
6596847ff0e1SMatthew G. Knepley . t - current timestep
6597847ff0e1SMatthew G. Knepley . U - state vector
6598847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
6599847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
6600847ff0e1SMatthew G. Knepley - ctx - an optional user context
6601847ff0e1SMatthew G. Knepley 
6602847ff0e1SMatthew G. Knepley   Output Parameters:
6603847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
6604847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
6605847ff0e1SMatthew G. Knepley 
6606847ff0e1SMatthew G. Knepley   Level: intermediate
6607847ff0e1SMatthew G. Knepley 
6608847ff0e1SMatthew G. Knepley   Notes:
6609847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
6610847ff0e1SMatthew G. Knepley 
6611847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
6612847ff0e1SMatthew G. Knepley 
6613847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
6614847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
6615847ff0e1SMatthew G. Knepley 
6616847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
6617847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
6618847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
6619847ff0e1SMatthew G. Knepley 
6620847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
6621847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
6622847ff0e1SMatthew G. Knepley @*/
6623847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
6624847ff0e1SMatthew G. Knepley {
6625847ff0e1SMatthew G. Knepley   SNES           snes;
6626847ff0e1SMatthew G. Knepley   MatFDColoring  color;
6627847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
6628847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
6629847ff0e1SMatthew G. Knepley 
6630847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
6631c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
6632847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
6633847ff0e1SMatthew G. Knepley   if (!color) {
6634847ff0e1SMatthew G. Knepley     DM         dm;
6635847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
6636847ff0e1SMatthew G. Knepley 
6637847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
6638847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
6639847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
6640847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
6641847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6642847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6643847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6644847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6645847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6646847ff0e1SMatthew G. Knepley     } else {
6647847ff0e1SMatthew G. Knepley       MatColoring mc;
6648847ff0e1SMatthew G. Knepley 
6649847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
6650847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
6651847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
6652847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
6653847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
6654847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
6655847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6656847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6657847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6658847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6659847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6660847ff0e1SMatthew G. Knepley     }
6661847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
6662847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
6663847ff0e1SMatthew G. Knepley   }
6664847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
6665847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
6666847ff0e1SMatthew G. Knepley   if (J != B) {
6667847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6668847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6669847ff0e1SMatthew G. Knepley   }
6670847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
6671847ff0e1SMatthew G. Knepley }
667293b34091SDebojyoti Ghosh 
667393b34091SDebojyoti Ghosh #undef __FUNCT__
6674cb9d8021SPierre Barbier de Reuille #define __FUNCT__ "TSSetFunctionDomainError"
6675cb9d8021SPierre Barbier de Reuille /*@
6676cb9d8021SPierre Barbier de Reuille     TSSetFunctionDomainError - Set the function testing if the current state vector is valid
6677cb9d8021SPierre Barbier de Reuille 
6678cb9d8021SPierre Barbier de Reuille     Input Parameters:
6679cb9d8021SPierre Barbier de Reuille     ts - the TS context
6680cb9d8021SPierre Barbier de Reuille     func - function called within TSFunctionDomainError
6681cb9d8021SPierre Barbier de Reuille 
6682cb9d8021SPierre Barbier de Reuille     Level: intermediate
6683cb9d8021SPierre Barbier de Reuille 
6684cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain
6685cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
6686cb9d8021SPierre Barbier de Reuille @*/
6687cb9d8021SPierre Barbier de Reuille 
6688d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
6689cb9d8021SPierre Barbier de Reuille {
6690cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
6691cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6692cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
6693cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
6694cb9d8021SPierre Barbier de Reuille }
6695cb9d8021SPierre Barbier de Reuille 
6696cb9d8021SPierre Barbier de Reuille #undef __FUNCT__
6697cb9d8021SPierre Barbier de Reuille #define __FUNCT__ "TSFunctionDomainError"
6698cb9d8021SPierre Barbier de Reuille /*@
6699cb9d8021SPierre Barbier de Reuille     TSFunctionDomainError - Check if the current state is valid
6700cb9d8021SPierre Barbier de Reuille 
6701cb9d8021SPierre Barbier de Reuille     Input Parameters:
6702cb9d8021SPierre Barbier de Reuille     ts - the TS context
6703cb9d8021SPierre Barbier de Reuille     stagetime - time of the simulation
6704d183316bSPierre Barbier de Reuille     Y - state vector to check.
6705cb9d8021SPierre Barbier de Reuille 
6706cb9d8021SPierre Barbier de Reuille     Output Parameter:
6707cb9d8021SPierre Barbier de Reuille     accept - Set to PETSC_FALSE if the current state vector is valid.
6708cb9d8021SPierre Barbier de Reuille 
6709cb9d8021SPierre Barbier de Reuille     Note:
6710cb9d8021SPierre Barbier de Reuille     This function should be used to ensure the state is in a valid part of the space.
6711cb9d8021SPierre Barbier de Reuille     For example, one can ensure here all values are positive.
6712*96a0c994SBarry Smith 
6713*96a0c994SBarry Smith     Level: advanced
6714cb9d8021SPierre Barbier de Reuille @*/
6715d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
6716cb9d8021SPierre Barbier de Reuille {
6717cb9d8021SPierre Barbier de Reuille   PetscErrorCode ierr;
6718cb9d8021SPierre Barbier de Reuille 
6719cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
6720cb9d8021SPierre Barbier de Reuille 
6721cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6722cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
6723cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
6724d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
6725cb9d8021SPierre Barbier de Reuille   }
6726cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
6727cb9d8021SPierre Barbier de Reuille }
67281ceb14c0SBarry Smith 
67291ceb14c0SBarry Smith #undef  __FUNCT__
6730e5168f73SEmil Constantinescu #define __FUNCT__ "TSClone"
673193b34091SDebojyoti Ghosh /*@C
6732e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
673393b34091SDebojyoti Ghosh 
673493b34091SDebojyoti Ghosh   Collective on MPI_Comm
673593b34091SDebojyoti Ghosh 
673693b34091SDebojyoti Ghosh   Input Parameter:
673793b34091SDebojyoti Ghosh . tsin    - The input TS
673893b34091SDebojyoti Ghosh 
673993b34091SDebojyoti Ghosh   Output Parameter:
6740e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
674193b34091SDebojyoti Ghosh 
67425eca1a21SEmil Constantinescu   Notes:
67435eca1a21SEmil 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.
67445eca1a21SEmil Constantinescu 
6745baa10174SEmil 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);
67465eca1a21SEmil Constantinescu 
67475eca1a21SEmil Constantinescu   Level: developer
674893b34091SDebojyoti Ghosh 
6749e5168f73SEmil Constantinescu .keywords: TS, clone
6750e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
675193b34091SDebojyoti Ghosh @*/
6752baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
675393b34091SDebojyoti Ghosh {
675493b34091SDebojyoti Ghosh   TS             t;
675593b34091SDebojyoti Ghosh   PetscErrorCode ierr;
6756dc846ba4SSatish Balay   SNES           snes_start;
6757dc846ba4SSatish Balay   DM             dm;
6758dc846ba4SSatish Balay   TSType         type;
675993b34091SDebojyoti Ghosh 
676093b34091SDebojyoti Ghosh   PetscFunctionBegin;
676193b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
676293b34091SDebojyoti Ghosh   *tsout = NULL;
676393b34091SDebojyoti Ghosh 
67647a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
676593b34091SDebojyoti Ghosh 
676693b34091SDebojyoti Ghosh   /* General TS description */
676793b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
676893b34091SDebojyoti Ghosh   t->setupcalled       = 0;
676993b34091SDebojyoti Ghosh   t->ksp_its           = 0;
677093b34091SDebojyoti Ghosh   t->snes_its          = 0;
677193b34091SDebojyoti Ghosh   t->nwork             = 0;
677293b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
677393b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
677493b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
677593b34091SDebojyoti Ghosh 
677634561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);                   CHKERRQ(ierr);
677734561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);                       CHKERRQ(ierr);
6778d15a3a53SEmil Constantinescu 
677993b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);                             CHKERRQ(ierr);
678093b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);                                 CHKERRQ(ierr);
678193b34091SDebojyoti Ghosh 
678293b34091SDebojyoti Ghosh   t->adapt=tsin->adapt;
678393b34091SDebojyoti Ghosh   PetscObjectReference((PetscObject)t->adapt);
678493b34091SDebojyoti Ghosh 
678593b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
678693b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
678793b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
678893b34091SDebojyoti Ghosh   t->time_step_orig    = tsin->time_step_orig;
678993b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
679093b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
679193b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
679293b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
679393b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
679493b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
679593b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
679693b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
679793b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
679893b34091SDebojyoti Ghosh 
679993b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type); CHKERRQ(ierr);
680093b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);     CHKERRQ(ierr);
680193b34091SDebojyoti Ghosh 
680293b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
680393b34091SDebojyoti Ghosh 
680493b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
680593b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
680693b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
680793b34091SDebojyoti Ghosh 
680893b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
680993b34091SDebojyoti Ghosh 
68100d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
68110d4fed19SBarry Smith     PetscInt i;
68120d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
68130d4fed19SBarry Smith     for (i=0; i<10; i++) {
68140d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
68150d4fed19SBarry Smith     }
68160d4fed19SBarry Smith   }
681793b34091SDebojyoti Ghosh   *tsout = t;
681893b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
681993b34091SDebojyoti Ghosh }
6820