xref: /petsc/src/ts/interface/ts.c (revision 022c081a6d8b02a670b429ae64c0e7826e2eb534)
1af0996ceSBarry Smith #include <petsc/private/tsimpl.h>        /*I "petscts.h"  I*/
2496e6a7aSJed Brown #include <petscdmshell.h>
31e25c274SJed Brown #include <petscdmda.h>
42d5ee99bSBarry Smith #include <petscviewer.h>
52d5ee99bSBarry Smith #include <petscdraw.h>
6d763cef2SBarry Smith 
7d5ba7fb7SMatthew Knepley /* Logging support */
8d74926cbSBarry Smith PetscClassId  TS_CLASSID, DMTS_CLASSID;
98d0ad7a8SHong Zhang PetscLogEvent TS_AdjointStep, TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
10d405a339SMatthew Knepley 
11feed9e9dSBarry Smith const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0};
1249354f04SShri Abhyankar 
132d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx {
142d5ee99bSBarry Smith   PetscViewer   viewer;
152d5ee99bSBarry Smith   Vec           initialsolution;
162d5ee99bSBarry Smith   PetscBool     showinitial;
172d5ee99bSBarry Smith   PetscInt      howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
182d5ee99bSBarry Smith   PetscBool     showtimestepandtime;
192d5ee99bSBarry Smith };
202d5ee99bSBarry Smith 
21fde5950dSBarry Smith /*@C
22fde5950dSBarry Smith    TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
23fde5950dSBarry Smith 
24fde5950dSBarry Smith    Collective on TS
25fde5950dSBarry Smith 
26fde5950dSBarry Smith    Input Parameters:
27fde5950dSBarry Smith +  ts - TS object you wish to monitor
28fde5950dSBarry Smith .  name - the monitor type one is seeking
29fde5950dSBarry Smith .  help - message indicating what monitoring is done
30fde5950dSBarry Smith .  manual - manual page for the monitor
31fde5950dSBarry Smith .  monitor - the monitor function
32fde5950dSBarry 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
33fde5950dSBarry Smith 
34fde5950dSBarry Smith    Level: developer
35fde5950dSBarry Smith 
36fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
37fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
38fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
39fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
40fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
41fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
42fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
43fde5950dSBarry Smith @*/
44721cd6eeSBarry Smith PetscErrorCode  TSMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*))
45fde5950dSBarry Smith {
46fde5950dSBarry Smith   PetscErrorCode    ierr;
47fde5950dSBarry Smith   PetscViewer       viewer;
48fde5950dSBarry Smith   PetscViewerFormat format;
49fde5950dSBarry Smith   PetscBool         flg;
50fde5950dSBarry Smith 
51fde5950dSBarry Smith   PetscFunctionBegin;
52fde5950dSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
53fde5950dSBarry Smith   if (flg) {
54721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
55721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
56721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
57fde5950dSBarry Smith     if (monitorsetup) {
58721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
59fde5950dSBarry Smith     }
60721cd6eeSBarry Smith     ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr);
61fde5950dSBarry Smith   }
62fde5950dSBarry Smith   PetscFunctionReturn(0);
63fde5950dSBarry Smith }
64fde5950dSBarry Smith 
65fde5950dSBarry Smith /*@C
66e875c4f7SBarry Smith    TSAdjointMonitorSensi - monitors the first lambda sensitivity
67287c2655SBarry Smith 
68287c2655SBarry Smith    Level: intermediate
69287c2655SBarry Smith 
70287c2655SBarry Smith .keywords: TS, set, monitor
71287c2655SBarry Smith 
72287c2655SBarry Smith .seealso: TSAdjointMonitorSet()
73287c2655SBarry Smith @*/
74f4c7b390SBarry Smith PetscErrorCode TSAdjointMonitorSensi(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
75287c2655SBarry Smith {
76287c2655SBarry Smith   PetscErrorCode ierr;
77287c2655SBarry Smith   PetscViewer    viewer = vf->viewer;
78287c2655SBarry Smith 
79287c2655SBarry Smith   PetscFunctionBegin;
80287c2655SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
81287c2655SBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
82287c2655SBarry Smith   ierr = VecView(lambda[0],viewer);CHKERRQ(ierr);
83287c2655SBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
84287c2655SBarry Smith   PetscFunctionReturn(0);
85287c2655SBarry Smith }
86287c2655SBarry Smith 
87287c2655SBarry Smith /*@C
88fde5950dSBarry Smith    TSAdjointMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
89fde5950dSBarry Smith 
90fde5950dSBarry Smith    Collective on TS
91fde5950dSBarry Smith 
92fde5950dSBarry Smith    Input Parameters:
93fde5950dSBarry Smith +  ts - TS object you wish to monitor
94fde5950dSBarry Smith .  name - the monitor type one is seeking
95fde5950dSBarry Smith .  help - message indicating what monitoring is done
96fde5950dSBarry Smith .  manual - manual page for the monitor
97fde5950dSBarry Smith .  monitor - the monitor function
98fde5950dSBarry 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
99fde5950dSBarry Smith 
100fde5950dSBarry Smith    Level: developer
101fde5950dSBarry Smith 
102fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
103fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
104fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
105fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
106fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
107fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
108fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
109fde5950dSBarry Smith @*/
110721cd6eeSBarry Smith PetscErrorCode  TSAdjointMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*))
111fde5950dSBarry Smith {
112fde5950dSBarry Smith   PetscErrorCode    ierr;
113fde5950dSBarry Smith   PetscViewer       viewer;
114fde5950dSBarry Smith   PetscViewerFormat format;
115fde5950dSBarry Smith   PetscBool         flg;
116fde5950dSBarry Smith 
117fde5950dSBarry Smith   PetscFunctionBegin;
118fde5950dSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
119fde5950dSBarry Smith   if (flg) {
120721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
121721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
122721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
123fde5950dSBarry Smith     if (monitorsetup) {
124721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
125fde5950dSBarry Smith     }
126721cd6eeSBarry Smith     ierr = TSAdjointMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr);
127fde5950dSBarry Smith   }
128fde5950dSBarry Smith   PetscFunctionReturn(0);
129fde5950dSBarry Smith }
130fde5950dSBarry Smith 
1312ffb9264SLisandro Dalcin static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt,TSAdaptType default_type)
1322ffb9264SLisandro Dalcin {
1332ffb9264SLisandro Dalcin   PetscErrorCode ierr;
1342ffb9264SLisandro Dalcin 
1352ffb9264SLisandro Dalcin   PetscFunctionBegin;
136b92453a8SLisandro Dalcin   PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1);
137b92453a8SLisandro Dalcin   PetscValidCharPointer(default_type,2);
1382ffb9264SLisandro Dalcin   if (!((PetscObject)adapt)->type_name) {
1392ffb9264SLisandro Dalcin     ierr = TSAdaptSetType(adapt,default_type);CHKERRQ(ierr);
1402ffb9264SLisandro Dalcin   }
1412ffb9264SLisandro Dalcin   PetscFunctionReturn(0);
1422ffb9264SLisandro Dalcin }
1432ffb9264SLisandro Dalcin 
144bdad233fSMatthew Knepley /*@
145bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
146bdad233fSMatthew Knepley 
147bdad233fSMatthew Knepley    Collective on TS
148bdad233fSMatthew Knepley 
149bdad233fSMatthew Knepley    Input Parameter:
150bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
151bdad233fSMatthew Knepley 
152bdad233fSMatthew Knepley    Options Database Keys:
153b6a60446SDebojyoti Ghosh +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE
154ef222394SBarry Smith .  -ts_save_trajectory - checkpoint the solution at each time-step
1553e4cdcaaSBarry Smith .  -ts_max_steps <maxsteps> - maximum number of time-steps to take
1563e4cdcaaSBarry Smith .  -ts_final_time <time> - maximum time to compute to
1573e4cdcaaSBarry Smith .  -ts_dt <dt> - initial time step
158a3cdaa26SBarry 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
159a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
160a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
161a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
162a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
163a3cdaa26SBarry Smith .  -ts_atol <atol> Absolute tolerance for local truncation error
164ef222394SBarry Smith .  -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
165847ff0e1SMatthew G. Knepley .  -ts_fd_color - Use finite differences with coloring to compute IJacobian
166bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
167de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
168de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
1696934998bSLisandro Dalcin .  -ts_monitor_lg_timestep - Monitor timestep size graphically
170de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
171de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
172de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
173de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
1743e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
1753e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
176fde5950dSBarry Smith .  -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep
177e4160dc7SJulian Andrej .  -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu)
178110eb670SHong Zhang .  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
179110eb670SHong Zhang .  -ts_adjoint_monitor - print information at each adjoint time step
18053ea634cSHong Zhang -  -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically
18153ea634cSHong Zhang 
18291b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
183bdad233fSMatthew Knepley 
184bdad233fSMatthew Knepley    Level: beginner
185bdad233fSMatthew Knepley 
186bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
187bdad233fSMatthew Knepley 
188a313700dSBarry Smith .seealso: TSGetType()
189bdad233fSMatthew Knepley @*/
1907087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
191bdad233fSMatthew Knepley {
192bc952696SBarry Smith   PetscBool              opt,flg,tflg;
193dfbe8321SBarry Smith   PetscErrorCode         ierr;
194eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
19531748224SBarry Smith   PetscReal              time_step;
19649354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
197d1212d36SBarry Smith   char                   dir[16];
198cd11d68dSLisandro Dalcin   TSIFunction            ifun;
1996991f827SBarry Smith   const char             *defaultType;
2006991f827SBarry Smith   char                   typeName[256];
201bdad233fSMatthew Knepley 
202bdad233fSMatthew Knepley   PetscFunctionBegin;
2030700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2046991f827SBarry Smith 
2056991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
206cd11d68dSLisandro Dalcin   ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
207cd11d68dSLisandro Dalcin 
208cd11d68dSLisandro Dalcin   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
209cd11d68dSLisandro Dalcin   if (((PetscObject)ts)->type_name)
210cd11d68dSLisandro Dalcin     defaultType = ((PetscObject)ts)->type_name;
211cd11d68dSLisandro Dalcin   else
212cd11d68dSLisandro Dalcin     defaultType = ifun ? TSBEULER : TSEULER;
2136991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr);
2146991f827SBarry Smith   if (opt) {
2156991f827SBarry Smith     ierr = TSSetType(ts,typeName);CHKERRQ(ierr);
2166991f827SBarry Smith   } else {
2176991f827SBarry Smith     ierr = TSSetType(ts,defaultType);CHKERRQ(ierr);
2186991f827SBarry Smith   }
219bdad233fSMatthew Knepley 
220bdad233fSMatthew Knepley   /* Handle generic TS options */
2210298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
2220298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
2230298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
22431748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
225cd11d68dSLisandro Dalcin   if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);}
22649354f04SShri 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);
22749354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
2280298fd71SBarry 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);
2290298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
2300298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
2310298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
2320298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
233bdad233fSMatthew Knepley 
23456f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
23556f85f32SBarry Smith   {
23656f85f32SBarry Smith   PetscBool set;
23756f85f32SBarry Smith   flg  = PETSC_FALSE;
23856f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
23956f85f32SBarry Smith   if (set) {
24056f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
24156f85f32SBarry Smith   }
24256f85f32SBarry Smith   }
24356f85f32SBarry Smith #endif
24456f85f32SBarry Smith 
245bdad233fSMatthew Knepley   /* Monitor options */
246cd11d68dSLisandro Dalcin   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr);
247fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr);
248fde5950dSBarry Smith   ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);CHKERRQ(ierr);
249e875c4f7SBarry Smith   ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor_sensi","Monitor sensitivity in the adjoint computation","TSAdjointMonitorSensi",TSAdjointMonitorSensi,NULL);CHKERRQ(ierr);
250fde5950dSBarry Smith 
2515180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
2525180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
2535180491cSLisandro Dalcin 
2544f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
255b3603a34SBarry Smith   if (opt) {
2560b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2573923b477SBarry Smith     PetscInt       howoften = 1;
258b3603a34SBarry Smith 
2590298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
2606ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2614f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
262bdad233fSMatthew Knepley   }
2636ba87a44SLisandro Dalcin 
2644f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
265ef20d060SBarry Smith   if (opt) {
2660b039ecaSBarry Smith     TSMonitorLGCtx ctx;
2673923b477SBarry Smith     PetscInt       howoften = 1;
268ef20d060SBarry Smith 
2690298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
2706ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2714f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
272ef20d060SBarry Smith   }
2736934998bSLisandro Dalcin 
2746934998bSLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2756934998bSLisandro Dalcin   if (opt) {
2766934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
2776934998bSLisandro Dalcin     PetscInt       howoften = 1;
2786934998bSLisandro Dalcin 
2796934998bSLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2806ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2816934998bSLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2826934998bSLisandro Dalcin   }
283201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
284201da799SBarry Smith   if (opt) {
285201da799SBarry Smith     TSMonitorLGCtx ctx;
286201da799SBarry Smith     PetscInt       howoften = 1;
287201da799SBarry Smith 
2880298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2896ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
290201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
291201da799SBarry Smith   }
292201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
293201da799SBarry Smith   if (opt) {
294201da799SBarry Smith     TSMonitorLGCtx ctx;
295201da799SBarry Smith     PetscInt       howoften = 1;
296201da799SBarry Smith 
2970298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2986ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
299201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
300201da799SBarry Smith   }
3018189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
3028189c53fSBarry Smith   if (opt) {
3038189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
3048189c53fSBarry Smith     PetscInt          howoften = 1;
3058189c53fSBarry Smith 
3060298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
3076934998bSLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3088189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
3098189c53fSBarry Smith   }
310ef20d060SBarry Smith   opt  = PETSC_FALSE;
3110dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
312a7cc72afSBarry Smith   if (opt) {
31383a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
31483a4ac43SBarry Smith     PetscInt         howoften = 1;
315a80ad3e0SBarry Smith 
3160298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
3176934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
31883a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
319bdad233fSMatthew Knepley   }
320fb1732b5SBarry Smith   opt  = PETSC_FALSE;
3219110b2e7SHong Zhang   ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr);
3229110b2e7SHong Zhang   if (opt) {
3239110b2e7SHong Zhang     TSMonitorDrawCtx ctx;
3249110b2e7SHong Zhang     PetscInt         howoften = 1;
3259110b2e7SHong Zhang 
3269110b2e7SHong Zhang     ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr);
3276934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3289110b2e7SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3299110b2e7SHong Zhang   }
3309110b2e7SHong Zhang   opt  = PETSC_FALSE;
3312d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
3322d5ee99bSBarry Smith   if (opt) {
3332d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
3342d5ee99bSBarry Smith     PetscReal        bounds[4];
3352d5ee99bSBarry Smith     PetscInt         n = 4;
3362d5ee99bSBarry Smith     PetscDraw        draw;
3376934998bSLisandro Dalcin     PetscDrawAxis    axis;
3382d5ee99bSBarry Smith 
3392d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
3402d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
3416934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr);
3422d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
3436934998bSLisandro Dalcin     ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr);
3446934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
3456934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
3462d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3472d5ee99bSBarry Smith   }
3482d5ee99bSBarry Smith   opt  = PETSC_FALSE;
3490dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
3503a471f94SBarry Smith   if (opt) {
35183a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
35283a4ac43SBarry Smith     PetscInt         howoften = 1;
3533a471f94SBarry Smith 
3540298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
3556934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
35683a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3573a471f94SBarry Smith   }
358fde5950dSBarry Smith 
359ed81e22dSJed Brown   opt  = PETSC_FALSE;
36091b97e58SBarry 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);
361ed81e22dSJed Brown   if (flg) {
362ed81e22dSJed Brown     const char *ptr,*ptr2;
363ed81e22dSJed Brown     char       *filetemplate;
364ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
365ed81e22dSJed Brown     /* Do some cursory validation of the input. */
366ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
367ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
368ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
369ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
370ce94432eSBarry 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");
371ed81e22dSJed Brown       if (ptr2) break;
372ed81e22dSJed Brown     }
373ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
374ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
375ed81e22dSJed Brown   }
376bdad233fSMatthew Knepley 
377d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
378d1212d36SBarry Smith   if (flg) {
379d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
380d1212d36SBarry Smith     int                  ray = 0;
381d1212d36SBarry Smith     DMDADirection        ddir;
382d1212d36SBarry Smith     DM                   da;
383d1212d36SBarry Smith     PetscMPIInt          rank;
384d1212d36SBarry Smith 
385ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
386d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
387d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
388ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
389d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
390d1212d36SBarry Smith 
391d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
392b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
393d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
394d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
395ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
396d1212d36SBarry Smith     if (!rank) {
397d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
398d1212d36SBarry Smith     }
39951b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
400d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
401d1212d36SBarry Smith   }
40251b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
40351b4a12fSMatthew G. Knepley   if (flg) {
40451b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
40551b4a12fSMatthew G. Knepley     int                 ray = 0;
40651b4a12fSMatthew G. Knepley     DMDADirection       ddir;
40751b4a12fSMatthew G. Knepley     DM                  da;
40851b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
409d1212d36SBarry Smith 
41051b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
41151b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
41251b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
41351b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
41451b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
4151c3436cfSJed Brown 
41651b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
417b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
41851b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
41951b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
42051b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
42151b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
42251b4a12fSMatthew G. Knepley   }
423a7a1495cSBarry Smith 
424b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
425b3d3934dSBarry Smith   if (opt) {
426b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
427b3d3934dSBarry Smith 
428b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
429b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
430b3d3934dSBarry Smith   }
431b3d3934dSBarry Smith 
432847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
433847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
434847ff0e1SMatthew G. Knepley   if (flg) {
435847ff0e1SMatthew G. Knepley     DM   dm;
436847ff0e1SMatthew G. Knepley     DMTS tdm;
437847ff0e1SMatthew G. Knepley 
438847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
439847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
440847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
441847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
442847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
443847ff0e1SMatthew G. Knepley   }
444847ff0e1SMatthew G. Knepley 
445d763cef2SBarry Smith   /* Handle specific TS options */
446d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
4476991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
448d763cef2SBarry Smith   }
449fbc52257SHong Zhang 
450a7bdc993SLisandro Dalcin   /* Handle TSAdapt options */
451a7bdc993SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
452a7bdc993SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
453a7bdc993SLisandro Dalcin   ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr);
454a7bdc993SLisandro Dalcin 
45568bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
4564f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
45768bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
45868bece0bSHong Zhang   if (tflg) {
45968bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
46068bece0bSHong Zhang   }
4614f122a70SLisandro Dalcin   tflg = ts->adjoint_solve ? PETSC_TRUE : PETSC_FALSE;
46268bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
46368bece0bSHong Zhang   if (flg) {
46468bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
46568bece0bSHong Zhang     ts->adjoint_solve = tflg;
46668bece0bSHong Zhang   }
467d763cef2SBarry Smith 
468d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
4690633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
470fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
471d763cef2SBarry Smith 
4724f122a70SLisandro Dalcin   if (ts->trajectory) {
4734f122a70SLisandro Dalcin     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
474d763cef2SBarry Smith   }
47568bece0bSHong Zhang 
4764f122a70SLisandro Dalcin   ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr);
4774f122a70SLisandro Dalcin   if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);}
4784f122a70SLisandro Dalcin   ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
479d763cef2SBarry Smith   PetscFunctionReturn(0);
480d763cef2SBarry Smith }
481d763cef2SBarry Smith 
482d2daff3dSHong Zhang /*@
48378fbdcc8SBarry Smith    TSGetTrajectory - Gets the trajectory from a TS if it exists
48478fbdcc8SBarry Smith 
48578fbdcc8SBarry Smith    Collective on TS
48678fbdcc8SBarry Smith 
48778fbdcc8SBarry Smith    Input Parameters:
48878fbdcc8SBarry Smith .  ts - the TS context obtained from TSCreate()
48978fbdcc8SBarry Smith 
49078fbdcc8SBarry Smith    Output Parameters;
49178fbdcc8SBarry Smith .  tr - the TSTrajectory object, if it exists
49278fbdcc8SBarry Smith 
49378fbdcc8SBarry Smith    Note: This routine should be called after all TS options have been set
49478fbdcc8SBarry Smith 
49578fbdcc8SBarry Smith    Level: advanced
49678fbdcc8SBarry Smith 
49778fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate()
49878fbdcc8SBarry Smith 
49978fbdcc8SBarry Smith .keywords: TS, set, checkpoint,
50078fbdcc8SBarry Smith @*/
50178fbdcc8SBarry Smith PetscErrorCode  TSGetTrajectory(TS ts,TSTrajectory *tr)
50278fbdcc8SBarry Smith {
50378fbdcc8SBarry Smith   PetscFunctionBegin;
50478fbdcc8SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
50578fbdcc8SBarry Smith   *tr = ts->trajectory;
50678fbdcc8SBarry Smith   PetscFunctionReturn(0);
50778fbdcc8SBarry Smith }
50878fbdcc8SBarry Smith 
50978fbdcc8SBarry Smith /*@
510bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
511d2daff3dSHong Zhang 
512d2daff3dSHong Zhang    Collective on TS
513d2daff3dSHong Zhang 
514d2daff3dSHong Zhang    Input Parameters:
515bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
516bc952696SBarry Smith 
51778fbdcc8SBarry Smith    Options Database:
51878fbdcc8SBarry Smith +  -ts_save_trajectory - saves the trajectory to a file
51978fbdcc8SBarry Smith -  -ts_trajectory_type type
52078fbdcc8SBarry Smith 
52168bece0bSHong Zhang Note: This routine should be called after all TS options have been set
522d2daff3dSHong Zhang 
52378fbdcc8SBarry Smith     The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/bin/PetscBinaryIOTrajectory.py and
52478fbdcc8SBarry Smith    MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m
52578fbdcc8SBarry Smith 
526d2daff3dSHong Zhang    Level: intermediate
527d2daff3dSHong Zhang 
52878fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectoryType, TSSetTrajectoryType()
529d2daff3dSHong Zhang 
530bc952696SBarry Smith .keywords: TS, set, checkpoint,
531d2daff3dSHong Zhang @*/
532bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
533d2daff3dSHong Zhang {
534bc952696SBarry Smith   PetscErrorCode ierr;
535bc952696SBarry Smith 
536d2daff3dSHong Zhang   PetscFunctionBegin;
537d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
538bc952696SBarry Smith   if (!ts->trajectory) {
539bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
540972caf09SHong Zhang     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
541bc952696SBarry Smith   }
542d2daff3dSHong Zhang   PetscFunctionReturn(0);
543d2daff3dSHong Zhang }
544d2daff3dSHong Zhang 
545a7a1495cSBarry Smith /*@
546a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
547a7a1495cSBarry Smith       set with TSSetRHSJacobian().
548a7a1495cSBarry Smith 
549a7a1495cSBarry Smith    Collective on TS and Vec
550a7a1495cSBarry Smith 
551a7a1495cSBarry Smith    Input Parameters:
552316643e7SJed Brown +  ts - the TS context
553a7a1495cSBarry Smith .  t - current timestep
5540910c330SBarry Smith -  U - input vector
555a7a1495cSBarry Smith 
556a7a1495cSBarry Smith    Output Parameters:
557a7a1495cSBarry Smith +  A - Jacobian matrix
558a7a1495cSBarry Smith .  B - optional preconditioning matrix
559a7a1495cSBarry Smith -  flag - flag indicating matrix structure
560a7a1495cSBarry Smith 
561a7a1495cSBarry Smith    Notes:
562a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
563a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
564a7a1495cSBarry Smith 
56594b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
566a7a1495cSBarry Smith    flag parameter.
567a7a1495cSBarry Smith 
568a7a1495cSBarry Smith    Level: developer
569a7a1495cSBarry Smith 
570a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
571a7a1495cSBarry Smith 
57294b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
573a7a1495cSBarry Smith @*/
574d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
575a7a1495cSBarry Smith {
576dfbe8321SBarry Smith   PetscErrorCode   ierr;
577270bf2e7SJed Brown   PetscObjectState Ustate;
5786c1e1eecSBarry Smith   PetscObjectId    Uid;
57924989b8cSPeter Brune   DM               dm;
580942e3340SBarry Smith   DMTS             tsdm;
58124989b8cSPeter Brune   TSRHSJacobian    rhsjacobianfunc;
58224989b8cSPeter Brune   void             *ctx;
58324989b8cSPeter Brune   TSIJacobian      ijacobianfunc;
584b2df71adSDebojyoti Ghosh   TSRHSFunction    rhsfunction;
585a7a1495cSBarry Smith 
586a7a1495cSBarry Smith   PetscFunctionBegin;
5870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5880910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5890910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
59024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
591942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
59224989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
5930298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
594b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
59559e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
5966c1e1eecSBarry Smith   ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr);
5976c1e1eecSBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
5980e4ef248SJed Brown     PetscFunctionReturn(0);
599f8ede8e7SJed Brown   }
600d90be118SSean Farley 
601ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
602d90be118SSean Farley 
603e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
60494ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
60594ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
60694ab13aaSBarry Smith     if (A != B) {
60794ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
60894ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
609e1244c69SJed Brown     }
610e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
611e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
612e1244c69SJed Brown   }
613e1244c69SJed Brown 
61424989b8cSPeter Brune   if (rhsjacobianfunc) {
6156cd88445SBarry Smith     PetscBool missing;
61694ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
617a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
618d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
619a7a1495cSBarry Smith     PetscStackPop;
62094ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
6216cd88445SBarry Smith     if (A) {
6226cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
6236cd88445SBarry 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");
6246cd88445SBarry Smith     }
6256cd88445SBarry Smith     if (B && B != A) {
6266cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
6276cd88445SBarry 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");
6286cd88445SBarry Smith     }
629ef66eb69SBarry Smith   } else {
63094ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
63194ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
632ef66eb69SBarry Smith   }
6330e4ef248SJed Brown   ts->rhsjacobian.time       = t;
6346c1e1eecSBarry Smith   ierr                       = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);
63559e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
636a7a1495cSBarry Smith   PetscFunctionReturn(0);
637a7a1495cSBarry Smith }
638a7a1495cSBarry Smith 
639316643e7SJed Brown /*@
640d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
641d763cef2SBarry Smith 
642316643e7SJed Brown    Collective on TS and Vec
643316643e7SJed Brown 
644316643e7SJed Brown    Input Parameters:
645316643e7SJed Brown +  ts - the TS context
646316643e7SJed Brown .  t - current time
6470910c330SBarry Smith -  U - state vector
648316643e7SJed Brown 
649316643e7SJed Brown    Output Parameter:
650316643e7SJed Brown .  y - right hand side
651316643e7SJed Brown 
652316643e7SJed Brown    Note:
653316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
654316643e7SJed Brown    is used internally within the nonlinear solvers.
655316643e7SJed Brown 
656316643e7SJed Brown    Level: developer
657316643e7SJed Brown 
658316643e7SJed Brown .keywords: TS, compute
659316643e7SJed Brown 
660316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
661316643e7SJed Brown @*/
6620910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
663d763cef2SBarry Smith {
664dfbe8321SBarry Smith   PetscErrorCode ierr;
66524989b8cSPeter Brune   TSRHSFunction  rhsfunction;
66624989b8cSPeter Brune   TSIFunction    ifunction;
66724989b8cSPeter Brune   void           *ctx;
66824989b8cSPeter Brune   DM             dm;
66924989b8cSPeter Brune 
670d763cef2SBarry Smith   PetscFunctionBegin;
6710700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6720910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6730700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
67424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
67524989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
6760298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
677d763cef2SBarry Smith 
678ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
679d763cef2SBarry Smith 
6800910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
68124989b8cSPeter Brune   if (rhsfunction) {
682d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
6830910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
684d763cef2SBarry Smith     PetscStackPop;
685214bc6a2SJed Brown   } else {
686214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
687b2cd27e8SJed Brown   }
68844a41b28SSean Farley 
6890910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
690d763cef2SBarry Smith   PetscFunctionReturn(0);
691d763cef2SBarry Smith }
692d763cef2SBarry Smith 
693ef20d060SBarry Smith /*@
694ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
695ef20d060SBarry Smith 
696ef20d060SBarry Smith    Collective on TS and Vec
697ef20d060SBarry Smith 
698ef20d060SBarry Smith    Input Parameters:
699ef20d060SBarry Smith +  ts - the TS context
700ef20d060SBarry Smith -  t - current time
701ef20d060SBarry Smith 
702ef20d060SBarry Smith    Output Parameter:
7030910c330SBarry Smith .  U - the solution
704ef20d060SBarry Smith 
705ef20d060SBarry Smith    Note:
706ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
707ef20d060SBarry Smith    is used internally within the nonlinear solvers.
708ef20d060SBarry Smith 
709ef20d060SBarry Smith    Level: developer
710ef20d060SBarry Smith 
711ef20d060SBarry Smith .keywords: TS, compute
712ef20d060SBarry Smith 
713abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
714ef20d060SBarry Smith @*/
7150910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
716ef20d060SBarry Smith {
717ef20d060SBarry Smith   PetscErrorCode     ierr;
718ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
719ef20d060SBarry Smith   void               *ctx;
720ef20d060SBarry Smith   DM                 dm;
721ef20d060SBarry Smith 
722ef20d060SBarry Smith   PetscFunctionBegin;
723ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7240910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
725ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
726ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
727ef20d060SBarry Smith 
728ef20d060SBarry Smith   if (solutionfunction) {
7299b7cd975SBarry Smith     PetscStackPush("TS user solution function");
7300910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
731ef20d060SBarry Smith     PetscStackPop;
732ef20d060SBarry Smith   }
733ef20d060SBarry Smith   PetscFunctionReturn(0);
734ef20d060SBarry Smith }
7359b7cd975SBarry Smith /*@
7369b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
7379b7cd975SBarry Smith 
7389b7cd975SBarry Smith    Collective on TS and Vec
7399b7cd975SBarry Smith 
7409b7cd975SBarry Smith    Input Parameters:
7419b7cd975SBarry Smith +  ts - the TS context
7429b7cd975SBarry Smith -  t - current time
7439b7cd975SBarry Smith 
7449b7cd975SBarry Smith    Output Parameter:
7459b7cd975SBarry Smith .  U - the function value
7469b7cd975SBarry Smith 
7479b7cd975SBarry Smith    Note:
7489b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
7499b7cd975SBarry Smith    is used internally within the nonlinear solvers.
7509b7cd975SBarry Smith 
7519b7cd975SBarry Smith    Level: developer
7529b7cd975SBarry Smith 
7539b7cd975SBarry Smith .keywords: TS, compute
7549b7cd975SBarry Smith 
7559b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7569b7cd975SBarry Smith @*/
7579b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7589b7cd975SBarry Smith {
7599b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7609b7cd975SBarry Smith   void               *ctx;
7619b7cd975SBarry Smith   DM                 dm;
7629b7cd975SBarry Smith 
7639b7cd975SBarry Smith   PetscFunctionBegin;
7649b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7659b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7669b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7679b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7689b7cd975SBarry Smith 
7699b7cd975SBarry Smith   if (forcing) {
7709b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
7719b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
7729b7cd975SBarry Smith     PetscStackPop;
7739b7cd975SBarry Smith   }
7749b7cd975SBarry Smith   PetscFunctionReturn(0);
7759b7cd975SBarry Smith }
776ef20d060SBarry Smith 
777214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
778214bc6a2SJed Brown {
7792dd45cf8SJed Brown   Vec            F;
780214bc6a2SJed Brown   PetscErrorCode ierr;
781214bc6a2SJed Brown 
782214bc6a2SJed Brown   PetscFunctionBegin;
7830298fd71SBarry Smith   *Frhs = NULL;
7840298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
785214bc6a2SJed Brown   if (!ts->Frhs) {
7862dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
787214bc6a2SJed Brown   }
788214bc6a2SJed Brown   *Frhs = ts->Frhs;
789214bc6a2SJed Brown   PetscFunctionReturn(0);
790214bc6a2SJed Brown }
791214bc6a2SJed Brown 
792214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
793214bc6a2SJed Brown {
794214bc6a2SJed Brown   Mat            A,B;
7952dd45cf8SJed Brown   PetscErrorCode ierr;
79641a1d4d2SBarry Smith   TSIJacobian    ijacobian;
797214bc6a2SJed Brown 
798214bc6a2SJed Brown   PetscFunctionBegin;
799c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
800c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
80141a1d4d2SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr);
802214bc6a2SJed Brown   if (Arhs) {
803214bc6a2SJed Brown     if (!ts->Arhs) {
80441a1d4d2SBarry Smith       if (ijacobian) {
805214bc6a2SJed Brown         ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
80641a1d4d2SBarry Smith       } else {
80741a1d4d2SBarry Smith         ts->Arhs = A;
80841a1d4d2SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
80941a1d4d2SBarry Smith       }
8103565c898SBarry Smith     } else {
8113565c898SBarry Smith       PetscBool flg;
8123565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
8133565c898SBarry Smith       /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */
8143565c898SBarry Smith       if (flg && !ijacobian && ts->Arhs == ts->Brhs){
8153565c898SBarry Smith         ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr);
8163565c898SBarry Smith         ts->Arhs = A;
8173565c898SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
8183565c898SBarry Smith       }
819214bc6a2SJed Brown     }
820214bc6a2SJed Brown     *Arhs = ts->Arhs;
821214bc6a2SJed Brown   }
822214bc6a2SJed Brown   if (Brhs) {
823214bc6a2SJed Brown     if (!ts->Brhs) {
824bdb70873SJed Brown       if (A != B) {
82541a1d4d2SBarry Smith         if (ijacobian) {
826214bc6a2SJed Brown           ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
827bdb70873SJed Brown         } else {
82841a1d4d2SBarry Smith           ts->Brhs = B;
82941a1d4d2SBarry Smith           ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
83041a1d4d2SBarry Smith         }
83141a1d4d2SBarry Smith       } else {
832bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
83351699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
834bdb70873SJed Brown       }
835214bc6a2SJed Brown     }
836214bc6a2SJed Brown     *Brhs = ts->Brhs;
837214bc6a2SJed Brown   }
838214bc6a2SJed Brown   PetscFunctionReturn(0);
839214bc6a2SJed Brown }
840214bc6a2SJed Brown 
841316643e7SJed Brown /*@
8420910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
843316643e7SJed Brown 
844316643e7SJed Brown    Collective on TS and Vec
845316643e7SJed Brown 
846316643e7SJed Brown    Input Parameters:
847316643e7SJed Brown +  ts - the TS context
848316643e7SJed Brown .  t - current time
8490910c330SBarry Smith .  U - state vector
8500910c330SBarry Smith .  Udot - time derivative of state vector
851214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
852316643e7SJed Brown 
853316643e7SJed Brown    Output Parameter:
854316643e7SJed Brown .  Y - right hand side
855316643e7SJed Brown 
856316643e7SJed Brown    Note:
857316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
858316643e7SJed Brown    is used internally within the nonlinear solvers.
859316643e7SJed Brown 
860316643e7SJed Brown    If the user did did not write their equations in implicit form, this
861316643e7SJed Brown    function recasts them in implicit form.
862316643e7SJed Brown 
863316643e7SJed Brown    Level: developer
864316643e7SJed Brown 
865316643e7SJed Brown .keywords: TS, compute
866316643e7SJed Brown 
867316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
868316643e7SJed Brown @*/
8690910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
870316643e7SJed Brown {
871316643e7SJed Brown   PetscErrorCode ierr;
87224989b8cSPeter Brune   TSIFunction    ifunction;
87324989b8cSPeter Brune   TSRHSFunction  rhsfunction;
87424989b8cSPeter Brune   void           *ctx;
87524989b8cSPeter Brune   DM             dm;
876316643e7SJed Brown 
877316643e7SJed Brown   PetscFunctionBegin;
8780700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8790910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8800910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
8810700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
882316643e7SJed Brown 
88324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
88424989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
8850298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
88624989b8cSPeter Brune 
887ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
888d90be118SSean Farley 
8890910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
89024989b8cSPeter Brune   if (ifunction) {
891316643e7SJed Brown     PetscStackPush("TS user implicit function");
8920910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
893316643e7SJed Brown     PetscStackPop;
894214bc6a2SJed Brown   }
895214bc6a2SJed Brown   if (imex) {
89624989b8cSPeter Brune     if (!ifunction) {
8970910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
8982dd45cf8SJed Brown     }
89924989b8cSPeter Brune   } else if (rhsfunction) {
90024989b8cSPeter Brune     if (ifunction) {
901214bc6a2SJed Brown       Vec Frhs;
902214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
9030910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
904214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
9052dd45cf8SJed Brown     } else {
9060910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
9070910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
908316643e7SJed Brown     }
9094a6899ffSJed Brown   }
9100910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
911316643e7SJed Brown   PetscFunctionReturn(0);
912316643e7SJed Brown }
913316643e7SJed Brown 
914316643e7SJed Brown /*@
915316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
916316643e7SJed Brown 
917316643e7SJed Brown    Collective on TS and Vec
918316643e7SJed Brown 
919316643e7SJed Brown    Input
920316643e7SJed Brown       Input Parameters:
921316643e7SJed Brown +  ts - the TS context
922316643e7SJed Brown .  t - current timestep
9230910c330SBarry Smith .  U - state vector
9240910c330SBarry Smith .  Udot - time derivative of state vector
925214bc6a2SJed Brown .  shift - shift to apply, see note below
926214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
927316643e7SJed Brown 
928316643e7SJed Brown    Output Parameters:
929316643e7SJed Brown +  A - Jacobian matrix
9303565c898SBarry Smith -  B - matrix from which the preconditioner is constructed; often the same as A
931316643e7SJed Brown 
932316643e7SJed Brown    Notes:
9330910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
934316643e7SJed Brown 
9350910c330SBarry Smith    dF/dU + shift*dF/dUdot
936316643e7SJed Brown 
937316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
938316643e7SJed Brown    is used internally within the nonlinear solvers.
939316643e7SJed Brown 
940316643e7SJed Brown    Level: developer
941316643e7SJed Brown 
942316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
943316643e7SJed Brown 
944316643e7SJed Brown .seealso:  TSSetIJacobian()
94563495f91SJed Brown @*/
946d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
947316643e7SJed Brown {
948316643e7SJed Brown   PetscErrorCode ierr;
94924989b8cSPeter Brune   TSIJacobian    ijacobian;
95024989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
95124989b8cSPeter Brune   DM             dm;
95224989b8cSPeter Brune   void           *ctx;
953316643e7SJed Brown 
954316643e7SJed Brown   PetscFunctionBegin;
9550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9560910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9570910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
958316643e7SJed Brown   PetscValidPointer(A,6);
95994ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
960316643e7SJed Brown   PetscValidPointer(B,7);
96194ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
96224989b8cSPeter Brune 
96324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
96424989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
9650298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
96624989b8cSPeter Brune 
967ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
968316643e7SJed Brown 
96994ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
97024989b8cSPeter Brune   if (ijacobian) {
9716cd88445SBarry Smith     PetscBool missing;
972316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
973d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
974316643e7SJed Brown     PetscStackPop;
9756cd88445SBarry Smith     ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
9766cd88445SBarry 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");
9773565c898SBarry Smith     if (B != A) {
9786cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
9796cd88445SBarry 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");
9806cd88445SBarry Smith     }
9814a6899ffSJed Brown   }
982214bc6a2SJed Brown   if (imex) {
983b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
9844c26be97Sstefano_zampini       PetscBool assembled;
98594ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
9864c26be97Sstefano_zampini       ierr = MatAssembled(A,&assembled);CHKERRQ(ierr);
9874c26be97Sstefano_zampini       if (!assembled) {
9884c26be97Sstefano_zampini         ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9894c26be97Sstefano_zampini         ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9904c26be97Sstefano_zampini       }
99194ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
99294ab13aaSBarry Smith       if (A != B) {
99394ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
9944c26be97Sstefano_zampini         ierr = MatAssembled(B,&assembled);CHKERRQ(ierr);
9954c26be97Sstefano_zampini         if (!assembled) {
9964c26be97Sstefano_zampini           ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9974c26be97Sstefano_zampini           ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9984c26be97Sstefano_zampini         }
99994ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
1000214bc6a2SJed Brown       }
1001214bc6a2SJed Brown     }
1002214bc6a2SJed Brown   } else {
1003e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
1004e1244c69SJed Brown     if (rhsjacobian) {
1005214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
1006d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
1007e1244c69SJed Brown     }
100894ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
10093565c898SBarry Smith       PetscBool flg;
1010e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
1011e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
10123565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
10133565c898SBarry Smith       /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */
10143565c898SBarry Smith       if (!flg) {
101594ab13aaSBarry Smith         ierr = MatScale(A,-1);CHKERRQ(ierr);
101694ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
10173565c898SBarry Smith       }
101894ab13aaSBarry Smith       if (A != B) {
101994ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
102094ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
1021316643e7SJed Brown       }
1022e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
1023e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1024e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
102594ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
102694ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
102794ab13aaSBarry Smith         if (A != B) {
102894ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
102994ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
1030214bc6a2SJed Brown         }
1031316643e7SJed Brown       }
103294ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
103394ab13aaSBarry Smith       if (A != B) {
103494ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
1035316643e7SJed Brown       }
1036316643e7SJed Brown     }
1037316643e7SJed Brown   }
103894ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
1039316643e7SJed Brown   PetscFunctionReturn(0);
1040316643e7SJed Brown }
1041316643e7SJed Brown 
1042d763cef2SBarry Smith /*@C
1043d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
1044b5abc632SBarry Smith     where U_t = G(t,u).
1045d763cef2SBarry Smith 
10463f9fe445SBarry Smith     Logically Collective on TS
1047d763cef2SBarry Smith 
1048d763cef2SBarry Smith     Input Parameters:
1049d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
10500298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
1051d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
1052d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
10530298fd71SBarry Smith           function evaluation routine (may be NULL)
1054d763cef2SBarry Smith 
1055d763cef2SBarry Smith     Calling sequence of func:
105687828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
1057d763cef2SBarry Smith 
1058d763cef2SBarry Smith +   t - current timestep
1059d763cef2SBarry Smith .   u - input vector
1060d763cef2SBarry Smith .   F - function vector
1061d763cef2SBarry Smith -   ctx - [optional] user-defined function context
1062d763cef2SBarry Smith 
1063d763cef2SBarry Smith     Level: beginner
1064d763cef2SBarry Smith 
10652bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
10662bbac0d3SBarry Smith 
1067d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1068d763cef2SBarry Smith 
1069ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
1070d763cef2SBarry Smith @*/
1071089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
1072d763cef2SBarry Smith {
1073089b2837SJed Brown   PetscErrorCode ierr;
1074089b2837SJed Brown   SNES           snes;
10750298fd71SBarry Smith   Vec            ralloc = NULL;
107624989b8cSPeter Brune   DM             dm;
1077d763cef2SBarry Smith 
1078089b2837SJed Brown   PetscFunctionBegin;
10790700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1080ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
108124989b8cSPeter Brune 
108224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
108324989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1084089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1085e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1086e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1087e856ceecSJed Brown     r = ralloc;
1088e856ceecSJed Brown   }
1089089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1090e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1091d763cef2SBarry Smith   PetscFunctionReturn(0);
1092d763cef2SBarry Smith }
1093d763cef2SBarry Smith 
1094ef20d060SBarry Smith /*@C
1095abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1096ef20d060SBarry Smith 
1097ef20d060SBarry Smith     Logically Collective on TS
1098ef20d060SBarry Smith 
1099ef20d060SBarry Smith     Input Parameters:
1100ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1101ef20d060SBarry Smith .   f - routine for evaluating the solution
1102ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
11030298fd71SBarry Smith           function evaluation routine (may be NULL)
1104ef20d060SBarry Smith 
1105ef20d060SBarry Smith     Calling sequence of func:
1106ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
1107ef20d060SBarry Smith 
1108ef20d060SBarry Smith +   t - current timestep
1109ef20d060SBarry Smith .   u - output vector
1110ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1111ef20d060SBarry Smith 
1112abd5a294SJed Brown     Notes:
1113abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1114abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1115abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1116abd5a294SJed Brown 
11174f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1118abd5a294SJed Brown 
1119ef20d060SBarry Smith     Level: beginner
1120ef20d060SBarry Smith 
1121ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1122ef20d060SBarry Smith 
11239b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
1124ef20d060SBarry Smith @*/
1125ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1126ef20d060SBarry Smith {
1127ef20d060SBarry Smith   PetscErrorCode ierr;
1128ef20d060SBarry Smith   DM             dm;
1129ef20d060SBarry Smith 
1130ef20d060SBarry Smith   PetscFunctionBegin;
1131ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1132ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1133ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1134ef20d060SBarry Smith   PetscFunctionReturn(0);
1135ef20d060SBarry Smith }
1136ef20d060SBarry Smith 
11379b7cd975SBarry Smith /*@C
11389b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
11399b7cd975SBarry Smith 
11409b7cd975SBarry Smith     Logically Collective on TS
11419b7cd975SBarry Smith 
11429b7cd975SBarry Smith     Input Parameters:
11439b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
1144e162b725SBarry Smith .   func - routine for evaluating the forcing function
11459b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
11460298fd71SBarry Smith           function evaluation routine (may be NULL)
11479b7cd975SBarry Smith 
11489b7cd975SBarry Smith     Calling sequence of func:
1149e162b725SBarry Smith $     func (TS ts,PetscReal t,Vec f,void *ctx);
11509b7cd975SBarry Smith 
11519b7cd975SBarry Smith +   t - current timestep
1152e162b725SBarry Smith .   f - output vector
11539b7cd975SBarry Smith -   ctx - [optional] user-defined function context
11549b7cd975SBarry Smith 
11559b7cd975SBarry Smith     Notes:
11569b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
1157e162b725SBarry Smith     create closed-form solutions with a non-physical forcing term. It allows you to use the Method of Manufactored Solution without directly editing the
1158e162b725SBarry Smith     definition of the problem you are solving and hence possibly introducing bugs.
1159e162b725SBarry Smith 
1160e162b725SBarry Smith     This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0
1161e162b725SBarry Smith 
1162e162b725SBarry Smith     This forcing function does not depend on the solution to the equations, it can only depend on spatial location, time, and possibly parameters, the
1163e162b725SBarry Smith     parameters can be passed in the ctx variable.
11649b7cd975SBarry Smith 
11659b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
11669b7cd975SBarry Smith 
11679b7cd975SBarry Smith     Level: beginner
11689b7cd975SBarry Smith 
11699b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
11709b7cd975SBarry Smith 
11719b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
11729b7cd975SBarry Smith @*/
1173e162b725SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx)
11749b7cd975SBarry Smith {
11759b7cd975SBarry Smith   PetscErrorCode ierr;
11769b7cd975SBarry Smith   DM             dm;
11779b7cd975SBarry Smith 
11789b7cd975SBarry Smith   PetscFunctionBegin;
11799b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
11809b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1181e162b725SBarry Smith   ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr);
11829b7cd975SBarry Smith   PetscFunctionReturn(0);
11839b7cd975SBarry Smith }
11849b7cd975SBarry Smith 
1185d763cef2SBarry Smith /*@C
1186f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1187b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1188d763cef2SBarry Smith 
11893f9fe445SBarry Smith    Logically Collective on TS
1190d763cef2SBarry Smith 
1191d763cef2SBarry Smith    Input Parameters:
1192d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1193e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1194e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1195d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1196d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
11970298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1198d763cef2SBarry Smith 
1199f7ab8db6SBarry Smith    Calling sequence of f:
1200ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1201d763cef2SBarry Smith 
1202d763cef2SBarry Smith +  t - current timestep
1203d763cef2SBarry Smith .  u - input vector
1204e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1205e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1206d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1207d763cef2SBarry Smith 
12086cd88445SBarry Smith    Notes:
12096cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
12106cd88445SBarry Smith 
12116cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1212ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1213d763cef2SBarry Smith 
1214d763cef2SBarry Smith    Level: beginner
1215d763cef2SBarry Smith 
1216d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1217d763cef2SBarry Smith 
1218ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1219d763cef2SBarry Smith 
1220d763cef2SBarry Smith @*/
1221e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1222d763cef2SBarry Smith {
1223277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1224089b2837SJed Brown   SNES           snes;
122524989b8cSPeter Brune   DM             dm;
122624989b8cSPeter Brune   TSIJacobian    ijacobian;
1227277b19d0SLisandro Dalcin 
1228d763cef2SBarry Smith   PetscFunctionBegin;
12290700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1230e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1231e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1232e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1233e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1234d763cef2SBarry Smith 
123524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
123624989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1237e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1238e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1239e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1240e1244c69SJed Brown   }
12410298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1242089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12435f659677SPeter Brune   if (!ijacobian) {
1244e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
12450e4ef248SJed Brown   }
1246e5d3d808SBarry Smith   if (Amat) {
1247e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
12480e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1249e5d3d808SBarry Smith     ts->Arhs = Amat;
12500e4ef248SJed Brown   }
1251e5d3d808SBarry Smith   if (Pmat) {
1252e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
12530e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1254e5d3d808SBarry Smith     ts->Brhs = Pmat;
12550e4ef248SJed Brown   }
1256d763cef2SBarry Smith   PetscFunctionReturn(0);
1257d763cef2SBarry Smith }
1258d763cef2SBarry Smith 
1259316643e7SJed Brown /*@C
1260b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1261316643e7SJed Brown 
12623f9fe445SBarry Smith    Logically Collective on TS
1263316643e7SJed Brown 
1264316643e7SJed Brown    Input Parameters:
1265316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
12660298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1267316643e7SJed Brown .  f   - the function evaluation routine
12680298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1269316643e7SJed Brown 
1270316643e7SJed Brown    Calling sequence of f:
1271316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1272316643e7SJed Brown 
1273316643e7SJed Brown +  t   - time at step/stage being solved
1274316643e7SJed Brown .  u   - state vector
1275316643e7SJed Brown .  u_t - time derivative of state vector
1276316643e7SJed Brown .  F   - function vector
1277316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1278316643e7SJed Brown 
1279316643e7SJed Brown    Important:
12802bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1281316643e7SJed Brown 
1282316643e7SJed Brown    Level: beginner
1283316643e7SJed Brown 
1284316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1285316643e7SJed Brown 
1286d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1287316643e7SJed Brown @*/
128851699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1289316643e7SJed Brown {
1290089b2837SJed Brown   PetscErrorCode ierr;
1291089b2837SJed Brown   SNES           snes;
129251699248SLisandro Dalcin   Vec            ralloc = NULL;
129324989b8cSPeter Brune   DM             dm;
1294316643e7SJed Brown 
1295316643e7SJed Brown   PetscFunctionBegin;
12960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
129751699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
129824989b8cSPeter Brune 
129924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
130024989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
130124989b8cSPeter Brune 
1302089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
130351699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
130451699248SLisandro Dalcin     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
130551699248SLisandro Dalcin     r  = ralloc;
1306e856ceecSJed Brown   }
130751699248SLisandro Dalcin   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
130851699248SLisandro Dalcin   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1309089b2837SJed Brown   PetscFunctionReturn(0);
1310089b2837SJed Brown }
1311089b2837SJed Brown 
1312089b2837SJed Brown /*@C
1313089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1314089b2837SJed Brown 
1315089b2837SJed Brown    Not Collective
1316089b2837SJed Brown 
1317089b2837SJed Brown    Input Parameter:
1318089b2837SJed Brown .  ts - the TS context
1319089b2837SJed Brown 
1320089b2837SJed Brown    Output Parameter:
13210298fd71SBarry Smith +  r - vector to hold residual (or NULL)
13220298fd71SBarry Smith .  func - the function to compute residual (or NULL)
13230298fd71SBarry Smith -  ctx - the function context (or NULL)
1324089b2837SJed Brown 
1325089b2837SJed Brown    Level: advanced
1326089b2837SJed Brown 
1327089b2837SJed Brown .keywords: TS, nonlinear, get, function
1328089b2837SJed Brown 
1329089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1330089b2837SJed Brown @*/
1331089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1332089b2837SJed Brown {
1333089b2837SJed Brown   PetscErrorCode ierr;
1334089b2837SJed Brown   SNES           snes;
133524989b8cSPeter Brune   DM             dm;
1336089b2837SJed Brown 
1337089b2837SJed Brown   PetscFunctionBegin;
1338089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1339089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13400298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
134124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
134224989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1343089b2837SJed Brown   PetscFunctionReturn(0);
1344089b2837SJed Brown }
1345089b2837SJed Brown 
1346089b2837SJed Brown /*@C
1347089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1348089b2837SJed Brown 
1349089b2837SJed Brown    Not Collective
1350089b2837SJed Brown 
1351089b2837SJed Brown    Input Parameter:
1352089b2837SJed Brown .  ts - the TS context
1353089b2837SJed Brown 
1354089b2837SJed Brown    Output Parameter:
13550298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
13560298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
13570298fd71SBarry Smith -  ctx - the function context (or NULL)
1358089b2837SJed Brown 
1359089b2837SJed Brown    Level: advanced
1360089b2837SJed Brown 
1361089b2837SJed Brown .keywords: TS, nonlinear, get, function
1362089b2837SJed Brown 
13632bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1364089b2837SJed Brown @*/
1365089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1366089b2837SJed Brown {
1367089b2837SJed Brown   PetscErrorCode ierr;
1368089b2837SJed Brown   SNES           snes;
136924989b8cSPeter Brune   DM             dm;
1370089b2837SJed Brown 
1371089b2837SJed Brown   PetscFunctionBegin;
1372089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1373089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13740298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
137524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
137624989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1377316643e7SJed Brown   PetscFunctionReturn(0);
1378316643e7SJed Brown }
1379316643e7SJed Brown 
1380316643e7SJed Brown /*@C
1381a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1382ae8867d6SBarry Smith         provided with TSSetIFunction().
1383316643e7SJed Brown 
13843f9fe445SBarry Smith    Logically Collective on TS
1385316643e7SJed Brown 
1386316643e7SJed Brown    Input Parameters:
1387316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1388e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1389e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1390316643e7SJed Brown .  f   - the Jacobian evaluation routine
13910298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1392316643e7SJed Brown 
1393316643e7SJed Brown    Calling sequence of f:
1394ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1395316643e7SJed Brown 
1396316643e7SJed Brown +  t    - time at step/stage being solved
13971b4a444bSJed Brown .  U    - state vector
13981b4a444bSJed Brown .  U_t  - time derivative of state vector
1399316643e7SJed Brown .  a    - shift
1400e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1401e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1402316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1403316643e7SJed Brown 
1404316643e7SJed Brown    Notes:
1405e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1406316643e7SJed Brown 
1407895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1408895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1409895c21f2SBarry Smith 
1410a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1411b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1412a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1413a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1414a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1415a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1416a4f0a591SBarry Smith 
14176cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
14186cd88445SBarry Smith 
14196cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1420ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1421ca5f011dSBarry Smith 
1422316643e7SJed Brown    Level: beginner
1423316643e7SJed Brown 
1424316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1425316643e7SJed Brown 
1426ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1427316643e7SJed Brown 
1428316643e7SJed Brown @*/
1429e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1430316643e7SJed Brown {
1431316643e7SJed Brown   PetscErrorCode ierr;
1432089b2837SJed Brown   SNES           snes;
143324989b8cSPeter Brune   DM             dm;
1434316643e7SJed Brown 
1435316643e7SJed Brown   PetscFunctionBegin;
14360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1437e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1438e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1439e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1440e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
144124989b8cSPeter Brune 
144224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
144324989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
144424989b8cSPeter Brune 
1445089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1446e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1447316643e7SJed Brown   PetscFunctionReturn(0);
1448316643e7SJed Brown }
1449316643e7SJed Brown 
1450e1244c69SJed Brown /*@
1451e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1452e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1453e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1454e1244c69SJed Brown    not been changed by the TS.
1455e1244c69SJed Brown 
1456e1244c69SJed Brown    Logically Collective
1457e1244c69SJed Brown 
1458e1244c69SJed Brown    Input Arguments:
1459e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1460e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1461e1244c69SJed Brown 
1462e1244c69SJed Brown    Level: intermediate
1463e1244c69SJed Brown 
1464e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1465e1244c69SJed Brown @*/
1466e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1467e1244c69SJed Brown {
1468e1244c69SJed Brown   PetscFunctionBegin;
1469e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1470e1244c69SJed Brown   PetscFunctionReturn(0);
1471e1244c69SJed Brown }
1472e1244c69SJed Brown 
1473efe9872eSLisandro Dalcin /*@C
1474efe9872eSLisandro Dalcin    TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1475efe9872eSLisandro Dalcin 
1476efe9872eSLisandro Dalcin    Logically Collective on TS
1477efe9872eSLisandro Dalcin 
1478efe9872eSLisandro Dalcin    Input Parameters:
1479efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1480efe9872eSLisandro Dalcin .  F   - vector to hold the residual (or NULL to have it created internally)
1481efe9872eSLisandro Dalcin .  fun - the function evaluation routine
1482efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1483efe9872eSLisandro Dalcin 
1484efe9872eSLisandro Dalcin    Calling sequence of fun:
1485efe9872eSLisandro Dalcin $  fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx);
1486efe9872eSLisandro Dalcin 
1487efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1488efe9872eSLisandro Dalcin .  U    - state vector
1489efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1490efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1491efe9872eSLisandro Dalcin .  F    - function vector
1492efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine (may be NULL)
1493efe9872eSLisandro Dalcin 
1494efe9872eSLisandro Dalcin    Level: beginner
1495efe9872eSLisandro Dalcin 
1496efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function
1497efe9872eSLisandro Dalcin 
1498efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian()
1499efe9872eSLisandro Dalcin @*/
1500efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx)
1501efe9872eSLisandro Dalcin {
1502efe9872eSLisandro Dalcin   DM             dm;
1503efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1504efe9872eSLisandro Dalcin 
1505efe9872eSLisandro Dalcin   PetscFunctionBegin;
1506efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1507efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2);
1508efe9872eSLisandro Dalcin   ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr);
1509efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1510efe9872eSLisandro Dalcin   ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1511efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1512efe9872eSLisandro Dalcin }
1513efe9872eSLisandro Dalcin 
1514efe9872eSLisandro Dalcin /*@C
1515efe9872eSLisandro Dalcin   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1516efe9872eSLisandro Dalcin 
1517efe9872eSLisandro Dalcin   Not Collective
1518efe9872eSLisandro Dalcin 
1519efe9872eSLisandro Dalcin   Input Parameter:
1520efe9872eSLisandro Dalcin . ts - the TS context
1521efe9872eSLisandro Dalcin 
1522efe9872eSLisandro Dalcin   Output Parameter:
1523efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL)
1524efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL)
1525efe9872eSLisandro Dalcin - ctx - the function context (or NULL)
1526efe9872eSLisandro Dalcin 
1527efe9872eSLisandro Dalcin   Level: advanced
1528efe9872eSLisandro Dalcin 
1529efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function
1530efe9872eSLisandro Dalcin 
1531efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction()
1532efe9872eSLisandro Dalcin @*/
1533efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1534efe9872eSLisandro Dalcin {
1535efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1536efe9872eSLisandro Dalcin   SNES           snes;
1537efe9872eSLisandro Dalcin   DM             dm;
1538efe9872eSLisandro Dalcin 
1539efe9872eSLisandro Dalcin   PetscFunctionBegin;
1540efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1541efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1542efe9872eSLisandro Dalcin   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1543efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1544efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1545efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1546efe9872eSLisandro Dalcin }
1547efe9872eSLisandro Dalcin 
1548efe9872eSLisandro Dalcin /*@C
1549bc77d74cSLisandro Dalcin    TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1550efe9872eSLisandro Dalcin         where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1551efe9872eSLisandro Dalcin 
1552efe9872eSLisandro Dalcin    Logically Collective on TS
1553efe9872eSLisandro Dalcin 
1554efe9872eSLisandro Dalcin    Input Parameters:
1555efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1556efe9872eSLisandro Dalcin .  J   - Jacobian matrix
1557efe9872eSLisandro Dalcin .  P   - preconditioning matrix for J (may be same as J)
1558efe9872eSLisandro Dalcin .  jac - the Jacobian evaluation routine
1559efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1560efe9872eSLisandro Dalcin 
1561efe9872eSLisandro Dalcin    Calling sequence of jac:
1562bc77d74cSLisandro Dalcin $  jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx);
1563efe9872eSLisandro Dalcin 
1564efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1565efe9872eSLisandro Dalcin .  U    - state vector
1566efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1567efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1568efe9872eSLisandro Dalcin .  v    - shift for U_t
1569efe9872eSLisandro Dalcin .  a    - shift for U_tt
1570efe9872eSLisandro Dalcin .  J    - Jacobian of G(U) = F(t,U,W+v*U,W'+a*U), equivalent to dF/dU + v*dF/dU_t  + a*dF/dU_tt
1571efe9872eSLisandro Dalcin .  P    - preconditioning matrix for J, may be same as J
1572efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine
1573efe9872eSLisandro Dalcin 
1574efe9872eSLisandro Dalcin    Notes:
1575efe9872eSLisandro Dalcin    The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1576efe9872eSLisandro Dalcin 
1577efe9872eSLisandro Dalcin    The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1578efe9872eSLisandro Dalcin    the Jacobian of G(U) = F(t,U,W+v*U,W'+a*U) where F(t,U,U_t,U_tt) = 0 is the DAE to be solved.
1579efe9872eSLisandro Dalcin    The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1580bc77d74cSLisandro Dalcin    parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1581efe9872eSLisandro Dalcin 
1582efe9872eSLisandro Dalcin    Level: beginner
1583efe9872eSLisandro Dalcin 
1584efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian
1585efe9872eSLisandro Dalcin 
1586efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1587efe9872eSLisandro Dalcin @*/
1588efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1589efe9872eSLisandro Dalcin {
1590efe9872eSLisandro Dalcin   DM             dm;
1591efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1592efe9872eSLisandro Dalcin 
1593efe9872eSLisandro Dalcin   PetscFunctionBegin;
1594efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1595efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2);
1596efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3);
1597efe9872eSLisandro Dalcin   ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr);
1598efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1599efe9872eSLisandro Dalcin   ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1600efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1601efe9872eSLisandro Dalcin }
1602efe9872eSLisandro Dalcin 
1603efe9872eSLisandro Dalcin /*@C
1604efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1605efe9872eSLisandro Dalcin 
1606efe9872eSLisandro Dalcin   Not Collective, but parallel objects are returned if TS is parallel
1607efe9872eSLisandro Dalcin 
1608efe9872eSLisandro Dalcin   Input Parameter:
1609efe9872eSLisandro Dalcin . ts  - The TS context obtained from TSCreate()
1610efe9872eSLisandro Dalcin 
1611efe9872eSLisandro Dalcin   Output Parameters:
1612efe9872eSLisandro Dalcin + J  - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1613efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J
1614efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1615efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1616efe9872eSLisandro Dalcin 
1617efe9872eSLisandro Dalcin   Notes: You can pass in NULL for any return argument you do not need.
1618efe9872eSLisandro Dalcin 
1619efe9872eSLisandro Dalcin   Level: advanced
1620efe9872eSLisandro Dalcin 
1621efe9872eSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
1622efe9872eSLisandro Dalcin 
1623efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian
1624efe9872eSLisandro Dalcin @*/
1625efe9872eSLisandro Dalcin PetscErrorCode  TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1626efe9872eSLisandro Dalcin {
1627efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1628efe9872eSLisandro Dalcin   SNES           snes;
1629efe9872eSLisandro Dalcin   DM             dm;
1630efe9872eSLisandro Dalcin 
1631efe9872eSLisandro Dalcin   PetscFunctionBegin;
1632efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1633efe9872eSLisandro Dalcin   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
1634efe9872eSLisandro Dalcin   ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr);
1635efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1636efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1637efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1638efe9872eSLisandro Dalcin }
1639efe9872eSLisandro Dalcin 
1640efe9872eSLisandro Dalcin /*@
1641efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1642efe9872eSLisandro Dalcin 
1643efe9872eSLisandro Dalcin   Collective on TS and Vec
1644efe9872eSLisandro Dalcin 
1645efe9872eSLisandro Dalcin   Input Parameters:
1646efe9872eSLisandro Dalcin + ts - the TS context
1647efe9872eSLisandro Dalcin . t - current time
1648efe9872eSLisandro Dalcin . U - state vector
1649efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t)
1650efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt)
1651efe9872eSLisandro Dalcin 
1652efe9872eSLisandro Dalcin   Output Parameter:
1653efe9872eSLisandro Dalcin . F - the residual vector
1654efe9872eSLisandro Dalcin 
1655efe9872eSLisandro Dalcin   Note:
1656efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1657efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1658efe9872eSLisandro Dalcin 
1659efe9872eSLisandro Dalcin   Level: developer
1660efe9872eSLisandro Dalcin 
1661efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector
1662efe9872eSLisandro Dalcin 
1663efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1664efe9872eSLisandro Dalcin @*/
1665efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1666efe9872eSLisandro Dalcin {
1667efe9872eSLisandro Dalcin   DM             dm;
1668efe9872eSLisandro Dalcin   TSI2Function   I2Function;
1669efe9872eSLisandro Dalcin   void           *ctx;
1670efe9872eSLisandro Dalcin   TSRHSFunction  rhsfunction;
1671efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1672efe9872eSLisandro Dalcin 
1673efe9872eSLisandro Dalcin   PetscFunctionBegin;
1674efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1675efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1676efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1677efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1678efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F,VEC_CLASSID,6);
1679efe9872eSLisandro Dalcin 
1680efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1681efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr);
1682efe9872eSLisandro Dalcin   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
1683efe9872eSLisandro Dalcin 
1684efe9872eSLisandro Dalcin   if (!I2Function) {
1685efe9872eSLisandro Dalcin     ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr);
1686efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1687efe9872eSLisandro Dalcin   }
1688efe9872eSLisandro Dalcin 
1689efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1690efe9872eSLisandro Dalcin 
1691efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit function");
1692efe9872eSLisandro Dalcin   ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr);
1693efe9872eSLisandro Dalcin   PetscStackPop;
1694efe9872eSLisandro Dalcin 
1695efe9872eSLisandro Dalcin   if (rhsfunction) {
1696efe9872eSLisandro Dalcin     Vec Frhs;
1697efe9872eSLisandro Dalcin     ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
1698efe9872eSLisandro Dalcin     ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
1699efe9872eSLisandro Dalcin     ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr);
1700efe9872eSLisandro Dalcin   }
1701efe9872eSLisandro Dalcin 
1702efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1703efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1704efe9872eSLisandro Dalcin }
1705efe9872eSLisandro Dalcin 
1706efe9872eSLisandro Dalcin /*@
1707efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1708efe9872eSLisandro Dalcin 
1709efe9872eSLisandro Dalcin   Collective on TS and Vec
1710efe9872eSLisandro Dalcin 
1711efe9872eSLisandro Dalcin   Input Parameters:
1712efe9872eSLisandro Dalcin + ts - the TS context
1713efe9872eSLisandro Dalcin . t - current timestep
1714efe9872eSLisandro Dalcin . U - state vector
1715efe9872eSLisandro Dalcin . V - time derivative of state vector
1716efe9872eSLisandro Dalcin . A - second time derivative of state vector
1717efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1718efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1719efe9872eSLisandro Dalcin 
1720efe9872eSLisandro Dalcin   Output Parameters:
1721efe9872eSLisandro Dalcin + J - Jacobian matrix
1722efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1723efe9872eSLisandro Dalcin 
1724efe9872eSLisandro Dalcin   Notes:
1725efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1726efe9872eSLisandro Dalcin 
1727efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1728efe9872eSLisandro Dalcin 
1729efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1730efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1731efe9872eSLisandro Dalcin 
1732efe9872eSLisandro Dalcin   Level: developer
1733efe9872eSLisandro Dalcin 
1734efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix
1735efe9872eSLisandro Dalcin 
1736efe9872eSLisandro Dalcin .seealso:  TSSetI2Jacobian()
1737efe9872eSLisandro Dalcin @*/
1738efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1739efe9872eSLisandro Dalcin {
1740efe9872eSLisandro Dalcin   DM             dm;
1741efe9872eSLisandro Dalcin   TSI2Jacobian   I2Jacobian;
1742efe9872eSLisandro Dalcin   void           *ctx;
1743efe9872eSLisandro Dalcin   TSRHSJacobian  rhsjacobian;
1744efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1745efe9872eSLisandro Dalcin 
1746efe9872eSLisandro Dalcin   PetscFunctionBegin;
1747efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1748efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1749efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1750efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1751efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J,MAT_CLASSID,8);
1752efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P,MAT_CLASSID,9);
1753efe9872eSLisandro Dalcin 
1754efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1755efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr);
1756efe9872eSLisandro Dalcin   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
1757efe9872eSLisandro Dalcin 
1758efe9872eSLisandro Dalcin   if (!I2Jacobian) {
1759efe9872eSLisandro Dalcin     ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr);
1760efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1761efe9872eSLisandro Dalcin   }
1762efe9872eSLisandro Dalcin 
1763efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1764efe9872eSLisandro Dalcin 
1765efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit Jacobian");
1766efe9872eSLisandro Dalcin   ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr);
1767efe9872eSLisandro Dalcin   PetscStackPop;
1768efe9872eSLisandro Dalcin 
1769efe9872eSLisandro Dalcin   if (rhsjacobian) {
1770efe9872eSLisandro Dalcin     Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1771efe9872eSLisandro Dalcin     ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr);
1772efe9872eSLisandro Dalcin     ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr);
1773efe9872eSLisandro Dalcin     ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr);
1774efe9872eSLisandro Dalcin     if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);}
1775efe9872eSLisandro Dalcin   }
1776efe9872eSLisandro Dalcin 
1777efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1778efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1779efe9872eSLisandro Dalcin }
1780efe9872eSLisandro Dalcin 
1781efe9872eSLisandro Dalcin /*@
1782efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1783efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1784efe9872eSLisandro Dalcin 
1785efe9872eSLisandro Dalcin    Logically Collective on TS and Vec
1786efe9872eSLisandro Dalcin 
1787efe9872eSLisandro Dalcin    Input Parameters:
1788efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1789efe9872eSLisandro Dalcin .  u - the solution vector
1790efe9872eSLisandro Dalcin -  v - the time derivative vector
1791efe9872eSLisandro Dalcin 
1792efe9872eSLisandro Dalcin    Level: beginner
1793efe9872eSLisandro Dalcin 
1794efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions
1795efe9872eSLisandro Dalcin @*/
1796efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1797efe9872eSLisandro Dalcin {
1798efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1799efe9872eSLisandro Dalcin 
1800efe9872eSLisandro Dalcin   PetscFunctionBegin;
1801efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1802efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1803efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1804efe9872eSLisandro Dalcin   ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
1805efe9872eSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr);
1806efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
1807efe9872eSLisandro Dalcin   ts->vec_dot = v;
1808efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1809efe9872eSLisandro Dalcin }
1810efe9872eSLisandro Dalcin 
1811efe9872eSLisandro Dalcin /*@
1812efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1813efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1814efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1815efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1816efe9872eSLisandro Dalcin 
1817efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1818efe9872eSLisandro Dalcin 
1819efe9872eSLisandro Dalcin    Input Parameter:
1820efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1821efe9872eSLisandro Dalcin 
1822efe9872eSLisandro Dalcin    Output Parameter:
1823efe9872eSLisandro Dalcin +  u - the vector containing the solution
1824efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1825efe9872eSLisandro Dalcin 
1826efe9872eSLisandro Dalcin    Level: intermediate
1827efe9872eSLisandro Dalcin 
1828efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1829efe9872eSLisandro Dalcin 
1830efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution
1831efe9872eSLisandro Dalcin @*/
1832efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1833efe9872eSLisandro Dalcin {
1834efe9872eSLisandro Dalcin   PetscFunctionBegin;
1835efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1836efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1837efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1838efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1839efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1840efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1841efe9872eSLisandro Dalcin }
1842efe9872eSLisandro Dalcin 
184355849f57SBarry Smith /*@C
184455849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
184555849f57SBarry Smith 
184655849f57SBarry Smith   Collective on PetscViewer
184755849f57SBarry Smith 
184855849f57SBarry Smith   Input Parameters:
184955849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
185055849f57SBarry Smith            some related function before a call to TSLoad().
185155849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
185255849f57SBarry Smith 
185355849f57SBarry Smith    Level: intermediate
185455849f57SBarry Smith 
185555849f57SBarry Smith   Notes:
185655849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
185755849f57SBarry Smith 
185855849f57SBarry Smith   Notes for advanced users:
185955849f57SBarry Smith   Most users should not need to know the details of the binary storage
186055849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
186155849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
186255849f57SBarry Smith   format is
186355849f57SBarry Smith .vb
186455849f57SBarry Smith      has not yet been determined
186555849f57SBarry Smith .ve
186655849f57SBarry Smith 
186755849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
186855849f57SBarry Smith @*/
1869f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
187055849f57SBarry Smith {
187155849f57SBarry Smith   PetscErrorCode ierr;
187255849f57SBarry Smith   PetscBool      isbinary;
187355849f57SBarry Smith   PetscInt       classid;
187455849f57SBarry Smith   char           type[256];
18752d53ad75SBarry Smith   DMTS           sdm;
1876ad6bc421SBarry Smith   DM             dm;
187755849f57SBarry Smith 
187855849f57SBarry Smith   PetscFunctionBegin;
1879f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
188055849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
188155849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
188255849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
188355849f57SBarry Smith 
1884060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1885ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1886060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1887f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1888f2c2a1b9SBarry Smith   if (ts->ops->load) {
1889f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1890f2c2a1b9SBarry Smith   }
1891ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1892ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1893ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1894f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1895f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
18962d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
18972d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
189855849f57SBarry Smith   PetscFunctionReturn(0);
189955849f57SBarry Smith }
190055849f57SBarry Smith 
19019804daf3SBarry Smith #include <petscdraw.h>
1902e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1903e04113cfSBarry Smith #include <petscviewersaws.h>
1904f05ece33SBarry Smith #endif
19057e2c5f70SBarry Smith /*@C
1906d763cef2SBarry Smith     TSView - Prints the TS data structure.
1907d763cef2SBarry Smith 
19084c49b128SBarry Smith     Collective on TS
1909d763cef2SBarry Smith 
1910d763cef2SBarry Smith     Input Parameters:
1911d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1912d763cef2SBarry Smith -   viewer - visualization context
1913d763cef2SBarry Smith 
1914d763cef2SBarry Smith     Options Database Key:
1915d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1916d763cef2SBarry Smith 
1917d763cef2SBarry Smith     Notes:
1918d763cef2SBarry Smith     The available visualization contexts include
1919b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1920b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1921d763cef2SBarry Smith          output where only the first processor opens
1922d763cef2SBarry Smith          the file.  All other processors send their
1923d763cef2SBarry Smith          data to the first processor to print.
1924d763cef2SBarry Smith 
1925d763cef2SBarry Smith     The user can open an alternative visualization context with
1926b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1927d763cef2SBarry Smith 
1928d763cef2SBarry Smith     Level: beginner
1929d763cef2SBarry Smith 
1930d763cef2SBarry Smith .keywords: TS, timestep, view
1931d763cef2SBarry Smith 
1932b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1933d763cef2SBarry Smith @*/
19347087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1935d763cef2SBarry Smith {
1936dfbe8321SBarry Smith   PetscErrorCode ierr;
193719fd82e9SBarry Smith   TSType         type;
19382b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
19392d53ad75SBarry Smith   DMTS           sdm;
1940e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1941536b137fSBarry Smith   PetscBool      issaws;
1942f05ece33SBarry Smith #endif
1943d763cef2SBarry Smith 
1944d763cef2SBarry Smith   PetscFunctionBegin;
19450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
19463050cee2SBarry Smith   if (!viewer) {
1947ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
19483050cee2SBarry Smith   }
19490700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1950c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1951fd16b177SBarry Smith 
1952251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1953251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
195455849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
19552b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1956e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1957536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1958f05ece33SBarry Smith #endif
195932077d6dSBarry Smith   if (iascii) {
1960dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
1961efd4aadfSBarry Smith     if (ts->ops->view) {
1962efd4aadfSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1963efd4aadfSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1964efd4aadfSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1965efd4aadfSBarry Smith     }
196677431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
19677c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1968efd4aadfSBarry Smith     if (ts->usessnes) {
1969efd4aadfSBarry Smith       PetscBool lin;
1970d763cef2SBarry Smith       if (ts->problem_type == TS_NONLINEAR) {
19715ef26d82SJed Brown         ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1972d763cef2SBarry Smith       }
19735ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1974efd4aadfSBarry Smith       ierr = PetscObjectTypeCompare((PetscObject)ts->snes,SNESKSPONLY,&lin);CHKERRQ(ierr);
1975efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr);
1976efd4aadfSBarry Smith     }
1977193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
1978a0af407cSBarry Smith     if (ts->vrtol) {
1979a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of relative error tolerances, ");CHKERRQ(ierr);
1980a0af407cSBarry Smith     } else {
1981a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr);
1982a0af407cSBarry Smith     }
1983a0af407cSBarry Smith     if (ts->vatol) {
1984a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of absolute error tolerances\n");CHKERRQ(ierr);
1985a0af407cSBarry Smith     } else {
1986a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr);
1987a0af407cSBarry Smith     }
1988efd4aadfSBarry Smith     ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);
1989efd4aadfSBarry Smith     if (ts->snes && ts->usessnes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
19902d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19912d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
19920f5bd95cSBarry Smith   } else if (isstring) {
1993a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1994b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
199555849f57SBarry Smith   } else if (isbinary) {
199655849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
199755849f57SBarry Smith     MPI_Comm    comm;
199855849f57SBarry Smith     PetscMPIInt rank;
199955849f57SBarry Smith     char        type[256];
200055849f57SBarry Smith 
200155849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
200255849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
200355849f57SBarry Smith     if (!rank) {
200455849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
200555849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
200655849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
200755849f57SBarry Smith     }
200855849f57SBarry Smith     if (ts->ops->view) {
200955849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
201055849f57SBarry Smith     }
2011efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2012f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
2013f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
20142d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
20152d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
20162b0a91c0SBarry Smith   } else if (isdraw) {
20172b0a91c0SBarry Smith     PetscDraw draw;
20182b0a91c0SBarry Smith     char      str[36];
201989fd9fafSBarry Smith     PetscReal x,y,bottom,h;
20202b0a91c0SBarry Smith 
20212b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
20222b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
20232b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
20242b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
202551fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
202689fd9fafSBarry Smith     bottom = y - h;
20272b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
20282b0a91c0SBarry Smith     if (ts->ops->view) {
20292b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
20302b0a91c0SBarry Smith     }
2031efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
2032efd4aadfSBarry Smith     if (ts->snes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
20332b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2034e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
2035536b137fSBarry Smith   } else if (issaws) {
2036d45a07a7SBarry Smith     PetscMPIInt rank;
20372657e9d9SBarry Smith     const char  *name;
20382657e9d9SBarry Smith 
20392657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
2040d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
2041d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
2042d45a07a7SBarry Smith       char       dir[1024];
2043d45a07a7SBarry Smith 
2044e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
2045a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
20462657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
20472657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
20482657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
2049d763cef2SBarry Smith     }
20500acecf5bSBarry Smith     if (ts->ops->view) {
20510acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
20520acecf5bSBarry Smith     }
2053f05ece33SBarry Smith #endif
2054f05ece33SBarry Smith   }
2055f05ece33SBarry Smith 
2056b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2057251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
2058b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2059d763cef2SBarry Smith   PetscFunctionReturn(0);
2060d763cef2SBarry Smith }
2061d763cef2SBarry Smith 
2062b07ff414SBarry Smith /*@
2063d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2064d763cef2SBarry Smith    the timesteppers.
2065d763cef2SBarry Smith 
20663f9fe445SBarry Smith    Logically Collective on TS
2067d763cef2SBarry Smith 
2068d763cef2SBarry Smith    Input Parameters:
2069d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2070d763cef2SBarry Smith -  usrP - optional user context
2071d763cef2SBarry Smith 
2072daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2073daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2074daf670e6SBarry Smith 
2075d763cef2SBarry Smith    Level: intermediate
2076d763cef2SBarry Smith 
2077d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
2078d763cef2SBarry Smith 
2079d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2080d763cef2SBarry Smith @*/
20817087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2082d763cef2SBarry Smith {
2083d763cef2SBarry Smith   PetscFunctionBegin;
20840700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2085d763cef2SBarry Smith   ts->user = usrP;
2086d763cef2SBarry Smith   PetscFunctionReturn(0);
2087d763cef2SBarry Smith }
2088d763cef2SBarry Smith 
2089b07ff414SBarry Smith /*@
2090d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2091d763cef2SBarry Smith     timestepper.
2092d763cef2SBarry Smith 
2093d763cef2SBarry Smith     Not Collective
2094d763cef2SBarry Smith 
2095d763cef2SBarry Smith     Input Parameter:
2096d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2097d763cef2SBarry Smith 
2098d763cef2SBarry Smith     Output Parameter:
2099d763cef2SBarry Smith .   usrP - user context
2100d763cef2SBarry Smith 
2101daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2102daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2103daf670e6SBarry Smith 
2104d763cef2SBarry Smith     Level: intermediate
2105d763cef2SBarry Smith 
2106d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
2107d763cef2SBarry Smith 
2108d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2109d763cef2SBarry Smith @*/
2110e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2111d763cef2SBarry Smith {
2112d763cef2SBarry Smith   PetscFunctionBegin;
21130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2114e71120c6SJed Brown   *(void**)usrP = ts->user;
2115d763cef2SBarry Smith   PetscFunctionReturn(0);
2116d763cef2SBarry Smith }
2117d763cef2SBarry Smith 
2118d763cef2SBarry Smith /*@
2119b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
2120d763cef2SBarry Smith 
2121d763cef2SBarry Smith    Not Collective
2122d763cef2SBarry Smith 
2123d763cef2SBarry Smith    Input Parameter:
2124d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2125d763cef2SBarry Smith 
2126d763cef2SBarry Smith    Output Parameter:
2127b8123daeSJed Brown .  iter - number of steps completed so far
2128d763cef2SBarry Smith 
2129d763cef2SBarry Smith    Level: intermediate
2130d763cef2SBarry Smith 
2131d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
21329be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2133d763cef2SBarry Smith @*/
21347087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
2135d763cef2SBarry Smith {
2136d763cef2SBarry Smith   PetscFunctionBegin;
21370700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21384482741eSBarry Smith   PetscValidIntPointer(iter,2);
2139d763cef2SBarry Smith   *iter = ts->steps;
2140d763cef2SBarry Smith   PetscFunctionReturn(0);
2141d763cef2SBarry Smith }
2142d763cef2SBarry Smith 
2143d763cef2SBarry Smith /*@
2144d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
2145d763cef2SBarry Smith    as well as the initial time.
2146d763cef2SBarry Smith 
21473f9fe445SBarry Smith    Logically Collective on TS
2148d763cef2SBarry Smith 
2149d763cef2SBarry Smith    Input Parameters:
2150d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2151d763cef2SBarry Smith .  initial_time - the initial time
2152d763cef2SBarry Smith -  time_step - the size of the timestep
2153d763cef2SBarry Smith 
2154d763cef2SBarry Smith    Level: intermediate
2155d763cef2SBarry Smith 
2156d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
2157d763cef2SBarry Smith 
2158d763cef2SBarry Smith .keywords: TS, set, initial, timestep
2159d763cef2SBarry Smith @*/
21607087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
2161d763cef2SBarry Smith {
2162e144a568SJed Brown   PetscErrorCode ierr;
2163e144a568SJed Brown 
2164d763cef2SBarry Smith   PetscFunctionBegin;
21650700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2166e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
2167d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
2168d763cef2SBarry Smith   PetscFunctionReturn(0);
2169d763cef2SBarry Smith }
2170d763cef2SBarry Smith 
2171d763cef2SBarry Smith /*@
2172d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2173d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2174d763cef2SBarry Smith 
21753f9fe445SBarry Smith    Logically Collective on TS
2176d763cef2SBarry Smith 
2177d763cef2SBarry Smith    Input Parameters:
2178d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2179d763cef2SBarry Smith -  time_step - the size of the timestep
2180d763cef2SBarry Smith 
2181d763cef2SBarry Smith    Level: intermediate
2182d763cef2SBarry Smith 
2183d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2184d763cef2SBarry Smith 
2185d763cef2SBarry Smith .keywords: TS, set, timestep
2186d763cef2SBarry Smith @*/
21877087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2188d763cef2SBarry Smith {
2189d763cef2SBarry Smith   PetscFunctionBegin;
21900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2191c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2192d763cef2SBarry Smith   ts->time_step = time_step;
2193d763cef2SBarry Smith   PetscFunctionReturn(0);
2194d763cef2SBarry Smith }
2195d763cef2SBarry Smith 
2196a43b19c4SJed Brown /*@
219749354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
219849354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
219949354f04SShri Abhyankar      or just return at the final time TS computed.
2200a43b19c4SJed Brown 
2201a43b19c4SJed Brown   Logically Collective on TS
2202a43b19c4SJed Brown 
2203a43b19c4SJed Brown    Input Parameter:
2204a43b19c4SJed Brown +   ts - the time-step context
220549354f04SShri Abhyankar -   eftopt - exact final time option
2206a43b19c4SJed Brown 
2207feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2208feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2209feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2210feed9e9dSBarry Smith 
2211feed9e9dSBarry Smith    Options Database:
2212feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2213feed9e9dSBarry Smith 
2214ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2215ee346746SBarry Smith     then the final time you selected.
2216ee346746SBarry Smith 
2217a43b19c4SJed Brown    Level: beginner
2218a43b19c4SJed Brown 
2219a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
2220a43b19c4SJed Brown @*/
222149354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2222a43b19c4SJed Brown {
2223a43b19c4SJed Brown   PetscFunctionBegin;
2224a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
222549354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
222649354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2227a43b19c4SJed Brown   PetscFunctionReturn(0);
2228a43b19c4SJed Brown }
2229a43b19c4SJed Brown 
2230d763cef2SBarry Smith /*@
2231d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2232d763cef2SBarry Smith 
2233d763cef2SBarry Smith    Not Collective
2234d763cef2SBarry Smith 
2235d763cef2SBarry Smith    Input Parameter:
2236d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2237d763cef2SBarry Smith 
2238d763cef2SBarry Smith    Output Parameter:
2239d763cef2SBarry Smith .  dt - the current timestep size
2240d763cef2SBarry Smith 
2241d763cef2SBarry Smith    Level: intermediate
2242d763cef2SBarry Smith 
2243d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2244d763cef2SBarry Smith 
2245d763cef2SBarry Smith .keywords: TS, get, timestep
2246d763cef2SBarry Smith @*/
22477087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2248d763cef2SBarry Smith {
2249d763cef2SBarry Smith   PetscFunctionBegin;
22500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2251f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2252d763cef2SBarry Smith   *dt = ts->time_step;
2253d763cef2SBarry Smith   PetscFunctionReturn(0);
2254d763cef2SBarry Smith }
2255d763cef2SBarry Smith 
2256d8e5e3e6SSatish Balay /*@
2257d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2258d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2259d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2260d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2261d763cef2SBarry Smith 
2262d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2263d763cef2SBarry Smith 
2264d763cef2SBarry Smith    Input Parameter:
2265d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2266d763cef2SBarry Smith 
2267d763cef2SBarry Smith    Output Parameter:
2268d763cef2SBarry Smith .  v - the vector containing the solution
2269d763cef2SBarry Smith 
227063e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
227163e21af5SBarry Smith    final time. It returns the solution at the next timestep.
227263e21af5SBarry Smith 
2273d763cef2SBarry Smith    Level: intermediate
2274d763cef2SBarry Smith 
2275b2bf4f3aSDebojyoti Ghosh .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents()
2276d763cef2SBarry Smith 
2277d763cef2SBarry Smith .keywords: TS, timestep, get, solution
2278d763cef2SBarry Smith @*/
22797087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2280d763cef2SBarry Smith {
2281d763cef2SBarry Smith   PetscFunctionBegin;
22820700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22834482741eSBarry Smith   PetscValidPointer(v,2);
22848737fe31SLisandro Dalcin   *v = ts->vec_sol;
2285d763cef2SBarry Smith   PetscFunctionReturn(0);
2286d763cef2SBarry Smith }
2287d763cef2SBarry Smith 
228803fe5f5eSDebojyoti Ghosh /*@
2289b2bf4f3aSDebojyoti Ghosh    TSGetSolutionComponents - Returns any solution components at the present
229003fe5f5eSDebojyoti Ghosh    timestep, if available for the time integration method being used.
2291b2bf4f3aSDebojyoti Ghosh    Solution components are quantities that share the same size and
229203fe5f5eSDebojyoti Ghosh    structure as the solution vector.
229303fe5f5eSDebojyoti Ghosh 
229403fe5f5eSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
229503fe5f5eSDebojyoti Ghosh 
229603fe5f5eSDebojyoti Ghosh    Parameters :
229703fe5f5eSDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
2298b2bf4f3aSDebojyoti Ghosh .  n - If v is PETSC_NULL, then the number of solution components is
2299b2bf4f3aSDebojyoti Ghosh        returned through n, else the n-th solution component is
230003fe5f5eSDebojyoti Ghosh        returned in v.
2301b2bf4f3aSDebojyoti Ghosh .  v - the vector containing the n-th solution component
230203fe5f5eSDebojyoti Ghosh        (may be PETSC_NULL to use this function to find out
2303b2bf4f3aSDebojyoti Ghosh         the number of solutions components).
230403fe5f5eSDebojyoti Ghosh 
23054cdd57e5SDebojyoti Ghosh    Level: advanced
230603fe5f5eSDebojyoti Ghosh 
230703fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution()
230803fe5f5eSDebojyoti Ghosh 
230903fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution
231003fe5f5eSDebojyoti Ghosh @*/
2311b2bf4f3aSDebojyoti Ghosh PetscErrorCode  TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v)
231203fe5f5eSDebojyoti Ghosh {
231303fe5f5eSDebojyoti Ghosh   PetscErrorCode ierr;
231403fe5f5eSDebojyoti Ghosh 
231503fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
231603fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2317b2bf4f3aSDebojyoti Ghosh   if (!ts->ops->getsolutioncomponents) *n = 0;
231803fe5f5eSDebojyoti Ghosh   else {
2319b2bf4f3aSDebojyoti Ghosh     ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr);
232003fe5f5eSDebojyoti Ghosh   }
232103fe5f5eSDebojyoti Ghosh   PetscFunctionReturn(0);
232203fe5f5eSDebojyoti Ghosh }
232303fe5f5eSDebojyoti Ghosh 
23244cdd57e5SDebojyoti Ghosh /*@
23254cdd57e5SDebojyoti Ghosh    TSGetAuxSolution - Returns an auxiliary solution at the present
23264cdd57e5SDebojyoti Ghosh    timestep, if available for the time integration method being used.
23274cdd57e5SDebojyoti Ghosh 
23284cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
23294cdd57e5SDebojyoti Ghosh 
23304cdd57e5SDebojyoti Ghosh    Parameters :
23314cdd57e5SDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
23324cdd57e5SDebojyoti Ghosh .  v - the vector containing the auxiliary solution
23334cdd57e5SDebojyoti Ghosh 
23344cdd57e5SDebojyoti Ghosh    Level: intermediate
23354cdd57e5SDebojyoti Ghosh 
23364cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution()
23374cdd57e5SDebojyoti Ghosh 
23384cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, solution
23394cdd57e5SDebojyoti Ghosh @*/
23404cdd57e5SDebojyoti Ghosh PetscErrorCode  TSGetAuxSolution(TS ts,Vec *v)
23414cdd57e5SDebojyoti Ghosh {
23424cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
23434cdd57e5SDebojyoti Ghosh 
23444cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
23454cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2346f6356ec7SDebojyoti Ghosh   if (ts->ops->getauxsolution) {
23474cdd57e5SDebojyoti Ghosh     ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr);
2348f6356ec7SDebojyoti Ghosh   } else {
2349f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v); CHKERRQ(ierr);
2350f6356ec7SDebojyoti Ghosh   }
23514cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
23524cdd57e5SDebojyoti Ghosh }
23534cdd57e5SDebojyoti Ghosh 
23544cdd57e5SDebojyoti Ghosh /*@
23554cdd57e5SDebojyoti Ghosh    TSGetTimeError - Returns the estimated error vector, if the chosen
23564cdd57e5SDebojyoti Ghosh    TSType has an error estimation functionality.
23574cdd57e5SDebojyoti Ghosh 
23584cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
23594cdd57e5SDebojyoti Ghosh 
23609657682dSDebojyoti Ghosh    Note: MUST call after TSSetUp()
23619657682dSDebojyoti Ghosh 
23624cdd57e5SDebojyoti Ghosh    Parameters :
23634cdd57e5SDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
2364657c1e31SEmil Constantinescu .  n - current estimate (n=0) or previous one (n=-1)
23654cdd57e5SDebojyoti Ghosh .  v - the vector containing the error (same size as the solution).
23664cdd57e5SDebojyoti Ghosh 
23674cdd57e5SDebojyoti Ghosh    Level: intermediate
23684cdd57e5SDebojyoti Ghosh 
236957df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError()
23704cdd57e5SDebojyoti Ghosh 
23714cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, error
23724cdd57e5SDebojyoti Ghosh @*/
23730a01e1b2SEmil Constantinescu PetscErrorCode  TSGetTimeError(TS ts,PetscInt n,Vec *v)
23744cdd57e5SDebojyoti Ghosh {
23754cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
23764cdd57e5SDebojyoti Ghosh 
23774cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
23784cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2379f6356ec7SDebojyoti Ghosh   if (ts->ops->gettimeerror) {
23800a01e1b2SEmil Constantinescu     ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr);
2381f6356ec7SDebojyoti Ghosh   } else {
2382f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v);CHKERRQ(ierr);
2383f6356ec7SDebojyoti Ghosh   }
23844cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
23854cdd57e5SDebojyoti Ghosh }
23864cdd57e5SDebojyoti Ghosh 
238757df6a1bSDebojyoti Ghosh /*@
238857df6a1bSDebojyoti Ghosh    TSSetTimeError - Sets the estimated error vector, if the chosen
238957df6a1bSDebojyoti Ghosh    TSType has an error estimation functionality. This can be used
239057df6a1bSDebojyoti Ghosh    to restart such a time integrator with a given error vector.
239157df6a1bSDebojyoti Ghosh 
239257df6a1bSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
239357df6a1bSDebojyoti Ghosh 
239457df6a1bSDebojyoti Ghosh    Parameters :
239557df6a1bSDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
239657df6a1bSDebojyoti Ghosh .  v - the vector containing the error (same size as the solution).
239757df6a1bSDebojyoti Ghosh 
239857df6a1bSDebojyoti Ghosh    Level: intermediate
239957df6a1bSDebojyoti Ghosh 
240057df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError)
240157df6a1bSDebojyoti Ghosh 
240257df6a1bSDebojyoti Ghosh .keywords: TS, timestep, get, error
240357df6a1bSDebojyoti Ghosh @*/
240457df6a1bSDebojyoti Ghosh PetscErrorCode  TSSetTimeError(TS ts,Vec v)
240557df6a1bSDebojyoti Ghosh {
240657df6a1bSDebojyoti Ghosh   PetscErrorCode ierr;
240757df6a1bSDebojyoti Ghosh 
240857df6a1bSDebojyoti Ghosh   PetscFunctionBegin;
240957df6a1bSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24109657682dSDebojyoti Ghosh   if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first");
241157df6a1bSDebojyoti Ghosh   if (ts->ops->settimeerror) {
241257df6a1bSDebojyoti Ghosh     ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr);
241357df6a1bSDebojyoti Ghosh   }
241457df6a1bSDebojyoti Ghosh   PetscFunctionReturn(0);
241557df6a1bSDebojyoti Ghosh }
241657df6a1bSDebojyoti Ghosh 
2417c235aa8dSHong Zhang /*@
2418dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
2419c235aa8dSHong Zhang 
2420c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
2421c235aa8dSHong Zhang 
2422c235aa8dSHong Zhang    Input Parameter:
2423c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
2424c235aa8dSHong Zhang 
2425c235aa8dSHong Zhang    Output Parameter:
2426abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
2427abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
2428c235aa8dSHong Zhang 
2429c235aa8dSHong Zhang    Level: intermediate
2430c235aa8dSHong Zhang 
2431c235aa8dSHong Zhang .seealso: TSGetTimeStep()
2432c235aa8dSHong Zhang 
2433c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
2434c235aa8dSHong Zhang @*/
2435dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
2436c235aa8dSHong Zhang {
2437c235aa8dSHong Zhang   PetscFunctionBegin;
2438c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2439abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
2440abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
2441abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
2442c235aa8dSHong Zhang   PetscFunctionReturn(0);
2443c235aa8dSHong Zhang }
2444c235aa8dSHong Zhang 
2445bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
2446d8e5e3e6SSatish Balay /*@
2447bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2448d763cef2SBarry Smith 
2449bdad233fSMatthew Knepley   Not collective
2450d763cef2SBarry Smith 
2451bdad233fSMatthew Knepley   Input Parameters:
2452bdad233fSMatthew Knepley + ts   - The TS
2453bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2454d763cef2SBarry Smith .vb
24550910c330SBarry Smith          U_t - A U = 0      (linear)
24560910c330SBarry Smith          U_t - A(t) U = 0   (linear)
24570910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2458d763cef2SBarry Smith .ve
2459d763cef2SBarry Smith 
2460d763cef2SBarry Smith    Level: beginner
2461d763cef2SBarry Smith 
2462bdad233fSMatthew Knepley .keywords: TS, problem type
2463bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2464d763cef2SBarry Smith @*/
24657087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2466a7cc72afSBarry Smith {
24679e2a6581SJed Brown   PetscErrorCode ierr;
24689e2a6581SJed Brown 
2469d763cef2SBarry Smith   PetscFunctionBegin;
24700700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2471bdad233fSMatthew Knepley   ts->problem_type = type;
24729e2a6581SJed Brown   if (type == TS_LINEAR) {
24739e2a6581SJed Brown     SNES snes;
24749e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
24759e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
24769e2a6581SJed Brown   }
2477d763cef2SBarry Smith   PetscFunctionReturn(0);
2478d763cef2SBarry Smith }
2479d763cef2SBarry Smith 
2480bdad233fSMatthew Knepley /*@C
2481bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2482bdad233fSMatthew Knepley 
2483bdad233fSMatthew Knepley   Not collective
2484bdad233fSMatthew Knepley 
2485bdad233fSMatthew Knepley   Input Parameter:
2486bdad233fSMatthew Knepley . ts   - The TS
2487bdad233fSMatthew Knepley 
2488bdad233fSMatthew Knepley   Output Parameter:
2489bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2490bdad233fSMatthew Knepley .vb
2491089b2837SJed Brown          M U_t = A U
2492089b2837SJed Brown          M(t) U_t = A(t) U
2493b5abc632SBarry Smith          F(t,U,U_t)
2494bdad233fSMatthew Knepley .ve
2495bdad233fSMatthew Knepley 
2496bdad233fSMatthew Knepley    Level: beginner
2497bdad233fSMatthew Knepley 
2498bdad233fSMatthew Knepley .keywords: TS, problem type
2499bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2500bdad233fSMatthew Knepley @*/
25017087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2502a7cc72afSBarry Smith {
2503bdad233fSMatthew Knepley   PetscFunctionBegin;
25040700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
25054482741eSBarry Smith   PetscValidIntPointer(type,2);
2506bdad233fSMatthew Knepley   *type = ts->problem_type;
2507bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2508bdad233fSMatthew Knepley }
2509d763cef2SBarry Smith 
2510d763cef2SBarry Smith /*@
2511d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
2512d763cef2SBarry Smith    of a timestepper.
2513d763cef2SBarry Smith 
2514d763cef2SBarry Smith    Collective on TS
2515d763cef2SBarry Smith 
2516d763cef2SBarry Smith    Input Parameter:
2517d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2518d763cef2SBarry Smith 
2519d763cef2SBarry Smith    Notes:
2520d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2521d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2522d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
2523d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2524d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
2525d763cef2SBarry Smith 
2526d763cef2SBarry Smith    Level: advanced
2527d763cef2SBarry Smith 
2528d763cef2SBarry Smith .keywords: TS, timestep, setup
2529d763cef2SBarry Smith 
2530d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
2531d763cef2SBarry Smith @*/
25327087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2533d763cef2SBarry Smith {
2534dfbe8321SBarry Smith   PetscErrorCode ierr;
25356c6b9e74SPeter Brune   DM             dm;
25366c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2537d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2538cd11d68dSLisandro Dalcin   TSIFunction    ifun;
25396c6b9e74SPeter Brune   TSIJacobian    ijac;
2540efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
25416c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
25422ffb9264SLisandro Dalcin   PetscBool      isnone;
2543d763cef2SBarry Smith 
2544d763cef2SBarry Smith   PetscFunctionBegin;
25450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2546277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2547277b19d0SLisandro Dalcin 
25487adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2549cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
2550cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
2551d763cef2SBarry Smith   }
2552277b19d0SLisandro Dalcin 
2553277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
2554277b19d0SLisandro Dalcin 
2555e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
2556e1244c69SJed Brown     Mat Amat,Pmat;
2557e1244c69SJed Brown     SNES snes;
2558e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2559e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2560e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2561e1244c69SJed Brown      * have displaced the RHS matrix */
2562e1244c69SJed Brown     if (Amat == ts->Arhs) {
2563abc0d4abSBarry Smith       /* we need to copy the values of the matrix because for the constant Jacobian case the user will never set the numerical values in this new location */
2564abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2565e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2566e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2567e1244c69SJed Brown     }
2568e1244c69SJed Brown     if (Pmat == ts->Brhs) {
2569abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2570e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2571e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2572e1244c69SJed Brown     }
2573e1244c69SJed Brown   }
25742ffb9264SLisandro Dalcin 
25752ffb9264SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
25762ffb9264SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
25772ffb9264SLisandro Dalcin 
2578277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2579000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2580277b19d0SLisandro Dalcin   }
2581277b19d0SLisandro Dalcin 
25822ffb9264SLisandro Dalcin   /* Attempt to check/preset a default value for the exact final time option */
25832ffb9264SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr);
25842ffb9264SLisandro Dalcin   if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED)
25852ffb9264SLisandro Dalcin     ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP;
25862ffb9264SLisandro Dalcin 
2587a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
25886c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
25896c6b9e74SPeter Brune    */
25906c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
25910298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
25926c6b9e74SPeter Brune   if (!func) {
25936c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
25946c6b9e74SPeter Brune   }
2595a6772fa2SLisandro Dalcin   /* If the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it.
25966c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
25976c6b9e74SPeter Brune    */
25980298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
25990298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
2600efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr);
26010298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
2602efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
26036c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
26046c6b9e74SPeter Brune   }
2605c0517034SDebojyoti Ghosh 
2606c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2607c0517034SDebojyoti Ghosh   if (ts->ops->startingmethod) {
2608c0517034SDebojyoti Ghosh     ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr);
2609c0517034SDebojyoti Ghosh   }
2610c0517034SDebojyoti Ghosh 
2611277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2612277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2613277b19d0SLisandro Dalcin }
2614277b19d0SLisandro Dalcin 
2615f6a906c0SBarry Smith /*@
2616f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
2617f6a906c0SBarry Smith    of an adjoint solver
2618f6a906c0SBarry Smith 
2619f6a906c0SBarry Smith    Collective on TS
2620f6a906c0SBarry Smith 
2621f6a906c0SBarry Smith    Input Parameter:
2622f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
2623f6a906c0SBarry Smith 
2624f6a906c0SBarry Smith    Level: advanced
2625f6a906c0SBarry Smith 
2626f6a906c0SBarry Smith .keywords: TS, timestep, setup
2627f6a906c0SBarry Smith 
2628947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
2629f6a906c0SBarry Smith @*/
2630f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
2631f6a906c0SBarry Smith {
2632f6a906c0SBarry Smith   PetscErrorCode ierr;
2633f6a906c0SBarry Smith 
2634f6a906c0SBarry Smith   PetscFunctionBegin;
2635f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2636f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
263723706b9aSHong Zhang   if (!ts->vecs_sensi) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
2638c5767687SHong Zhang   if (ts->vecs_sensip && !ts->Jacp) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"Must call TSAdjointSetRHSJacobian() first");
2639d8151eeaSBarry Smith 
2640947abb85SHong Zhang   if (ts->vec_costintegral) { /* if there is integral in the cost function */
2641d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2642d8151eeaSBarry Smith     if (ts->vecs_sensip){
2643d8151eeaSBarry Smith       ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2644d8151eeaSBarry Smith     }
2645947abb85SHong Zhang   }
2646d8151eeaSBarry Smith 
264742f2b339SBarry Smith   if (ts->ops->adjointsetup) {
264842f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
2649f6a906c0SBarry Smith   }
2650f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
2651f6a906c0SBarry Smith   PetscFunctionReturn(0);
2652f6a906c0SBarry Smith }
2653f6a906c0SBarry Smith 
2654277b19d0SLisandro Dalcin /*@
2655277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2656277b19d0SLisandro Dalcin 
2657277b19d0SLisandro Dalcin    Collective on TS
2658277b19d0SLisandro Dalcin 
2659277b19d0SLisandro Dalcin    Input Parameter:
2660277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2661277b19d0SLisandro Dalcin 
2662277b19d0SLisandro Dalcin    Level: beginner
2663277b19d0SLisandro Dalcin 
2664277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2665277b19d0SLisandro Dalcin 
2666277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2667277b19d0SLisandro Dalcin @*/
2668277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2669277b19d0SLisandro Dalcin {
2670277b19d0SLisandro Dalcin   PetscErrorCode ierr;
2671277b19d0SLisandro Dalcin 
2672277b19d0SLisandro Dalcin   PetscFunctionBegin;
2673277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2674b18ea86cSHong Zhang 
2675277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2676277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2677277b19d0SLisandro Dalcin   }
2678277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2679e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2680bbd56ea5SKarl Rupp 
26814e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
26824e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2683214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
26846bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2685efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
2686e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2687e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
268838637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2689bbd56ea5SKarl Rupp 
2690d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2691d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2692715f1b00SHong Zhang 
2693ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
26942c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
269536eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2696715f1b00SHong Zhang 
2697*022c081aSHong Zhang   ierr = PetscFree(ts->vecs_fwdsensipacked);CHKERRQ(ierr);
2698*022c081aSHong Zhang 
2699277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2700d763cef2SBarry Smith   PetscFunctionReturn(0);
2701d763cef2SBarry Smith }
2702d763cef2SBarry Smith 
2703d8e5e3e6SSatish Balay /*@
2704d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2705d763cef2SBarry Smith    with TSCreate().
2706d763cef2SBarry Smith 
2707d763cef2SBarry Smith    Collective on TS
2708d763cef2SBarry Smith 
2709d763cef2SBarry Smith    Input Parameter:
2710d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2711d763cef2SBarry Smith 
2712d763cef2SBarry Smith    Level: beginner
2713d763cef2SBarry Smith 
2714d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2715d763cef2SBarry Smith 
2716d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2717d763cef2SBarry Smith @*/
27186bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2719d763cef2SBarry Smith {
27206849ba73SBarry Smith   PetscErrorCode ierr;
2721d763cef2SBarry Smith 
2722d763cef2SBarry Smith   PetscFunctionBegin;
27236bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
27246bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
27256bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2726d763cef2SBarry Smith 
27276bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2728277b19d0SLisandro Dalcin 
2729e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2730e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
27316bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
27326d4c513bSLisandro Dalcin 
2733bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2734bc952696SBarry Smith 
273584df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
27366427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
27376427ac75SLisandro Dalcin 
27386bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
27396bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
27406bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
27410dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
27426d4c513bSLisandro Dalcin 
2743a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2744d763cef2SBarry Smith   PetscFunctionReturn(0);
2745d763cef2SBarry Smith }
2746d763cef2SBarry Smith 
2747d8e5e3e6SSatish Balay /*@
2748d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2749d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2750d763cef2SBarry Smith 
2751d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2752d763cef2SBarry Smith 
2753d763cef2SBarry Smith    Input Parameter:
2754d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2755d763cef2SBarry Smith 
2756d763cef2SBarry Smith    Output Parameter:
2757d763cef2SBarry Smith .  snes - the nonlinear solver context
2758d763cef2SBarry Smith 
2759d763cef2SBarry Smith    Notes:
2760d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2761d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
276294b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2763d763cef2SBarry Smith 
2764d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
27650298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2766d763cef2SBarry Smith 
2767d763cef2SBarry Smith    Level: beginner
2768d763cef2SBarry Smith 
2769d763cef2SBarry Smith .keywords: timestep, get, SNES
2770d763cef2SBarry Smith @*/
27717087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2772d763cef2SBarry Smith {
2773d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2774d372ba47SLisandro Dalcin 
2775d763cef2SBarry Smith   PetscFunctionBegin;
27760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27774482741eSBarry Smith   PetscValidPointer(snes,2);
2778d372ba47SLisandro Dalcin   if (!ts->snes) {
2779ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
27800298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
27813bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2782d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2783496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
27849e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
27859e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
27869e2a6581SJed Brown     }
2787d372ba47SLisandro Dalcin   }
2788d763cef2SBarry Smith   *snes = ts->snes;
2789d763cef2SBarry Smith   PetscFunctionReturn(0);
2790d763cef2SBarry Smith }
2791d763cef2SBarry Smith 
2792deb2cd25SJed Brown /*@
2793deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2794deb2cd25SJed Brown 
2795deb2cd25SJed Brown    Collective
2796deb2cd25SJed Brown 
2797deb2cd25SJed Brown    Input Parameter:
2798deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2799deb2cd25SJed Brown -  snes - the nonlinear solver context
2800deb2cd25SJed Brown 
2801deb2cd25SJed Brown    Notes:
2802deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2803deb2cd25SJed Brown 
2804deb2cd25SJed Brown    Level: developer
2805deb2cd25SJed Brown 
2806deb2cd25SJed Brown .keywords: timestep, set, SNES
2807deb2cd25SJed Brown @*/
2808deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2809deb2cd25SJed Brown {
2810deb2cd25SJed Brown   PetscErrorCode ierr;
2811d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2812deb2cd25SJed Brown 
2813deb2cd25SJed Brown   PetscFunctionBegin;
2814deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2815deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2816deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2817deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2818bbd56ea5SKarl Rupp 
2819deb2cd25SJed Brown   ts->snes = snes;
2820bbd56ea5SKarl Rupp 
28210298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
28220298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2823740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
28240298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2825740132f1SEmil Constantinescu   }
2826deb2cd25SJed Brown   PetscFunctionReturn(0);
2827deb2cd25SJed Brown }
2828deb2cd25SJed Brown 
2829d8e5e3e6SSatish Balay /*@
283094b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2831d763cef2SBarry Smith    a TS (timestepper) context.
2832d763cef2SBarry Smith 
283394b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2834d763cef2SBarry Smith 
2835d763cef2SBarry Smith    Input Parameter:
2836d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2837d763cef2SBarry Smith 
2838d763cef2SBarry Smith    Output Parameter:
283994b7f48cSBarry Smith .  ksp - the nonlinear solver context
2840d763cef2SBarry Smith 
2841d763cef2SBarry Smith    Notes:
284294b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2843d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2844d763cef2SBarry Smith    KSP and PC contexts as well.
2845d763cef2SBarry Smith 
284694b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
28470298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2848d763cef2SBarry Smith 
2849d763cef2SBarry Smith    Level: beginner
2850d763cef2SBarry Smith 
285194b7f48cSBarry Smith .keywords: timestep, get, KSP
2852d763cef2SBarry Smith @*/
28537087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2854d763cef2SBarry Smith {
2855d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2856089b2837SJed Brown   SNES           snes;
2857d372ba47SLisandro Dalcin 
2858d763cef2SBarry Smith   PetscFunctionBegin;
28590700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28604482741eSBarry Smith   PetscValidPointer(ksp,2);
286117186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2862e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2863089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2864089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2865d763cef2SBarry Smith   PetscFunctionReturn(0);
2866d763cef2SBarry Smith }
2867d763cef2SBarry Smith 
2868d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2869d763cef2SBarry Smith 
2870adb62b0dSMatthew Knepley /*@
2871adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2872adb62b0dSMatthew Knepley    maximum time for iteration.
2873adb62b0dSMatthew Knepley 
28743f9fe445SBarry Smith    Not Collective
2875adb62b0dSMatthew Knepley 
2876adb62b0dSMatthew Knepley    Input Parameters:
2877adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
28780298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
28790298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2880adb62b0dSMatthew Knepley 
2881adb62b0dSMatthew Knepley    Level: intermediate
2882adb62b0dSMatthew Knepley 
2883adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2884adb62b0dSMatthew Knepley @*/
28857087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2886adb62b0dSMatthew Knepley {
2887adb62b0dSMatthew Knepley   PetscFunctionBegin;
28880700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2889abc0a331SBarry Smith   if (maxsteps) {
28904482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2891adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2892adb62b0dSMatthew Knepley   }
2893abc0a331SBarry Smith   if (maxtime) {
28944482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2895adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2896adb62b0dSMatthew Knepley   }
2897adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2898adb62b0dSMatthew Knepley }
2899adb62b0dSMatthew Knepley 
2900d763cef2SBarry Smith /*@
2901d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2902d763cef2SBarry Smith    maximum time for iteration.
2903d763cef2SBarry Smith 
29043f9fe445SBarry Smith    Logically Collective on TS
2905d763cef2SBarry Smith 
2906d763cef2SBarry Smith    Input Parameters:
2907d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2908d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2909d763cef2SBarry Smith -  maxtime - final time to iterate to
2910d763cef2SBarry Smith 
2911d763cef2SBarry Smith    Options Database Keys:
2912d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
29133bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2914d763cef2SBarry Smith 
2915d763cef2SBarry Smith    Notes:
2916d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2917d763cef2SBarry Smith 
2918d763cef2SBarry Smith    Level: intermediate
2919d763cef2SBarry Smith 
2920d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2921a43b19c4SJed Brown 
2922a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2923d763cef2SBarry Smith @*/
29247087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2925d763cef2SBarry Smith {
2926d763cef2SBarry Smith   PetscFunctionBegin;
29270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2928c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2929c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
293039b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
293139b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2932d763cef2SBarry Smith   PetscFunctionReturn(0);
2933d763cef2SBarry Smith }
2934d763cef2SBarry Smith 
2935d763cef2SBarry Smith /*@
2936d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2937d763cef2SBarry Smith    for use by the TS routines.
2938d763cef2SBarry Smith 
29393f9fe445SBarry Smith    Logically Collective on TS and Vec
2940d763cef2SBarry Smith 
2941d763cef2SBarry Smith    Input Parameters:
2942d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
29430910c330SBarry Smith -  u - the solution vector
2944d763cef2SBarry Smith 
2945d763cef2SBarry Smith    Level: beginner
2946d763cef2SBarry Smith 
2947715f1b00SHong Zhang .keywords: TS, timestep, set, solution, initial values
2948d763cef2SBarry Smith @*/
29490910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2950d763cef2SBarry Smith {
29518737fe31SLisandro Dalcin   PetscErrorCode ierr;
2952496e6a7aSJed Brown   DM             dm;
29538737fe31SLisandro Dalcin 
2954d763cef2SBarry Smith   PetscFunctionBegin;
29550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
29560910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
29570910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
29586bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
29590910c330SBarry Smith   ts->vec_sol = u;
2960bbd56ea5SKarl Rupp 
2961496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
29620910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2963d763cef2SBarry Smith   PetscFunctionReturn(0);
2964d763cef2SBarry Smith }
2965d763cef2SBarry Smith 
296673b18844SBarry Smith /*@
296773b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
296873b18844SBarry Smith 
296973b18844SBarry Smith    Logically Collective on TS
297073b18844SBarry Smith 
297173b18844SBarry Smith    Input Parameters:
297273b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
297373b18844SBarry Smith .  steps - number of steps to use
297473b18844SBarry Smith 
297573b18844SBarry Smith    Level: intermediate
297673b18844SBarry Smith 
297773b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
297873b18844SBarry Smith           so as to integrate back to less than the original timestep
297973b18844SBarry Smith 
298073b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
298173b18844SBarry Smith 
298273b18844SBarry Smith .seealso: TSSetExactFinalTime()
298373b18844SBarry Smith @*/
298473b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
298573b18844SBarry Smith {
298673b18844SBarry Smith   PetscFunctionBegin;
298773b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
298873b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
298973b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
299073b18844SBarry 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");
299173b18844SBarry Smith   ts->adjoint_max_steps = steps;
299273b18844SBarry Smith   PetscFunctionReturn(0);
299373b18844SBarry Smith }
299473b18844SBarry Smith 
2995c235aa8dSHong Zhang /*@
2996715f1b00SHong Zhang    TSSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial values and w.r.t. the problem parameters
29970cf82b59SBarry Smith       for use by the TSAdjoint routines.
2998c235aa8dSHong Zhang 
2999c235aa8dSHong Zhang    Logically Collective on TS and Vec
3000c235aa8dSHong Zhang 
3001c235aa8dSHong Zhang    Input Parameters:
3002c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
3003abc2977eSBarry 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
3004abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
3005c235aa8dSHong Zhang 
3006c235aa8dSHong Zhang    Level: beginner
3007c235aa8dSHong Zhang 
3008abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
30090cf82b59SBarry Smith 
3010715f1b00SHong Zhang .keywords: TS, timestep, set, sensitivity, initial values
3011c235aa8dSHong Zhang @*/
3012dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
3013c235aa8dSHong Zhang {
3014c235aa8dSHong Zhang   PetscFunctionBegin;
3015c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3016abc2977eSBarry Smith   PetscValidPointer(lambda,2);
3017abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
3018abc2977eSBarry Smith   ts->vecs_sensip = mu;
3019dfb21088SHong 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");
3020abc2977eSBarry Smith   ts->numcost  = numcost;
3021ad8e2604SHong Zhang   PetscFunctionReturn(0);
3022ad8e2604SHong Zhang }
3023ad8e2604SHong Zhang 
3024ad8e2604SHong Zhang /*@C
30250cf82b59SBarry 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.
3026ad8e2604SHong Zhang 
3027ad8e2604SHong Zhang   Logically Collective on TS
3028ad8e2604SHong Zhang 
3029ad8e2604SHong Zhang   Input Parameters:
3030ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
3031ad8e2604SHong Zhang - func - The function
3032ad8e2604SHong Zhang 
3033ad8e2604SHong Zhang   Calling sequence of func:
30340cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
303505755b9cSHong Zhang +   t - current timestep
30360cf82b59SBarry Smith .   y - input vector (current ODE solution)
303705755b9cSHong Zhang .   A - output matrix
303805755b9cSHong Zhang -   ctx - [optional] user-defined function context
3039ad8e2604SHong Zhang 
3040ad8e2604SHong Zhang   Level: intermediate
3041ad8e2604SHong Zhang 
30420cf82b59SBarry 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
30430cf82b59SBarry Smith 
3044ad8e2604SHong Zhang .keywords: TS, sensitivity
3045ad8e2604SHong Zhang .seealso:
3046ad8e2604SHong Zhang @*/
30475bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
3048ad8e2604SHong Zhang {
3049ad8e2604SHong Zhang   PetscErrorCode ierr;
3050ad8e2604SHong Zhang 
3051ad8e2604SHong Zhang   PetscFunctionBegin;
3052ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
305323706b9aSHong Zhang   PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
3054ad8e2604SHong Zhang 
3055ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
3056ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
3057ad8e2604SHong Zhang   if(Amat) {
3058ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
3059ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
3060ad8e2604SHong Zhang     ts->Jacp = Amat;
3061ad8e2604SHong Zhang   }
3062ad8e2604SHong Zhang   PetscFunctionReturn(0);
3063ad8e2604SHong Zhang }
3064ad8e2604SHong Zhang 
30650cf82b59SBarry Smith /*@C
30665bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
3067ad8e2604SHong Zhang 
3068ad8e2604SHong Zhang   Collective on TS
3069ad8e2604SHong Zhang 
3070ad8e2604SHong Zhang   Input Parameters:
3071ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
3072ad8e2604SHong Zhang 
3073ad8e2604SHong Zhang   Level: developer
3074ad8e2604SHong Zhang 
3075ad8e2604SHong Zhang .keywords: TS, sensitivity
30765bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
3077ad8e2604SHong Zhang @*/
30785bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
3079ad8e2604SHong Zhang {
3080ad8e2604SHong Zhang   PetscErrorCode ierr;
3081ad8e2604SHong Zhang 
3082ad8e2604SHong Zhang   PetscFunctionBegin;
3083ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3084ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
3085ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
3086ad8e2604SHong Zhang 
3087ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
3088ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
3089ad8e2604SHong Zhang   PetscStackPop;
3090c235aa8dSHong Zhang   PetscFunctionReturn(0);
3091c235aa8dSHong Zhang }
3092c235aa8dSHong Zhang 
30936fd0887fSHong Zhang /*@C
3094dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
30956fd0887fSHong Zhang 
30966fd0887fSHong Zhang     Logically Collective on TS
30976fd0887fSHong Zhang 
30986fd0887fSHong Zhang     Input Parameters:
30996fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
3100abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
31013d1d12c6SHong Zhang .   costintegral - vector that stores the integral values
31020cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
3103b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
3104b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
3105feaa1ddbSSatish Balay .   fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run
3106b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
31076fd0887fSHong Zhang 
31080cf82b59SBarry Smith     Calling sequence of rf:
31093d1d12c6SHong Zhang $   PetscErrorCode rf(TS ts,PetscReal t,Vec y,Vec f,void *ctx);
31106fd0887fSHong Zhang 
3111b612ec54SBarry Smith     Calling sequence of drdyf:
31120cf82b59SBarry Smith $   PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
3113b612ec54SBarry Smith 
3114b612ec54SBarry Smith     Calling sequence of drdpf:
31150cf82b59SBarry Smith $   PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
3116b612ec54SBarry Smith 
3117b612ec54SBarry Smith     Level: intermediate
31186fd0887fSHong Zhang 
3119715f1b00SHong Zhang     Notes: For optimization there is usually a single cost function (numcost = 1). For sensitivities there may be multiple cost functions
31200cf82b59SBarry Smith 
31216fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
31226fd0887fSHong Zhang 
3123dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
31246fd0887fSHong Zhang @*/
31253d1d12c6SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost,Vec costintegral,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
3126d8151eeaSBarry Smith                                                           PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
3127b1cb36f3SHong Zhang                                                           PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),
3128b1cb36f3SHong Zhang                                                           PetscBool fwd,void *ctx)
31296fd0887fSHong Zhang {
31306fd0887fSHong Zhang   PetscErrorCode ierr;
31316fd0887fSHong Zhang 
31326fd0887fSHong Zhang   PetscFunctionBegin;
31336fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
31343d1d12c6SHong Zhang   if (costintegral) PetscValidHeaderSpecific(costintegral,VEC_CLASSID,3);
3135715f1b00SHong 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() or TSForwardSetIntegralGradients()");
3136c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
31376fd0887fSHong Zhang 
31383d1d12c6SHong Zhang   if (costintegral) {
31393d1d12c6SHong Zhang     ierr = PetscObjectReference((PetscObject)costintegral);CHKERRQ(ierr);
31403d1d12c6SHong Zhang     ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
31413d1d12c6SHong Zhang     ts->vec_costintegral = costintegral;
31423d1d12c6SHong Zhang   } else { ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr); /* works for serial only */ }
31433d1d12c6SHong Zhang 
3144b1cb36f3SHong Zhang   ts->costintegralfwd  = fwd; /* Evaluate the cost integral in forward run if fwd is true */
31452c39e106SBarry Smith   ierr                 = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
31460cf82b59SBarry Smith   ts->costintegrand    = rf;
314705755b9cSHong Zhang   ts->costintegrandctx = ctx;
3148b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
3149b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
31506fd0887fSHong Zhang   PetscFunctionReturn(0);
31516fd0887fSHong Zhang }
31526fd0887fSHong Zhang 
315336eaed60SHong Zhang /*@
3154dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
315536eaed60SHong Zhang    It is valid to call the routine after a backward run.
315636eaed60SHong Zhang 
315736eaed60SHong Zhang    Not Collective
315836eaed60SHong Zhang 
315936eaed60SHong Zhang    Input Parameter:
316036eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
316136eaed60SHong Zhang 
316236eaed60SHong Zhang    Output Parameter:
31632c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
316436eaed60SHong Zhang 
316536eaed60SHong Zhang    Level: intermediate
316636eaed60SHong Zhang 
3167dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
316836eaed60SHong Zhang 
316936eaed60SHong Zhang .keywords: TS, sensitivity analysis
317036eaed60SHong Zhang @*/
3171dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
317236eaed60SHong Zhang {
317336eaed60SHong Zhang   PetscFunctionBegin;
317436eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
317536eaed60SHong Zhang   PetscValidPointer(v,2);
31762c39e106SBarry Smith   *v = ts->vec_costintegral;
317736eaed60SHong Zhang   PetscFunctionReturn(0);
317836eaed60SHong Zhang }
317936eaed60SHong Zhang 
31806fd0887fSHong Zhang /*@
3181*022c081aSHong Zhang    TSComputeCostIntegrand - Evaluates the integral function in the cost functions.
31826fd0887fSHong Zhang 
31836fd0887fSHong Zhang    Input Parameters:
31846fd0887fSHong Zhang +  ts - the TS context
31856fd0887fSHong Zhang .  t - current time
31860cf82b59SBarry Smith -  y - state vector, i.e. current solution
31876fd0887fSHong Zhang 
31886fd0887fSHong Zhang    Output Parameter:
3189abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
31906fd0887fSHong Zhang 
31916fd0887fSHong Zhang    Note:
31926fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
31936fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
31946fd0887fSHong Zhang 
31956fd0887fSHong Zhang    Level: developer
31966fd0887fSHong Zhang 
31976fd0887fSHong Zhang .keywords: TS, compute
31986fd0887fSHong Zhang 
3199dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
32006fd0887fSHong Zhang @*/
3201*022c081aSHong Zhang PetscErrorCode TSComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
32026fd0887fSHong Zhang {
32036fd0887fSHong Zhang   PetscErrorCode ierr;
32046fd0887fSHong Zhang 
32056fd0887fSHong Zhang   PetscFunctionBegin;
32066fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
32070cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
32086fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
32096fd0887fSHong Zhang 
32100cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
3211e4680132SHong Zhang   if (ts->costintegrand) {
3212e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
32130cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
32146fd0887fSHong Zhang     PetscStackPop;
32156fd0887fSHong Zhang   } else {
32166fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
32176fd0887fSHong Zhang   }
32186fd0887fSHong Zhang 
32190cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
32206fd0887fSHong Zhang   PetscFunctionReturn(0);
32216fd0887fSHong Zhang }
32226fd0887fSHong Zhang 
322305755b9cSHong Zhang /*@
3224d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
322505755b9cSHong Zhang 
322605755b9cSHong Zhang   Collective on TS
322705755b9cSHong Zhang 
322805755b9cSHong Zhang   Input Parameters:
322905755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
323005755b9cSHong Zhang 
323105755b9cSHong Zhang   Notes:
3232d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
323305755b9cSHong Zhang   so most users would not generally call this routine themselves.
323405755b9cSHong Zhang 
323505755b9cSHong Zhang   Level: developer
323605755b9cSHong Zhang 
323705755b9cSHong Zhang .keywords: TS, sensitivity
3238d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
323905755b9cSHong Zhang @*/
32400cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
324105755b9cSHong Zhang {
324205755b9cSHong Zhang   PetscErrorCode ierr;
324305755b9cSHong Zhang 
324405755b9cSHong Zhang   PetscFunctionBegin;
324505755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
32460cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
324705755b9cSHong Zhang 
324805755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
32490cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
325005755b9cSHong Zhang   PetscStackPop;
325105755b9cSHong Zhang   PetscFunctionReturn(0);
325205755b9cSHong Zhang }
325305755b9cSHong Zhang 
325405755b9cSHong Zhang /*@
3255d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
325605755b9cSHong Zhang 
325705755b9cSHong Zhang   Collective on TS
325805755b9cSHong Zhang 
325905755b9cSHong Zhang   Input Parameters:
326005755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
326105755b9cSHong Zhang 
326205755b9cSHong Zhang   Notes:
326305755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
326405755b9cSHong Zhang   so most users would not generally call this routine themselves.
326505755b9cSHong Zhang 
326605755b9cSHong Zhang   Level: developer
326705755b9cSHong Zhang 
326805755b9cSHong Zhang .keywords: TS, sensitivity
3269d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
327005755b9cSHong Zhang @*/
32710cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
327205755b9cSHong Zhang {
327305755b9cSHong Zhang   PetscErrorCode ierr;
327405755b9cSHong Zhang 
327505755b9cSHong Zhang   PetscFunctionBegin;
327605755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
32770cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
327805755b9cSHong Zhang 
327905755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
32800cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
328105755b9cSHong Zhang   PetscStackPop;
328205755b9cSHong Zhang   PetscFunctionReturn(0);
328305755b9cSHong Zhang }
328405755b9cSHong Zhang 
3285ac226902SBarry Smith /*@C
3286000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
32873f2090d5SJed Brown   called once at the beginning of each time step.
3288000e7ae3SMatthew Knepley 
32893f9fe445SBarry Smith   Logically Collective on TS
3290000e7ae3SMatthew Knepley 
3291000e7ae3SMatthew Knepley   Input Parameters:
3292000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3293000e7ae3SMatthew Knepley - func - The function
3294000e7ae3SMatthew Knepley 
3295000e7ae3SMatthew Knepley   Calling sequence of func:
3296000e7ae3SMatthew Knepley . func (TS ts);
3297000e7ae3SMatthew Knepley 
3298000e7ae3SMatthew Knepley   Level: intermediate
3299000e7ae3SMatthew Knepley 
3300000e7ae3SMatthew Knepley .keywords: TS, timestep
33019be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
3302000e7ae3SMatthew Knepley @*/
33037087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3304000e7ae3SMatthew Knepley {
3305000e7ae3SMatthew Knepley   PetscFunctionBegin;
33060700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3307ae60f76fSBarry Smith   ts->prestep = func;
3308000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3309000e7ae3SMatthew Knepley }
3310000e7ae3SMatthew Knepley 
331109ee8438SJed Brown /*@
33123f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
33133f2090d5SJed Brown 
33143f2090d5SJed Brown   Collective on TS
33153f2090d5SJed Brown 
33163f2090d5SJed Brown   Input Parameters:
33173f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
33183f2090d5SJed Brown 
33193f2090d5SJed Brown   Notes:
33203f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
33213f2090d5SJed Brown   so most users would not generally call this routine themselves.
33223f2090d5SJed Brown 
33233f2090d5SJed Brown   Level: developer
33243f2090d5SJed Brown 
33253f2090d5SJed Brown .keywords: TS, timestep
33269be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
33273f2090d5SJed Brown @*/
33287087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
33293f2090d5SJed Brown {
33303f2090d5SJed Brown   PetscErrorCode ierr;
33313f2090d5SJed Brown 
33323f2090d5SJed Brown   PetscFunctionBegin;
33330700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3334ae60f76fSBarry Smith   if (ts->prestep) {
3335ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
3336312ce896SJed Brown   }
33373f2090d5SJed Brown   PetscFunctionReturn(0);
33383f2090d5SJed Brown }
33393f2090d5SJed Brown 
3340b8123daeSJed Brown /*@C
3341b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3342b8123daeSJed Brown   called once at the beginning of each stage.
3343b8123daeSJed Brown 
3344b8123daeSJed Brown   Logically Collective on TS
3345b8123daeSJed Brown 
3346b8123daeSJed Brown   Input Parameters:
3347b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3348b8123daeSJed Brown - func - The function
3349b8123daeSJed Brown 
3350b8123daeSJed Brown   Calling sequence of func:
3351b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
3352b8123daeSJed Brown 
3353b8123daeSJed Brown   Level: intermediate
3354b8123daeSJed Brown 
3355b8123daeSJed Brown   Note:
3356b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
3357b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
3358b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3359b8123daeSJed Brown 
3360b8123daeSJed Brown .keywords: TS, timestep
33619be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3362b8123daeSJed Brown @*/
3363b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3364b8123daeSJed Brown {
3365b8123daeSJed Brown   PetscFunctionBegin;
3366b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3367ae60f76fSBarry Smith   ts->prestage = func;
3368b8123daeSJed Brown   PetscFunctionReturn(0);
3369b8123daeSJed Brown }
3370b8123daeSJed Brown 
33719be3e283SDebojyoti Ghosh /*@C
33729be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
33739be3e283SDebojyoti Ghosh   called once at the end of each stage.
33749be3e283SDebojyoti Ghosh 
33759be3e283SDebojyoti Ghosh   Logically Collective on TS
33769be3e283SDebojyoti Ghosh 
33779be3e283SDebojyoti Ghosh   Input Parameters:
33789be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
33799be3e283SDebojyoti Ghosh - func - The function
33809be3e283SDebojyoti Ghosh 
33819be3e283SDebojyoti Ghosh   Calling sequence of func:
33829be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
33839be3e283SDebojyoti Ghosh 
33849be3e283SDebojyoti Ghosh   Level: intermediate
33859be3e283SDebojyoti Ghosh 
33869be3e283SDebojyoti Ghosh   Note:
33879be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
33889be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
33899be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
33909be3e283SDebojyoti Ghosh 
33919be3e283SDebojyoti Ghosh .keywords: TS, timestep
33929be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
33939be3e283SDebojyoti Ghosh @*/
33949be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
33959be3e283SDebojyoti Ghosh {
33969be3e283SDebojyoti Ghosh   PetscFunctionBegin;
33979be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
33989be3e283SDebojyoti Ghosh   ts->poststage = func;
33999be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
34009be3e283SDebojyoti Ghosh }
34019be3e283SDebojyoti Ghosh 
3402c688d042SShri Abhyankar /*@C
3403c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3404c688d042SShri Abhyankar   called once at the end of each step evaluation.
3405c688d042SShri Abhyankar 
3406c688d042SShri Abhyankar   Logically Collective on TS
3407c688d042SShri Abhyankar 
3408c688d042SShri Abhyankar   Input Parameters:
3409c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3410c688d042SShri Abhyankar - func - The function
3411c688d042SShri Abhyankar 
3412c688d042SShri Abhyankar   Calling sequence of func:
3413c688d042SShri Abhyankar . PetscErrorCode func(TS ts);
3414c688d042SShri Abhyankar 
3415c688d042SShri Abhyankar   Level: intermediate
3416c688d042SShri Abhyankar 
3417c688d042SShri Abhyankar   Note:
34181785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
34191785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3420e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3421e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3422e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3423c688d042SShri Abhyankar 
3424c688d042SShri Abhyankar .keywords: TS, timestep
3425c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3426c688d042SShri Abhyankar @*/
3427c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3428c688d042SShri Abhyankar {
3429c688d042SShri Abhyankar   PetscFunctionBegin;
3430c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3431c688d042SShri Abhyankar   ts->postevaluate = func;
3432c688d042SShri Abhyankar   PetscFunctionReturn(0);
3433c688d042SShri Abhyankar }
3434c688d042SShri Abhyankar 
3435b8123daeSJed Brown /*@
3436b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3437b8123daeSJed Brown 
3438b8123daeSJed Brown   Collective on TS
3439b8123daeSJed Brown 
3440b8123daeSJed Brown   Input Parameters:
3441b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
34429be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3443b8123daeSJed Brown 
3444b8123daeSJed Brown   Notes:
3445b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3446b8123daeSJed Brown   most users would not generally call this routine themselves.
3447b8123daeSJed Brown 
3448b8123daeSJed Brown   Level: developer
3449b8123daeSJed Brown 
3450b8123daeSJed Brown .keywords: TS, timestep
34519be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3452b8123daeSJed Brown @*/
3453b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3454b8123daeSJed Brown {
3455b8123daeSJed Brown   PetscErrorCode ierr;
3456b8123daeSJed Brown 
3457b8123daeSJed Brown   PetscFunctionBegin;
3458b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3459ae60f76fSBarry Smith   if (ts->prestage) {
3460ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3461b8123daeSJed Brown   }
3462b8123daeSJed Brown   PetscFunctionReturn(0);
3463b8123daeSJed Brown }
3464b8123daeSJed Brown 
34659be3e283SDebojyoti Ghosh /*@
34669be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
34679be3e283SDebojyoti Ghosh 
34689be3e283SDebojyoti Ghosh   Collective on TS
34699be3e283SDebojyoti Ghosh 
34709be3e283SDebojyoti Ghosh   Input Parameters:
34719be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
34729be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
34739be3e283SDebojyoti Ghosh   stageindex  - Stage number
34749be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
34759be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
34769be3e283SDebojyoti Ghosh 
34779be3e283SDebojyoti Ghosh   Notes:
34789be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
34799be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
34809be3e283SDebojyoti Ghosh 
34819be3e283SDebojyoti Ghosh   Level: developer
34829be3e283SDebojyoti Ghosh 
34839be3e283SDebojyoti Ghosh .keywords: TS, timestep
34849be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
34859be3e283SDebojyoti Ghosh @*/
34869be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
34879be3e283SDebojyoti Ghosh {
34889be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
34899be3e283SDebojyoti Ghosh 
34909be3e283SDebojyoti Ghosh   PetscFunctionBegin;
34919be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
34924beae5d8SLisandro Dalcin   if (ts->poststage) {
34939be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
34949be3e283SDebojyoti Ghosh   }
34959be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
34969be3e283SDebojyoti Ghosh }
34979be3e283SDebojyoti Ghosh 
3498c688d042SShri Abhyankar /*@
3499c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3500c688d042SShri Abhyankar 
3501c688d042SShri Abhyankar   Collective on TS
3502c688d042SShri Abhyankar 
3503c688d042SShri Abhyankar   Input Parameters:
3504c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3505c688d042SShri Abhyankar 
3506c688d042SShri Abhyankar   Notes:
3507c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3508c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3509c688d042SShri Abhyankar 
3510c688d042SShri Abhyankar   Level: developer
3511c688d042SShri Abhyankar 
3512c688d042SShri Abhyankar .keywords: TS, timestep
3513c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3514c688d042SShri Abhyankar @*/
3515c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3516c688d042SShri Abhyankar {
3517c688d042SShri Abhyankar   PetscErrorCode ierr;
3518c688d042SShri Abhyankar 
3519c688d042SShri Abhyankar   PetscFunctionBegin;
3520c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3521c688d042SShri Abhyankar   if (ts->postevaluate) {
3522c688d042SShri Abhyankar     PetscStackCallStandard((*ts->postevaluate),(ts));
3523c688d042SShri Abhyankar   }
3524c688d042SShri Abhyankar   PetscFunctionReturn(0);
3525c688d042SShri Abhyankar }
3526c688d042SShri Abhyankar 
3527ac226902SBarry Smith /*@C
3528000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
35293f2090d5SJed Brown   called once at the end of each time step.
3530000e7ae3SMatthew Knepley 
35313f9fe445SBarry Smith   Logically Collective on TS
3532000e7ae3SMatthew Knepley 
3533000e7ae3SMatthew Knepley   Input Parameters:
3534000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3535000e7ae3SMatthew Knepley - func - The function
3536000e7ae3SMatthew Knepley 
3537000e7ae3SMatthew Knepley   Calling sequence of func:
3538b8123daeSJed Brown $ func (TS ts);
3539000e7ae3SMatthew Knepley 
35401785ff2aSShri Abhyankar   Notes:
35411785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
35421785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
35431785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
35441785ff2aSShri Abhyankar 
3545000e7ae3SMatthew Knepley   Level: intermediate
3546000e7ae3SMatthew Knepley 
3547000e7ae3SMatthew Knepley .keywords: TS, timestep
35481785ff2aSShri Abhyankar .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
3549000e7ae3SMatthew Knepley @*/
35507087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3551000e7ae3SMatthew Knepley {
3552000e7ae3SMatthew Knepley   PetscFunctionBegin;
35530700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3554ae60f76fSBarry Smith   ts->poststep = func;
3555000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3556000e7ae3SMatthew Knepley }
3557000e7ae3SMatthew Knepley 
355809ee8438SJed Brown /*@
35593f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
35603f2090d5SJed Brown 
35613f2090d5SJed Brown   Collective on TS
35623f2090d5SJed Brown 
35633f2090d5SJed Brown   Input Parameters:
35643f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
35653f2090d5SJed Brown 
35663f2090d5SJed Brown   Notes:
35673f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
35683f2090d5SJed Brown   so most users would not generally call this routine themselves.
35693f2090d5SJed Brown 
35703f2090d5SJed Brown   Level: developer
35713f2090d5SJed Brown 
35723f2090d5SJed Brown .keywords: TS, timestep
35733f2090d5SJed Brown @*/
35747087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
35753f2090d5SJed Brown {
35763f2090d5SJed Brown   PetscErrorCode ierr;
35773f2090d5SJed Brown 
35783f2090d5SJed Brown   PetscFunctionBegin;
35790700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3580ae60f76fSBarry Smith   if (ts->poststep) {
3581ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
358272ac3e02SJed Brown   }
35833f2090d5SJed Brown   PetscFunctionReturn(0);
35843f2090d5SJed Brown }
35853f2090d5SJed Brown 
3586d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3587d763cef2SBarry Smith 
3588d763cef2SBarry Smith /*@C
3589a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3590d763cef2SBarry Smith    timestep to display the iteration's  progress.
3591d763cef2SBarry Smith 
35923f9fe445SBarry Smith    Logically Collective on TS
3593d763cef2SBarry Smith 
3594d763cef2SBarry Smith    Input Parameters:
3595d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3596e213d8f1SJed Brown .  monitor - monitoring routine
3597329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
35980298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3599b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
36000298fd71SBarry Smith           (may be NULL)
3601d763cef2SBarry Smith 
3602e213d8f1SJed Brown    Calling sequence of monitor:
36030910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3604d763cef2SBarry Smith 
3605d763cef2SBarry Smith +    ts - the TS context
360663e21af5SBarry Smith .    steps - iteration number (after the final time step the monitor routine may be called with a step of -1, this indicates the solution has been interpolated to this time)
36071f06c33eSBarry Smith .    time - current time
36080910c330SBarry Smith .    u - current iterate
3609d763cef2SBarry Smith -    mctx - [optional] monitoring context
3610d763cef2SBarry Smith 
3611d763cef2SBarry Smith    Notes:
3612d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3613d763cef2SBarry Smith    already has been loaded.
3614d763cef2SBarry Smith 
3615025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
3616025f1a04SBarry Smith 
3617d763cef2SBarry Smith    Level: intermediate
3618d763cef2SBarry Smith 
3619d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3620d763cef2SBarry Smith 
3621a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3622d763cef2SBarry Smith @*/
3623c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3624d763cef2SBarry Smith {
362578064530SBarry Smith   PetscErrorCode ierr;
362678064530SBarry Smith   PetscInt       i;
362778064530SBarry Smith   PetscBool      identical;
362878064530SBarry Smith 
3629d763cef2SBarry Smith   PetscFunctionBegin;
36300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
363178064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
363278064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
363378064530SBarry Smith     if (identical) PetscFunctionReturn(0);
363478064530SBarry Smith   }
363517186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3636d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
36378704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3638d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3639d763cef2SBarry Smith   PetscFunctionReturn(0);
3640d763cef2SBarry Smith }
3641d763cef2SBarry Smith 
3642d763cef2SBarry Smith /*@C
3643a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3644d763cef2SBarry Smith 
36453f9fe445SBarry Smith    Logically Collective on TS
3646d763cef2SBarry Smith 
3647d763cef2SBarry Smith    Input Parameters:
3648d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3649d763cef2SBarry Smith 
3650d763cef2SBarry Smith    Notes:
3651d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3652d763cef2SBarry Smith 
3653d763cef2SBarry Smith    Level: intermediate
3654d763cef2SBarry Smith 
3655d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3656d763cef2SBarry Smith 
3657a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3658d763cef2SBarry Smith @*/
36597087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3660d763cef2SBarry Smith {
3661d952e501SBarry Smith   PetscErrorCode ierr;
3662d952e501SBarry Smith   PetscInt       i;
3663d952e501SBarry Smith 
3664d763cef2SBarry Smith   PetscFunctionBegin;
36650700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3666d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
36678704b422SBarry Smith     if (ts->monitordestroy[i]) {
36688704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3669d952e501SBarry Smith     }
3670d952e501SBarry Smith   }
3671d763cef2SBarry Smith   ts->numbermonitors = 0;
3672d763cef2SBarry Smith   PetscFunctionReturn(0);
3673d763cef2SBarry Smith }
3674d763cef2SBarry Smith 
3675721cd6eeSBarry Smith /*@C
3676721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
36775516499fSSatish Balay 
36785516499fSSatish Balay    Level: intermediate
367941251cbbSSatish Balay 
36805516499fSSatish Balay .keywords: TS, set, monitor
36815516499fSSatish Balay 
368263e21af5SBarry Smith .seealso:  TSMonitorSet()
368341251cbbSSatish Balay @*/
3684721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3685d763cef2SBarry Smith {
3686dfbe8321SBarry Smith   PetscErrorCode ierr;
3687721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
368841aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3689d132466eSBarry Smith 
3690d763cef2SBarry Smith   PetscFunctionBegin;
36914d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
369241aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
369341aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3694721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
369541aca3d6SBarry Smith   if (iascii) {
3696649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
369763e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
369863e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
369963e21af5SBarry Smith     } else {
37008392e04aSShri 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);
370163e21af5SBarry Smith     }
3702649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
370341aca3d6SBarry Smith   } else if (ibinary) {
370441aca3d6SBarry Smith     PetscMPIInt rank;
370541aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
370641aca3d6SBarry Smith     if (!rank) {
3707450a797fSBarry Smith       PetscBool skipHeader;
3708450a797fSBarry Smith       PetscInt  classid = REAL_FILE_CLASSID;
3709450a797fSBarry Smith 
3710450a797fSBarry Smith       ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr);
3711450a797fSBarry Smith       if (!skipHeader) {
3712450a797fSBarry Smith          ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
3713450a797fSBarry Smith        }
371441aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
371541aca3d6SBarry Smith     } else {
371641aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
371741aca3d6SBarry Smith     }
371841aca3d6SBarry Smith   }
3719721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3720d763cef2SBarry Smith   PetscFunctionReturn(0);
3721d763cef2SBarry Smith }
3722d763cef2SBarry Smith 
37239110b2e7SHong Zhang /*@C
37249110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
37259110b2e7SHong Zhang    timestep to display the iteration's  progress.
37269110b2e7SHong Zhang 
37279110b2e7SHong Zhang    Logically Collective on TS
37289110b2e7SHong Zhang 
37299110b2e7SHong Zhang    Input Parameters:
37309110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
37319110b2e7SHong Zhang .  adjointmonitor - monitoring routine
37329110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
37339110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
37349110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
37359110b2e7SHong Zhang           (may be NULL)
37369110b2e7SHong Zhang 
37379110b2e7SHong Zhang    Calling sequence of monitor:
37389110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
37399110b2e7SHong Zhang 
37409110b2e7SHong Zhang +    ts - the TS context
37419110b2e7SHong 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
37429110b2e7SHong Zhang                                been interpolated to)
37439110b2e7SHong Zhang .    time - current time
37449110b2e7SHong Zhang .    u - current iterate
37459110b2e7SHong Zhang .    numcost - number of cost functionos
37469110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
37479110b2e7SHong Zhang .    mu - sensitivities to parameters
37489110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
37499110b2e7SHong Zhang 
37509110b2e7SHong Zhang    Notes:
37519110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
37529110b2e7SHong Zhang    already has been loaded.
37539110b2e7SHong Zhang 
37549110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
37559110b2e7SHong Zhang 
37569110b2e7SHong Zhang    Level: intermediate
37579110b2e7SHong Zhang 
37589110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
37599110b2e7SHong Zhang 
37609110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
37619110b2e7SHong Zhang @*/
37629110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
37639110b2e7SHong Zhang {
376478064530SBarry Smith   PetscErrorCode ierr;
376578064530SBarry Smith   PetscInt       i;
376678064530SBarry Smith   PetscBool      identical;
376778064530SBarry Smith 
37689110b2e7SHong Zhang   PetscFunctionBegin;
37699110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
377078064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
377178064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr);
377278064530SBarry Smith     if (identical) PetscFunctionReturn(0);
377378064530SBarry Smith   }
37749110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
37759110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
37769110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
37779110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
37789110b2e7SHong Zhang   PetscFunctionReturn(0);
37799110b2e7SHong Zhang }
37809110b2e7SHong Zhang 
37819110b2e7SHong Zhang /*@C
37829110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
37839110b2e7SHong Zhang 
37849110b2e7SHong Zhang    Logically Collective on TS
37859110b2e7SHong Zhang 
37869110b2e7SHong Zhang    Input Parameters:
37879110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
37889110b2e7SHong Zhang 
37899110b2e7SHong Zhang    Notes:
37909110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
37919110b2e7SHong Zhang 
37929110b2e7SHong Zhang    Level: intermediate
37939110b2e7SHong Zhang 
37949110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
37959110b2e7SHong Zhang 
37969110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
37979110b2e7SHong Zhang @*/
37989110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
37999110b2e7SHong Zhang {
38009110b2e7SHong Zhang   PetscErrorCode ierr;
38019110b2e7SHong Zhang   PetscInt       i;
38029110b2e7SHong Zhang 
38039110b2e7SHong Zhang   PetscFunctionBegin;
38049110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
38059110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
38069110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
38079110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
38089110b2e7SHong Zhang     }
38099110b2e7SHong Zhang   }
38109110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
38119110b2e7SHong Zhang   PetscFunctionReturn(0);
38129110b2e7SHong Zhang }
38139110b2e7SHong Zhang 
3814721cd6eeSBarry Smith /*@C
3815721cd6eeSBarry Smith    TSAdjointMonitorDefault - the default monitor of adjoint computations
3816110eb670SHong Zhang 
3817110eb670SHong Zhang    Level: intermediate
3818110eb670SHong Zhang 
3819110eb670SHong Zhang .keywords: TS, set, monitor
3820110eb670SHong Zhang 
3821110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
3822110eb670SHong Zhang @*/
3823721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
3824110eb670SHong Zhang {
3825110eb670SHong Zhang   PetscErrorCode ierr;
3826721cd6eeSBarry Smith   PetscViewer    viewer = vf->viewer;
3827110eb670SHong Zhang 
3828110eb670SHong Zhang   PetscFunctionBegin;
3829110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3830721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
3831110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3832110eb670SHong 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);
3833110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3834721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3835110eb670SHong Zhang   PetscFunctionReturn(0);
3836110eb670SHong Zhang }
3837110eb670SHong Zhang 
3838cd652676SJed Brown /*@
3839cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3840cd652676SJed Brown 
3841cd652676SJed Brown    Collective on TS
3842cd652676SJed Brown 
3843cd652676SJed Brown    Input Argument:
3844cd652676SJed Brown +  ts - time stepping context
3845cd652676SJed Brown -  t - time to interpolate to
3846cd652676SJed Brown 
3847cd652676SJed Brown    Output Argument:
38480910c330SBarry Smith .  U - state at given time
3849cd652676SJed Brown 
3850cd652676SJed Brown    Level: intermediate
3851cd652676SJed Brown 
3852cd652676SJed Brown    Developer Notes:
3853cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3854cd652676SJed Brown 
3855cd652676SJed Brown .keywords: TS, set
3856cd652676SJed Brown 
3857874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
3858cd652676SJed Brown @*/
38590910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3860cd652676SJed Brown {
3861cd652676SJed Brown   PetscErrorCode ierr;
3862cd652676SJed Brown 
3863cd652676SJed Brown   PetscFunctionBegin;
3864cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3865b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3866be5899b3SLisandro Dalcin   if (t < ts->ptime_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)ts->ptime_prev,(double)ts->ptime);
3867ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
38680910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3869cd652676SJed Brown   PetscFunctionReturn(0);
3870cd652676SJed Brown }
3871cd652676SJed Brown 
3872d763cef2SBarry Smith /*@
38736d9e5789SSean Farley    TSStep - Steps one time step
3874d763cef2SBarry Smith 
3875d763cef2SBarry Smith    Collective on TS
3876d763cef2SBarry Smith 
3877d763cef2SBarry Smith    Input Parameter:
3878d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3879d763cef2SBarry Smith 
388027829d71SBarry Smith    Level: developer
3881d763cef2SBarry Smith 
3882b8123daeSJed Brown    Notes:
388327829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
388427829d71SBarry Smith 
3885b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3886b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3887b8123daeSJed Brown 
388825cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
388925cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
389025cb2221SBarry Smith 
3891d763cef2SBarry Smith .keywords: TS, timestep, solve
3892d763cef2SBarry Smith 
38939be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3894d763cef2SBarry Smith @*/
3895193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3896d763cef2SBarry Smith {
3897dfbe8321SBarry Smith   PetscErrorCode   ierr;
3898fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3899be5899b3SLisandro Dalcin   PetscReal        ptime;
3900d763cef2SBarry Smith 
3901d763cef2SBarry Smith   PetscFunctionBegin;
39020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3903fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3904fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3905fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3906fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3907fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3908fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3909302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
3910fffbeea8SBarry Smith 
3911d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
391268bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3913d405a339SMatthew Knepley 
3914a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSStep()");
3915be5899b3SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
3916a6772fa2SLisandro Dalcin 
3917be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
3918362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3919be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
3920e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3921d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3922193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3923d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3924be5899b3SLisandro Dalcin   ts->ptime_prev = ptime;
3925be5899b3SLisandro Dalcin   ts->steps++; ts->total_steps++;
3926be5899b3SLisandro Dalcin   ts->steprollback = PETSC_FALSE;
392728d5b5d6SLisandro Dalcin   ts->steprestart  = PETSC_FALSE;
3928362cd11cSLisandro Dalcin 
3929362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3930cef5090cSJed Brown     if (ts->errorifstepfailed) {
393108c7845fSBarry 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]);
393208c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3933d2daff3dSHong Zhang     }
393408c7845fSBarry Smith   } else if (!ts->reason) {
393508c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
393608c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
393708c7845fSBarry Smith   }
393808c7845fSBarry Smith   PetscFunctionReturn(0);
393908c7845fSBarry Smith }
394008c7845fSBarry Smith 
394108c7845fSBarry Smith /*@
3942b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
394308c7845fSBarry Smith 
394408c7845fSBarry Smith    Collective on TS
394508c7845fSBarry Smith 
394608c7845fSBarry Smith    Input Parameter:
394708c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
394808c7845fSBarry Smith 
39496a4d4014SLisandro Dalcin    Level: intermediate
39506a4d4014SLisandro Dalcin 
3951b957a604SHong Zhang .keywords: TS, adjoint, step
39526a4d4014SLisandro Dalcin 
3953b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
39546a4d4014SLisandro Dalcin @*/
395508c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
39566a4d4014SLisandro Dalcin {
395708c7845fSBarry Smith   DM               dm;
39586a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
39596a4d4014SLisandro Dalcin 
39606a4d4014SLisandro Dalcin   PetscFunctionBegin;
39614a2ae208SSatish Balay   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
396208c7845fSBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
396308c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3964d763cef2SBarry Smith 
3965685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr);
3966d763cef2SBarry Smith 
3967be5899b3SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3968be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime;
396942f2b339SBarry 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);
3970be5899b3SLisandro Dalcin   ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
397142f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
39728d0ad7a8SHong Zhang   ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
3973be5899b3SLisandro Dalcin   ts->steps++; ts->total_steps--;
3974362cd11cSLisandro Dalcin 
3975362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3976cef5090cSJed Brown     if (ts->errorifstepfailed) {
39776c4ed002SBarry 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]);
39786c4ed002SBarry 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]);
39796c4ed002SBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3980cef5090cSJed Brown     }
3981362cd11cSLisandro Dalcin   } else if (!ts->reason) {
398273b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
3983362cd11cSLisandro Dalcin   }
3984d763cef2SBarry Smith   PetscFunctionReturn(0);
3985d763cef2SBarry Smith }
3986d763cef2SBarry Smith 
39877cbde773SLisandro Dalcin /*@
39887cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
39897cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
39907cbde773SLisandro Dalcin 
39917cbde773SLisandro Dalcin    Collective on TS
39927cbde773SLisandro Dalcin 
39937cbde773SLisandro Dalcin    Input Arguments:
39947cbde773SLisandro Dalcin +  ts - time stepping context
39957cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
39967cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
39977cbde773SLisandro Dalcin 
39987cbde773SLisandro Dalcin    Output Arguments:
39997cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
40007cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
40017cbde773SLisandro Dalcin 
40027cbde773SLisandro Dalcin    Level: advanced
40037cbde773SLisandro Dalcin 
40047cbde773SLisandro Dalcin    Notes:
40057cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
40067cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
40077cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
40087cbde773SLisandro Dalcin 
40097cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
40107cbde773SLisandro Dalcin @*/
40117cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
40127cbde773SLisandro Dalcin {
40137cbde773SLisandro Dalcin   PetscErrorCode ierr;
40147cbde773SLisandro Dalcin 
40157cbde773SLisandro Dalcin   PetscFunctionBegin;
40167cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
40177cbde773SLisandro Dalcin   PetscValidType(ts,1);
40187cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
40197cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
40207cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
40217cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
40227cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
40237cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
40247cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
40257cbde773SLisandro Dalcin   PetscFunctionReturn(0);
40267cbde773SLisandro Dalcin }
40277cbde773SLisandro Dalcin 
402805175c85SJed Brown /*@
402905175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
403005175c85SJed Brown 
40311c3436cfSJed Brown    Collective on TS
403205175c85SJed Brown 
403305175c85SJed Brown    Input Arguments:
40341c3436cfSJed Brown +  ts - time stepping context
40351c3436cfSJed Brown .  order - desired order of accuracy
40360298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
403705175c85SJed Brown 
403805175c85SJed Brown    Output Arguments:
40390910c330SBarry Smith .  U - state at the end of the current step
404005175c85SJed Brown 
404105175c85SJed Brown    Level: advanced
404205175c85SJed Brown 
4043108c343cSJed Brown    Notes:
4044108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
4045108c343cSJed 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.
4046108c343cSJed Brown 
40471c3436cfSJed Brown .seealso: TSStep(), TSAdapt
404805175c85SJed Brown @*/
40490910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
405005175c85SJed Brown {
405105175c85SJed Brown   PetscErrorCode ierr;
405205175c85SJed Brown 
405305175c85SJed Brown   PetscFunctionBegin;
405405175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
405505175c85SJed Brown   PetscValidType(ts,1);
40560910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4057ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
40580910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
405905175c85SJed Brown   PetscFunctionReturn(0);
406005175c85SJed Brown }
406105175c85SJed Brown 
4062b1cb36f3SHong Zhang /*@
4063b1cb36f3SHong Zhang    TSForwardCostIntegral - Evaluate the cost integral in the forward run.
4064b1cb36f3SHong Zhang 
4065b1cb36f3SHong Zhang    Collective on TS
4066b1cb36f3SHong Zhang 
4067b1cb36f3SHong Zhang    Input Arguments:
4068b1cb36f3SHong Zhang .  ts - time stepping context
4069b1cb36f3SHong Zhang 
4070b1cb36f3SHong Zhang    Level: advanced
4071b1cb36f3SHong Zhang 
4072b1cb36f3SHong Zhang    Notes:
4073b1cb36f3SHong Zhang    This function cannot be called until TSStep() has been completed.
4074b1cb36f3SHong Zhang 
4075b1cb36f3SHong Zhang .seealso: TSSolve(), TSAdjointCostIntegral()
4076b1cb36f3SHong Zhang @*/
4077b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts)
4078b1cb36f3SHong Zhang {
4079b1cb36f3SHong Zhang   PetscErrorCode ierr;
4080b1cb36f3SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4081b1cb36f3SHong Zhang   if (!ts->ops->forwardintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the forward run",((PetscObject)ts)->type_name);
4082b1cb36f3SHong Zhang   ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr);
4083b1cb36f3SHong Zhang   PetscFunctionReturn(0);
4084b1cb36f3SHong Zhang }
4085d67e68b7SBarry Smith 
4086d763cef2SBarry Smith /*@
4087d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
4088d763cef2SBarry Smith 
4089d763cef2SBarry Smith    Collective on TS
4090d763cef2SBarry Smith 
4091d763cef2SBarry Smith    Input Parameter:
4092d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
409363e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
409463e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
40955a3a76d0SJed Brown 
4096d763cef2SBarry Smith    Level: beginner
4097d763cef2SBarry Smith 
40985a3a76d0SJed Brown    Notes:
40995a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
41005a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
41015a3a76d0SJed Brown    stepped over the final time.
41025a3a76d0SJed Brown 
4103d763cef2SBarry Smith .keywords: TS, timestep, solve
4104d763cef2SBarry Smith 
410563e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
4106d763cef2SBarry Smith @*/
4107cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
4108d763cef2SBarry Smith {
4109b06615a5SLisandro Dalcin   Vec               solution;
4110d763cef2SBarry Smith   PetscErrorCode    ierr;
4111d763cef2SBarry Smith 
4112d763cef2SBarry Smith   PetscFunctionBegin;
4113d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4114f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
4115feed9e9dSBarry Smith 
411649354f04SShri 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 */
4117b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
41180910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
4119b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
4120b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
4121b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
41225a3a76d0SJed Brown     }
41230910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
4124715f1b00SHong Zhang     if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
4125bbd56ea5SKarl Rupp   } else if (u) {
41260910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
41275a3a76d0SJed Brown   }
4128b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
412968bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4130a6772fa2SLisandro Dalcin 
4131a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSSolve()");
4132a6772fa2SLisandro Dalcin   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
4133a6772fa2SLisandro Dalcin 
4134715f1b00SHong Zhang   if (ts->forward_solve) {
4135715f1b00SHong Zhang     ierr = TSForwardSetUp(ts);CHKERRQ(ierr);
4136715f1b00SHong Zhang   }
4137715f1b00SHong Zhang 
4138e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
4139715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
4140e7069c78SShri      TSTrajectory to incorrectly save the output files
4141e7069c78SShri   */
4142715f1b00SHong Zhang   /* reset time step and iteration counters */
4143193ac0bcSJed Brown   ts->steps             = 0;
41445ef26d82SJed Brown   ts->ksp_its           = 0;
41455ef26d82SJed Brown   ts->snes_its          = 0;
4146c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
4147c610991cSLisandro Dalcin   ts->reject            = 0;
4148193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
4149193ac0bcSJed Brown 
4150ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
4151f05ece33SBarry Smith 
4152193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
4153193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
4154a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4155cc708dedSBarry Smith     ts->solvetime = ts->ptime;
4156a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
4157be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
4158db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
4159db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
4160e7069c78SShri 
4161938c94caSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41626427ac75SLisandro Dalcin     ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
4163e7069c78SShri 
416428d5b5d6SLisandro Dalcin     ts->steprollback = PETSC_FALSE;
416528d5b5d6SLisandro Dalcin     ts->steprestart  = PETSC_TRUE;
41666427ac75SLisandro Dalcin 
4167e1a7a14fSJed Brown     while (!ts->reason) {
4168938c94caSShri Abhyankar       ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41699687d888SLisandro Dalcin       if (!ts->steprollback) {
41709687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
41719687d888SLisandro Dalcin       }
4172193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
4173e783b05fSHong Zhang       if (ts->vec_costintegral && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */
4174b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
4175b1cb36f3SHong Zhang       }
4176715f1b00SHong Zhang       if (!ts->steprollback && ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */
4177715f1b00SHong Zhang           ierr = TSForwardStep(ts);CHKERRQ(ierr);
4178715f1b00SHong Zhang       }
417910b82f12SShri Abhyankar       ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
4180e783b05fSHong Zhang       ierr = TSEventHandler(ts);CHKERRQ(ierr); /* The right-hand side may be changed due to event. Be careful with Any computation using the RHS information after this point. */
4181e783b05fSHong Zhang       if (!ts->steprollback) {
4182938c94caSShri Abhyankar         ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41831eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
4184aeb4809dSShri Abhyankar       }
4185193ac0bcSJed Brown     }
4186938c94caSShri Abhyankar     ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
41876427ac75SLisandro Dalcin 
418849354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
41890910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
4190cc708dedSBarry Smith       ts->solvetime = ts->max_time;
4191b06615a5SLisandro Dalcin       solution = u;
419263e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
41930574a7fbSJed Brown     } else {
4194ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4195cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4196b06615a5SLisandro Dalcin       solution = ts->vec_sol;
41970574a7fbSJed Brown     }
4198193ac0bcSJed Brown   }
4199d2daff3dSHong Zhang 
4200ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
420163e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
420256f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
4203ef222394SBarry Smith   if (ts->adjoint_solve) {
4204ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
42052b0a91c0SBarry Smith   }
4206d763cef2SBarry Smith   PetscFunctionReturn(0);
4207d763cef2SBarry Smith }
4208d763cef2SBarry Smith 
4209b1cb36f3SHong Zhang /*@
4210b1cb36f3SHong Zhang  TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run.
4211b1cb36f3SHong Zhang 
4212b1cb36f3SHong Zhang  Collective on TS
4213b1cb36f3SHong Zhang 
4214b1cb36f3SHong Zhang  Input Arguments:
4215b1cb36f3SHong Zhang  .  ts - time stepping context
4216b1cb36f3SHong Zhang 
4217b1cb36f3SHong Zhang  Level: advanced
4218b1cb36f3SHong Zhang 
4219b1cb36f3SHong Zhang  Notes:
4220b1cb36f3SHong Zhang  This function cannot be called until TSAdjointStep() has been completed.
4221b1cb36f3SHong Zhang 
4222b1cb36f3SHong Zhang  .seealso: TSAdjointSolve(), TSAdjointStep
4223b1cb36f3SHong Zhang  @*/
4224b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts)
4225b1cb36f3SHong Zhang {
4226b1cb36f3SHong Zhang     PetscErrorCode ierr;
4227b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4228b1cb36f3SHong Zhang     if (!ts->ops->adjointintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the adjoint run",((PetscObject)ts)->type_name);
4229b1cb36f3SHong Zhang     ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr);
4230b1cb36f3SHong Zhang     PetscFunctionReturn(0);
4231b1cb36f3SHong Zhang }
4232b1cb36f3SHong Zhang 
4233c88f2d44SBarry Smith /*@
4234c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
4235c88f2d44SBarry Smith 
4236c88f2d44SBarry Smith    Collective on TS
4237c88f2d44SBarry Smith 
4238c88f2d44SBarry Smith    Input Parameter:
42392c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
4240c88f2d44SBarry Smith 
4241e87fd094SBarry Smith    Options Database:
4242715f1b00SHong Zhang . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial values
4243e87fd094SBarry Smith 
4244c88f2d44SBarry Smith    Level: intermediate
4245c88f2d44SBarry Smith 
4246c88f2d44SBarry Smith    Notes:
4247c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
4248c88f2d44SBarry Smith 
424973b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
425073b18844SBarry Smith 
4251c88f2d44SBarry Smith .keywords: TS, timestep, solve
4252c88f2d44SBarry Smith 
4253b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
4254c88f2d44SBarry Smith @*/
42552c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
4256c88f2d44SBarry Smith {
4257c88f2d44SBarry Smith   PetscErrorCode    ierr;
4258c88f2d44SBarry Smith 
4259c88f2d44SBarry Smith   PetscFunctionBegin;
4260c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4261c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
426268bece0bSHong Zhang 
4263c88f2d44SBarry Smith   /* reset time step and iteration counters */
4264c88f2d44SBarry Smith   ts->steps             = 0;
4265c88f2d44SBarry Smith   ts->ksp_its           = 0;
4266c88f2d44SBarry Smith   ts->snes_its          = 0;
4267c88f2d44SBarry Smith   ts->num_snes_failures = 0;
4268c88f2d44SBarry Smith   ts->reject            = 0;
4269c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
4270c88f2d44SBarry Smith 
427173b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
4272c88f2d44SBarry Smith 
427373b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
4274c88f2d44SBarry Smith   while (!ts->reason) {
427555c52731SHong Zhang     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
42769110b2e7SHong Zhang     ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
42776427ac75SLisandro Dalcin     ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr);
4278616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
4279b1cb36f3SHong Zhang     if (ts->vec_costintegral && !ts->costintegralfwd) {
4280b1cb36f3SHong Zhang       ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr);
4281b1cb36f3SHong Zhang     }
4282c88f2d44SBarry Smith   }
428326656371SHong Zhang   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
428426656371SHong Zhang   ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
4285c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
4286e210cd0eSHong Zhang   ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr);
4287685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
4288c88f2d44SBarry Smith   PetscFunctionReturn(0);
4289c88f2d44SBarry Smith }
4290c88f2d44SBarry Smith 
42917db568b7SBarry Smith /*@C
4292228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4293228d79bcSJed Brown 
4294228d79bcSJed Brown    Collective on TS
4295228d79bcSJed Brown 
4296228d79bcSJed Brown    Input Parameters:
4297228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
4298228d79bcSJed Brown .  step - step number that has just completed
4299228d79bcSJed Brown .  ptime - model time of the state
43000910c330SBarry Smith -  u - state at the current model time
4301228d79bcSJed Brown 
4302228d79bcSJed Brown    Notes:
43037db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
43047db568b7SBarry Smith    Users would almost never call this routine directly.
4305228d79bcSJed Brown 
430663e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
430763e21af5SBarry Smith 
43087db568b7SBarry Smith    Level: developer
4309228d79bcSJed Brown 
4310228d79bcSJed Brown .keywords: TS, timestep
4311228d79bcSJed Brown @*/
43120910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4313d763cef2SBarry Smith {
4314d6152f81SLisandro Dalcin   DM             dm;
4315a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
4316d6152f81SLisandro Dalcin   PetscErrorCode ierr;
4317d763cef2SBarry Smith 
4318d763cef2SBarry Smith   PetscFunctionBegin;
4319b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4320b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4321d6152f81SLisandro Dalcin 
4322d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
4323d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
4324d6152f81SLisandro Dalcin 
43255edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
4326d763cef2SBarry Smith   for (i=0; i<n; i++) {
43270910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
4328d763cef2SBarry Smith   }
43295edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
4330d763cef2SBarry Smith   PetscFunctionReturn(0);
4331d763cef2SBarry Smith }
4332d763cef2SBarry Smith 
43337db568b7SBarry Smith /*@C
43349110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
43359110b2e7SHong Zhang 
43369110b2e7SHong Zhang    Collective on TS
43379110b2e7SHong Zhang 
43389110b2e7SHong Zhang    Input Parameters:
43399110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
43409110b2e7SHong Zhang .  step - step number that has just completed
43419110b2e7SHong Zhang .  ptime - model time of the state
43429110b2e7SHong Zhang .  u - state at the current model time
43439110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
43449110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
43459110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
43469110b2e7SHong Zhang 
43479110b2e7SHong Zhang    Notes:
43487db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
43497db568b7SBarry Smith    Users would almost never call this routine directly.
43509110b2e7SHong Zhang 
43517db568b7SBarry Smith    Level: developer
43529110b2e7SHong Zhang 
43539110b2e7SHong Zhang .keywords: TS, timestep
43549110b2e7SHong Zhang @*/
43559110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
43569110b2e7SHong Zhang {
43579110b2e7SHong Zhang   PetscErrorCode ierr;
43589110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
43599110b2e7SHong Zhang 
43609110b2e7SHong Zhang   PetscFunctionBegin;
43619110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
43629110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
43639110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
43649110b2e7SHong Zhang   for (i=0; i<n; i++) {
43659110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
43669110b2e7SHong Zhang   }
43679110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
43689110b2e7SHong Zhang   PetscFunctionReturn(0);
43699110b2e7SHong Zhang }
43709110b2e7SHong Zhang 
4371d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
4372d763cef2SBarry Smith /*@C
43737db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4374a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
4375d763cef2SBarry Smith 
4376d763cef2SBarry Smith    Collective on TS
4377d763cef2SBarry Smith 
4378d763cef2SBarry Smith    Input Parameters:
4379d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
4380d763cef2SBarry Smith .  label - the title to put in the title bar
43817c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
4382a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
4383a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4384d763cef2SBarry Smith 
4385d763cef2SBarry Smith    Output Parameter:
43860b039ecaSBarry Smith .  ctx - the context
4387d763cef2SBarry Smith 
4388d763cef2SBarry Smith    Options Database Key:
43894f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
43907db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
43917db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
43927db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
43937db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4394b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4395d763cef2SBarry Smith 
4396d763cef2SBarry Smith    Notes:
4397a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
4398d763cef2SBarry Smith 
43997db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
44007db568b7SBarry Smith 
44017db568b7SBarry 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
44027db568b7SBarry 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
44037db568b7SBarry Smith    as the first argument.
44047db568b7SBarry Smith 
44057db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
44067db568b7SBarry Smith 
4407d763cef2SBarry Smith    Level: intermediate
4408d763cef2SBarry Smith 
44097db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
4410d763cef2SBarry Smith 
44117db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
44127db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
44137db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
44147db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
44157db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
44167c922b88SBarry Smith 
4417d763cef2SBarry Smith @*/
4418a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4419d763cef2SBarry Smith {
44207f52daa2SLisandro Dalcin   PetscDraw      draw;
4421dfbe8321SBarry Smith   PetscErrorCode ierr;
4422d763cef2SBarry Smith 
4423d763cef2SBarry Smith   PetscFunctionBegin;
4424b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
44257f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
44267f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
44277f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
4428287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
44297f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
4430a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
4431d763cef2SBarry Smith   PetscFunctionReturn(0);
4432d763cef2SBarry Smith }
4433d763cef2SBarry Smith 
4434b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4435d763cef2SBarry Smith {
44360b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4437c32365f1SBarry Smith   PetscReal      x   = ptime,y;
4438dfbe8321SBarry Smith   PetscErrorCode ierr;
4439d763cef2SBarry Smith 
4440d763cef2SBarry Smith   PetscFunctionBegin;
444163e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
4442b06615a5SLisandro Dalcin   if (!step) {
4443a9f9c1f6SBarry Smith     PetscDrawAxis axis;
4444a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
44456934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr);
4446a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4447a9f9c1f6SBarry Smith   }
4448c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
444908763aebSBarry Smith   y =  PetscLog10Real(y);
44500b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
4451b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
44520b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
44536934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
44543923b477SBarry Smith   }
4455d763cef2SBarry Smith   PetscFunctionReturn(0);
4456d763cef2SBarry Smith }
4457d763cef2SBarry Smith 
4458d763cef2SBarry Smith /*@C
4459a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4460a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
4461d763cef2SBarry Smith 
44620b039ecaSBarry Smith    Collective on TSMonitorLGCtx
4463d763cef2SBarry Smith 
4464d763cef2SBarry Smith    Input Parameter:
44650b039ecaSBarry Smith .  ctx - the monitor context
4466d763cef2SBarry Smith 
4467d763cef2SBarry Smith    Level: intermediate
4468d763cef2SBarry Smith 
4469d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
4470d763cef2SBarry Smith 
44714f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
4472d763cef2SBarry Smith @*/
4473a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4474d763cef2SBarry Smith {
4475dfbe8321SBarry Smith   PetscErrorCode ierr;
4476d763cef2SBarry Smith 
4477d763cef2SBarry Smith   PetscFunctionBegin;
44787684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
44797684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
44807684fa3eSBarry Smith   }
44810b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
448231152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
4483387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
4484387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
4485387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
44860b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
4487d763cef2SBarry Smith   PetscFunctionReturn(0);
4488d763cef2SBarry Smith }
4489d763cef2SBarry Smith 
4490d763cef2SBarry Smith /*@
4491b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4492d763cef2SBarry Smith 
4493d763cef2SBarry Smith    Not Collective
4494d763cef2SBarry Smith 
4495d763cef2SBarry Smith    Input Parameter:
4496d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4497d763cef2SBarry Smith 
4498d763cef2SBarry Smith    Output Parameter:
449963e21af5SBarry Smith .  t  - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime().
4500d763cef2SBarry Smith 
4501d763cef2SBarry Smith    Level: beginner
4502d763cef2SBarry Smith 
4503b8123daeSJed Brown    Note:
4504b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
45059be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4506b8123daeSJed Brown 
450763e21af5SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime()
4508d763cef2SBarry Smith 
4509d763cef2SBarry Smith .keywords: TS, get, time
4510d763cef2SBarry Smith @*/
45117087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4512d763cef2SBarry Smith {
4513d763cef2SBarry Smith   PetscFunctionBegin;
45140700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4515f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4516d763cef2SBarry Smith   *t = ts->ptime;
4517d763cef2SBarry Smith   PetscFunctionReturn(0);
4518d763cef2SBarry Smith }
4519d763cef2SBarry Smith 
4520e5e524a1SHong Zhang /*@
4521e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4522e5e524a1SHong Zhang 
4523e5e524a1SHong Zhang    Not Collective
4524e5e524a1SHong Zhang 
4525e5e524a1SHong Zhang    Input Parameter:
4526e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4527e5e524a1SHong Zhang 
4528e5e524a1SHong Zhang    Output Parameter:
4529e5e524a1SHong Zhang .  t  - the previous time
4530e5e524a1SHong Zhang 
4531e5e524a1SHong Zhang    Level: beginner
4532e5e524a1SHong Zhang 
4533e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
4534e5e524a1SHong Zhang 
4535e5e524a1SHong Zhang .keywords: TS, get, time
4536e5e524a1SHong Zhang @*/
4537e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4538e5e524a1SHong Zhang {
4539e5e524a1SHong Zhang   PetscFunctionBegin;
4540e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4541e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4542e5e524a1SHong Zhang   *t = ts->ptime_prev;
4543e5e524a1SHong Zhang   PetscFunctionReturn(0);
4544e5e524a1SHong Zhang }
4545e5e524a1SHong Zhang 
45466a4d4014SLisandro Dalcin /*@
45476a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
45486a4d4014SLisandro Dalcin 
45493f9fe445SBarry Smith    Logically Collective on TS
45506a4d4014SLisandro Dalcin 
45516a4d4014SLisandro Dalcin    Input Parameters:
45526a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
45536a4d4014SLisandro Dalcin -  time - the time
45546a4d4014SLisandro Dalcin 
45556a4d4014SLisandro Dalcin    Level: intermediate
45566a4d4014SLisandro Dalcin 
45576a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
45586a4d4014SLisandro Dalcin 
45596a4d4014SLisandro Dalcin .keywords: TS, set, time
45606a4d4014SLisandro Dalcin @*/
45617087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
45626a4d4014SLisandro Dalcin {
45636a4d4014SLisandro Dalcin   PetscFunctionBegin;
45640700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4565c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
45666a4d4014SLisandro Dalcin   ts->ptime = t;
45676a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
45686a4d4014SLisandro Dalcin }
45696a4d4014SLisandro Dalcin 
4570d763cef2SBarry Smith /*@C
4571d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4572d763cef2SBarry Smith    TS options in the database.
4573d763cef2SBarry Smith 
45743f9fe445SBarry Smith    Logically Collective on TS
4575d763cef2SBarry Smith 
4576d763cef2SBarry Smith    Input Parameter:
4577d763cef2SBarry Smith +  ts     - The TS context
4578d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4579d763cef2SBarry Smith 
4580d763cef2SBarry Smith    Notes:
4581d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4582d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4583d763cef2SBarry Smith    hyphen.
4584d763cef2SBarry Smith 
4585d763cef2SBarry Smith    Level: advanced
4586d763cef2SBarry Smith 
4587d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
4588d763cef2SBarry Smith 
4589d763cef2SBarry Smith .seealso: TSSetFromOptions()
4590d763cef2SBarry Smith 
4591d763cef2SBarry Smith @*/
45927087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4593d763cef2SBarry Smith {
4594dfbe8321SBarry Smith   PetscErrorCode ierr;
4595089b2837SJed Brown   SNES           snes;
4596d763cef2SBarry Smith 
4597d763cef2SBarry Smith   PetscFunctionBegin;
45980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4599d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4600089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4601089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4602d763cef2SBarry Smith   PetscFunctionReturn(0);
4603d763cef2SBarry Smith }
4604d763cef2SBarry Smith 
4605d763cef2SBarry Smith /*@C
4606d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4607d763cef2SBarry Smith    TS options in the database.
4608d763cef2SBarry Smith 
46093f9fe445SBarry Smith    Logically Collective on TS
4610d763cef2SBarry Smith 
4611d763cef2SBarry Smith    Input Parameter:
4612d763cef2SBarry Smith +  ts     - The TS context
4613d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4614d763cef2SBarry Smith 
4615d763cef2SBarry Smith    Notes:
4616d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4617d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4618d763cef2SBarry Smith    hyphen.
4619d763cef2SBarry Smith 
4620d763cef2SBarry Smith    Level: advanced
4621d763cef2SBarry Smith 
4622d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
4623d763cef2SBarry Smith 
4624d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4625d763cef2SBarry Smith 
4626d763cef2SBarry Smith @*/
46277087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4628d763cef2SBarry Smith {
4629dfbe8321SBarry Smith   PetscErrorCode ierr;
4630089b2837SJed Brown   SNES           snes;
4631d763cef2SBarry Smith 
4632d763cef2SBarry Smith   PetscFunctionBegin;
46330700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4634d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4635089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4636089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4637d763cef2SBarry Smith   PetscFunctionReturn(0);
4638d763cef2SBarry Smith }
4639d763cef2SBarry Smith 
4640d763cef2SBarry Smith /*@C
4641d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4642d763cef2SBarry Smith    TS options in the database.
4643d763cef2SBarry Smith 
4644d763cef2SBarry Smith    Not Collective
4645d763cef2SBarry Smith 
4646d763cef2SBarry Smith    Input Parameter:
4647d763cef2SBarry Smith .  ts - The TS context
4648d763cef2SBarry Smith 
4649d763cef2SBarry Smith    Output Parameter:
4650d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4651d763cef2SBarry Smith 
4652d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
4653d763cef2SBarry Smith    sufficient length to hold the prefix.
4654d763cef2SBarry Smith 
4655d763cef2SBarry Smith    Level: intermediate
4656d763cef2SBarry Smith 
4657d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
4658d763cef2SBarry Smith 
4659d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4660d763cef2SBarry Smith @*/
46617087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4662d763cef2SBarry Smith {
4663dfbe8321SBarry Smith   PetscErrorCode ierr;
4664d763cef2SBarry Smith 
4665d763cef2SBarry Smith   PetscFunctionBegin;
46660700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
46674482741eSBarry Smith   PetscValidPointer(prefix,2);
4668d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4669d763cef2SBarry Smith   PetscFunctionReturn(0);
4670d763cef2SBarry Smith }
4671d763cef2SBarry Smith 
4672d763cef2SBarry Smith /*@C
4673d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4674d763cef2SBarry Smith 
4675d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4676d763cef2SBarry Smith 
4677d763cef2SBarry Smith    Input Parameter:
4678d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4679d763cef2SBarry Smith 
4680d763cef2SBarry Smith    Output Parameters:
4681e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4682e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4683e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4684e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4685d763cef2SBarry Smith 
46860298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
4687d763cef2SBarry Smith 
4688d763cef2SBarry Smith    Level: intermediate
4689d763cef2SBarry Smith 
469026d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
4691d763cef2SBarry Smith 
4692d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
4693d763cef2SBarry Smith @*/
4694e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4695d763cef2SBarry Smith {
4696089b2837SJed Brown   PetscErrorCode ierr;
469724989b8cSPeter Brune   DM             dm;
4698089b2837SJed Brown 
4699d763cef2SBarry Smith   PetscFunctionBegin;
470023a57915SBarry Smith   if (Amat || Pmat) {
470123a57915SBarry Smith     SNES snes;
4702089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
470323a57915SBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4704e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
470523a57915SBarry Smith   }
470624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
470724989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4708d763cef2SBarry Smith   PetscFunctionReturn(0);
4709d763cef2SBarry Smith }
4710d763cef2SBarry Smith 
47112eca1d9cSJed Brown /*@C
47122eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
47132eca1d9cSJed Brown 
47142eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
47152eca1d9cSJed Brown 
47162eca1d9cSJed Brown    Input Parameter:
47172eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
47182eca1d9cSJed Brown 
47192eca1d9cSJed Brown    Output Parameters:
4720e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4721e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
47222eca1d9cSJed Brown .  f   - The function to compute the matrices
47232eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
47242eca1d9cSJed Brown 
47250298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
47262eca1d9cSJed Brown 
47272eca1d9cSJed Brown    Level: advanced
47282eca1d9cSJed Brown 
47292eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
47302eca1d9cSJed Brown 
47312eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
47322eca1d9cSJed Brown @*/
4733e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
47342eca1d9cSJed Brown {
4735089b2837SJed Brown   PetscErrorCode ierr;
473624989b8cSPeter Brune   DM             dm;
47370910c330SBarry Smith 
47382eca1d9cSJed Brown   PetscFunctionBegin;
4739c0aab802Sstefano_zampini   if (Amat || Pmat) {
4740c0aab802Sstefano_zampini     SNES snes;
4741089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4742f7d39f7aSBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4743e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
4744c0aab802Sstefano_zampini   }
474524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
474624989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
47472eca1d9cSJed Brown   PetscFunctionReturn(0);
47482eca1d9cSJed Brown }
47492eca1d9cSJed Brown 
47501713a123SBarry Smith /*@C
475183a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
47521713a123SBarry Smith    VecView() for the solution at each timestep
47531713a123SBarry Smith 
47541713a123SBarry Smith    Collective on TS
47551713a123SBarry Smith 
47561713a123SBarry Smith    Input Parameters:
47571713a123SBarry Smith +  ts - the TS context
47581713a123SBarry Smith .  step - current time-step
4759142b95e3SSatish Balay .  ptime - current time
47600298fd71SBarry Smith -  dummy - either a viewer or NULL
47611713a123SBarry Smith 
476299fdda47SBarry Smith    Options Database:
476399fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
476499fdda47SBarry Smith 
4765387f4636SBarry 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
476699fdda47SBarry Smith        will look bad
476799fdda47SBarry Smith 
47681713a123SBarry Smith    Level: intermediate
47691713a123SBarry Smith 
47701713a123SBarry Smith .keywords: TS,  vector, monitor, view
47711713a123SBarry Smith 
4772a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
47731713a123SBarry Smith @*/
47740910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
47751713a123SBarry Smith {
4776dfbe8321SBarry Smith   PetscErrorCode   ierr;
477783a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4778473a3ab2SBarry Smith   PetscDraw        draw;
47791713a123SBarry Smith 
47801713a123SBarry Smith   PetscFunctionBegin;
47816083293cSBarry Smith   if (!step && ictx->showinitial) {
47826083293cSBarry Smith     if (!ictx->initialsolution) {
47830910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
47841713a123SBarry Smith     }
47850910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
47866083293cSBarry Smith   }
4787b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
47880dcf80beSBarry Smith 
47896083293cSBarry Smith   if (ictx->showinitial) {
47906083293cSBarry Smith     PetscReal pause;
47916083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
47926083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
47936083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
47946083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
47956083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
47966083293cSBarry Smith   }
47970910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4798473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
479951fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4800473a3ab2SBarry Smith     char      time[32];
4801473a3ab2SBarry Smith 
4802473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
480385b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4804473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4805473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
480651fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4807473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4808473a3ab2SBarry Smith   }
4809473a3ab2SBarry Smith 
48106083293cSBarry Smith   if (ictx->showinitial) {
48116083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
48126083293cSBarry Smith   }
48131713a123SBarry Smith   PetscFunctionReturn(0);
48141713a123SBarry Smith }
48151713a123SBarry Smith 
48169110b2e7SHong Zhang /*@C
48179110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
48189110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
48199110b2e7SHong Zhang 
48209110b2e7SHong Zhang    Collective on TS
48219110b2e7SHong Zhang 
48229110b2e7SHong Zhang    Input Parameters:
48239110b2e7SHong Zhang +  ts - the TS context
48249110b2e7SHong Zhang .  step - current time-step
48259110b2e7SHong Zhang .  ptime - current time
48269110b2e7SHong Zhang .  u - current state
48279110b2e7SHong Zhang .  numcost - number of cost functions
48289110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
48299110b2e7SHong Zhang .  mu - sensitivities to parameters
48309110b2e7SHong Zhang -  dummy - either a viewer or NULL
48319110b2e7SHong Zhang 
48329110b2e7SHong Zhang    Level: intermediate
48339110b2e7SHong Zhang 
48349110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
48359110b2e7SHong Zhang 
48369110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
48379110b2e7SHong Zhang @*/
48389110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
48399110b2e7SHong Zhang {
48409110b2e7SHong Zhang   PetscErrorCode   ierr;
48419110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
48429110b2e7SHong Zhang   PetscDraw        draw;
4843a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
4844a0046e2cSSatish Balay   char             time[32];
48459110b2e7SHong Zhang 
48469110b2e7SHong Zhang   PetscFunctionBegin;
48479110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
48489110b2e7SHong Zhang 
48499110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
48509110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
48519110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
48529110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
48539110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
48549110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
48559110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
48569110b2e7SHong Zhang   PetscFunctionReturn(0);
48579110b2e7SHong Zhang }
48589110b2e7SHong Zhang 
48592d5ee99bSBarry Smith /*@C
48602d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
48612d5ee99bSBarry Smith 
48622d5ee99bSBarry Smith    Collective on TS
48632d5ee99bSBarry Smith 
48642d5ee99bSBarry Smith    Input Parameters:
48652d5ee99bSBarry Smith +  ts - the TS context
48662d5ee99bSBarry Smith .  step - current time-step
48672d5ee99bSBarry Smith .  ptime - current time
48682d5ee99bSBarry Smith -  dummy - either a viewer or NULL
48692d5ee99bSBarry Smith 
48702d5ee99bSBarry Smith    Level: intermediate
48712d5ee99bSBarry Smith 
48722d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
48732d5ee99bSBarry Smith 
48742d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
48752d5ee99bSBarry Smith @*/
48762d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
48772d5ee99bSBarry Smith {
48782d5ee99bSBarry Smith   PetscErrorCode    ierr;
48792d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
48802d5ee99bSBarry Smith   PetscDraw         draw;
48816934998bSLisandro Dalcin   PetscDrawAxis     axis;
48822d5ee99bSBarry Smith   PetscInt          n;
48832d5ee99bSBarry Smith   PetscMPIInt       size;
48846934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
48852d5ee99bSBarry Smith   char              time[32];
48862d5ee99bSBarry Smith   const PetscScalar *U;
48872d5ee99bSBarry Smith 
48882d5ee99bSBarry Smith   PetscFunctionBegin;
48896934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
48906934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
48912d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
48926934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
48932d5ee99bSBarry Smith 
48942d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
48956934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
48966934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
48976934998bSLisandro Dalcin   if (!step) {
48986934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
48996934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
49006934998bSLisandro Dalcin   }
49012d5ee99bSBarry Smith 
49022d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
49036934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
49046934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
4905a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
49066934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
49072d5ee99bSBarry Smith 
49086934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
49096934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
49102d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
49114b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
491285b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
49132d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
491451fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
49152d5ee99bSBarry Smith   }
49166934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
49172d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
491856d62c8fSLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
49196934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
49202d5ee99bSBarry Smith   PetscFunctionReturn(0);
49212d5ee99bSBarry Smith }
49222d5ee99bSBarry Smith 
49236083293cSBarry Smith /*@C
492483a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
49256083293cSBarry Smith 
49266083293cSBarry Smith    Collective on TS
49276083293cSBarry Smith 
49286083293cSBarry Smith    Input Parameters:
49296083293cSBarry Smith .    ctx - the monitor context
49306083293cSBarry Smith 
49316083293cSBarry Smith    Level: intermediate
49326083293cSBarry Smith 
49336083293cSBarry Smith .keywords: TS,  vector, monitor, view
49346083293cSBarry Smith 
493583a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
49366083293cSBarry Smith @*/
493783a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
49386083293cSBarry Smith {
49396083293cSBarry Smith   PetscErrorCode ierr;
49406083293cSBarry Smith 
49416083293cSBarry Smith   PetscFunctionBegin;
494283a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
494383a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
494483a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
49456083293cSBarry Smith   PetscFunctionReturn(0);
49466083293cSBarry Smith }
49476083293cSBarry Smith 
49486083293cSBarry Smith /*@C
494983a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
49506083293cSBarry Smith 
49516083293cSBarry Smith    Collective on TS
49526083293cSBarry Smith 
49536083293cSBarry Smith    Input Parameter:
49546083293cSBarry Smith .    ts - time-step context
49556083293cSBarry Smith 
49566083293cSBarry Smith    Output Patameter:
49576083293cSBarry Smith .    ctx - the monitor context
49586083293cSBarry Smith 
495999fdda47SBarry Smith    Options Database:
496099fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
496199fdda47SBarry Smith 
49626083293cSBarry Smith    Level: intermediate
49636083293cSBarry Smith 
49646083293cSBarry Smith .keywords: TS,  vector, monitor, view
49656083293cSBarry Smith 
496683a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
49676083293cSBarry Smith @*/
496883a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
49696083293cSBarry Smith {
49706083293cSBarry Smith   PetscErrorCode   ierr;
49716083293cSBarry Smith 
49726083293cSBarry Smith   PetscFunctionBegin;
4973b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
497483a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4975e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4976bbd56ea5SKarl Rupp 
497783a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4978473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
4979c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4980473a3ab2SBarry Smith 
4981473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
4982c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
49836083293cSBarry Smith   PetscFunctionReturn(0);
49846083293cSBarry Smith }
49856083293cSBarry Smith 
49863a471f94SBarry Smith /*@C
498783a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
49883a471f94SBarry Smith    VecView() for the error at each timestep
49893a471f94SBarry Smith 
49903a471f94SBarry Smith    Collective on TS
49913a471f94SBarry Smith 
49923a471f94SBarry Smith    Input Parameters:
49933a471f94SBarry Smith +  ts - the TS context
49943a471f94SBarry Smith .  step - current time-step
49953a471f94SBarry Smith .  ptime - current time
49960298fd71SBarry Smith -  dummy - either a viewer or NULL
49973a471f94SBarry Smith 
49983a471f94SBarry Smith    Level: intermediate
49993a471f94SBarry Smith 
50003a471f94SBarry Smith .keywords: TS,  vector, monitor, view
50013a471f94SBarry Smith 
50023a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
50033a471f94SBarry Smith @*/
50040910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
50053a471f94SBarry Smith {
50063a471f94SBarry Smith   PetscErrorCode   ierr;
500783a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
500883a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
50093a471f94SBarry Smith   Vec              work;
50103a471f94SBarry Smith 
50113a471f94SBarry Smith   PetscFunctionBegin;
5012b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
50130910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
50143a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
50150910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
50163a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
50173a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
50183a471f94SBarry Smith   PetscFunctionReturn(0);
50193a471f94SBarry Smith }
50203a471f94SBarry Smith 
5021af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
50226c699258SBarry Smith /*@
50232a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
50246c699258SBarry Smith 
50253f9fe445SBarry Smith    Logically Collective on TS and DM
50266c699258SBarry Smith 
50276c699258SBarry Smith    Input Parameters:
50282a808120SBarry Smith +  ts - the ODE integrator object
50292a808120SBarry Smith -  dm - the dm, cannot be NULL
50306c699258SBarry Smith 
50316c699258SBarry Smith    Level: intermediate
50326c699258SBarry Smith 
50336c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
50346c699258SBarry Smith @*/
50357087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
50366c699258SBarry Smith {
50376c699258SBarry Smith   PetscErrorCode ierr;
5038089b2837SJed Brown   SNES           snes;
5039942e3340SBarry Smith   DMTS           tsdm;
50406c699258SBarry Smith 
50416c699258SBarry Smith   PetscFunctionBegin;
50420700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
50432a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
504470663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
5045942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
50462a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
5047942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
5048942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
504924989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
505024989b8cSPeter Brune         tsdm->originaldm = dm;
505124989b8cSPeter Brune       }
505224989b8cSPeter Brune     }
50536bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
505424989b8cSPeter Brune   }
50556c699258SBarry Smith   ts->dm = dm;
5056bbd56ea5SKarl Rupp 
5057089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5058089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
50596c699258SBarry Smith   PetscFunctionReturn(0);
50606c699258SBarry Smith }
50616c699258SBarry Smith 
50626c699258SBarry Smith /*@
50636c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
50646c699258SBarry Smith 
50653f9fe445SBarry Smith    Not Collective
50666c699258SBarry Smith 
50676c699258SBarry Smith    Input Parameter:
50686c699258SBarry Smith . ts - the preconditioner context
50696c699258SBarry Smith 
50706c699258SBarry Smith    Output Parameter:
50716c699258SBarry Smith .  dm - the dm
50726c699258SBarry Smith 
50736c699258SBarry Smith    Level: intermediate
50746c699258SBarry Smith 
50756c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
50766c699258SBarry Smith @*/
50777087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
50786c699258SBarry Smith {
5079496e6a7aSJed Brown   PetscErrorCode ierr;
5080496e6a7aSJed Brown 
50816c699258SBarry Smith   PetscFunctionBegin;
50820700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5083496e6a7aSJed Brown   if (!ts->dm) {
5084ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
5085496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
5086496e6a7aSJed Brown   }
50876c699258SBarry Smith   *dm = ts->dm;
50886c699258SBarry Smith   PetscFunctionReturn(0);
50896c699258SBarry Smith }
50901713a123SBarry Smith 
50910f5c6efeSJed Brown /*@
50920f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
50930f5c6efeSJed Brown 
50943f9fe445SBarry Smith    Logically Collective on SNES
50950f5c6efeSJed Brown 
50960f5c6efeSJed Brown    Input Parameter:
5097d42a1c89SJed Brown + snes - nonlinear solver
50980910c330SBarry Smith . U - the current state at which to evaluate the residual
5099d42a1c89SJed Brown - ctx - user context, must be a TS
51000f5c6efeSJed Brown 
51010f5c6efeSJed Brown    Output Parameter:
51020f5c6efeSJed Brown . F - the nonlinear residual
51030f5c6efeSJed Brown 
51040f5c6efeSJed Brown    Notes:
51050f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
51060f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
51070f5c6efeSJed Brown 
51080f5c6efeSJed Brown    Level: advanced
51090f5c6efeSJed Brown 
51100f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
51110f5c6efeSJed Brown @*/
51120910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
51130f5c6efeSJed Brown {
51140f5c6efeSJed Brown   TS             ts = (TS)ctx;
51150f5c6efeSJed Brown   PetscErrorCode ierr;
51160f5c6efeSJed Brown 
51170f5c6efeSJed Brown   PetscFunctionBegin;
51180f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
51190910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
51200f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
51210f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
51220910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
51230f5c6efeSJed Brown   PetscFunctionReturn(0);
51240f5c6efeSJed Brown }
51250f5c6efeSJed Brown 
51260f5c6efeSJed Brown /*@
51270f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
51280f5c6efeSJed Brown 
51290f5c6efeSJed Brown    Collective on SNES
51300f5c6efeSJed Brown 
51310f5c6efeSJed Brown    Input Parameter:
51320f5c6efeSJed Brown + snes - nonlinear solver
51330910c330SBarry Smith . U - the current state at which to evaluate the residual
51340f5c6efeSJed Brown - ctx - user context, must be a TS
51350f5c6efeSJed Brown 
51360f5c6efeSJed Brown    Output Parameter:
51370f5c6efeSJed Brown + A - the Jacobian
51380f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
51390f5c6efeSJed Brown - flag - indicates any structure change in the matrix
51400f5c6efeSJed Brown 
51410f5c6efeSJed Brown    Notes:
51420f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
51430f5c6efeSJed Brown 
51440f5c6efeSJed Brown    Level: developer
51450f5c6efeSJed Brown 
51460f5c6efeSJed Brown .seealso: SNESSetJacobian()
51470f5c6efeSJed Brown @*/
5148d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
51490f5c6efeSJed Brown {
51500f5c6efeSJed Brown   TS             ts = (TS)ctx;
51510f5c6efeSJed Brown   PetscErrorCode ierr;
51520f5c6efeSJed Brown 
51530f5c6efeSJed Brown   PetscFunctionBegin;
51540f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
51550910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
51560f5c6efeSJed Brown   PetscValidPointer(A,3);
515794ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
51580f5c6efeSJed Brown   PetscValidPointer(B,4);
515994ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
51600f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
5161d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
51620f5c6efeSJed Brown   PetscFunctionReturn(0);
51630f5c6efeSJed Brown }
5164325fc9f4SBarry Smith 
51650e4ef248SJed Brown /*@C
51669ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
51670e4ef248SJed Brown 
51680e4ef248SJed Brown    Collective on TS
51690e4ef248SJed Brown 
51700e4ef248SJed Brown    Input Arguments:
51710e4ef248SJed Brown +  ts - time stepping context
51720e4ef248SJed Brown .  t - time at which to evaluate
51730910c330SBarry Smith .  U - state at which to evaluate
51740e4ef248SJed Brown -  ctx - context
51750e4ef248SJed Brown 
51760e4ef248SJed Brown    Output Arguments:
51770e4ef248SJed Brown .  F - right hand side
51780e4ef248SJed Brown 
51790e4ef248SJed Brown    Level: intermediate
51800e4ef248SJed Brown 
51810e4ef248SJed Brown    Notes:
51820e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
51830e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
51840e4ef248SJed Brown 
51850e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
51860e4ef248SJed Brown @*/
51870910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
51880e4ef248SJed Brown {
51890e4ef248SJed Brown   PetscErrorCode ierr;
51900e4ef248SJed Brown   Mat            Arhs,Brhs;
51910e4ef248SJed Brown 
51920e4ef248SJed Brown   PetscFunctionBegin;
51930e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
5194d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
51950910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
51960e4ef248SJed Brown   PetscFunctionReturn(0);
51970e4ef248SJed Brown }
51980e4ef248SJed Brown 
51990e4ef248SJed Brown /*@C
52000e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
52010e4ef248SJed Brown 
52020e4ef248SJed Brown    Collective on TS
52030e4ef248SJed Brown 
52040e4ef248SJed Brown    Input Arguments:
52050e4ef248SJed Brown +  ts - time stepping context
52060e4ef248SJed Brown .  t - time at which to evaluate
52070910c330SBarry Smith .  U - state at which to evaluate
52080e4ef248SJed Brown -  ctx - context
52090e4ef248SJed Brown 
52100e4ef248SJed Brown    Output Arguments:
52110e4ef248SJed Brown +  A - pointer to operator
52120e4ef248SJed Brown .  B - pointer to preconditioning matrix
52130e4ef248SJed Brown -  flg - matrix structure flag
52140e4ef248SJed Brown 
52150e4ef248SJed Brown    Level: intermediate
52160e4ef248SJed Brown 
52170e4ef248SJed Brown    Notes:
52180e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
52190e4ef248SJed Brown 
52200e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
52210e4ef248SJed Brown @*/
5222d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
52230e4ef248SJed Brown {
52240e4ef248SJed Brown   PetscFunctionBegin;
52250e4ef248SJed Brown   PetscFunctionReturn(0);
52260e4ef248SJed Brown }
52270e4ef248SJed Brown 
52280026cea9SSean Farley /*@C
52290026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
52300026cea9SSean Farley 
52310026cea9SSean Farley    Collective on TS
52320026cea9SSean Farley 
52330026cea9SSean Farley    Input Arguments:
52340026cea9SSean Farley +  ts - time stepping context
52350026cea9SSean Farley .  t - time at which to evaluate
52360910c330SBarry Smith .  U - state at which to evaluate
52370910c330SBarry Smith .  Udot - time derivative of state vector
52380026cea9SSean Farley -  ctx - context
52390026cea9SSean Farley 
52400026cea9SSean Farley    Output Arguments:
52410026cea9SSean Farley .  F - left hand side
52420026cea9SSean Farley 
52430026cea9SSean Farley    Level: intermediate
52440026cea9SSean Farley 
52450026cea9SSean Farley    Notes:
52460910c330SBarry 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
52470026cea9SSean Farley    user is required to write their own TSComputeIFunction.
52480026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
52490026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
52500026cea9SSean Farley 
52519ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
52529ae8fd06SBarry Smith 
52539ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
52540026cea9SSean Farley @*/
52550910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
52560026cea9SSean Farley {
52570026cea9SSean Farley   PetscErrorCode ierr;
52580026cea9SSean Farley   Mat            A,B;
52590026cea9SSean Farley 
52600026cea9SSean Farley   PetscFunctionBegin;
52610298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
5262d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
52630910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
52640026cea9SSean Farley   PetscFunctionReturn(0);
52650026cea9SSean Farley }
52660026cea9SSean Farley 
52670026cea9SSean Farley /*@C
5268b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
52690026cea9SSean Farley 
52700026cea9SSean Farley    Collective on TS
52710026cea9SSean Farley 
52720026cea9SSean Farley    Input Arguments:
52730026cea9SSean Farley +  ts - time stepping context
52740026cea9SSean Farley .  t - time at which to evaluate
52750910c330SBarry Smith .  U - state at which to evaluate
52760910c330SBarry Smith .  Udot - time derivative of state vector
52770026cea9SSean Farley .  shift - shift to apply
52780026cea9SSean Farley -  ctx - context
52790026cea9SSean Farley 
52800026cea9SSean Farley    Output Arguments:
52810026cea9SSean Farley +  A - pointer to operator
52820026cea9SSean Farley .  B - pointer to preconditioning matrix
52830026cea9SSean Farley -  flg - matrix structure flag
52840026cea9SSean Farley 
5285b41af12eSJed Brown    Level: advanced
52860026cea9SSean Farley 
52870026cea9SSean Farley    Notes:
52880026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
52890026cea9SSean Farley 
5290b41af12eSJed Brown    It is only appropriate for problems of the form
5291b41af12eSJed Brown 
5292b41af12eSJed Brown $     M Udot = F(U,t)
5293b41af12eSJed Brown 
5294b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
5295b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5296b41af12eSJed Brown   an implicit operator of the form
5297b41af12eSJed Brown 
5298b41af12eSJed Brown $    shift*M + J
5299b41af12eSJed Brown 
5300b41af12eSJed 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
5301b41af12eSJed Brown   a copy of M or reassemble it when requested.
5302b41af12eSJed Brown 
53030026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
53040026cea9SSean Farley @*/
5305d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
53060026cea9SSean Farley {
5307b41af12eSJed Brown   PetscErrorCode ierr;
5308b41af12eSJed Brown 
53090026cea9SSean Farley   PetscFunctionBegin;
531094ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
5311b41af12eSJed Brown   ts->ijacobian.shift = shift;
53120026cea9SSean Farley   PetscFunctionReturn(0);
53130026cea9SSean Farley }
5314b41af12eSJed Brown 
5315e817cc15SEmil Constantinescu /*@
5316e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
5317e817cc15SEmil Constantinescu 
5318e817cc15SEmil Constantinescu    Not Collective
5319e817cc15SEmil Constantinescu 
5320e817cc15SEmil Constantinescu    Input Parameter:
5321e817cc15SEmil Constantinescu .  ts - the TS context
5322e817cc15SEmil Constantinescu 
5323e817cc15SEmil Constantinescu    Output Parameter:
53244e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
5325e817cc15SEmil Constantinescu 
5326e817cc15SEmil Constantinescu    Level: beginner
5327e817cc15SEmil Constantinescu 
5328e817cc15SEmil Constantinescu .keywords: TS, equation type
5329e817cc15SEmil Constantinescu 
5330e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
5331e817cc15SEmil Constantinescu @*/
5332e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
5333e817cc15SEmil Constantinescu {
5334e817cc15SEmil Constantinescu   PetscFunctionBegin;
5335e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5336e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
5337e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
5338e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5339e817cc15SEmil Constantinescu }
5340e817cc15SEmil Constantinescu 
5341e817cc15SEmil Constantinescu /*@
5342e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
5343e817cc15SEmil Constantinescu 
5344e817cc15SEmil Constantinescu    Not Collective
5345e817cc15SEmil Constantinescu 
5346e817cc15SEmil Constantinescu    Input Parameter:
5347e817cc15SEmil Constantinescu +  ts - the TS context
53481297b224SEmil Constantinescu -  equation_type - see TSEquationType
5349e817cc15SEmil Constantinescu 
5350e817cc15SEmil Constantinescu    Level: advanced
5351e817cc15SEmil Constantinescu 
5352e817cc15SEmil Constantinescu .keywords: TS, equation type
5353e817cc15SEmil Constantinescu 
5354e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
5355e817cc15SEmil Constantinescu @*/
5356e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
5357e817cc15SEmil Constantinescu {
5358e817cc15SEmil Constantinescu   PetscFunctionBegin;
5359e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5360e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
5361e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5362e817cc15SEmil Constantinescu }
53630026cea9SSean Farley 
53644af1b03aSJed Brown /*@
53654af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
53664af1b03aSJed Brown 
53674af1b03aSJed Brown    Not Collective
53684af1b03aSJed Brown 
53694af1b03aSJed Brown    Input Parameter:
53704af1b03aSJed Brown .  ts - the TS context
53714af1b03aSJed Brown 
53724af1b03aSJed Brown    Output Parameter:
53734af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
53744af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
53754af1b03aSJed Brown 
5376487e0bb9SJed Brown    Level: beginner
53774af1b03aSJed Brown 
5378cd652676SJed Brown    Notes:
5379cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
53804af1b03aSJed Brown 
53814af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
53824af1b03aSJed Brown 
53834af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
53844af1b03aSJed Brown @*/
53854af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
53864af1b03aSJed Brown {
53874af1b03aSJed Brown   PetscFunctionBegin;
53884af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53894af1b03aSJed Brown   PetscValidPointer(reason,2);
53904af1b03aSJed Brown   *reason = ts->reason;
53914af1b03aSJed Brown   PetscFunctionReturn(0);
53924af1b03aSJed Brown }
53934af1b03aSJed Brown 
5394d6ad946cSShri Abhyankar /*@
5395d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5396d6ad946cSShri Abhyankar 
5397d6ad946cSShri Abhyankar    Not Collective
5398d6ad946cSShri Abhyankar 
5399d6ad946cSShri Abhyankar    Input Parameter:
5400d6ad946cSShri Abhyankar +  ts - the TS context
5401d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5402d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
5403d6ad946cSShri Abhyankar 
5404f5abba47SShri Abhyankar    Level: advanced
5405d6ad946cSShri Abhyankar 
5406d6ad946cSShri Abhyankar    Notes:
5407d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
5408d6ad946cSShri Abhyankar 
5409d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
5410d6ad946cSShri Abhyankar 
5411d6ad946cSShri Abhyankar .seealso: TSConvergedReason
5412d6ad946cSShri Abhyankar @*/
5413d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
5414d6ad946cSShri Abhyankar {
5415d6ad946cSShri Abhyankar   PetscFunctionBegin;
5416d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5417d6ad946cSShri Abhyankar   ts->reason = reason;
5418d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
5419d6ad946cSShri Abhyankar }
5420d6ad946cSShri Abhyankar 
5421cc708dedSBarry Smith /*@
5422cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
5423cc708dedSBarry Smith 
5424cc708dedSBarry Smith    Not Collective
5425cc708dedSBarry Smith 
5426cc708dedSBarry Smith    Input Parameter:
5427cc708dedSBarry Smith .  ts - the TS context
5428cc708dedSBarry Smith 
5429cc708dedSBarry Smith    Output Parameter:
543063e21af5SBarry Smith .  ftime - the final time. This time corresponds to the final time set with TSSetDuration()
5431cc708dedSBarry Smith 
5432487e0bb9SJed Brown    Level: beginner
5433cc708dedSBarry Smith 
5434cc708dedSBarry Smith    Notes:
5435cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
5436cc708dedSBarry Smith 
5437cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
5438cc708dedSBarry Smith 
5439cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
5440cc708dedSBarry Smith @*/
5441cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
5442cc708dedSBarry Smith {
5443cc708dedSBarry Smith   PetscFunctionBegin;
5444cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5445cc708dedSBarry Smith   PetscValidPointer(ftime,2);
5446cc708dedSBarry Smith   *ftime = ts->solvetime;
5447cc708dedSBarry Smith   PetscFunctionReturn(0);
5448cc708dedSBarry Smith }
5449cc708dedSBarry Smith 
54502c18e0fdSBarry Smith /*@
54512c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
54522c18e0fdSBarry Smith 
54532c18e0fdSBarry Smith    Not Collective
54542c18e0fdSBarry Smith 
54552c18e0fdSBarry Smith    Input Parameter:
54562c18e0fdSBarry Smith .  ts - the TS context
54572c18e0fdSBarry Smith 
54582c18e0fdSBarry Smith    Output Parameter:
54592c18e0fdSBarry Smith .  steps - the number of steps
54602c18e0fdSBarry Smith 
54612c18e0fdSBarry Smith    Level: beginner
54622c18e0fdSBarry Smith 
54632c18e0fdSBarry Smith    Notes:
54642c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
54652c18e0fdSBarry Smith 
54662c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
54672c18e0fdSBarry Smith 
54682c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
54692c18e0fdSBarry Smith @*/
54702c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
54712c18e0fdSBarry Smith {
54722c18e0fdSBarry Smith   PetscFunctionBegin;
54732c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
54742c18e0fdSBarry Smith   PetscValidPointer(steps,2);
54752c18e0fdSBarry Smith   *steps = ts->total_steps;
54762c18e0fdSBarry Smith   PetscFunctionReturn(0);
54772c18e0fdSBarry Smith }
54782c18e0fdSBarry Smith 
54799f67acb7SJed Brown /*@
54805ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
54819f67acb7SJed Brown    used by the time integrator.
54829f67acb7SJed Brown 
54839f67acb7SJed Brown    Not Collective
54849f67acb7SJed Brown 
54859f67acb7SJed Brown    Input Parameter:
54869f67acb7SJed Brown .  ts - TS context
54879f67acb7SJed Brown 
54889f67acb7SJed Brown    Output Parameter:
54899f67acb7SJed Brown .  nits - number of nonlinear iterations
54909f67acb7SJed Brown 
54919f67acb7SJed Brown    Notes:
54929f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
54939f67acb7SJed Brown 
54949f67acb7SJed Brown    Level: intermediate
54959f67acb7SJed Brown 
54969f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
54979f67acb7SJed Brown 
54985ef26d82SJed Brown .seealso:  TSGetKSPIterations()
54999f67acb7SJed Brown @*/
55005ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
55019f67acb7SJed Brown {
55029f67acb7SJed Brown   PetscFunctionBegin;
55039f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
55049f67acb7SJed Brown   PetscValidIntPointer(nits,2);
55055ef26d82SJed Brown   *nits = ts->snes_its;
55069f67acb7SJed Brown   PetscFunctionReturn(0);
55079f67acb7SJed Brown }
55089f67acb7SJed Brown 
55099f67acb7SJed Brown /*@
55105ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
55119f67acb7SJed Brown    used by the time integrator.
55129f67acb7SJed Brown 
55139f67acb7SJed Brown    Not Collective
55149f67acb7SJed Brown 
55159f67acb7SJed Brown    Input Parameter:
55169f67acb7SJed Brown .  ts - TS context
55179f67acb7SJed Brown 
55189f67acb7SJed Brown    Output Parameter:
55199f67acb7SJed Brown .  lits - number of linear iterations
55209f67acb7SJed Brown 
55219f67acb7SJed Brown    Notes:
55229f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
55239f67acb7SJed Brown 
55249f67acb7SJed Brown    Level: intermediate
55259f67acb7SJed Brown 
55269f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
55279f67acb7SJed Brown 
55285ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
55299f67acb7SJed Brown @*/
55305ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
55319f67acb7SJed Brown {
55329f67acb7SJed Brown   PetscFunctionBegin;
55339f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
55349f67acb7SJed Brown   PetscValidIntPointer(lits,2);
55355ef26d82SJed Brown   *lits = ts->ksp_its;
55369f67acb7SJed Brown   PetscFunctionReturn(0);
55379f67acb7SJed Brown }
55389f67acb7SJed Brown 
5539cef5090cSJed Brown /*@
5540cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5541cef5090cSJed Brown 
5542cef5090cSJed Brown    Not Collective
5543cef5090cSJed Brown 
5544cef5090cSJed Brown    Input Parameter:
5545cef5090cSJed Brown .  ts - TS context
5546cef5090cSJed Brown 
5547cef5090cSJed Brown    Output Parameter:
5548cef5090cSJed Brown .  rejects - number of steps rejected
5549cef5090cSJed Brown 
5550cef5090cSJed Brown    Notes:
5551cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5552cef5090cSJed Brown 
5553cef5090cSJed Brown    Level: intermediate
5554cef5090cSJed Brown 
5555cef5090cSJed Brown .keywords: TS, get, number
5556cef5090cSJed Brown 
55575ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5558cef5090cSJed Brown @*/
5559cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5560cef5090cSJed Brown {
5561cef5090cSJed Brown   PetscFunctionBegin;
5562cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5563cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5564cef5090cSJed Brown   *rejects = ts->reject;
5565cef5090cSJed Brown   PetscFunctionReturn(0);
5566cef5090cSJed Brown }
5567cef5090cSJed Brown 
5568cef5090cSJed Brown /*@
5569cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5570cef5090cSJed Brown 
5571cef5090cSJed Brown    Not Collective
5572cef5090cSJed Brown 
5573cef5090cSJed Brown    Input Parameter:
5574cef5090cSJed Brown .  ts - TS context
5575cef5090cSJed Brown 
5576cef5090cSJed Brown    Output Parameter:
5577cef5090cSJed Brown .  fails - number of failed nonlinear solves
5578cef5090cSJed Brown 
5579cef5090cSJed Brown    Notes:
5580cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5581cef5090cSJed Brown 
5582cef5090cSJed Brown    Level: intermediate
5583cef5090cSJed Brown 
5584cef5090cSJed Brown .keywords: TS, get, number
5585cef5090cSJed Brown 
55865ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5587cef5090cSJed Brown @*/
5588cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5589cef5090cSJed Brown {
5590cef5090cSJed Brown   PetscFunctionBegin;
5591cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5592cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5593cef5090cSJed Brown   *fails = ts->num_snes_failures;
5594cef5090cSJed Brown   PetscFunctionReturn(0);
5595cef5090cSJed Brown }
5596cef5090cSJed Brown 
5597cef5090cSJed Brown /*@
5598cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5599cef5090cSJed Brown 
5600cef5090cSJed Brown    Not Collective
5601cef5090cSJed Brown 
5602cef5090cSJed Brown    Input Parameter:
5603cef5090cSJed Brown +  ts - TS context
5604cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5605cef5090cSJed Brown 
5606cef5090cSJed Brown    Notes:
5607cef5090cSJed Brown    The counter is reset to zero for each step
5608cef5090cSJed Brown 
5609cef5090cSJed Brown    Options Database Key:
5610cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5611cef5090cSJed Brown 
5612cef5090cSJed Brown    Level: intermediate
5613cef5090cSJed Brown 
5614cef5090cSJed Brown .keywords: TS, set, maximum, number
5615cef5090cSJed Brown 
56165ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5617cef5090cSJed Brown @*/
5618cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5619cef5090cSJed Brown {
5620cef5090cSJed Brown   PetscFunctionBegin;
5621cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5622cef5090cSJed Brown   ts->max_reject = rejects;
5623cef5090cSJed Brown   PetscFunctionReturn(0);
5624cef5090cSJed Brown }
5625cef5090cSJed Brown 
5626cef5090cSJed Brown /*@
5627cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5628cef5090cSJed Brown 
5629cef5090cSJed Brown    Not Collective
5630cef5090cSJed Brown 
5631cef5090cSJed Brown    Input Parameter:
5632cef5090cSJed Brown +  ts - TS context
5633cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5634cef5090cSJed Brown 
5635cef5090cSJed Brown    Notes:
5636cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5637cef5090cSJed Brown 
5638cef5090cSJed Brown    Options Database Key:
5639cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5640cef5090cSJed Brown 
5641cef5090cSJed Brown    Level: intermediate
5642cef5090cSJed Brown 
5643cef5090cSJed Brown .keywords: TS, set, maximum, number
5644cef5090cSJed Brown 
56455ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5646cef5090cSJed Brown @*/
5647cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5648cef5090cSJed Brown {
5649cef5090cSJed Brown   PetscFunctionBegin;
5650cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5651cef5090cSJed Brown   ts->max_snes_failures = fails;
5652cef5090cSJed Brown   PetscFunctionReturn(0);
5653cef5090cSJed Brown }
5654cef5090cSJed Brown 
5655cef5090cSJed Brown /*@
5656cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5657cef5090cSJed Brown 
5658cef5090cSJed Brown    Not Collective
5659cef5090cSJed Brown 
5660cef5090cSJed Brown    Input Parameter:
5661cef5090cSJed Brown +  ts - TS context
5662cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5663cef5090cSJed Brown 
5664cef5090cSJed Brown    Options Database Key:
5665cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5666cef5090cSJed Brown 
5667cef5090cSJed Brown    Level: intermediate
5668cef5090cSJed Brown 
5669cef5090cSJed Brown .keywords: TS, set, error
5670cef5090cSJed Brown 
56715ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5672cef5090cSJed Brown @*/
5673cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5674cef5090cSJed Brown {
5675cef5090cSJed Brown   PetscFunctionBegin;
5676cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5677cef5090cSJed Brown   ts->errorifstepfailed = err;
5678cef5090cSJed Brown   PetscFunctionReturn(0);
5679cef5090cSJed Brown }
5680cef5090cSJed Brown 
5681fb1732b5SBarry Smith /*@C
5682fde5950dSBarry 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
5683fb1732b5SBarry Smith 
5684fb1732b5SBarry Smith    Collective on TS
5685fb1732b5SBarry Smith 
5686fb1732b5SBarry Smith    Input Parameters:
5687fb1732b5SBarry Smith +  ts - the TS context
5688fb1732b5SBarry Smith .  step - current time-step
5689fb1732b5SBarry Smith .  ptime - current time
56900910c330SBarry Smith .  u - current state
5691721cd6eeSBarry Smith -  vf - viewer and its format
5692fb1732b5SBarry Smith 
5693fb1732b5SBarry Smith    Level: intermediate
5694fb1732b5SBarry Smith 
5695fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
5696fb1732b5SBarry Smith 
5697fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5698fb1732b5SBarry Smith @*/
5699721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5700fb1732b5SBarry Smith {
5701fb1732b5SBarry Smith   PetscErrorCode ierr;
5702fb1732b5SBarry Smith 
5703fb1732b5SBarry Smith   PetscFunctionBegin;
5704721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5705721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5706721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5707ed81e22dSJed Brown   PetscFunctionReturn(0);
5708ed81e22dSJed Brown }
5709ed81e22dSJed Brown 
5710ed81e22dSJed Brown /*@C
5711ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5712ed81e22dSJed Brown 
5713ed81e22dSJed Brown    Collective on TS
5714ed81e22dSJed Brown 
5715ed81e22dSJed Brown    Input Parameters:
5716ed81e22dSJed Brown +  ts - the TS context
5717ed81e22dSJed Brown .  step - current time-step
5718ed81e22dSJed Brown .  ptime - current time
57190910c330SBarry Smith .  u - current state
5720ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5721ed81e22dSJed Brown 
5722ed81e22dSJed Brown    Level: intermediate
5723ed81e22dSJed Brown 
5724ed81e22dSJed Brown    Notes:
5725ed81e22dSJed 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.
5726ed81e22dSJed Brown    These are named according to the file name template.
5727ed81e22dSJed Brown 
5728ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5729ed81e22dSJed Brown 
5730ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5731ed81e22dSJed Brown 
5732ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5733ed81e22dSJed Brown @*/
57340910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5735ed81e22dSJed Brown {
5736ed81e22dSJed Brown   PetscErrorCode ierr;
5737ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5738ed81e22dSJed Brown   PetscViewer    viewer;
5739ed81e22dSJed Brown 
5740ed81e22dSJed Brown   PetscFunctionBegin;
574163e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
57428caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5743ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
57440910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5745ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5746ed81e22dSJed Brown   PetscFunctionReturn(0);
5747ed81e22dSJed Brown }
5748ed81e22dSJed Brown 
5749ed81e22dSJed Brown /*@C
5750ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5751ed81e22dSJed Brown 
5752ed81e22dSJed Brown    Collective on TS
5753ed81e22dSJed Brown 
5754ed81e22dSJed Brown    Input Parameters:
5755ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5756ed81e22dSJed Brown 
5757ed81e22dSJed Brown    Level: intermediate
5758ed81e22dSJed Brown 
5759ed81e22dSJed Brown    Note:
5760ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5761ed81e22dSJed Brown 
5762ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5763ed81e22dSJed Brown 
5764ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5765ed81e22dSJed Brown @*/
5766ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5767ed81e22dSJed Brown {
5768ed81e22dSJed Brown   PetscErrorCode ierr;
5769ed81e22dSJed Brown 
5770ed81e22dSJed Brown   PetscFunctionBegin;
5771ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5772fb1732b5SBarry Smith   PetscFunctionReturn(0);
5773fb1732b5SBarry Smith }
5774fb1732b5SBarry Smith 
577584df9cb4SJed Brown /*@
5776552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
577784df9cb4SJed Brown 
5778ed81e22dSJed Brown    Collective on TS if controller has not been created yet
577984df9cb4SJed Brown 
578084df9cb4SJed Brown    Input Arguments:
5781ed81e22dSJed Brown .  ts - time stepping context
578284df9cb4SJed Brown 
578384df9cb4SJed Brown    Output Arguments:
5784ed81e22dSJed Brown .  adapt - adaptive controller
578584df9cb4SJed Brown 
578684df9cb4SJed Brown    Level: intermediate
578784df9cb4SJed Brown 
5788ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
578984df9cb4SJed Brown @*/
5790552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
579184df9cb4SJed Brown {
579284df9cb4SJed Brown   PetscErrorCode ierr;
579384df9cb4SJed Brown 
579484df9cb4SJed Brown   PetscFunctionBegin;
579584df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5796bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
579784df9cb4SJed Brown   if (!ts->adapt) {
5798ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
57993bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
58001c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
580184df9cb4SJed Brown   }
5802bec58848SLisandro Dalcin   *adapt = ts->adapt;
580384df9cb4SJed Brown   PetscFunctionReturn(0);
580484df9cb4SJed Brown }
5805d6ebe24aSShri Abhyankar 
58061c3436cfSJed Brown /*@
58071c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
58081c3436cfSJed Brown 
58091c3436cfSJed Brown    Logically Collective
58101c3436cfSJed Brown 
58111c3436cfSJed Brown    Input Arguments:
58121c3436cfSJed Brown +  ts - time integration context
58131c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
58140298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
58151c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
58160298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
58171c3436cfSJed Brown 
5818a3cdaa26SBarry Smith    Options Database keys:
5819a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5820a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5821a3cdaa26SBarry Smith 
58223ff766beSShri Abhyankar    Notes:
58233ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
58243ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
58253ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
58263ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
58273ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
58283ff766beSShri Abhyankar    differential variables.
58293ff766beSShri Abhyankar 
58301c3436cfSJed Brown    Level: beginner
58311c3436cfSJed Brown 
5832c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
58331c3436cfSJed Brown @*/
58341c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
58351c3436cfSJed Brown {
58361c3436cfSJed Brown   PetscErrorCode ierr;
58371c3436cfSJed Brown 
58381c3436cfSJed Brown   PetscFunctionBegin;
5839c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
58401c3436cfSJed Brown   if (vatol) {
58411c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
58421c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
58431c3436cfSJed Brown     ts->vatol = vatol;
58441c3436cfSJed Brown   }
5845c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
58461c3436cfSJed Brown   if (vrtol) {
58471c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
58481c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
58491c3436cfSJed Brown     ts->vrtol = vrtol;
58501c3436cfSJed Brown   }
58511c3436cfSJed Brown   PetscFunctionReturn(0);
58521c3436cfSJed Brown }
58531c3436cfSJed Brown 
5854c5033834SJed Brown /*@
5855c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5856c5033834SJed Brown 
5857c5033834SJed Brown    Logically Collective
5858c5033834SJed Brown 
5859c5033834SJed Brown    Input Arguments:
5860c5033834SJed Brown .  ts - time integration context
5861c5033834SJed Brown 
5862c5033834SJed Brown    Output Arguments:
58630298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
58640298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
58650298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
58660298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5867c5033834SJed Brown 
5868c5033834SJed Brown    Level: beginner
5869c5033834SJed Brown 
5870c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5871c5033834SJed Brown @*/
5872c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5873c5033834SJed Brown {
5874c5033834SJed Brown   PetscFunctionBegin;
5875c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5876c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5877c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5878c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5879c5033834SJed Brown   PetscFunctionReturn(0);
5880c5033834SJed Brown }
5881c5033834SJed Brown 
58829c6b16b5SShri Abhyankar /*@
5883a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
58849c6b16b5SShri Abhyankar 
58859c6b16b5SShri Abhyankar    Collective on TS
58869c6b16b5SShri Abhyankar 
58879c6b16b5SShri Abhyankar    Input Arguments:
58889c6b16b5SShri Abhyankar +  ts - time stepping context
5889a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5890a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
58919c6b16b5SShri Abhyankar 
58929c6b16b5SShri Abhyankar    Output Arguments:
58937453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
58947453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
58957453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
58969c6b16b5SShri Abhyankar 
58979c6b16b5SShri Abhyankar    Level: developer
58989c6b16b5SShri Abhyankar 
5899deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
59009c6b16b5SShri Abhyankar @*/
59017453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
59029c6b16b5SShri Abhyankar {
59039c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
59049c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
59057453f775SEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
59067453f775SEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
59079c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
59087453f775SEmil Constantinescu   PetscReal         sum,suma,sumr,gsum,gsuma,gsumr,diff;
59097453f775SEmil Constantinescu   PetscReal         tol,tola,tolr;
59107453f775SEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
59119c6b16b5SShri Abhyankar 
59129c6b16b5SShri Abhyankar   PetscFunctionBegin;
59139c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5914a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5915a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5916a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5917a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5918a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5919a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
59208a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
59218a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
5922a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
59239c6b16b5SShri Abhyankar 
59249c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
59259c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
59269c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
59279c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
59289c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
59297453f775SEmil Constantinescu   sum  = 0.; n_loc  = 0;
59307453f775SEmil Constantinescu   suma = 0.; na_loc = 0;
59317453f775SEmil Constantinescu   sumr = 0.; nr_loc = 0;
59329c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
59339c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
59349c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59359c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59369c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
59377453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59387453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
59397453f775SEmil Constantinescu       if(tola>0.){
59407453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
59417453f775SEmil Constantinescu         na_loc++;
59427453f775SEmil Constantinescu       }
59437453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59447453f775SEmil Constantinescu       if(tolr>0.){
59457453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
59467453f775SEmil Constantinescu         nr_loc++;
59477453f775SEmil Constantinescu       }
59487453f775SEmil Constantinescu       tol=tola+tolr;
59497453f775SEmil Constantinescu       if(tol>0.){
59507453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
59517453f775SEmil Constantinescu         n_loc++;
59527453f775SEmil Constantinescu       }
59539c6b16b5SShri Abhyankar     }
59549c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59559c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59569c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
59579c6b16b5SShri Abhyankar     const PetscScalar *atol;
59589c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59599c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
59607453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59617453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
59627453f775SEmil Constantinescu       if(tola>0.){
59637453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
59647453f775SEmil Constantinescu         na_loc++;
59657453f775SEmil Constantinescu       }
59667453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59677453f775SEmil Constantinescu       if(tolr>0.){
59687453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
59697453f775SEmil Constantinescu         nr_loc++;
59707453f775SEmil Constantinescu       }
59717453f775SEmil Constantinescu       tol=tola+tolr;
59727453f775SEmil Constantinescu       if(tol>0.){
59737453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
59747453f775SEmil Constantinescu         n_loc++;
59757453f775SEmil Constantinescu       }
59769c6b16b5SShri Abhyankar     }
59779c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59789c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
59799c6b16b5SShri Abhyankar     const PetscScalar *rtol;
59809c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59819c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
59827453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
59837453f775SEmil Constantinescu       tola = ts->atol;
59847453f775SEmil Constantinescu       if(tola>0.){
59857453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
59867453f775SEmil Constantinescu         na_loc++;
59877453f775SEmil Constantinescu       }
59887453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59897453f775SEmil Constantinescu       if(tolr>0.){
59907453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
59917453f775SEmil Constantinescu         nr_loc++;
59927453f775SEmil Constantinescu       }
59937453f775SEmil Constantinescu       tol=tola+tolr;
59947453f775SEmil Constantinescu       if(tol>0.){
59957453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
59967453f775SEmil Constantinescu         n_loc++;
59977453f775SEmil Constantinescu       }
59989c6b16b5SShri Abhyankar     }
59999c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60009c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
60019c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
60027453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
60037453f775SEmil Constantinescu      tola = ts->atol;
60047453f775SEmil Constantinescu       if(tola>0.){
60057453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
60067453f775SEmil Constantinescu         na_loc++;
60077453f775SEmil Constantinescu       }
60087453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60097453f775SEmil Constantinescu       if(tolr>0.){
60107453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
60117453f775SEmil Constantinescu         nr_loc++;
60127453f775SEmil Constantinescu       }
60137453f775SEmil Constantinescu       tol=tola+tolr;
60147453f775SEmil Constantinescu       if(tol>0.){
60157453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
60167453f775SEmil Constantinescu         n_loc++;
60177453f775SEmil Constantinescu       }
60189c6b16b5SShri Abhyankar     }
60199c6b16b5SShri Abhyankar   }
60209c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
60219c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
60229c6b16b5SShri Abhyankar 
60237453f775SEmil Constantinescu   err_loc[0] = sum;
60247453f775SEmil Constantinescu   err_loc[1] = suma;
60257453f775SEmil Constantinescu   err_loc[2] = sumr;
60267453f775SEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
60277453f775SEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
60287453f775SEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
60297453f775SEmil Constantinescu 
6030a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
60317453f775SEmil Constantinescu 
60327453f775SEmil Constantinescu   gsum   = err_glb[0];
60337453f775SEmil Constantinescu   gsuma  = err_glb[1];
60347453f775SEmil Constantinescu   gsumr  = err_glb[2];
60357453f775SEmil Constantinescu   n_glb  = err_glb[3];
60367453f775SEmil Constantinescu   na_glb = err_glb[4];
60377453f775SEmil Constantinescu   nr_glb = err_glb[5];
60387453f775SEmil Constantinescu 
6039b1316ef9SEmil Constantinescu   *norm  = 0.;
6040b1316ef9SEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
6041b1316ef9SEmil Constantinescu   *norma = 0.;
6042b1316ef9SEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
6043b1316ef9SEmil Constantinescu   *normr = 0.;
6044b1316ef9SEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
60459c6b16b5SShri Abhyankar 
60469c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
60477453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
60487453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
60499c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
60509c6b16b5SShri Abhyankar }
60519c6b16b5SShri Abhyankar 
60529c6b16b5SShri Abhyankar /*@
6053a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
60549c6b16b5SShri Abhyankar 
60559c6b16b5SShri Abhyankar    Collective on TS
60569c6b16b5SShri Abhyankar 
60579c6b16b5SShri Abhyankar    Input Arguments:
60589c6b16b5SShri Abhyankar +  ts - time stepping context
6059a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6060a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
60619c6b16b5SShri Abhyankar 
60629c6b16b5SShri Abhyankar    Output Arguments:
60637453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
60647453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
60657453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
60669c6b16b5SShri Abhyankar 
60679c6b16b5SShri Abhyankar    Level: developer
60689c6b16b5SShri Abhyankar 
6069deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
60709c6b16b5SShri Abhyankar @*/
60717453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
60729c6b16b5SShri Abhyankar {
60739c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
60747453f775SEmil Constantinescu   PetscInt          i,n,N,rstart;
60759c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
60767453f775SEmil Constantinescu   PetscReal         max,gmax,maxa,gmaxa,maxr,gmaxr;
60777453f775SEmil Constantinescu   PetscReal         tol,tola,tolr,diff;
60787453f775SEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
60799c6b16b5SShri Abhyankar 
60809c6b16b5SShri Abhyankar   PetscFunctionBegin;
60819c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6082a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
6083a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
6084a4868fbcSLisandro Dalcin   PetscValidType(U,2);
6085a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
6086a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
6087a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
60888a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
60898a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
6090a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
60919c6b16b5SShri Abhyankar 
60929c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
60939c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
60949c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
60959c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
60969c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
60977453f775SEmil Constantinescu 
60987453f775SEmil Constantinescu   max=0.;
60997453f775SEmil Constantinescu   maxa=0.;
61007453f775SEmil Constantinescu   maxr=0.;
61017453f775SEmil Constantinescu 
61027453f775SEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
61039c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
61049c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61059c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61067453f775SEmil Constantinescu 
61077453f775SEmil Constantinescu     for (i=0; i<n; i++) {
61087453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
61097453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
61107453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61117453f775SEmil Constantinescu       tol  = tola+tolr;
61127453f775SEmil Constantinescu       if(tola>0.){
61137453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
61147453f775SEmil Constantinescu       }
61157453f775SEmil Constantinescu       if(tolr>0.){
61167453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
61177453f775SEmil Constantinescu       }
61187453f775SEmil Constantinescu       if(tol>0.){
61197453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
61207453f775SEmil Constantinescu       }
61219c6b16b5SShri Abhyankar     }
61229c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61239c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61249c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
61259c6b16b5SShri Abhyankar     const PetscScalar *atol;
61269c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61277453f775SEmil Constantinescu     for (i=0; i<n; i++) {
61287453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
61297453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
61307453f775SEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61317453f775SEmil Constantinescu       tol  = tola+tolr;
61327453f775SEmil Constantinescu       if(tola>0.){
61337453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
61347453f775SEmil Constantinescu       }
61357453f775SEmil Constantinescu       if(tolr>0.){
61367453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
61377453f775SEmil Constantinescu       }
61387453f775SEmil Constantinescu       if(tol>0.){
61397453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
61407453f775SEmil Constantinescu       }
61419c6b16b5SShri Abhyankar     }
61429c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61439c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
61449c6b16b5SShri Abhyankar     const PetscScalar *rtol;
61459c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61467453f775SEmil Constantinescu 
61477453f775SEmil Constantinescu     for (i=0; i<n; i++) {
61487453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
61497453f775SEmil Constantinescu       tola = ts->atol;
61507453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61517453f775SEmil Constantinescu       tol  = tola+tolr;
61527453f775SEmil Constantinescu       if(tola>0.){
61537453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
61547453f775SEmil Constantinescu       }
61557453f775SEmil Constantinescu       if(tolr>0.){
61567453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
61577453f775SEmil Constantinescu       }
61587453f775SEmil Constantinescu       if(tol>0.){
61597453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
61607453f775SEmil Constantinescu       }
61619c6b16b5SShri Abhyankar     }
61629c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61639c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
61647453f775SEmil Constantinescu 
61657453f775SEmil Constantinescu     for (i=0; i<n; i++) {
61667453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
61677453f775SEmil Constantinescu       tola = ts->atol;
61687453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61697453f775SEmil Constantinescu       tol  = tola+tolr;
61707453f775SEmil Constantinescu       if(tola>0.){
61717453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
61727453f775SEmil Constantinescu       }
61737453f775SEmil Constantinescu       if(tolr>0.){
61747453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
61757453f775SEmil Constantinescu       }
61767453f775SEmil Constantinescu       if(tol>0.){
61777453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
61787453f775SEmil Constantinescu       }
61799c6b16b5SShri Abhyankar     }
61809c6b16b5SShri Abhyankar   }
61819c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
61829c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
61837453f775SEmil Constantinescu   err_loc[0] = max;
61847453f775SEmil Constantinescu   err_loc[1] = maxa;
61857453f775SEmil Constantinescu   err_loc[2] = maxr;
6186a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
61877453f775SEmil Constantinescu   gmax   = err_glb[0];
61887453f775SEmil Constantinescu   gmaxa  = err_glb[1];
61897453f775SEmil Constantinescu   gmaxr  = err_glb[2];
61909c6b16b5SShri Abhyankar 
61919c6b16b5SShri Abhyankar   *norm = gmax;
61927453f775SEmil Constantinescu   *norma = gmaxa;
61937453f775SEmil Constantinescu   *normr = gmaxr;
61949c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
61957453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
61967453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
61979c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
61989c6b16b5SShri Abhyankar }
61999c6b16b5SShri Abhyankar 
62001c3436cfSJed Brown /*@
62018a175baeSEmil Constantinescu    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
62021c3436cfSJed Brown 
62031c3436cfSJed Brown    Collective on TS
62041c3436cfSJed Brown 
62051c3436cfSJed Brown    Input Arguments:
62061c3436cfSJed Brown +  ts - time stepping context
6207a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6208a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
6209a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
62107619abb3SShri 
62111c3436cfSJed Brown    Output Arguments:
62128a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
62138a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
62148a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
6215a4868fbcSLisandro Dalcin 
6216a4868fbcSLisandro Dalcin    Options Database Keys:
6217a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
6218a4868fbcSLisandro Dalcin 
62191c3436cfSJed Brown    Level: developer
62201c3436cfSJed Brown 
62218a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm
62221c3436cfSJed Brown @*/
62237453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
62241c3436cfSJed Brown {
62258beabaa1SBarry Smith   PetscErrorCode ierr;
62261c3436cfSJed Brown 
62271c3436cfSJed Brown   PetscFunctionBegin;
6228a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
62297453f775SEmil Constantinescu     ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6230a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
62317453f775SEmil Constantinescu     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6232a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
62331c3436cfSJed Brown   PetscFunctionReturn(0);
62341c3436cfSJed Brown }
62351c3436cfSJed Brown 
62368a175baeSEmil Constantinescu 
62378a175baeSEmil Constantinescu /*@
62388a175baeSEmil Constantinescu    TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances
62398a175baeSEmil Constantinescu 
62408a175baeSEmil Constantinescu    Collective on TS
62418a175baeSEmil Constantinescu 
62428a175baeSEmil Constantinescu    Input Arguments:
62438a175baeSEmil Constantinescu +  ts - time stepping context
62448a175baeSEmil Constantinescu .  E - error vector
62458a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
62468a175baeSEmil Constantinescu -  Y - state vector, previous time step
62478a175baeSEmil Constantinescu 
62488a175baeSEmil Constantinescu    Output Arguments:
62498a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
62508a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
62518a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
62528a175baeSEmil Constantinescu 
62538a175baeSEmil Constantinescu    Level: developer
62548a175baeSEmil Constantinescu 
62558a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity()
62568a175baeSEmil Constantinescu @*/
62578a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
62588a175baeSEmil Constantinescu {
62598a175baeSEmil Constantinescu   PetscErrorCode    ierr;
62608a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
62618a175baeSEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
62628a175baeSEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
62638a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
62648a175baeSEmil Constantinescu   PetscReal         err,sum,suma,sumr,gsum,gsuma,gsumr;
62658a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
62668a175baeSEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
62678a175baeSEmil Constantinescu 
62688a175baeSEmil Constantinescu   PetscFunctionBegin;
62698a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
62708a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
62718a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
62728a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
62738a175baeSEmil Constantinescu   PetscValidType(E,2);
62748a175baeSEmil Constantinescu   PetscValidType(U,3);
62758a175baeSEmil Constantinescu   PetscValidType(Y,4);
62768a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
62778a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
62788a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
62798a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
62808a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
62818a175baeSEmil Constantinescu 
62828a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
62838a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
62848a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
62858a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
62868a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
62878a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
62888a175baeSEmil Constantinescu   sum  = 0.; n_loc  = 0;
62898a175baeSEmil Constantinescu   suma = 0.; na_loc = 0;
62908a175baeSEmil Constantinescu   sumr = 0.; nr_loc = 0;
62918a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {
62928a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
62938a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
62948a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62958a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
62968a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
62978a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
62988a175baeSEmil Constantinescu       if(tola>0.){
62998a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
63008a175baeSEmil Constantinescu         na_loc++;
63018a175baeSEmil Constantinescu       }
63028a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63038a175baeSEmil Constantinescu       if(tolr>0.){
63048a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
63058a175baeSEmil Constantinescu         nr_loc++;
63068a175baeSEmil Constantinescu       }
63078a175baeSEmil Constantinescu       tol=tola+tolr;
63088a175baeSEmil Constantinescu       if(tol>0.){
63098a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
63108a175baeSEmil Constantinescu         n_loc++;
63118a175baeSEmil Constantinescu       }
63128a175baeSEmil Constantinescu     }
63138a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63148a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63158a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
63168a175baeSEmil Constantinescu     const PetscScalar *atol;
63178a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63188a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
63198a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63208a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
63218a175baeSEmil Constantinescu       if(tola>0.){
63228a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
63238a175baeSEmil Constantinescu         na_loc++;
63248a175baeSEmil Constantinescu       }
63258a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63268a175baeSEmil Constantinescu       if(tolr>0.){
63278a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
63288a175baeSEmil Constantinescu         nr_loc++;
63298a175baeSEmil Constantinescu       }
63308a175baeSEmil Constantinescu       tol=tola+tolr;
63318a175baeSEmil Constantinescu       if(tol>0.){
63328a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
63338a175baeSEmil Constantinescu         n_loc++;
63348a175baeSEmil Constantinescu       }
63358a175baeSEmil Constantinescu     }
63368a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
63378a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
63388a175baeSEmil Constantinescu     const PetscScalar *rtol;
63398a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63408a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
63418a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63428a175baeSEmil Constantinescu       tola = ts->atol;
63438a175baeSEmil Constantinescu       if(tola>0.){
63448a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
63458a175baeSEmil Constantinescu         na_loc++;
63468a175baeSEmil Constantinescu       }
63478a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63488a175baeSEmil Constantinescu       if(tolr>0.){
63498a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
63508a175baeSEmil Constantinescu         nr_loc++;
63518a175baeSEmil Constantinescu       }
63528a175baeSEmil Constantinescu       tol=tola+tolr;
63538a175baeSEmil Constantinescu       if(tol>0.){
63548a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
63558a175baeSEmil Constantinescu         n_loc++;
63568a175baeSEmil Constantinescu       }
63578a175baeSEmil Constantinescu     }
63588a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
63598a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
63608a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
63618a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
63628a175baeSEmil Constantinescu      tola = ts->atol;
63638a175baeSEmil Constantinescu       if(tola>0.){
63648a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
63658a175baeSEmil Constantinescu         na_loc++;
63668a175baeSEmil Constantinescu       }
63678a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
63688a175baeSEmil Constantinescu       if(tolr>0.){
63698a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
63708a175baeSEmil Constantinescu         nr_loc++;
63718a175baeSEmil Constantinescu       }
63728a175baeSEmil Constantinescu       tol=tola+tolr;
63738a175baeSEmil Constantinescu       if(tol>0.){
63748a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
63758a175baeSEmil Constantinescu         n_loc++;
63768a175baeSEmil Constantinescu       }
63778a175baeSEmil Constantinescu     }
63788a175baeSEmil Constantinescu   }
63798a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
63808a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
63818a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
63828a175baeSEmil Constantinescu 
63838a175baeSEmil Constantinescu   err_loc[0] = sum;
63848a175baeSEmil Constantinescu   err_loc[1] = suma;
63858a175baeSEmil Constantinescu   err_loc[2] = sumr;
63868a175baeSEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
63878a175baeSEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
63888a175baeSEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
63898a175baeSEmil Constantinescu 
6390a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
63918a175baeSEmil Constantinescu 
63928a175baeSEmil Constantinescu   gsum   = err_glb[0];
63938a175baeSEmil Constantinescu   gsuma  = err_glb[1];
63948a175baeSEmil Constantinescu   gsumr  = err_glb[2];
63958a175baeSEmil Constantinescu   n_glb  = err_glb[3];
63968a175baeSEmil Constantinescu   na_glb = err_glb[4];
63978a175baeSEmil Constantinescu   nr_glb = err_glb[5];
63988a175baeSEmil Constantinescu 
63998a175baeSEmil Constantinescu   *norm  = 0.;
64008a175baeSEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
64018a175baeSEmil Constantinescu   *norma = 0.;
64028a175baeSEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
64038a175baeSEmil Constantinescu   *normr = 0.;
64048a175baeSEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
64058a175baeSEmil Constantinescu 
64068a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
64078a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
64088a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
64098a175baeSEmil Constantinescu   PetscFunctionReturn(0);
64108a175baeSEmil Constantinescu }
64118a175baeSEmil Constantinescu 
64128a175baeSEmil Constantinescu /*@
64138a175baeSEmil Constantinescu    TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances
64148a175baeSEmil Constantinescu    Collective on TS
64158a175baeSEmil Constantinescu 
64168a175baeSEmil Constantinescu    Input Arguments:
64178a175baeSEmil Constantinescu +  ts - time stepping context
64188a175baeSEmil Constantinescu .  E - error vector
64198a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
64208a175baeSEmil Constantinescu -  Y - state vector, previous time step
64218a175baeSEmil Constantinescu 
64228a175baeSEmil Constantinescu    Output Arguments:
64238a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
64248a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
64258a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
64268a175baeSEmil Constantinescu 
64278a175baeSEmil Constantinescu    Level: developer
64288a175baeSEmil Constantinescu 
64298a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2()
64308a175baeSEmil Constantinescu @*/
64318a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
64328a175baeSEmil Constantinescu {
64338a175baeSEmil Constantinescu   PetscErrorCode    ierr;
64348a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
64358a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
64368a175baeSEmil Constantinescu   PetscReal         err,max,gmax,maxa,gmaxa,maxr,gmaxr;
64378a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
64388a175baeSEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
64398a175baeSEmil Constantinescu 
64408a175baeSEmil Constantinescu   PetscFunctionBegin;
64418a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
64428a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
64438a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
64448a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
64458a175baeSEmil Constantinescu   PetscValidType(E,2);
64468a175baeSEmil Constantinescu   PetscValidType(U,3);
64478a175baeSEmil Constantinescu   PetscValidType(Y,4);
64488a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
64498a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
64508a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
64518a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
64528a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
64538a175baeSEmil Constantinescu 
64548a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
64558a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
64568a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
64578a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
64588a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
64598a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
64608a175baeSEmil Constantinescu 
64618a175baeSEmil Constantinescu   max=0.;
64628a175baeSEmil Constantinescu   maxa=0.;
64638a175baeSEmil Constantinescu   maxr=0.;
64648a175baeSEmil Constantinescu 
64658a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
64668a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
64678a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
64688a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
64698a175baeSEmil Constantinescu 
64708a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
64718a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
64728a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
64738a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
64748a175baeSEmil Constantinescu       tol  = tola+tolr;
64758a175baeSEmil Constantinescu       if(tola>0.){
64768a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
64778a175baeSEmil Constantinescu       }
64788a175baeSEmil Constantinescu       if(tolr>0.){
64798a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
64808a175baeSEmil Constantinescu       }
64818a175baeSEmil Constantinescu       if(tol>0.){
64828a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
64838a175baeSEmil Constantinescu       }
64848a175baeSEmil Constantinescu     }
64858a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
64868a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
64878a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
64888a175baeSEmil Constantinescu     const PetscScalar *atol;
64898a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
64908a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
64918a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
64928a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
64938a175baeSEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
64948a175baeSEmil Constantinescu       tol  = tola+tolr;
64958a175baeSEmil Constantinescu       if(tola>0.){
64968a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
64978a175baeSEmil Constantinescu       }
64988a175baeSEmil Constantinescu       if(tolr>0.){
64998a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
65008a175baeSEmil Constantinescu       }
65018a175baeSEmil Constantinescu       if(tol>0.){
65028a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
65038a175baeSEmil Constantinescu       }
65048a175baeSEmil Constantinescu     }
65058a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65068a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
65078a175baeSEmil Constantinescu     const PetscScalar *rtol;
65088a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65098a175baeSEmil Constantinescu 
65108a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65118a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65128a175baeSEmil Constantinescu       tola = ts->atol;
65138a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65148a175baeSEmil Constantinescu       tol  = tola+tolr;
65158a175baeSEmil Constantinescu       if(tola>0.){
65168a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
65178a175baeSEmil Constantinescu       }
65188a175baeSEmil Constantinescu       if(tolr>0.){
65198a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
65208a175baeSEmil Constantinescu       }
65218a175baeSEmil Constantinescu       if(tol>0.){
65228a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
65238a175baeSEmil Constantinescu       }
65248a175baeSEmil Constantinescu     }
65258a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65268a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
65278a175baeSEmil Constantinescu 
65288a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65298a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65308a175baeSEmil Constantinescu       tola = ts->atol;
65318a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65328a175baeSEmil Constantinescu       tol  = tola+tolr;
65338a175baeSEmil Constantinescu       if(tola>0.){
65348a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
65358a175baeSEmil Constantinescu       }
65368a175baeSEmil Constantinescu       if(tolr>0.){
65378a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
65388a175baeSEmil Constantinescu       }
65398a175baeSEmil Constantinescu       if(tol>0.){
65408a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
65418a175baeSEmil Constantinescu       }
65428a175baeSEmil Constantinescu     }
65438a175baeSEmil Constantinescu   }
65448a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
65458a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
65468a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
65478a175baeSEmil Constantinescu   err_loc[0] = max;
65488a175baeSEmil Constantinescu   err_loc[1] = maxa;
65498a175baeSEmil Constantinescu   err_loc[2] = maxr;
6550a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
65518a175baeSEmil Constantinescu   gmax   = err_glb[0];
65528a175baeSEmil Constantinescu   gmaxa  = err_glb[1];
65538a175baeSEmil Constantinescu   gmaxr  = err_glb[2];
65548a175baeSEmil Constantinescu 
65558a175baeSEmil Constantinescu   *norm = gmax;
65568a175baeSEmil Constantinescu   *norma = gmaxa;
65578a175baeSEmil Constantinescu   *normr = gmaxr;
65588a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
65598a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
65608a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
65618a175baeSEmil Constantinescu   PetscFunctionReturn(0);
65628a175baeSEmil Constantinescu }
65638a175baeSEmil Constantinescu 
65648a175baeSEmil Constantinescu /*@
65658a175baeSEmil Constantinescu    TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
65668a175baeSEmil Constantinescu 
65678a175baeSEmil Constantinescu    Collective on TS
65688a175baeSEmil Constantinescu 
65698a175baeSEmil Constantinescu    Input Arguments:
65708a175baeSEmil Constantinescu +  ts - time stepping context
65718a175baeSEmil Constantinescu .  E - error vector
65728a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
65738a175baeSEmil Constantinescu .  Y - state vector, previous time step
65748a175baeSEmil Constantinescu -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
65758a175baeSEmil Constantinescu 
65768a175baeSEmil Constantinescu    Output Arguments:
65778a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
65788a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
65798a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
65808a175baeSEmil Constantinescu 
65818a175baeSEmil Constantinescu    Options Database Keys:
65828a175baeSEmil Constantinescu .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
65838a175baeSEmil Constantinescu 
65848a175baeSEmil Constantinescu    Level: developer
65858a175baeSEmil Constantinescu 
65868a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
65878a175baeSEmil Constantinescu @*/
65888a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
65898a175baeSEmil Constantinescu {
65908a175baeSEmil Constantinescu   PetscErrorCode ierr;
65918a175baeSEmil Constantinescu 
65928a175baeSEmil Constantinescu   PetscFunctionBegin;
65938a175baeSEmil Constantinescu   if (wnormtype == NORM_2) {
65948a175baeSEmil Constantinescu     ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
65958a175baeSEmil Constantinescu   } else if(wnormtype == NORM_INFINITY) {
65968a175baeSEmil Constantinescu     ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
65978a175baeSEmil Constantinescu   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
65988a175baeSEmil Constantinescu   PetscFunctionReturn(0);
65998a175baeSEmil Constantinescu }
66008a175baeSEmil Constantinescu 
66018a175baeSEmil Constantinescu 
66028d59e960SJed Brown /*@
66038d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
66048d59e960SJed Brown 
66058d59e960SJed Brown    Logically Collective on TS
66068d59e960SJed Brown 
66078d59e960SJed Brown    Input Arguments:
66088d59e960SJed Brown +  ts - time stepping context
66098d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
66108d59e960SJed Brown 
66118d59e960SJed Brown    Note:
66128d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
66138d59e960SJed Brown 
66148d59e960SJed Brown    Level: intermediate
66158d59e960SJed Brown 
66168d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
66178d59e960SJed Brown @*/
66188d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
66198d59e960SJed Brown {
66208d59e960SJed Brown   PetscFunctionBegin;
66218d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
66228d59e960SJed Brown   ts->cfltime_local = cfltime;
66238d59e960SJed Brown   ts->cfltime       = -1.;
66248d59e960SJed Brown   PetscFunctionReturn(0);
66258d59e960SJed Brown }
66268d59e960SJed Brown 
66278d59e960SJed Brown /*@
66288d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
66298d59e960SJed Brown 
66308d59e960SJed Brown    Collective on TS
66318d59e960SJed Brown 
66328d59e960SJed Brown    Input Arguments:
66338d59e960SJed Brown .  ts - time stepping context
66348d59e960SJed Brown 
66358d59e960SJed Brown    Output Arguments:
66368d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
66378d59e960SJed Brown 
66388d59e960SJed Brown    Level: advanced
66398d59e960SJed Brown 
66408d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
66418d59e960SJed Brown @*/
66428d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
66438d59e960SJed Brown {
66448d59e960SJed Brown   PetscErrorCode ierr;
66458d59e960SJed Brown 
66468d59e960SJed Brown   PetscFunctionBegin;
66478d59e960SJed Brown   if (ts->cfltime < 0) {
6648b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
66498d59e960SJed Brown   }
66508d59e960SJed Brown   *cfltime = ts->cfltime;
66518d59e960SJed Brown   PetscFunctionReturn(0);
66528d59e960SJed Brown }
66538d59e960SJed Brown 
6654d6ebe24aSShri Abhyankar /*@
6655d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6656d6ebe24aSShri Abhyankar 
6657d6ebe24aSShri Abhyankar    Input Parameters:
6658d6ebe24aSShri Abhyankar .  ts   - the TS context.
6659d6ebe24aSShri Abhyankar .  xl   - lower bound.
6660d6ebe24aSShri Abhyankar .  xu   - upper bound.
6661d6ebe24aSShri Abhyankar 
6662d6ebe24aSShri Abhyankar    Notes:
6663d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6664e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6665d6ebe24aSShri Abhyankar 
66662bd2b0e6SSatish Balay    Level: advanced
66672bd2b0e6SSatish Balay 
6668d6ebe24aSShri Abhyankar @*/
6669d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6670d6ebe24aSShri Abhyankar {
6671d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6672d6ebe24aSShri Abhyankar   SNES           snes;
6673d6ebe24aSShri Abhyankar 
6674d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6675d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6676d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6677d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6678d6ebe24aSShri Abhyankar }
6679d6ebe24aSShri Abhyankar 
6680325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
6681c6db04a5SJed Brown #include <mex.h>
6682325fc9f4SBarry Smith 
6683325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
6684325fc9f4SBarry Smith 
6685325fc9f4SBarry Smith /*
6686325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
6687325fc9f4SBarry Smith                          TSSetFunctionMatlab().
6688325fc9f4SBarry Smith 
6689325fc9f4SBarry Smith    Collective on TS
6690325fc9f4SBarry Smith 
6691325fc9f4SBarry Smith    Input Parameters:
6692325fc9f4SBarry Smith +  snes - the TS context
66930910c330SBarry Smith -  u - input vector
6694325fc9f4SBarry Smith 
6695325fc9f4SBarry Smith    Output Parameter:
6696325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
6697325fc9f4SBarry Smith 
6698325fc9f4SBarry Smith    Notes:
6699325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
6700325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
6701325fc9f4SBarry Smith    themselves.
6702325fc9f4SBarry Smith 
6703325fc9f4SBarry Smith    Level: developer
6704325fc9f4SBarry Smith 
6705325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6706325fc9f4SBarry Smith 
6707325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6708325fc9f4SBarry Smith */
67090910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
6710325fc9f4SBarry Smith {
6711325fc9f4SBarry Smith   PetscErrorCode  ierr;
6712325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6713325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
6714325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
6715325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
6716325fc9f4SBarry Smith 
6717325fc9f4SBarry Smith   PetscFunctionBegin;
6718325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
67190910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
67200910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
6721325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
67220910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
6723325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
6724325fc9f4SBarry Smith 
6725325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
67260910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
67270910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
67280910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
6729bbd56ea5SKarl Rupp 
6730325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6731325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
6732325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6733325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6734325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
6735325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
6736325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
6737325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
6738325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6739325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6740325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6741325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6742325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6743325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6744325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6745325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6746325fc9f4SBarry Smith   PetscFunctionReturn(0);
6747325fc9f4SBarry Smith }
6748325fc9f4SBarry Smith 
6749325fc9f4SBarry Smith /*
6750325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
6751325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
6752e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
6753325fc9f4SBarry Smith 
6754325fc9f4SBarry Smith    Logically Collective on TS
6755325fc9f4SBarry Smith 
6756325fc9f4SBarry Smith    Input Parameters:
6757325fc9f4SBarry Smith +  ts - the TS context
6758325fc9f4SBarry Smith -  func - function evaluation routine
6759325fc9f4SBarry Smith 
6760325fc9f4SBarry Smith    Calling sequence of func:
67610910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
6762325fc9f4SBarry Smith 
6763325fc9f4SBarry Smith    Level: beginner
6764325fc9f4SBarry Smith 
6765325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
6766325fc9f4SBarry Smith 
6767325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6768325fc9f4SBarry Smith */
6769cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
6770325fc9f4SBarry Smith {
6771325fc9f4SBarry Smith   PetscErrorCode  ierr;
6772325fc9f4SBarry Smith   TSMatlabContext *sctx;
6773325fc9f4SBarry Smith 
6774325fc9f4SBarry Smith   PetscFunctionBegin;
6775325fc9f4SBarry Smith   /* currently sctx is memory bleed */
677695dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
6777325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6778325fc9f4SBarry Smith   /*
6779325fc9f4SBarry Smith      This should work, but it doesn't
6780325fc9f4SBarry Smith   sctx->ctx = ctx;
6781325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6782325fc9f4SBarry Smith   */
6783325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6784bbd56ea5SKarl Rupp 
67850298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
6786325fc9f4SBarry Smith   PetscFunctionReturn(0);
6787325fc9f4SBarry Smith }
6788325fc9f4SBarry Smith 
6789325fc9f4SBarry Smith /*
6790325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
6791325fc9f4SBarry Smith                          TSSetJacobianMatlab().
6792325fc9f4SBarry Smith 
6793325fc9f4SBarry Smith    Collective on TS
6794325fc9f4SBarry Smith 
6795325fc9f4SBarry Smith    Input Parameters:
6796cdcf91faSSean Farley +  ts - the TS context
67970910c330SBarry Smith .  u - input vector
6798325fc9f4SBarry Smith .  A, B - the matrices
6799325fc9f4SBarry Smith -  ctx - user context
6800325fc9f4SBarry Smith 
6801325fc9f4SBarry Smith    Level: developer
6802325fc9f4SBarry Smith 
6803325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6804325fc9f4SBarry Smith 
6805325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6806325fc9f4SBarry Smith @*/
6807f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
6808325fc9f4SBarry Smith {
6809325fc9f4SBarry Smith   PetscErrorCode  ierr;
6810325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6811325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
6812325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
6813325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
6814325fc9f4SBarry Smith 
6815325fc9f4SBarry Smith   PetscFunctionBegin;
6816cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
68170910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
6818325fc9f4SBarry Smith 
68190910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
6820325fc9f4SBarry Smith 
6821cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
68220910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
68230910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
68240910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
68250910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
6826bbd56ea5SKarl Rupp 
6827325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6828325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
6829325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6830325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6831325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
6832325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
6833325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
6834325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
6835325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
6836325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
6837325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6838325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6839325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6840325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6841325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6842325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6843325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6844325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
6845325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
6846325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6847325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
6848325fc9f4SBarry Smith   PetscFunctionReturn(0);
6849325fc9f4SBarry Smith }
6850325fc9f4SBarry Smith 
6851325fc9f4SBarry Smith /*
6852325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
6853e3c5b3baSBarry 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
6854325fc9f4SBarry Smith 
6855325fc9f4SBarry Smith    Logically Collective on TS
6856325fc9f4SBarry Smith 
6857325fc9f4SBarry Smith    Input Parameters:
6858cdcf91faSSean Farley +  ts - the TS context
6859325fc9f4SBarry Smith .  A,B - Jacobian matrices
6860325fc9f4SBarry Smith .  func - function evaluation routine
6861325fc9f4SBarry Smith -  ctx - user context
6862325fc9f4SBarry Smith 
6863325fc9f4SBarry Smith    Calling sequence of func:
68640910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
6865325fc9f4SBarry Smith 
6866325fc9f4SBarry Smith    Level: developer
6867325fc9f4SBarry Smith 
6868325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
6869325fc9f4SBarry Smith 
6870325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6871325fc9f4SBarry Smith */
6872cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
6873325fc9f4SBarry Smith {
6874325fc9f4SBarry Smith   PetscErrorCode  ierr;
6875325fc9f4SBarry Smith   TSMatlabContext *sctx;
6876325fc9f4SBarry Smith 
6877325fc9f4SBarry Smith   PetscFunctionBegin;
6878325fc9f4SBarry Smith   /* currently sctx is memory bleed */
687995dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
6880325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6881325fc9f4SBarry Smith   /*
6882325fc9f4SBarry Smith      This should work, but it doesn't
6883325fc9f4SBarry Smith   sctx->ctx = ctx;
6884325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6885325fc9f4SBarry Smith   */
6886325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6887bbd56ea5SKarl Rupp 
6888cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
6889325fc9f4SBarry Smith   PetscFunctionReturn(0);
6890325fc9f4SBarry Smith }
6891325fc9f4SBarry Smith 
6892b5b1a830SBarry Smith /*
6893b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
6894b5b1a830SBarry Smith 
6895b5b1a830SBarry Smith    Collective on TS
6896b5b1a830SBarry Smith 
6897b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6898b5b1a830SBarry Smith @*/
68990910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
6900b5b1a830SBarry Smith {
6901b5b1a830SBarry Smith   PetscErrorCode  ierr;
6902b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6903a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
6904b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
6905b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
6906b5b1a830SBarry Smith 
6907b5b1a830SBarry Smith   PetscFunctionBegin;
6908cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
69090910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
6910b5b1a830SBarry Smith 
6911cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
69120910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
6913bbd56ea5SKarl Rupp 
6914b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6915b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
6916b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
6917b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
6918b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
6919b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
6920b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
6921b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6922b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
6923b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
6924b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
6925b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
6926b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
6927b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
6928b5b1a830SBarry Smith   PetscFunctionReturn(0);
6929b5b1a830SBarry Smith }
6930b5b1a830SBarry Smith 
6931b5b1a830SBarry Smith /*
6932b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
6933b5b1a830SBarry Smith 
6934b5b1a830SBarry Smith    Level: developer
6935b5b1a830SBarry Smith 
6936b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
6937b5b1a830SBarry Smith 
6938b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6939b5b1a830SBarry Smith */
6940cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
6941b5b1a830SBarry Smith {
6942b5b1a830SBarry Smith   PetscErrorCode  ierr;
6943b5b1a830SBarry Smith   TSMatlabContext *sctx;
6944b5b1a830SBarry Smith 
6945b5b1a830SBarry Smith   PetscFunctionBegin;
6946b5b1a830SBarry Smith   /* currently sctx is memory bleed */
694795dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
6948b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6949b5b1a830SBarry Smith   /*
6950b5b1a830SBarry Smith      This should work, but it doesn't
6951b5b1a830SBarry Smith   sctx->ctx = ctx;
6952b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6953b5b1a830SBarry Smith   */
6954b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6955bbd56ea5SKarl Rupp 
69560298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
6957b5b1a830SBarry Smith   PetscFunctionReturn(0);
6958b5b1a830SBarry Smith }
6959325fc9f4SBarry Smith #endif
6960b3603a34SBarry Smith 
6961b3603a34SBarry Smith /*@C
69624f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
6963b3603a34SBarry Smith        in a time based line graph
6964b3603a34SBarry Smith 
6965b3603a34SBarry Smith    Collective on TS
6966b3603a34SBarry Smith 
6967b3603a34SBarry Smith    Input Parameters:
6968b3603a34SBarry Smith +  ts - the TS context
6969b3603a34SBarry Smith .  step - current time-step
6970b3603a34SBarry Smith .  ptime - current time
69717db568b7SBarry Smith .  u - current solution
69727db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
6973b3603a34SBarry Smith 
6974b3d3934dSBarry Smith    Options Database:
69759ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
6976b3d3934dSBarry Smith 
6977b3603a34SBarry Smith    Level: intermediate
6978b3603a34SBarry Smith 
69796934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component solutions in a separate window
6980b3603a34SBarry Smith 
6981b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
6982b3603a34SBarry Smith 
69837db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
69847db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
69857db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
69867db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
6987b3603a34SBarry Smith @*/
69887db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6989b3603a34SBarry Smith {
6990b3603a34SBarry Smith   PetscErrorCode    ierr;
69917db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
6992b3603a34SBarry Smith   const PetscScalar *yy;
699380666b62SBarry Smith   Vec               v;
6994b3603a34SBarry Smith 
6995b3603a34SBarry Smith   PetscFunctionBegin;
699663e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
699758ff32f7SBarry Smith   if (!step) {
6998a9f9c1f6SBarry Smith     PetscDrawAxis axis;
69996934998bSLisandro Dalcin     PetscInt      dim;
7000a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7001a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
7002bab0a581SBarry Smith     if (!ctx->names) {
7003bab0a581SBarry Smith       PetscBool flg;
7004bab0a581SBarry Smith       /* user provides names of variables to plot but no names has been set so assume names are integer values */
7005bab0a581SBarry Smith       ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr);
7006bab0a581SBarry Smith       if (flg) {
7007bab0a581SBarry Smith         PetscInt i,n;
7008bab0a581SBarry Smith         char     **names;
7009bab0a581SBarry Smith         ierr = VecGetSize(u,&n);CHKERRQ(ierr);
7010bab0a581SBarry Smith         ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr);
7011bab0a581SBarry Smith         for (i=0; i<n; i++) {
7012bab0a581SBarry Smith           ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr);
7013bab0a581SBarry Smith           ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr);
7014bab0a581SBarry Smith         }
7015bab0a581SBarry Smith         names[n] = NULL;
7016bab0a581SBarry Smith         ctx->names = names;
7017bab0a581SBarry Smith       }
7018bab0a581SBarry Smith     }
7019387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
7020387f4636SBarry Smith       char      **displaynames;
7021387f4636SBarry Smith       PetscBool flg;
7022387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
702395dccacaSBarry Smith       ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr);
7024387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
7025c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
7026387f4636SBarry Smith       if (flg) {
7027a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
7028387f4636SBarry Smith       }
7029387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
7030387f4636SBarry Smith     }
7031387f4636SBarry Smith     if (ctx->displaynames) {
7032387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
7033387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
7034387f4636SBarry Smith     } else if (ctx->names) {
70350910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
70360b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7037387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
7038b0bc92c6SBarry Smith     } else {
7039b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
7040b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7041387f4636SBarry Smith     }
70420b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
704358ff32f7SBarry Smith   }
70446934998bSLisandro Dalcin 
70456934998bSLisandro Dalcin   if (!ctx->transform) v = u;
70466934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
704780666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
70486934998bSLisandro Dalcin   if (ctx->displaynames) {
70496934998bSLisandro Dalcin     PetscInt i;
70506934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
70516934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
70526934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
70536934998bSLisandro Dalcin   } else {
7054e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
7055e3efe391SJed Brown     PetscInt  i,n;
70566934998bSLisandro Dalcin     PetscReal *yreal;
705780666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
7058785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
7059e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
70600b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
7061e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
7062e3efe391SJed Brown #else
70630b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
7064e3efe391SJed Brown #endif
706580666b62SBarry Smith   }
70666934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
70676934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
70686934998bSLisandro Dalcin 
7069b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
70700b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
70716934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
70723923b477SBarry Smith   }
7073b3603a34SBarry Smith   PetscFunctionReturn(0);
7074b3603a34SBarry Smith }
7075b3603a34SBarry Smith 
7076b037adc7SBarry Smith /*@C
707731152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
7078b037adc7SBarry Smith 
7079b037adc7SBarry Smith    Collective on TS
7080b037adc7SBarry Smith 
7081b037adc7SBarry Smith    Input Parameters:
7082b037adc7SBarry Smith +  ts - the TS context
7083b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
7084b037adc7SBarry Smith 
7085b037adc7SBarry Smith    Level: intermediate
7086b037adc7SBarry Smith 
70877db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
70887db568b7SBarry Smith 
7089b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
7090b037adc7SBarry Smith 
7091a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
7092b037adc7SBarry Smith @*/
709331152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
7094b037adc7SBarry Smith {
7095b037adc7SBarry Smith   PetscErrorCode    ierr;
7096b037adc7SBarry Smith   PetscInt          i;
7097b037adc7SBarry Smith 
7098b037adc7SBarry Smith   PetscFunctionBegin;
7099b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7100b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
71015537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
7102b3d3934dSBarry Smith       break;
7103b3d3934dSBarry Smith     }
7104b3d3934dSBarry Smith   }
7105b3d3934dSBarry Smith   PetscFunctionReturn(0);
7106b3d3934dSBarry Smith }
7107b3d3934dSBarry Smith 
7108e673d494SBarry Smith /*@C
7109e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
7110e673d494SBarry Smith 
7111e673d494SBarry Smith    Collective on TS
7112e673d494SBarry Smith 
7113e673d494SBarry Smith    Input Parameters:
7114e673d494SBarry Smith +  ts - the TS context
7115e673d494SBarry Smith -  names - the names of the components, final string must be NULL
7116e673d494SBarry Smith 
7117e673d494SBarry Smith    Level: intermediate
7118e673d494SBarry Smith 
7119e673d494SBarry Smith .keywords: TS,  vector, monitor, view
7120e673d494SBarry Smith 
7121a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
7122e673d494SBarry Smith @*/
7123e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
7124e673d494SBarry Smith {
7125e673d494SBarry Smith   PetscErrorCode    ierr;
7126e673d494SBarry Smith 
7127e673d494SBarry Smith   PetscFunctionBegin;
7128e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
7129e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
7130e673d494SBarry Smith   PetscFunctionReturn(0);
7131e673d494SBarry Smith }
7132e673d494SBarry Smith 
7133b3d3934dSBarry Smith /*@C
7134b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
7135b3d3934dSBarry Smith 
7136b3d3934dSBarry Smith    Collective on TS
7137b3d3934dSBarry Smith 
7138b3d3934dSBarry Smith    Input Parameter:
7139b3d3934dSBarry Smith .  ts - the TS context
7140b3d3934dSBarry Smith 
7141b3d3934dSBarry Smith    Output Parameter:
7142b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
7143b3d3934dSBarry Smith 
7144b3d3934dSBarry Smith    Level: intermediate
7145b3d3934dSBarry Smith 
71467db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
71477db568b7SBarry Smith 
7148b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7149b3d3934dSBarry Smith 
7150b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7151b3d3934dSBarry Smith @*/
7152b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
7153b3d3934dSBarry Smith {
7154b3d3934dSBarry Smith   PetscInt       i;
7155b3d3934dSBarry Smith 
7156b3d3934dSBarry Smith   PetscFunctionBegin;
7157b3d3934dSBarry Smith   *names = NULL;
7158b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7159b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
71605537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
7161b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
7162b3d3934dSBarry Smith       break;
7163387f4636SBarry Smith     }
7164387f4636SBarry Smith   }
7165387f4636SBarry Smith   PetscFunctionReturn(0);
7166387f4636SBarry Smith }
7167387f4636SBarry Smith 
7168a66092f1SBarry Smith /*@C
7169a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
7170a66092f1SBarry Smith 
7171a66092f1SBarry Smith    Collective on TS
7172a66092f1SBarry Smith 
7173a66092f1SBarry Smith    Input Parameters:
7174a66092f1SBarry Smith +  ctx - the TSMonitorLG context
7175a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
7176a66092f1SBarry Smith 
7177a66092f1SBarry Smith    Level: intermediate
7178a66092f1SBarry Smith 
7179a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
7180a66092f1SBarry Smith 
7181a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
7182a66092f1SBarry Smith @*/
7183a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
7184a66092f1SBarry Smith {
7185a66092f1SBarry Smith   PetscInt          j = 0,k;
7186a66092f1SBarry Smith   PetscErrorCode    ierr;
7187a66092f1SBarry Smith 
7188a66092f1SBarry Smith   PetscFunctionBegin;
7189a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
7190a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
7191a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
7192a66092f1SBarry Smith   while (displaynames[j]) j++;
7193a66092f1SBarry Smith   ctx->ndisplayvariables = j;
7194a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
7195a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
7196a66092f1SBarry Smith   j = 0;
7197a66092f1SBarry Smith   while (displaynames[j]) {
7198a66092f1SBarry Smith     k = 0;
7199a66092f1SBarry Smith     while (ctx->names[k]) {
7200a66092f1SBarry Smith       PetscBool flg;
7201a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
7202a66092f1SBarry Smith       if (flg) {
7203a66092f1SBarry Smith         ctx->displayvariables[j] = k;
7204a66092f1SBarry Smith         break;
7205a66092f1SBarry Smith       }
7206a66092f1SBarry Smith       k++;
7207a66092f1SBarry Smith     }
7208a66092f1SBarry Smith     j++;
7209a66092f1SBarry Smith   }
7210a66092f1SBarry Smith   PetscFunctionReturn(0);
7211a66092f1SBarry Smith }
7212a66092f1SBarry Smith 
7213387f4636SBarry Smith /*@C
7214387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
7215387f4636SBarry Smith 
7216387f4636SBarry Smith    Collective on TS
7217387f4636SBarry Smith 
7218387f4636SBarry Smith    Input Parameters:
7219387f4636SBarry Smith +  ts - the TS context
7220387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
7221387f4636SBarry Smith 
72227db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
72237db568b7SBarry Smith 
7224387f4636SBarry Smith    Level: intermediate
7225387f4636SBarry Smith 
7226387f4636SBarry Smith .keywords: TS,  vector, monitor, view
7227387f4636SBarry Smith 
7228387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
7229387f4636SBarry Smith @*/
7230387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
7231387f4636SBarry Smith {
7232a66092f1SBarry Smith   PetscInt          i;
7233387f4636SBarry Smith   PetscErrorCode    ierr;
7234387f4636SBarry Smith 
7235387f4636SBarry Smith   PetscFunctionBegin;
7236387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7237387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
72385537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
7239b3d3934dSBarry Smith       break;
7240b037adc7SBarry Smith     }
7241b037adc7SBarry Smith   }
7242b037adc7SBarry Smith   PetscFunctionReturn(0);
7243b037adc7SBarry Smith }
7244b037adc7SBarry Smith 
724580666b62SBarry Smith /*@C
724680666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
724780666b62SBarry Smith 
724880666b62SBarry Smith    Collective on TS
724980666b62SBarry Smith 
725080666b62SBarry Smith    Input Parameters:
725180666b62SBarry Smith +  ts - the TS context
725280666b62SBarry Smith .  transform - the transform function
72537684fa3eSBarry Smith .  destroy - function to destroy the optional context
725480666b62SBarry Smith -  ctx - optional context used by transform function
725580666b62SBarry Smith 
72567db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
72577db568b7SBarry Smith 
725880666b62SBarry Smith    Level: intermediate
725980666b62SBarry Smith 
726080666b62SBarry Smith .keywords: TS,  vector, monitor, view
726180666b62SBarry Smith 
7262a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
726380666b62SBarry Smith @*/
72647684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
726580666b62SBarry Smith {
726680666b62SBarry Smith   PetscInt          i;
7267a66092f1SBarry Smith   PetscErrorCode    ierr;
726880666b62SBarry Smith 
726980666b62SBarry Smith   PetscFunctionBegin;
727080666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
727180666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
72725537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
727380666b62SBarry Smith     }
727480666b62SBarry Smith   }
727580666b62SBarry Smith   PetscFunctionReturn(0);
727680666b62SBarry Smith }
727780666b62SBarry Smith 
7278e673d494SBarry Smith /*@C
7279e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
7280e673d494SBarry Smith 
7281e673d494SBarry Smith    Collective on TSLGCtx
7282e673d494SBarry Smith 
7283e673d494SBarry Smith    Input Parameters:
7284e673d494SBarry Smith +  ts - the TS context
7285e673d494SBarry Smith .  transform - the transform function
72867684fa3eSBarry Smith .  destroy - function to destroy the optional context
7287e673d494SBarry Smith -  ctx - optional context used by transform function
7288e673d494SBarry Smith 
7289e673d494SBarry Smith    Level: intermediate
7290e673d494SBarry Smith 
7291e673d494SBarry Smith .keywords: TS,  vector, monitor, view
7292e673d494SBarry Smith 
7293a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
7294e673d494SBarry Smith @*/
72957684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
7296e673d494SBarry Smith {
7297e673d494SBarry Smith   PetscFunctionBegin;
7298e673d494SBarry Smith   ctx->transform    = transform;
72997684fa3eSBarry Smith   ctx->transformdestroy = destroy;
7300e673d494SBarry Smith   ctx->transformctx = tctx;
7301e673d494SBarry Smith   PetscFunctionReturn(0);
7302e673d494SBarry Smith }
7303e673d494SBarry Smith 
7304ef20d060SBarry Smith /*@C
73054f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
7306ef20d060SBarry Smith        in a time based line graph
7307ef20d060SBarry Smith 
7308ef20d060SBarry Smith    Collective on TS
7309ef20d060SBarry Smith 
7310ef20d060SBarry Smith    Input Parameters:
7311ef20d060SBarry Smith +  ts - the TS context
7312ef20d060SBarry Smith .  step - current time-step
7313ef20d060SBarry Smith .  ptime - current time
73147db568b7SBarry Smith .  u - current solution
73157db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
7316ef20d060SBarry Smith 
7317ef20d060SBarry Smith    Level: intermediate
7318ef20d060SBarry Smith 
73196934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component errors in a separate window
7320abd5a294SJed Brown 
7321abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
7322abd5a294SJed Brown 
7323abd5a294SJed Brown    Options Database Keys:
73244f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
7325ef20d060SBarry Smith 
7326ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
7327ef20d060SBarry Smith 
7328abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
7329ef20d060SBarry Smith @*/
73300910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
7331ef20d060SBarry Smith {
7332ef20d060SBarry Smith   PetscErrorCode    ierr;
73330b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
7334ef20d060SBarry Smith   const PetscScalar *yy;
7335ef20d060SBarry Smith   Vec               y;
7336ef20d060SBarry Smith 
7337ef20d060SBarry Smith   PetscFunctionBegin;
7338a9f9c1f6SBarry Smith   if (!step) {
7339a9f9c1f6SBarry Smith     PetscDrawAxis axis;
73406934998bSLisandro Dalcin     PetscInt      dim;
7341a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
73421ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
73430910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
7344a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7345a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7346a9f9c1f6SBarry Smith   }
73470910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
7348ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
73490910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
7350ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
7351e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
7352e3efe391SJed Brown   {
7353e3efe391SJed Brown     PetscReal *yreal;
7354e3efe391SJed Brown     PetscInt  i,n;
7355e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
7356785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
7357e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
73580b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
7359e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
7360e3efe391SJed Brown   }
7361e3efe391SJed Brown #else
73620b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
7363e3efe391SJed Brown #endif
7364ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
7365ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
7366b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
73670b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
73686934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
73693923b477SBarry Smith   }
7370ef20d060SBarry Smith   PetscFunctionReturn(0);
7371ef20d060SBarry Smith }
7372ef20d060SBarry Smith 
7373201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7374201da799SBarry Smith {
7375201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7376201da799SBarry Smith   PetscReal      x   = ptime,y;
7377201da799SBarry Smith   PetscErrorCode ierr;
7378201da799SBarry Smith   PetscInt       its;
7379201da799SBarry Smith 
7380201da799SBarry Smith   PetscFunctionBegin;
738163e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7382201da799SBarry Smith   if (!n) {
7383201da799SBarry Smith     PetscDrawAxis axis;
7384201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7385201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
7386201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7387201da799SBarry Smith     ctx->snes_its = 0;
7388201da799SBarry Smith   }
7389201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
7390201da799SBarry Smith   y    = its - ctx->snes_its;
7391201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
73923fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7393201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
73946934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7395201da799SBarry Smith   }
7396201da799SBarry Smith   ctx->snes_its = its;
7397201da799SBarry Smith   PetscFunctionReturn(0);
7398201da799SBarry Smith }
7399201da799SBarry Smith 
7400201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7401201da799SBarry Smith {
7402201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7403201da799SBarry Smith   PetscReal      x   = ptime,y;
7404201da799SBarry Smith   PetscErrorCode ierr;
7405201da799SBarry Smith   PetscInt       its;
7406201da799SBarry Smith 
7407201da799SBarry Smith   PetscFunctionBegin;
740863e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7409201da799SBarry Smith   if (!n) {
7410201da799SBarry Smith     PetscDrawAxis axis;
7411201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7412201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
7413201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7414201da799SBarry Smith     ctx->ksp_its = 0;
7415201da799SBarry Smith   }
7416201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
7417201da799SBarry Smith   y    = its - ctx->ksp_its;
7418201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
741999fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7420201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
74216934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7422201da799SBarry Smith   }
7423201da799SBarry Smith   ctx->ksp_its = its;
7424201da799SBarry Smith   PetscFunctionReturn(0);
7425201da799SBarry Smith }
7426f9c1d6abSBarry Smith 
7427f9c1d6abSBarry Smith /*@
7428f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
7429f9c1d6abSBarry Smith 
7430f9c1d6abSBarry Smith    Collective on TS and Vec
7431f9c1d6abSBarry Smith 
7432f9c1d6abSBarry Smith    Input Parameters:
7433f9c1d6abSBarry Smith +  ts - the TS context
7434f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
7435f9c1d6abSBarry Smith 
7436f9c1d6abSBarry Smith    Output Parameters:
7437f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
7438f9c1d6abSBarry Smith 
7439f9c1d6abSBarry Smith    Level: developer
7440f9c1d6abSBarry Smith 
7441f9c1d6abSBarry Smith .keywords: TS, compute
7442f9c1d6abSBarry Smith 
7443f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
7444f9c1d6abSBarry Smith @*/
7445f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
7446f9c1d6abSBarry Smith {
7447f9c1d6abSBarry Smith   PetscErrorCode ierr;
7448f9c1d6abSBarry Smith 
7449f9c1d6abSBarry Smith   PetscFunctionBegin;
7450f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7451ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
7452f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
7453f9c1d6abSBarry Smith   PetscFunctionReturn(0);
7454f9c1d6abSBarry Smith }
745524655328SShri 
7456b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
7457b3d3934dSBarry Smith /*@C
7458b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
7459b3d3934dSBarry Smith 
7460b3d3934dSBarry Smith    Collective on TS
7461b3d3934dSBarry Smith 
7462b3d3934dSBarry Smith    Input Parameters:
7463b3d3934dSBarry Smith .  ts  - the ODE solver object
7464b3d3934dSBarry Smith 
7465b3d3934dSBarry Smith    Output Parameter:
7466b3d3934dSBarry Smith .  ctx - the context
7467b3d3934dSBarry Smith 
7468b3d3934dSBarry Smith    Level: intermediate
7469b3d3934dSBarry Smith 
7470b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
7471b3d3934dSBarry Smith 
7472b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
7473b3d3934dSBarry Smith 
7474b3d3934dSBarry Smith @*/
7475b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
7476b3d3934dSBarry Smith {
7477b3d3934dSBarry Smith   PetscErrorCode ierr;
7478b3d3934dSBarry Smith 
7479b3d3934dSBarry Smith   PetscFunctionBegin;
7480a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
7481b3d3934dSBarry Smith   PetscFunctionReturn(0);
7482b3d3934dSBarry Smith }
7483b3d3934dSBarry Smith 
7484b3d3934dSBarry Smith /*@C
7485b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
7486b3d3934dSBarry Smith 
7487b3d3934dSBarry Smith    Collective on TS
7488b3d3934dSBarry Smith 
7489b3d3934dSBarry Smith    Input Parameters:
7490b3d3934dSBarry Smith +  ts - the TS context
7491b3d3934dSBarry Smith .  step - current time-step
7492b3d3934dSBarry Smith .  ptime - current time
74937db568b7SBarry Smith .  u  - current solution
74947db568b7SBarry Smith -  dctx - the envelope context
7495b3d3934dSBarry Smith 
7496b3d3934dSBarry Smith    Options Database:
7497b3d3934dSBarry Smith .  -ts_monitor_envelope
7498b3d3934dSBarry Smith 
7499b3d3934dSBarry Smith    Level: intermediate
7500b3d3934dSBarry Smith 
7501b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
7502b3d3934dSBarry Smith 
7503b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7504b3d3934dSBarry Smith 
75057db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
7506b3d3934dSBarry Smith @*/
75077db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7508b3d3934dSBarry Smith {
7509b3d3934dSBarry Smith   PetscErrorCode       ierr;
75107db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
7511b3d3934dSBarry Smith 
7512b3d3934dSBarry Smith   PetscFunctionBegin;
7513b3d3934dSBarry Smith   if (!ctx->max) {
7514b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
7515b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
7516b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
7517b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
7518b3d3934dSBarry Smith   } else {
7519b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
7520b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
7521b3d3934dSBarry Smith   }
7522b3d3934dSBarry Smith   PetscFunctionReturn(0);
7523b3d3934dSBarry Smith }
7524b3d3934dSBarry Smith 
7525b3d3934dSBarry Smith /*@C
7526b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
7527b3d3934dSBarry Smith 
7528b3d3934dSBarry Smith    Collective on TS
7529b3d3934dSBarry Smith 
7530b3d3934dSBarry Smith    Input Parameter:
7531b3d3934dSBarry Smith .  ts - the TS context
7532b3d3934dSBarry Smith 
7533b3d3934dSBarry Smith    Output Parameter:
7534b3d3934dSBarry Smith +  max - the maximum values
7535b3d3934dSBarry Smith -  min - the minimum values
7536b3d3934dSBarry Smith 
75377db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
75387db568b7SBarry Smith 
7539b3d3934dSBarry Smith    Level: intermediate
7540b3d3934dSBarry Smith 
7541b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7542b3d3934dSBarry Smith 
7543b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7544b3d3934dSBarry Smith @*/
7545b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
7546b3d3934dSBarry Smith {
7547b3d3934dSBarry Smith   PetscInt i;
7548b3d3934dSBarry Smith 
7549b3d3934dSBarry Smith   PetscFunctionBegin;
7550b3d3934dSBarry Smith   if (max) *max = NULL;
7551b3d3934dSBarry Smith   if (min) *min = NULL;
7552b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7553b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
75545537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7555b3d3934dSBarry Smith       if (max) *max = ctx->max;
7556b3d3934dSBarry Smith       if (min) *min = ctx->min;
7557b3d3934dSBarry Smith       break;
7558b3d3934dSBarry Smith     }
7559b3d3934dSBarry Smith   }
7560b3d3934dSBarry Smith   PetscFunctionReturn(0);
7561b3d3934dSBarry Smith }
7562b3d3934dSBarry Smith 
7563b3d3934dSBarry Smith /*@C
7564b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7565b3d3934dSBarry Smith 
7566b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7567b3d3934dSBarry Smith 
7568b3d3934dSBarry Smith    Input Parameter:
7569b3d3934dSBarry Smith .  ctx - the monitor context
7570b3d3934dSBarry Smith 
7571b3d3934dSBarry Smith    Level: intermediate
7572b3d3934dSBarry Smith 
7573b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
7574b3d3934dSBarry Smith 
75757db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7576b3d3934dSBarry Smith @*/
7577b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7578b3d3934dSBarry Smith {
7579b3d3934dSBarry Smith   PetscErrorCode ierr;
7580b3d3934dSBarry Smith 
7581b3d3934dSBarry Smith   PetscFunctionBegin;
7582b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7583b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7584b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7585b3d3934dSBarry Smith   PetscFunctionReturn(0);
7586b3d3934dSBarry Smith }
7587f2dee214SBarry Smith 
758824655328SShri /*@
758924655328SShri    TSRollBack - Rolls back one time step
759024655328SShri 
759124655328SShri    Collective on TS
759224655328SShri 
759324655328SShri    Input Parameter:
759424655328SShri .  ts - the TS context obtained from TSCreate()
759524655328SShri 
759624655328SShri    Level: advanced
759724655328SShri 
759824655328SShri .keywords: TS, timestep, rollback
759924655328SShri 
760024655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
760124655328SShri @*/
760224655328SShri PetscErrorCode  TSRollBack(TS ts)
760324655328SShri {
760424655328SShri   PetscErrorCode ierr;
760524655328SShri 
760624655328SShri   PetscFunctionBegin;
760724655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7608b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
760924655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
761024655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
761124655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
761224655328SShri   ts->ptime = ts->ptime_prev;
7613be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
7614be5899b3SLisandro Dalcin   ts->steps--; ts->total_steps--;
761510b82f12SShri Abhyankar   ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
7616b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
761724655328SShri   PetscFunctionReturn(0);
761824655328SShri }
7619aeb4809dSShri Abhyankar 
7620ff22ae23SHong Zhang /*@
7621ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7622ff22ae23SHong Zhang 
7623ff22ae23SHong Zhang    Input Parameter:
7624ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7625ff22ae23SHong Zhang 
7626ff22ae23SHong Zhang    Level: advanced
7627ff22ae23SHong Zhang 
7628ff22ae23SHong Zhang .keywords: TS, getstages
7629ff22ae23SHong Zhang 
7630ff22ae23SHong Zhang .seealso: TSCreate()
7631ff22ae23SHong Zhang @*/
7632ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7633ff22ae23SHong Zhang {
7634ff22ae23SHong Zhang   PetscErrorCode ierr;
7635ff22ae23SHong Zhang 
7636ff22ae23SHong Zhang   PetscFunctionBegin;
7637ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7638ff22ae23SHong Zhang   PetscValidPointer(ns,2);
7639ff22ae23SHong Zhang 
7640ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
7641ff22ae23SHong Zhang   else {
7642ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7643ff22ae23SHong Zhang   }
7644ff22ae23SHong Zhang   PetscFunctionReturn(0);
7645ff22ae23SHong Zhang }
7646ff22ae23SHong Zhang 
7647847ff0e1SMatthew G. Knepley /*@C
7648847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7649847ff0e1SMatthew G. Knepley 
7650847ff0e1SMatthew G. Knepley   Collective on SNES
7651847ff0e1SMatthew G. Knepley 
7652847ff0e1SMatthew G. Knepley   Input Parameters:
7653847ff0e1SMatthew G. Knepley + ts - the TS context
7654847ff0e1SMatthew G. Knepley . t - current timestep
7655847ff0e1SMatthew G. Knepley . U - state vector
7656847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7657847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7658847ff0e1SMatthew G. Knepley - ctx - an optional user context
7659847ff0e1SMatthew G. Knepley 
7660847ff0e1SMatthew G. Knepley   Output Parameters:
7661847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7662847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7663847ff0e1SMatthew G. Knepley 
7664847ff0e1SMatthew G. Knepley   Level: intermediate
7665847ff0e1SMatthew G. Knepley 
7666847ff0e1SMatthew G. Knepley   Notes:
7667847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7668847ff0e1SMatthew G. Knepley 
7669847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7670847ff0e1SMatthew G. Knepley 
7671847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7672847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7673847ff0e1SMatthew G. Knepley 
7674847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7675847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7676847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7677847ff0e1SMatthew G. Knepley 
7678847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
7679847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7680847ff0e1SMatthew G. Knepley @*/
7681847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7682847ff0e1SMatthew G. Knepley {
7683847ff0e1SMatthew G. Knepley   SNES           snes;
7684847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7685847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7686847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
7687847ff0e1SMatthew G. Knepley 
7688847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
7689c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
7690847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
7691847ff0e1SMatthew G. Knepley   if (!color) {
7692847ff0e1SMatthew G. Knepley     DM         dm;
7693847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
7694847ff0e1SMatthew G. Knepley 
7695847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
7696847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
7697847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
7698847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
7699847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7700847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7701847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7702847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7703847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7704847ff0e1SMatthew G. Knepley     } else {
7705847ff0e1SMatthew G. Knepley       MatColoring mc;
7706847ff0e1SMatthew G. Knepley 
7707847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
7708847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
7709847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
7710847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
7711847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
7712847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
7713847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7714847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7715847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7716847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7717847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7718847ff0e1SMatthew G. Knepley     }
7719847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
7720847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
7721847ff0e1SMatthew G. Knepley   }
7722847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
7723847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
7724847ff0e1SMatthew G. Knepley   if (J != B) {
7725847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7726847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7727847ff0e1SMatthew G. Knepley   }
7728847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
7729847ff0e1SMatthew G. Knepley }
773093b34091SDebojyoti Ghosh 
7731cb9d8021SPierre Barbier de Reuille /*@
7732cb9d8021SPierre Barbier de Reuille     TSSetFunctionDomainError - Set the function testing if the current state vector is valid
7733cb9d8021SPierre Barbier de Reuille 
7734cb9d8021SPierre Barbier de Reuille     Input Parameters:
7735cb9d8021SPierre Barbier de Reuille     ts - the TS context
7736cb9d8021SPierre Barbier de Reuille     func - function called within TSFunctionDomainError
7737cb9d8021SPierre Barbier de Reuille 
7738cb9d8021SPierre Barbier de Reuille     Level: intermediate
7739cb9d8021SPierre Barbier de Reuille 
7740cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain
7741cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
7742cb9d8021SPierre Barbier de Reuille @*/
7743cb9d8021SPierre Barbier de Reuille 
7744d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
7745cb9d8021SPierre Barbier de Reuille {
7746cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7747cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7748cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
7749cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7750cb9d8021SPierre Barbier de Reuille }
7751cb9d8021SPierre Barbier de Reuille 
7752cb9d8021SPierre Barbier de Reuille /*@
7753cb9d8021SPierre Barbier de Reuille     TSFunctionDomainError - Check if the current state is valid
7754cb9d8021SPierre Barbier de Reuille 
7755cb9d8021SPierre Barbier de Reuille     Input Parameters:
7756cb9d8021SPierre Barbier de Reuille     ts - the TS context
7757cb9d8021SPierre Barbier de Reuille     stagetime - time of the simulation
7758d183316bSPierre Barbier de Reuille     Y - state vector to check.
7759cb9d8021SPierre Barbier de Reuille 
7760cb9d8021SPierre Barbier de Reuille     Output Parameter:
7761cb9d8021SPierre Barbier de Reuille     accept - Set to PETSC_FALSE if the current state vector is valid.
7762cb9d8021SPierre Barbier de Reuille 
7763cb9d8021SPierre Barbier de Reuille     Note:
7764cb9d8021SPierre Barbier de Reuille     This function should be used to ensure the state is in a valid part of the space.
7765cb9d8021SPierre Barbier de Reuille     For example, one can ensure here all values are positive.
776696a0c994SBarry Smith 
776796a0c994SBarry Smith     Level: advanced
7768cb9d8021SPierre Barbier de Reuille @*/
7769d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
7770cb9d8021SPierre Barbier de Reuille {
7771cb9d8021SPierre Barbier de Reuille   PetscErrorCode ierr;
7772cb9d8021SPierre Barbier de Reuille 
7773cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7774cb9d8021SPierre Barbier de Reuille 
7775cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7776cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
7777cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
7778d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
7779cb9d8021SPierre Barbier de Reuille   }
7780cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7781cb9d8021SPierre Barbier de Reuille }
77821ceb14c0SBarry Smith 
778393b34091SDebojyoti Ghosh /*@C
7784e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
778593b34091SDebojyoti Ghosh 
778693b34091SDebojyoti Ghosh   Collective on MPI_Comm
778793b34091SDebojyoti Ghosh 
778893b34091SDebojyoti Ghosh   Input Parameter:
778993b34091SDebojyoti Ghosh . tsin    - The input TS
779093b34091SDebojyoti Ghosh 
779193b34091SDebojyoti Ghosh   Output Parameter:
7792e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
779393b34091SDebojyoti Ghosh 
77945eca1a21SEmil Constantinescu   Notes:
77955eca1a21SEmil 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.
77965eca1a21SEmil Constantinescu 
7797baa10174SEmil 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);
77985eca1a21SEmil Constantinescu 
77995eca1a21SEmil Constantinescu   Level: developer
780093b34091SDebojyoti Ghosh 
7801e5168f73SEmil Constantinescu .keywords: TS, clone
7802e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
780393b34091SDebojyoti Ghosh @*/
7804baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
780593b34091SDebojyoti Ghosh {
780693b34091SDebojyoti Ghosh   TS             t;
780793b34091SDebojyoti Ghosh   PetscErrorCode ierr;
7808dc846ba4SSatish Balay   SNES           snes_start;
7809dc846ba4SSatish Balay   DM             dm;
7810dc846ba4SSatish Balay   TSType         type;
781193b34091SDebojyoti Ghosh 
781293b34091SDebojyoti Ghosh   PetscFunctionBegin;
781393b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
781493b34091SDebojyoti Ghosh   *tsout = NULL;
781593b34091SDebojyoti Ghosh 
78167a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
781793b34091SDebojyoti Ghosh 
781893b34091SDebojyoti Ghosh   /* General TS description */
781993b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
782093b34091SDebojyoti Ghosh   t->setupcalled       = 0;
782193b34091SDebojyoti Ghosh   t->ksp_its           = 0;
782293b34091SDebojyoti Ghosh   t->snes_its          = 0;
782393b34091SDebojyoti Ghosh   t->nwork             = 0;
782493b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
782593b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
782693b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
782793b34091SDebojyoti Ghosh 
782834561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
782934561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
7830d15a3a53SEmil Constantinescu 
783193b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
783293b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
783393b34091SDebojyoti Ghosh 
783493b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
783551699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
783693b34091SDebojyoti Ghosh 
7837e7069c78SShri   t->trajectory = tsin->trajectory;
7838e7069c78SShri   ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr);
7839e7069c78SShri 
7840e7069c78SShri   t->event = tsin->event;
78416b10a48eSSatish Balay   if (t->event) t->event->refct++;
7842e7069c78SShri 
784393b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
784493b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
7845e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
784693b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
784793b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
784893b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
7849e7069c78SShri   t->total_steps       = tsin->total_steps;
785093b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
785193b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
785293b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
785393b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
785493b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
785593b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
785693b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
785793b34091SDebojyoti Ghosh 
785893b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
785993b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
786093b34091SDebojyoti Ghosh 
786193b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
786293b34091SDebojyoti Ghosh 
786393b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
786493b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
786593b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
786693b34091SDebojyoti Ghosh 
786793b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
786893b34091SDebojyoti Ghosh 
78690d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
78700d4fed19SBarry Smith     PetscInt i;
78710d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
78720d4fed19SBarry Smith     for (i=0; i<10; i++) {
78730d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
78740d4fed19SBarry Smith     }
78750d4fed19SBarry Smith   }
787693b34091SDebojyoti Ghosh   *tsout = t;
787793b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
787893b34091SDebojyoti Ghosh }
7879